AssetValue

Defined in: packages/helpers/src/modules/assetValue.ts:49

Extends

• BigIntArithmetics

Constructors

Constructor

new AssetValue(__namedParameters): AssetValue

Defined in: packages/helpers/src/modules/assetValue.ts:61

Parameters

__namedParameters

object & { chain: Chain; identifier?: undefined; symbol: string; } | { chain?: undefined; identifier: string; symbol?: undefined; }

Returns

AssetValue

Overrides

BigIntArithmetics.constructor

Properties

address?

optional address: string

Defined in: packages/helpers/src/modules/assetValue.ts:50

---

bigIntValue

bigIntValue: bigint = 0n

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:70

Inherited from

BigIntArithmetics.bigIntValue

---

chain

chain: Chain

Defined in: packages/helpers/src/modules/assetValue.ts:51

---

chainId

chainId: ChainId

Defined in: packages/helpers/src/modules/assetValue.ts:59

---

decimal?

optional decimal: number

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:71

Inherited from

BigIntArithmetics.decimal

---

decimalMultiplier

decimalMultiplier: bigint

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:69

Inherited from

BigIntArithmetics.decimalMultiplier

---

isGasAsset

isGasAsset: boolean = false

Defined in: packages/helpers/src/modules/assetValue.ts:52

---

isSynthetic

isSynthetic: boolean = false

Defined in: packages/helpers/src/modules/assetValue.ts:53

---

isTradeAsset

isTradeAsset: boolean = false

Defined in: packages/helpers/src/modules/assetValue.ts:54

---

symbol

symbol: string

Defined in: packages/helpers/src/modules/assetValue.ts:55

---

tax?

optional tax: TokenTax

Defined in: packages/helpers/src/modules/assetValue.ts:56

---

ticker

ticker: string

Defined in: packages/helpers/src/modules/assetValue.ts:57

---

type

type: Chain | "Synth" | "Trade" | "Native"

Defined in: packages/helpers/src/modules/assetValue.ts:58

Methods

add()

add(…args): AssetValue

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:117

Parameters

args

…InitialisationValueType[]

Returns

AssetValue

Inherited from

BigIntArithmetics.add

---

div()

div(…args): AssetValue

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:126

Parameters

args

…InitialisationValueType[]

Returns

AssetValue

Inherited from

BigIntArithmetics.div

---

eq()

eq(assetValue): boolean

Defined in: packages/helpers/src/modules/assetValue.ts:106

Parameters

assetValue

AssetValue

Returns

boolean

---

eqAsset()

eqAsset(__namedParameters): boolean

Defined in: packages/helpers/src/modules/assetValue.ts:102

Parameters

__namedParameters

chain

Chain

symbol

string

Returns

boolean

---

eqValue()

eqValue(value): boolean

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:141

Parameters

value

InitialisationValueType

Returns

boolean

Inherited from

BigIntArithmetics.eqValue

---

formatBigIntToSafeValue()

formatBigIntToSafeValue(value, decimal?): string

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:278

Parameters

value

bigint

decimal?

number

Returns

string

Inherited from

BigIntArithmetics.formatBigIntToSafeValue

---

getBaseValue()

getBaseValue<T>(type, decimal?): NumberPrimitivesType[T]

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:164

Type Parameters

T

T extends AllowedNumberTypes

Parameters

type

T

decimal?

number

Returns

NumberPrimitivesType[T]

Inherited from

BigIntArithmetics.getBaseValue

---

getBigIntValue()

getBigIntValue(value, decimal?): bigint

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:181

Parameters

value

InitialisationValueType

decimal?

number

Returns

bigint

Inherited from

BigIntArithmetics.getBigIntValue

---

getValue()

getValue<T>(type, decimal?): NumberPrimitivesType[T]

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:145

Type Parameters

T

T extends AllowedNumberTypes

Parameters

type

T

decimal?

number

Returns

NumberPrimitivesType[T]

Inherited from

BigIntArithmetics.getValue

---

gt()

gt(value): boolean

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:129

Parameters

value

InitialisationValueType

Returns

boolean

Inherited from

BigIntArithmetics.gt

---

gte()

gte(value): boolean

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:132

Parameters

value

InitialisationValueType

Returns

boolean

Inherited from

BigIntArithmetics.gte

---

lt()

lt(value): boolean

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:135

Parameters

value

InitialisationValueType

Returns

boolean

Inherited from

BigIntArithmetics.lt

---

lte()

lte(value): boolean

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:138

Parameters

value

InitialisationValueType

Returns

boolean

Inherited from

BigIntArithmetics.lte

---

mul()

mul(…args): AssetValue

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:123

Parameters

args

…InitialisationValueType[]

Returns

AssetValue

Inherited from

BigIntArithmetics.mul

---

set()

set(value): this

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:108

Parameters

value

SKBigIntParams

Returns

this

Inherited from

BigIntArithmetics.set

---

sub()

sub(…args): AssetValue

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:120

Parameters

args

…InitialisationValueType[]

Returns

AssetValue

Inherited from

BigIntArithmetics.sub

---

toAbbreviation()

toAbbreviation(digits): string

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:239

Parameters

digits

number = 2

Returns

string

Inherited from

BigIntArithmetics.toAbbreviation

---

toCurrency()

toCurrency(currency, __namedParameters): string

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:253

Parameters

currency

string = "$"

__namedParameters

currencyPosition?

string = "start"

decimal?

number = 2

decimalSeparator?

string = "."

thousandSeparator?

string = ","

Returns

string

Inherited from

BigIntArithmetics.toCurrency

---

toFixed()

toFixed(fixedDigits): string

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:221

Parameters

fixedDigits

number = 6

Returns

string

Inherited from

BigIntArithmetics.toFixed

---

toSignificant()

toSignificant(significantDigits): string

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:191

Parameters

significantDigits

number = 6

Returns

string

Inherited from

BigIntArithmetics.toSignificant

---

toString()

toString(__namedParameters): string

Defined in: packages/helpers/src/modules/assetValue.ts:88

Returns a string representation of an object.

Parameters

__namedParameters

includeSynthProtocol?

boolean

Returns

string

---

toUrl()

toUrl(): string

Defined in: packages/helpers/src/modules/assetValue.ts:94

Returns

string

---

from()

static from<T>(__namedParameters): ConditionalAssetValueReturn<T>

Defined in: packages/helpers/src/modules/assetValue.ts:127

Type Parameters

T

T extends object

Parameters

__namedParameters

T & AssetValueFromParams

Returns

ConditionalAssetValueReturn<T>

---

fromBigInt()

static fromBigInt(value, decimal?): BigIntArithmetics

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:73

Parameters

value

bigint

decimal?

number

Returns

BigIntArithmetics

Inherited from

BigIntArithmetics.fromBigInt

---

fromUrl()

static fromUrl(urlAsset, value): AssetValue

Defined in: packages/helpers/src/modules/assetValue.ts:113

Parameters

urlAsset

string

value

NumberPrimitives = 0

Returns

AssetValue

---

loadStaticAssets()

static loadStaticAssets(listNames?): Promise<boolean>

Defined in: packages/helpers/src/modules/assetValue.ts:177

Parameters

listNames?

keyof TokenLists[]

Returns

Promise<boolean>

---

setStaticAssets()

static setStaticAssets(tokenMap): boolean

Defined in: packages/helpers/src/modules/assetValue.ts:194

Parameters

tokenMap

Map<string, object & { decimal: number; } | { decimals: number; }>

Returns

boolean

---

shiftDecimals()

static shiftDecimals(__namedParameters): BigIntArithmetics

Defined in: packages/helpers/src/modules/bigIntArithmetics.ts:80

Parameters

__namedParameters

from

number

to

number

value

SwapKitNumber

Returns

BigIntArithmetics

Inherited from

BigIntArithmetics.shiftDecimals