Class: Pool<T>

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:113

Base class that implements the CustomType interface. It provides default implementations for all methods.

IMPORTANT: You must implement the getNumberFieldNames method yourself for this class to work properly. Also, you will need to implement the convert method yourself if you want to use it in a typed manner. This can be done by simply calling convertClassPropertiesAndMaintainNumberTypes(this, convertFunction, options) and casting the result to the correct type.

Extends#

• BaseNumberTypeClass<Pool<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iPool<T>

Constructors#

Constructor#

new Pool<T>(data): Pool<T>

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:121

Parameters#

data#

iPool<T>

Returns#

Pool<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

address#

address: string

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:114

Implementation of#

iPool.address

---

id#

id: T

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:115

Implementation of#

iPool.id

---

poolAssets#

poolAssets: iPoolAsset<T>[]

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:118

Implementation of#

iPool.poolAssets

---

poolParams#

poolParams: iPoolParams<T>

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:116

Implementation of#

iPool.poolParams

---

totalShares#

totalShares: iCosmosCoin<T>

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:117

Implementation of#

iPool.totalShares

---

totalWeight#

totalWeight: T

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:119

Implementation of#

iPool.totalWeight

Methods#

clone()#

clone(): Pool

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:151

Deep copies the object and returns a new instance.

Returns#

Pool

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

convert<U>(convertFunction, options?): Pool<U>

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:135

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

Pool<U>

Overrides#

BaseNumberTypeClass.convert

---

equals()#

equals<U>(other, normalizeNumberTypes?): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

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#

U extends CustomType<U>

Parameters#

other#

CustomType<U> | null | undefined

normalizeNumberTypes?#

boolean

Returns#

boolean

Inherited from#

BaseNumberTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:131

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns#

string[]

Overrides#

BaseNumberTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns#

boolean

Inherited from#

BaseNumberTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

Converts the object to a JSON object with all primitive types.

Returns#

JsonObject

Inherited from#

BaseNumberTypeClass.toJson

---

toJsonString()#

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns#

string

Inherited from#

BaseNumberTypeClass.toJsonString

---

toProto()#

toProto(): Pool

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:139

Returns#

Pool

---

fromJson()#

static fromJson<U>(jsonValue, convertFunction, options?): Pool<U>

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:147

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

Pool<U>

---

fromJsonString()#

static fromJsonString<U>(jsonString, convertFunction, options?): Pool<U>

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:151

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

Pool<U>

---

fromProto()#

static fromProto<U>(item, convertFunction): Pool<U>

Defined in: packages/bitbadgesjs-sdk/src/gamm/classes.ts:159

Type Parameters#

U#

U extends NumberType

Parameters#

item#

Pool

convertFunction#

(item) => U

Returns#

Pool<U>