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

    Class Transfer

    Transfer defines the details of a transfer of tokens.

    from message badges.Transfer

    Hierarchy

    Index

    Constructors

    constructor

    Properties

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

    Methods

    equals fromBinary fromJson fromJsonString

    Constructors

    Properties

    affiliateAddress: string = ""

    Affiliate address for the transfer.

    from field: string affiliateAddress = 13;

    balances: badges.Balance[] = []

    The balances to be transferred.

    from field: repeated badges.Balance balances = 3;

    ethSignatureProofs: badges.ETHSignatureProof[] = []

    The ETH signature proofs / solutions for all ETH signature challenges required for the transfer.

    from field: repeated badges.ETHSignatureProof ethSignatureProofs = 6;

    from: string = ""

    The address of the sender of the transfer.

    from field: string from = 1;

    memo: string = ""

    The memo for the transfer.

    from field: string memo = 7;

    merkleProofs: badges.MerkleProof[] = []

    The Merkle proofs / solutions for all Merkle challenges required for the transfer.

    from field: repeated badges.MerkleProof merkleProofs = 5;

    numAttempts: string = ""

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

    from field: string numAttempts = 14;

    onlyCheckPrioritizedCollectionApprovals: boolean = false

    Whether to only check prioritized approvals for the transfer. If true, we will only check the prioritized approvals and fail if none of them match (i.e. do not check any non-prioritized approvals). If false, we will check the prioritized approvals first and then scan through the rest of the approvals.

    from field: bool onlyCheckPrioritizedCollectionApprovals = 9;

    onlyCheckPrioritizedIncomingApprovals: boolean = false

    Whether to only check prioritized approvals for the transfer. If true, we will only check the prioritized approvals and fail if none of them match (i.e. do not check any non-prioritized approvals). If false, we will check the prioritized approvals first and then scan through the rest of the approvals.

    from field: bool onlyCheckPrioritizedIncomingApprovals = 10;

    onlyCheckPrioritizedOutgoingApprovals: boolean = false

    Whether to only check prioritized approvals for the transfer. If true, we will only check the prioritized approvals and fail if none of them match (i.e. do not check any non-prioritized approvals). If false, we will check the prioritized approvals first and then scan through the rest of the approvals.

    from field: bool onlyCheckPrioritizedOutgoingApprovals = 11;

    precalculateBalancesFromApproval?: badges.ApprovalIdentifierDetails

    If defined, we will use the predeterminedBalances from the specified approval to calculate the balances at execution time. We will override the balances field with the precalculated balances. Only applicable for approvals with predeterminedBalances set.

    from field: badges.ApprovalIdentifierDetails precalculateBalancesFromApproval = 4;

    precalculationOptions?: badges.PrecalculationOptions

    The options for precalculating the balances.

    from field: badges.PrecalculationOptions precalculationOptions = 12;

    prioritizedApprovals: badges.ApprovalIdentifierDetails[] = []

    The prioritized approvals for the transfer. By default, we scan linearly through the approvals and use the first match. This field can be used to prioritize specific approvals and scan through them first.

    from field: repeated badges.ApprovalIdentifierDetails prioritizedApprovals = 8;

    toAddresses: string[] = []

    The addresses of the recipients of the transfer.

    from field: repeated string toAddresses = 2;

    fields: FieldList = ...
    runtime: ProtoRuntime = proto3
    typeName: "badges.Transfer"

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods