bitbadgesjs-sdk - v0.22.7
    Preparing search index...

    Class TransferWithIncrements<T>

    TransferWithIncrements is a type that is used to better handle batch transfers, potentially with incremented tokenIDs.

    For example, if you have 100 addresses and want to send 1 token to each address, you would set toAddressesLength to 100 and incrementIdsBy to 1. This would send token IDs 1 to the first address, 2 to the second, and so on.

    This type is compatible with the getBalancesAfterTransfers function and the getTransfersFromTransfersWithIncrements function.

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    balances: BalanceArray<T>

    The balances to transfer.

    durationFromTimestamp?: T

    The number of unix milliseconds to approve starting from now.

    from: string

    The address to transfer from.

    incrementOwnershipTimesBy?: T

    The number to increment the ownershipTimes by for each transfer.

    incrementTokenIdsBy?: T

    The number to increment the tokenIDs by for each transfer.

    memo?: string

    Arbitrary memo for the transfer.

    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.

    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.

    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.

    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.

    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.

    precalculationOptions?: PrecalculationOptions<T>

    The precalculation options for the transfer.

    prioritizedApprovals?: ApprovalIdentifierDetails<T>[]

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

    toAddresses: string[]

    The addresses to transfer to.

    toAddressesLength?: T

    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)).

    Methods