Class: MsgExitPool<T>

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

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<MsgExitPool<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iMsgExitPool<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iMsgExitPool<T>

Returns#

MsgExitPool<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

poolId#

poolId: T

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

Implementation of#

iMsgExitPool.poolId

---

sender#

sender: string

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

Implementation of#

iMsgExitPool.sender

---

shareInAmount#

shareInAmount: T

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

Implementation of#

iMsgExitPool.shareInAmount

---

tokenOutMins#

tokenOutMins: CosmosCoin<T>[]

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

Implementation of#

iMsgExitPool.tokenOutMins

Methods#

clone()#

clone(): MsgExitPool

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

Deep copies the object and returns a new instance.

Returns#

MsgExitPool

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

MsgExitPool<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/tx/classes.ts:392

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

---

toBech32Addresses()#

toBech32Addresses(prefix): MsgExitPool<T>

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

Parameters#

prefix#

string

Returns#

MsgExitPool<T>

---

toCosmWasmPayloadString()#

toCosmWasmPayloadString(): string

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

Returns#

string

---

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(): MsgExitPool

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

Returns#

MsgExitPool

---

fromJson()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

MsgExitPool<U>

---

fromJsonString()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

MsgExitPool<U>

---

fromProto()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

item#

MsgExitPool

convertFunction#

(item) => U

Returns#

MsgExitPool<U>