Module utils/src

Index

Variables

Functions

Variables

Const MAX_GAS

MAX_GAS: BN = ...

Const ONE_TGAS

ONE_TGAS: BN = ...

Const ZERO

ZERO: BN = ...

Functions

bnToApproximateDecimal

bnToApproximateDecimal(v: BN, decimals: number, precision?: number): number

- Defined in utils/src/math.ts:27
Parameters
- v: BN
- decimals: number
- Optional precision: number
Returns number

bnToFixed

bnToFixed(num: BN, decimals: number, precision?: number): string

- Defined in utils/src/format.ts:12
Analogous to Number.toFixed() for BN values. Example

example
bnToFixed(new BN(123), 2, 5) === '1.23000'; // true

Parameters
- num: BN
  
  on-chain integer representation
- decimals: number
  
  number of decimals
- Optional precision: number
  
  optional precision, same as in Number.toFixed()
Returns string

decimalToBn

decimalToBn(price: number, decimals: number): BN

- Defined in utils/src/math.ts:35
Parameters
- price: number
- decimals: number
Returns BN

denomination

denomination(decimals: number): BN

- Defined in utils/src/math.ts:7
Parameters
- decimals: number
Returns BN

floorToBn

floorToBn(v: BN, closest: BN): BN

- Defined in utils/src/math.ts:23
Parameters
- v: BN
- closest: BN
Returns BN

floorToDecimals

floorToDecimals(v: BN, decimals: number): BN

- Defined in utils/src/math.ts:15
Parameters
- v: BN
- decimals: number
Returns BN

functionCallWithOutcome

functionCallWithOutcome<T>(account: Account, params: FunctionCallOptions): Promise<{ executionOutcome: FinalExecutionOutcome; response: T }>

- Defined in utils/src/functionCallWithOutcome.ts:16
This function calls a change method, returning both the return value of the call and the execution outcome.

Some use cases need transaction/receipt IDs after calling a change method, which makes the NEAR SDK's Contract class unsuitable. https://github.com/near/near-api-js/blob/c84aef6cc18fe5ac1063411c95283ba3130fa656/src/contract.ts#L145

Type Parameters
- T = any
Parameters
- account: Account
- params: FunctionCallOptions
Returns Promise<{ executionOutcome: FinalExecutionOutcome; response: T }>

roundDownTo

roundDownTo(v: BN, nearest: BN): BN

- Defined in utils/src/math.ts:11
Parameters
- v: BN
- nearest: BN
Returns BN

tgasAmount

tgasAmount(tgas: number): BN

- Defined in utils/src/gas.ts:6
Parameters
- tgas: number
Returns BN

toDecimalPaddedString

toDecimalPaddedString(val: string, decimals?: number): string

- Defined in utils/src/format.ts:49
Turn a decimal number into its on-chain integer representation.

example
toDecimalPaddedString('1.23', 2) === '123'

Parameters
- val: string
  
  A number as a string
- Optional decimals: number
  
  Number of decimals
Returns string
BN of the number

Generated using TypeDoc