Class CosmosCoin<T>

Type for Cosmos SDK Coin information with support for bigint amounts (e.g. { amount: 1000000, denom: 'badge' }).

Type Parameters

T extends NumberType

Hierarchy (view full)

BaseNumberTypeClass<CosmosCoin<T>>
- CosmosCoin

Implements

iCosmosCoin<T>

Index

Constructors

Properties

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString fromProto

Constructors

constructor

new CosmosCoin<T>(data): CosmosCoin<T>
Type Parameters
- T extends NumberType
Parameters
- data: iCosmosCoin<T>
Returns CosmosCoin<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/coin.ts:23

Properties

amount

amount: T

The amount of the coin.

denom

denom: string

The denomination of the coin (e.g. "badge").

Methods

clone

clone(): CosmosCoin<T>
Deep copies the object and returns a new instance.

Returns CosmosCoin<T>
Inherited from BaseNumberTypeClass.clone
- Defined in src/common/base.ts:121

convert

convert<U>(convertFunction, options?): CosmosCoin<U>
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
  - - (item): U
    - Parameters
      item: NumberType
      Returns U
- Optionaloptions: ConvertOptions
Returns CosmosCoin<U>
Overrides BaseNumberTypeClass.convert
- Defined in src/core/coin.ts:33

equals

equals<U>(other, normalizeNumberTypes?): 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 BaseNumberTypeClass.equals
- Defined in src/common/base.ts:117

getNumberFieldNames

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

Returns string[]
Overrides BaseNumberTypeClass.getNumberFieldNames
- Defined in src/core/coin.ts:29

hasNumberFields

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

Returns boolean
Inherited from BaseNumberTypeClass.hasNumberFields
- Defined in src/common/base.ts:131

toJson

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

Returns JsonObject
Inherited from BaseNumberTypeClass.toJson
- Defined in src/common/base.ts:109

toJsonString

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

Returns string
Inherited from BaseNumberTypeClass.toJsonString
- Defined in src/common/base.ts:113

`Static`fromProto

fromProto<T>(data, convertFunction): CosmosCoin<T>
Type Parameters
- T extends NumberType
Parameters
- data: {
  amount: string;
  denom: string;
  }
  - amount: string
  - denom: string
- convertFunction: ((val: NumberType) => T)
  - - (val): T
    - Parameters
      val: NumberType
      Returns T
Returns CosmosCoin<T>
- Defined in src/core/coin.ts:37