Class PriceToken<T>

Contains token structure with price in usd per 1 unit.

Type Parameters

T extends BlockchainName = BlockchainName

Hierarchy

Token<T>
- PriceToken
  - PriceTokenAmount

Index

Constructors

Properties

address blockchain decimals name symbol

Accessors

asStruct isNative isWrapped price

Methods

clone cloneAndCreate getAndUpdateTokenPrice isEqualTo isEqualToTokens createFromToken createToken createTokens tokensToAddresses

Constructors

constructor

new PriceToken<T>(tokenStruct: PriceTokenStruct<T>): PriceToken<T>
Type Parameters
- T extends BlockchainName = BlockchainName
Parameters
- tokenStruct: PriceTokenStruct<T>
Returns PriceToken<T>
Overrides Token.constructor
- Defined in src/common/tokens/price-token.ts:63

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(): PriceTokenStruct<T>
Serializes priceToken and its price to struct object.

Returns PriceTokenStruct<T>
- Defined in src/common/tokens/price-token.ts:56

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

price

get price(): BigNumber
Returns BigNumber
- Defined in src/common/tokens/price-token.ts:49

Methods

clone

clone(tokenStruct?: Partial<PriceTokenStruct<BlockchainName>>): PriceToken<BlockchainName>
Parameters
- Optional tokenStruct: Partial<PriceTokenStruct<BlockchainName>>
Returns PriceToken<BlockchainName>
Overrides Token.clone
- Defined in src/common/tokens/price-token.ts:92

cloneAndCreate

cloneAndCreate(tokenStruct?: Partial<PriceTokenStruct<BlockchainName>>): Promise<PriceToken<BlockchainName>>
Clones token with fetching new price.
Parameters
- Optional tokenStruct: Partial<PriceTokenStruct<BlockchainName>>
Returns Promise<PriceToken<BlockchainName>>
- Defined in src/common/tokens/price-token.ts:84

getAndUpdateTokenPrice

getAndUpdateTokenPrice(): Promise<BigNumber>
Fetches current token price and saves it into token.

Returns Promise<BigNumber>
- Defined in src/common/tokens/price-token.ts:71

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

`Static` createFromToken

createFromToken<T>(token: TokenStruct<T>): Promise<PriceToken<T>>
Creates PriceToken, fetching token's price.
Type Parameters
- T extends BlockchainName = BlockchainName
Parameters
- token: TokenStruct<T>
  
  Token structure.
Returns Promise<PriceToken<T>>
- Defined in src/common/tokens/price-token.ts:37

`Static` createToken

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

`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