Interface: iTransfer<T>

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:347

Extended by#

• iTransferWithIncrements

Type Parameters#

T#

T extends NumberType

Properties#

balances#

balances: iBalance<T>[]

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:361

The balances to transfer.

---

ethSignatureProofs?#

optional ethSignatureProofs?: iETHSignatureProof[]

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:376

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

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:351

The address to transfer from.

---

memo?#

optional memo?: string

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:381

Arbitrary memo for the transfer.

---

merkleProofs?#

optional merkleProofs?: iMerkleProof[]

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:371

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.

---

onlyCheckPrioritizedCollectionApprovals?#

optional onlyCheckPrioritizedCollectionApprovals?: boolean

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:393

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.

---

onlyCheckPrioritizedIncomingApprovals?#

optional onlyCheckPrioritizedIncomingApprovals?: boolean

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:400

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.

---

onlyCheckPrioritizedOutgoingApprovals?#

optional onlyCheckPrioritizedOutgoingApprovals?: boolean

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:407

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.

---

precalculateBalancesFromApproval?#

optional precalculateBalancesFromApproval?: iPrecalculateBalancesFromApprovalDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:366

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

---

prioritizedApprovals?#

optional prioritizedApprovals?: iApprovalIdentifierDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:386

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

---

toAddresses#

toAddresses: string[]

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:356

The addresses to transfer to.