Class CoinTransfer<T>

Type Parameters

T extends NumberType

Hierarchy (view full)

BaseNumberTypeClass<CoinTransfer<T>>
- CoinTransfer

Implements

iCoinTransfer<T>

Index

Constructors

Properties

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString toProto fromProto

Constructors

constructor

new CoinTransfer<T>(coinTransfer): CoinTransfer<T>
Type Parameters
- T extends NumberType
Parameters
- coinTransfer: iCoinTransfer<T>
Returns CoinTransfer<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/misc.ts:314

Properties

coins

coins: CosmosCoin<T>[]

The coins

to

to: string

The recipient of the coin transfer. This should be a Bech32 BitBadges address.

Methods

clone

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

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

convert

convert<U>(convertFunction, options?): CoinTransfer<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 CoinTransfer<U>
Overrides BaseNumberTypeClass.convert
- Defined in src/core/misc.ts:324

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/misc.ts:320

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

toProto

toProto(): proto.badges.CoinTransfer
Returns proto.badges.CoinTransfer
- Defined in src/core/misc.ts:331

`Static`fromProto

fromProto<U>(item, convertFunction): CoinTransfer<U>
Type Parameters
- U extends NumberType
Parameters
- item: proto.badges.CoinTransfer
- convertFunction: ((item: NumberType) => U)
  - - (item): U
    - Parameters
      item: NumberType
      Returns U
Returns CoinTransfer<U>
- Defined in src/core/misc.ts:335