Interface iTransferWithIncrements<T>

interface iTransferWithIncrements<T> {
    balances: iBalance<T>[];
    from: string;
    incrementBadgeIdsBy?: T;
    incrementOwnershipTimesBy?: T;
    memo?: string;
    merkleProofs?: iMerkleProof[];
    onlyCheckPrioritizedCollectionApprovals?: boolean;
    onlyCheckPrioritizedIncomingApprovals?: boolean;
    onlyCheckPrioritizedOutgoingApprovals?: boolean;
    precalculateBalancesFromApproval?: iApprovalIdentifierDetails;
    prioritizedApprovals?: iApprovalIdentifierDetails[];
    toAddresses: string[];
    toAddressesLength?: T;
    zkProofSolutions?: iZkProofSolution[];
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

balances from incrementBadgeIdsBy? incrementOwnershipTimesBy? memo? merkleProofs? onlyCheckPrioritizedCollectionApprovals? onlyCheckPrioritizedIncomingApprovals? onlyCheckPrioritizedOutgoingApprovals? precalculateBalancesFromApproval? prioritizedApprovals? toAddresses toAddressesLength? zkProofSolutions?

Properties

balances

balances: iBalance<T>[]

The balances to transfer.

from

from: string

The address to transfer from.

OptionalincrementBadgeIdsBy

incrementBadgeIdsBy?: T

The number to increment the badgeIDs by for each transfer.

OptionalincrementOwnershipTimesBy

incrementOwnershipTimesBy?: T

The number to increment the ownershipTimes by for each transfer.

Optionalmemo

memo?: string

Arbitrary memo for the transfer.

OptionalmerkleProofs

merkleProofs?: iMerkleProof[]

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.

OptionalonlyCheckPrioritizedCollectionApprovals

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.

OptionalonlyCheckPrioritizedIncomingApprovals

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.

OptionalonlyCheckPrioritizedOutgoingApprovals

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.

OptionalprecalculateBalancesFromApproval

precalculateBalancesFromApproval?: iApprovalIdentifierDetails

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

OptionalprioritizedApprovals

prioritizedApprovals?: iApprovalIdentifierDetails[]

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

toAddresses

toAddresses: string[]

The addresses to transfer to.

OptionaltoAddressesLength

toAddressesLength?: T

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

OptionalzkProofSolutions

zkProofSolutions?: iZkProofSolution[]

The zk proof solutions for approvals.

Settings

Member Visibility

On This Page

Properties