Class PoolInfo<T>

Type Parameters

T extends NumberType

Hierarchy (View Summary)

CustomTypeClass<PoolInfo<T>>
- PoolInfo

Implements

iPoolInfo<T>

Index

Constructors

Properties

address allAssetDenoms lastLiquidityUpdate lastVolumeUpdate liquidity poolId poolParams? volume

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

new PoolInfo<T extends NumberType>(data: iPoolInfo<T>): PoolInfo<T>
Type Parameters
- T extends NumberType
Parameters
- data: iPoolInfo<T>
Returns PoolInfo<T>
Overrides CustomTypeClass.constructor
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/misc.ts:1754

Properties

address

address: string

allAssetDenoms

allAssetDenoms: string[]

lastLiquidityUpdate

lastLiquidityUpdate: number

lastVolumeUpdate

lastVolumeUpdate: number

liquidity

liquidity: CosmosCoin<T>[]

poolId

poolId: string

`Optional`poolParams

poolParams?: { exitFee: string; swapFee: string }

volume

volume: PoolInfoVolume<T>

Methods

clone

clone(): PoolInfo
Deep copies the object and returns a new instance.

Returns PoolInfo
Inherited from CustomTypeClass.clone
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:105

convert

convert<U extends NumberType>(
convertFunction: (item: NumberType) => U,
options?: ConvertOptions,
): PoolInfo<U>
Type Parameters
- U extends NumberType
Parameters
- convertFunction: (item: NumberType) => U
- Optionaloptions: ConvertOptions
Returns PoolInfo<U>
Deprecated
This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.
Overrides CustomTypeClass.convert
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/misc.ts:1770

equals

equals<U extends CustomType<U>>(
other: undefined | null | CustomType<U>,
normalizeNumberTypes?: boolean,
): boolean
Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").
Type Parameters
- U extends CustomType<U>
Parameters
- other: undefined | null | CustomType<U>
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from CustomTypeClass.equals
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:101

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Overrides CustomTypeClass.getNumberFieldNames
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/misc.ts:1766

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Inherited from CustomTypeClass.hasNumberFields
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:115

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Inherited from CustomTypeClass.toJson
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:93

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Inherited from CustomTypeClass.toJsonString
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:97