Class TokenAmount<T>

Contains token structure with price and amount.

Type Parameters

T extends BlockchainName = BlockchainName

Hierarchy

Token<T>
- TokenAmount

Index

Constructors

Properties

address blockchain decimals name symbol

Accessors

asStruct isNative isWrapped stringWeiAmount tokenAmount weiAmount

Methods

clone isEqualTo isEqualToTokens weiAmountMinusSlippage weiAmountPlusSlippage createToken createTokens tokensToAddresses

Constructors

constructor

new TokenAmount<T>(tokenStruct: TokenAmountStruct<T>): TokenAmount<T>
Type Parameters
- T extends BlockchainName = BlockchainName
Parameters
- tokenStruct: TokenAmountStruct<T>
Returns TokenAmount<T>
Overrides Token.constructor
- Defined in src/common/tokens/token-amount.ts:64

Properties

`Readonly` address

address: string

`Readonly` blockchain

blockchain: T

`Readonly` decimals

decimals: number

`Readonly` name

name: string

`Readonly` symbol

symbol: string

Accessors

asStruct

get asStruct(): TokenAmountStruct<T>
Serializes priceTokenAmount to struct object.

Returns TokenAmountStruct<T>
- Defined in src/common/tokens/token-amount.ts:57

isNative

get isNative(): boolean
Returns boolean
Inherited from Token.isNative
- Defined in src/common/tokens/token.ts:118

isWrapped

get isWrapped(): boolean
Returns boolean
Inherited from Token.isWrapped
- Defined in src/common/tokens/token.ts:128

stringWeiAmount

get stringWeiAmount(): string
Gets set amount in wei and converted to string.

Returns string
- Defined in src/common/tokens/token-amount.ts:43

tokenAmount

get tokenAmount(): BigNumber
Gets set amount with decimals.

Returns BigNumber
- Defined in src/common/tokens/token-amount.ts:50

weiAmount

get weiAmount(): BigNumber
Gets set amount in wei.

Returns BigNumber
- Defined in src/common/tokens/token-amount.ts:36

Methods

clone

clone(tokenStruct?: Partial<TokenAmountStruct<BlockchainName>>): TokenAmount<BlockchainName>
Parameters
- Optional tokenStruct: Partial<TokenAmountStruct<BlockchainName>>
Returns TokenAmount<BlockchainName>
Overrides Token.clone
- Defined in src/common/tokens/token-amount.ts:91

isEqualTo

isEqualTo(token: TokenBaseStruct<BlockchainName>): boolean
Parameters
- token: TokenBaseStruct<BlockchainName>
Returns boolean
Inherited from Token.isEqualTo
- Defined in src/common/tokens/token.ts:145

isEqualToTokens

isEqualToTokens(tokens: TokenBaseStruct<BlockchainName>[]): boolean
Parameters
- tokens: TokenBaseStruct<BlockchainName>[]
Returns boolean
Inherited from Token.isEqualToTokens
- Defined in src/common/tokens/token.ts:151

weiAmountMinusSlippage

weiAmountMinusSlippage(slippage: number): BigNumber
Returns wei amount decreased by (1 - slippage) times.
Parameters
- slippage: number
  
  Slippage in range from 0 to 1.
Returns BigNumber
- Defined in src/common/tokens/token-amount.ts:79

weiAmountPlusSlippage

weiAmountPlusSlippage(slippage: number): BigNumber
Returns wei amount increased by (1 - slippage) times.
Parameters
- slippage: number
  
  Slippage in range from 0 to 1.
Returns BigNumber
- Defined in src/common/tokens/token-amount.ts:87

`Static` createToken

createToken<T>(tokenAmountBaseStruct: TokenAmountBaseStruct<T>): Promise<TokenAmount<T>>
Creates PriceTokenAmount based on token's address and blockchain.
Type Parameters
- T extends BlockchainName = BlockchainName
Parameters
- tokenAmountBaseStruct: TokenAmountBaseStruct<T>
  
  Base token structure with amount.
Returns Promise<TokenAmount<T>>
Overrides Token.createToken
- Defined in src/common/tokens/token-amount.ts:21

`Static` createTokens

createTokens<T>(tokensAddresses: string[] | readonly string[], blockchain: T): Promise<Token<T>[]>
Creates array of Tokens based on tokens' addresses and blockchain.
Type Parameters
- T extends BlockchainName = BlockchainName
Parameters
- tokensAddresses: string[] | readonly string[]
- blockchain: T
Returns Promise<Token<T>[]>
Inherited from Token.createTokens
- Defined in src/common/tokens/token.ts:67

`Static` tokensToAddresses

tokensToAddresses(tokens: Token<BlockchainName>[]): string[]
Maps provided tokens to their addresses.
Parameters
- tokens: Token<BlockchainName>[]
Returns string[]
Inherited from Token.tokensToAddresses
- Defined in src/common/tokens/token.ts:104

Generated using TypeDoc