Class Transfer<T>

Transfer is used to represent a transfer of tokens. This is compatible with the MsgTransferTokens message.

Constructors

constructor

new Transfer<T extends NumberType>(transfer: iTransfer<T>): Transfer<T>
Type Parameters
- T extends NumberType
Parameters
- transfer: iTransfer<T>
Returns Transfer<T>
Overrides BaseNumberTypeClass.constructor
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/transfers.ts:36

Properties

`Optional`affiliateAddress

affiliateAddress?: string

The affiliate address for the transfer.

balances

balances: BalanceArray<T>

The balances to transfer.

`Optional`ethSignatureProofs

ethSignatureProofs?: ETHSignatureProof[]

The ETH signature proofs that satisfy the ETH signature challenges in the approvals. If the transfer deducts from multiple approvals, we check all the ETH signature proofs and assert at least one is valid for every challenge.

from

from: string

The address to transfer from.

`Optional`memo

memo?: string

Arbitrary memo for the transfer.

`Optional`merkleProofs

merkleProofs?: MerkleProof[]

The merkle proofs that satisfy the mkerkle challenges in the approvals. If the transfer deducts from multiple approvals, we check all the merkle proofs and assert at least one is valid for every challenge.

`Optional`numAttempts

numAttempts?: T

The number of times to attempt approval validation. If 0 / not specified, we default to only one.

`Optional`onlyCheckPrioritizedCollectionApprovals

onlyCheckPrioritizedCollectionApprovals?: boolean

Whether or not to only check the prioritized approvals. If false, we will check all approvals with any prioritized first.

This only applies to the "collection" level approvals specified.

`Optional`onlyCheckPrioritizedIncomingApprovals

onlyCheckPrioritizedIncomingApprovals?: boolean

Whether or not to only check the prioritized approvals. If false, we will check all approvals with any prioritized first.

This only applies to the "incoming" level approvals specified.

`Optional`onlyCheckPrioritizedOutgoingApprovals

onlyCheckPrioritizedOutgoingApprovals?: boolean

Whether or not to only check the prioritized approvals. If false, we will check all approvals with any prioritized first.

This only applies to the "outgoing" level approvals specified.

`Optional`precalculateBalancesFromApproval

precalculateBalancesFromApproval?: ApprovalIdentifierDetails<T>

If specified, we will precalculate from this approval and override the balances. This can only be used when the specified approval has predeterminedBalances set.

`Optional`precalculationOptions

precalculationOptions?: PrecalculationOptions<T>

The precalculation options for the transfer.

`Optional`prioritizedApprovals

prioritizedApprovals?: ApprovalIdentifierDetails<T>[]

The prioritized approvals to use for the transfer. If specified, we will check these first.

toAddresses

toAddresses: string[]

The addresses to transfer to.

Methods

clone

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

Returns Transfer
Inherited from BaseNumberTypeClass.clone
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:151

convert

convert(
convertFunction: (item: NumberType) => U,
options?: ConvertOptions,
): Transfer
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: (item: NumberType) => U
- Optionaloptions: ConvertOptions
Returns Transfer
Overrides BaseNumberTypeClass.convert
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/transfers.ts:63

equals

equals>(
other: undefined | null | CustomType,
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
Parameters
- other: undefined | null | CustomType
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from BaseNumberTypeClass.equals
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:147

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 CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/transfers.ts:59

hasNumberFields

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

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

toBech32Addresses

toBech32Addresses(prefix: string): Transfer<T>
Parameters
- prefix: string
Returns Transfer<T>
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/transfers.ts:111

toJson

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

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

toJsonString

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

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

toProto

toProto(): badges.Transfer
Returns badges.Transfer
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/transfers.ts:67

`Static`fromJson

fromJson(
 jsonValue: JsonValue,
 convertFunction: (item: NumberType) => U,
 options?: Partial<JsonReadOptions>,
): Transfer
Type Parameters
- U extends NumberType
Parameters
- jsonValue: JsonValue
- convertFunction: (item: NumberType) => U
- Optionaloptions: Partial<JsonReadOptions>
Returns Transfer
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/transfers.ts:71

`Static`fromJsonString

fromJsonString(
 jsonString: string,
 convertFunction: (item: NumberType) => U,
 options?: Partial<JsonReadOptions>,
): Transfer
Type Parameters
- U extends NumberType
Parameters
- jsonString: string
- convertFunction: (item: NumberType) => U
- Optionaloptions: Partial<JsonReadOptions>
Returns Transfer
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/transfers.ts:79

`Static`fromProto

fromProto(
item: badges.Transfer,
convertFunction: (item: NumberType) => U,
): Transfer
Type Parameters
- U extends NumberType
Parameters
- item: badges.Transfer
- convertFunction: (item: NumberType) => U
Returns Transfer
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/transfers.ts:87

Class Transfer<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Transfer<T>

Properties

OptionalaffiliateAddress

balances

OptionalethSignatureProofs

from

Optionalmemo

OptionalmerkleProofs

OptionalnumAttempts

OptionalonlyCheckPrioritizedCollectionApprovals

OptionalonlyCheckPrioritizedIncomingApprovals

OptionalonlyCheckPrioritizedOutgoingApprovals

OptionalprecalculateBalancesFromApproval

OptionalprecalculationOptions

OptionalprioritizedApprovals

toAddresses

Methods

clone

Returns Transfer

convert

Type Parameters

Parameters

Returns Transfer<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

hasNumberFields

Returns boolean

toBech32Addresses

Parameters

Returns Transfer<T>

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns badges.Transfer

StaticfromJson

Type Parameters

Parameters

Returns Transfer<U>

StaticfromJsonString

Type Parameters

Parameters

Returns Transfer<U>

StaticfromProto

Type Parameters

Parameters

Returns Transfer<U>

Settings

On This Page

`Optional`affiliateAddress

`Optional`ethSignatureProofs

`Optional`memo

`Optional`merkleProofs

`Optional`numAttempts

`Optional`onlyCheckPrioritizedCollectionApprovals

`Optional`onlyCheckPrioritizedIncomingApprovals

`Optional`onlyCheckPrioritizedOutgoingApprovals

`Optional`precalculateBalancesFromApproval

`Optional`precalculationOptions

`Optional`prioritizedApprovals

`Static`fromJson

`Static`fromJsonString

`Static`fromProto