Class Token<T>

Contains main token's fields.

Type Parameters

T extends BlockchainName = BlockchainName

Hierarchy

Token
- PriceToken
- TokenAmount

Index

Constructors

Properties

address blockchain decimals name symbol

Accessors

isNative isWrapped

Methods

clone isEqualTo isEqualToTokens createToken createTokens tokensToAddresses

Constructors

constructor

new Token<T>(tokenStruct: TokenStruct<T>): Token<T>
Type Parameters
- T extends BlockchainName = BlockchainName
Parameters
- tokenStruct: TokenStruct<T>
Returns Token<T>
- Defined in src/common/tokens/token.ts:137

Properties

`Readonly` address

address: string

`Readonly` blockchain

blockchain: T

`Readonly` decimals

decimals: number

`Readonly` name

name: string

`Readonly` symbol

symbol: string

Accessors

isNative

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

isWrapped

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

Methods

clone

clone(tokenStruct?: Partial<TokenStruct<BlockchainName>>): Token<BlockchainName>
Parameters
- Optional tokenStruct: Partial<TokenStruct<BlockchainName>>
Returns Token<BlockchainName>
- Defined in src/common/tokens/token.ts:155

isEqualTo

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

isEqualToTokens

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

`Static` createToken

createToken<T>(tokenBaseStruct: TokenBaseStruct<T>): Promise<Token<T>>
Creates Token based on token's address and blockchain.
Type Parameters
- T extends BlockchainName = BlockchainName
Parameters
- tokenBaseStruct: TokenBaseStruct<T>
  
  Base token structure.
Returns Promise<Token<T>>
- Defined in src/common/tokens/token.ts:30

`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>[]>
- 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[]
- Defined in src/common/tokens/token.ts:104

Generated using TypeDoc