Interface: iTransferWithIncrements<T>

Defined in: packages/bitbadgesjs-sdk/src/core/transfers.ts:149

Extends#

• iTransfer<T>

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.

Inherited from#

iTransfer.balances

---

durationFromTimestamp?#

optional durationFromTimestamp?: T

Defined in: packages/bitbadgesjs-sdk/src/core/transfers.ts:160

The number of unix milliseconds to approve starting from now.

---

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.

Inherited from#

iTransfer.ethSignatureProofs

---

from#

from: string

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

The address to transfer from.

Inherited from#

iTransfer.from

---

incrementOwnershipTimesBy?#

optional incrementOwnershipTimesBy?: T

Defined in: packages/bitbadgesjs-sdk/src/core/transfers.ts:157

The number to increment the ownershipTimes by for each transfer.

---

incrementTokenIdsBy?#

optional incrementTokenIdsBy?: T

Defined in: packages/bitbadgesjs-sdk/src/core/transfers.ts:154

The number to increment the tokenIDs by for each transfer.

---

memo?#

optional memo?: string

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

Arbitrary memo for the transfer.

Inherited from#

iTransfer.memo

---

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.

Inherited from#

iTransfer.merkleProofs

---

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.

Inherited from#

iTransfer.onlyCheckPrioritizedCollectionApprovals

---

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.

Inherited from#

iTransfer.onlyCheckPrioritizedIncomingApprovals

---

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.

Inherited from#

iTransfer.onlyCheckPrioritizedOutgoingApprovals

---

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.

Inherited from#

iTransfer.precalculateBalancesFromApproval

---

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.

Inherited from#

iTransfer.prioritizedApprovals

---

toAddresses#

toAddresses: string[]

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

The addresses to transfer to.

Inherited from#

iTransfer.toAddresses

---

toAddressesLength?#

optional toAddressesLength?: T

Defined in: packages/bitbadgesjs-sdk/src/core/transfers.ts:151

The number of addresses to send the tokens to. This takes priority over toAddresses.length (used when you don't know exact addresses (i.e. you know number of codes)).