Class TokenAmount

Hierarchy

TokenAmount

Index

Constructors

Properties

amount decimals uiAmount uiAmountFloat

Methods

add addb addn div divb divn do eq gt isZero lt mul mulb muln sub subb subn mint tokenAccount tokenAmount tokenPrice tokens tokensToLamports zero

Constructors

constructor

new TokenAmount(amount: BN, decimals: number): helpers.TokenAmount
Parameters
- amount: BN
- decimals: number
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:91

Properties

amount

amount: BN

Raw amount of token lamports

decimals

decimals: number

Number of decimals configured for token's mint

uiAmount

uiAmount: string

Token amount as string, accounts for decimals

uiAmountFloat

uiAmountFloat: number

Token amount as a float, accounts for decimals. Imprecise at large numbers

Methods

add

add(b: helpers.TokenAmount): helpers.TokenAmount
Parameters
- b: helpers.TokenAmount
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:167

addb

addb(b: BN): helpers.TokenAmount
Parameters
- b: BN
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:171

addn

addn(b: number): helpers.TokenAmount
Parameters
- b: number
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:175

div

div(b: helpers.TokenAmount): helpers.TokenAmount
Parameters
- b: helpers.TokenAmount
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:203

divb

divb(b: BN): helpers.TokenAmount
Parameters
- b: BN
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:207

divn

divn(b: number): helpers.TokenAmount
Parameters
- b: number
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:211

`Private` do

do(b: helpers.TokenAmount, fn: ((b: BN) => BN)): helpers.TokenAmount
Parameters
- b: helpers.TokenAmount
- fn: ((b: BN) => BN)
  - - (b: BN): BN
    - Parameters
      
      b: BN
      
      Returns BN
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:231

eq

eq(b: helpers.TokenAmount): boolean
Parameters
- b: helpers.TokenAmount
Returns boolean
- Defined in src/helpers/util.ts:223

gt

gt(b: helpers.TokenAmount): boolean
Parameters
- b: helpers.TokenAmount
Returns boolean
- Defined in src/helpers/util.ts:219

isZero

isZero(): boolean
Returns boolean
- Defined in src/helpers/util.ts:227

lt

lt(b: helpers.TokenAmount): boolean
Parameters
- b: helpers.TokenAmount
Returns boolean
- Defined in src/helpers/util.ts:215

mul

mul(b: helpers.TokenAmount): helpers.TokenAmount
Parameters
- b: helpers.TokenAmount
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:191

mulb

mulb(b: BN): helpers.TokenAmount
Parameters
- b: BN
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:195

muln

muln(b: number): helpers.TokenAmount
Parameters
- b: number
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:199

sub

sub(b: helpers.TokenAmount): helpers.TokenAmount
Parameters
- b: helpers.TokenAmount
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:179

subb

subb(b: BN): helpers.TokenAmount
Parameters
- b: BN
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:183

subn

subn(b: number): helpers.TokenAmount
Parameters
- b: number
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:187

`Static` mint

mint(mint: MintInfo): helpers.TokenAmount
Parameters
- mint: MintInfo
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:110

`Static` tokenAccount

tokenAccount(tokenAccount: TokenAccountInfo, decimals: number): helpers.TokenAmount
Parameters
- tokenAccount: TokenAccountInfo
- decimals: number
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:106

`Static` `Private` tokenAmount

tokenAmount(lamports: BN, decimals: number): number
Parameters
- lamports: BN
- decimals: number
Returns number
- Defined in src/helpers/util.ts:118

`Static` tokenPrice

tokenPrice(marketValue: number, price: number, decimals: number): helpers.TokenAmount
Parameters
- marketValue: number
- price: number
- decimals: number
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:123

`Static` tokens

tokens(tokenAmount: string, decimals: number): helpers.TokenAmount
Parameters
- tokenAmount: string
- decimals: number
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:114

`Static` `Private` tokensToLamports

tokensToLamports(uiAmount: string, decimals: number): BN
Parameters
- uiAmount: string
- decimals: number
Returns BN
- Defined in src/helpers/util.ts:129

`Static` zero

zero(decimals: number): helpers.TokenAmount
Parameters
- decimals: number
Returns helpers.TokenAmount
- Defined in src/helpers/util.ts:102

Generated using TypeDoc