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

    Interface iTransfer<T>

    interface iTransfer<T extends NumberType> {
        affiliateAddress?: string;
        balances: iBalance<T>[];
        ethSignatureProofs?: iETHSignatureProof[];
        from: string;
        memo?: string;
        merkleProofs?: iMerkleProof[];
        numAttempts?: T;
        onlyCheckPrioritizedCollectionApprovals?: boolean;
        onlyCheckPrioritizedIncomingApprovals?: boolean;
        onlyCheckPrioritizedOutgoingApprovals?: boolean;
        precalculateBalancesFromApproval?: iApprovalIdentifierDetails<T>;
        precalculationOptions?: iPrecalculationOptions<T>;
        prioritizedApprovals?: iApprovalIdentifierDetails<T>[];
        toAddresses: string[];
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    affiliateAddress? balances ethSignatureProofs? from memo? merkleProofs? numAttempts? onlyCheckPrioritizedCollectionApprovals? onlyCheckPrioritizedIncomingApprovals? onlyCheckPrioritizedOutgoingApprovals? precalculateBalancesFromApproval? precalculationOptions? prioritizedApprovals? toAddresses

    Properties

    affiliateAddress?: string

    The affiliate address for the transfer.

    balances: iBalance<T>[]

    The balances to transfer.

    ethSignatureProofs?: iETHSignatureProof[]

    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: string

    The address to transfer from.

    memo?: string

    Arbitrary memo for the transfer.

    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.

    numAttempts?: T

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

    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?: iApprovalIdentifierDetails<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?: iPrecalculationOptions<T>

    The precalculation options for the transfer.

    prioritizedApprovals?: iApprovalIdentifierDetails<T>[]

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

    toAddresses: string[]

    The addresses to transfer to.

    Settings

    Member Visibility

    On This Page

    Properties