Class PriceTokenAmount<T>

Contains token structure with price and amount.

Type Parameters

T extends BlockchainName = BlockchainName

Hierarchy

PriceToken<T>
- PriceTokenAmount

Index

Constructors

constructor

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

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>
Inherited from PriceToken.asStruct
- Defined in src/common/tokens/price-token.ts:56

asStructWithAmount

get asStructWithAmount(): PriceTokenAmountStruct<T>
Serializes priceTokenAmount to struct object.

Returns PriceTokenAmountStruct<T>
- Defined in src/common/tokens/price-token-amount.ts:74

isNative

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

isWrapped

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

price

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

stringWeiAmount

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

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

tokenAmount

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

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

weiAmount

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

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

Methods

calculatePriceImpactPercent

calculatePriceImpactPercent(toToken: PriceTokenAmount<BlockchainName>): null | number
Calculates trade price impact percent if instance token is selling token, and parameter is buying token. If selling usd amount is less than buying usd amount, returns 0.
Parameters
- toToken: PriceTokenAmount<BlockchainName>
  
  Token to buy.
Returns null | number
- Defined in src/common/tokens/price-token-amount.ts:129

clone

clone(tokenStruct?: Partial<PriceTokenAmountStruct<BlockchainName>>): PriceTokenAmount<BlockchainName>
Parameters
- Optional tokenStruct: Partial<PriceTokenAmountStruct<BlockchainName>>
Returns PriceTokenAmount<BlockchainName>
Overrides PriceToken.clone
- Defined in src/common/tokens/price-token-amount.ts:120

cloneAndCreate

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

getAndUpdateTokenPrice

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

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

isEqualTo

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

isEqualToTokens

isEqualToTokens(tokens: TokenBaseStruct<BlockchainName>[]): boolean
Parameters
- tokens: TokenBaseStruct<BlockchainName>[]
Returns boolean
Inherited from PriceToken.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/price-token-amount.ts:97

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/price-token-amount.ts:105

`Static` createFromToken

createFromToken<T>(tokenAmount: Object): Promise<PriceTokenAmount<T>>
Creates PriceTokenAmount, fetching token's price.
Type Parameters
- T extends BlockchainName = BlockchainName
Parameters
- tokenAmount: Object
  
  Token structure with amount.
Returns Promise<PriceTokenAmount<T>>
Overrides PriceToken.createFromToken
- Defined in src/common/tokens/price-token-amount.ts:38

`Static` createToken

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

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

Class PriceTokenAmount<T>

Type Parameters

T extends BlockchainName = BlockchainName

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends BlockchainName = BlockchainName

Parameters

tokenStruct: PriceTokenAmountStruct<T>

Returns PriceTokenAmount<T>

Properties

Readonly address

Readonly blockchain

Readonly decimals

Readonly name

Readonly symbol

Accessors

asStruct

Returns PriceTokenStruct<T>

asStructWithAmount

Returns PriceTokenAmountStruct<T>

isNative

Returns boolean

isWrapped

Returns boolean

price

Returns BigNumber

stringWeiAmount

Returns string

tokenAmount

Returns BigNumber

weiAmount

Returns BigNumber

Methods

calculatePriceImpactPercent

Parameters

toToken: PriceTokenAmount<BlockchainName>

Returns null | number

clone

Parameters

Optional tokenStruct: Partial<PriceTokenAmountStruct<BlockchainName>>

Returns PriceTokenAmount<BlockchainName>

cloneAndCreate

Parameters

Optional tokenStruct: Partial<PriceTokenAmountStruct<BlockchainName>>

Returns Promise<PriceTokenAmount<BlockchainName>>

getAndUpdateTokenPrice

Returns Promise<BigNumber>

isEqualTo

Parameters

token: TokenBaseStruct<BlockchainName>

Returns boolean

isEqualToTokens

Parameters

tokens: TokenBaseStruct<BlockchainName>[]

Returns boolean

weiAmountMinusSlippage

Parameters

slippage: number

Returns BigNumber

weiAmountPlusSlippage

Parameters

slippage: number

Returns BigNumber

Static createFromToken

Type Parameters

T extends BlockchainName = BlockchainName

Parameters

tokenAmount: Object

Returns Promise<PriceTokenAmount<T>>

Static createToken

Type Parameters

T extends BlockchainName = BlockchainName

Parameters

`Readonly` address

`Readonly` blockchain

`Readonly` decimals

`Readonly` name

`Readonly` symbol

`Optional` tokenStruct: Partial<PriceTokenAmountStruct<BlockchainName>>

`Optional` tokenStruct: Partial<PriceTokenAmountStruct<BlockchainName>>

`Static` createFromToken

`Static` createToken

`Static` createTokens

`Static` tokensToAddresses