Class TokenAmount

Hierarchy

TokenAmount

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TokenAmount(lamports: BN, decimals: number, mint: PublicKey): TokenAmount

- Defined in common/tokenAmount.ts:25
Creates an instance of TokenAmount.

memberof
TokenAmount

Parameters
- lamports: BN
- decimals: number
- mint: PublicKey
Returns TokenAmount

Properties

decimals

decimals: number

Number of decimals configured for token's mint

lamports

lamports: BN

Raw amount of token lamports

mint

mint: PublicKey

tokens

tokens: number

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

uiTokens

uiTokens: string

Token amount as string for UI, accounts for decimals. Imprecise at large numbers

Methods

add

add(b: TokenAmount): TokenAmount

- Defined in common/tokenAmount.ts:156
Parameters
- b: TokenAmount
Returns TokenAmount

addb

addb(b: BN): TokenAmount

- Defined in common/tokenAmount.ts:160
Parameters
- b: BN
Returns TokenAmount

addn

addn(b: number): TokenAmount

- Defined in common/tokenAmount.ts:164
Parameters
- b: number
Returns TokenAmount

div

div(b: TokenAmount): TokenAmount

- Defined in common/tokenAmount.ts:192
Parameters
- b: TokenAmount
Returns TokenAmount

divb

divb(b: BN): TokenAmount

- Defined in common/tokenAmount.ts:196
Parameters
- b: BN
Returns TokenAmount

divn

divn(b: number): TokenAmount

- Defined in common/tokenAmount.ts:200
Parameters
- b: number
Returns TokenAmount

eq

eq(b: TokenAmount): boolean

- Defined in common/tokenAmount.ts:212
Parameters
- b: TokenAmount
Returns boolean

gt

gt(b: TokenAmount): boolean

- Defined in common/tokenAmount.ts:208
Parameters
- b: TokenAmount
Returns boolean

isZero

isZero(): boolean

- Defined in common/tokenAmount.ts:216
Returns boolean

lt

lt(b: TokenAmount): boolean

- Defined in common/tokenAmount.ts:204
Parameters
- b: TokenAmount
Returns boolean

mul

mul(b: TokenAmount): TokenAmount

- Defined in common/tokenAmount.ts:180
Parameters
- b: TokenAmount
Returns TokenAmount

mulb

mulb(b: BN): TokenAmount

- Defined in common/tokenAmount.ts:184
Parameters
- b: BN
Returns TokenAmount

muln

muln(b: number): TokenAmount

- Defined in common/tokenAmount.ts:188
Parameters
- b: number
Returns TokenAmount

sub

sub(b: TokenAmount): TokenAmount

- Defined in common/tokenAmount.ts:168
Parameters
- b: TokenAmount
Returns TokenAmount

subb

subb(b: BN): TokenAmount

- Defined in common/tokenAmount.ts:172
Parameters
- b: BN
Returns TokenAmount

subn

subn(b: number): TokenAmount

- Defined in common/tokenAmount.ts:176
Parameters
- b: number
Returns TokenAmount

Static mint

mint(mint: Mint, mintAddress: PublicKey): TokenAmount

- Defined in common/tokenAmount.ts:66
static
memberof
TokenAmount

Parameters
- mint: Mint
- mintAddress: PublicKey
Returns TokenAmount

Static tokenAccount

tokenAccount(tokenAccount: Account, decimals: number): TokenAmount

- Defined in common/tokenAmount.ts:55
static
memberof
TokenAmount

Parameters
- tokenAccount: Account
- decimals: number
Returns TokenAmount

Static tokenPrice

tokenPrice(marketValue: number, price: number, decimals: number, mint: PublicKey): TokenAmount

- Defined in common/tokenAmount.ts:104
static
memberof
TokenAmount

Parameters
- marketValue: number
- price: number
- decimals: number
- mint: PublicKey
Returns TokenAmount

Static tokens

tokens(tokenAmount: string, decimals: number, mint: PublicKey): TokenAmount

- Defined in common/tokenAmount.ts:78
static
memberof
TokenAmount

Parameters
- tokenAmount: string
- decimals: number
- mint: PublicKey
Returns TokenAmount

Static zero

zero(decimals: number, mint: PublicKey): TokenAmount

- Defined in common/tokenAmount.ts:44
static
memberof
TokenAmount

Parameters
- decimals: number
- mint: PublicKey
Returns TokenAmount

Generated using TypeDoc