xrpl
    Preparing search index...

    Interface XChainClaim

    The XChainClaim transaction completes a cross-chain transfer of value. It allows a user to claim the value on the destination chain - the equivalent of the value locked on the source chain.

    interface XChainClaim {
        Account: string;
        AccountTxnID?: string;
        Amount: Amount;
        Delegate?: string;
        Destination: string;
        DestinationTag?: number;
        Fee?: string;
        Flags?: number | GlobalFlagsInterface;
        LastLedgerSequence?: number;
        Memos?: Memo[];
        NetworkID?: number;
        Sequence?: number;
        Signers?: Signer[];
        SigningPubKey?: string;
        SourceTag?: number;
        TicketSequence?: number;
        TransactionType: "XChainClaim";
        TxnSignature?: string;
        XChainBridge: XChainBridge;
        XChainClaimID: string | number;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    Account AccountTxnID? Amount Delegate? Destination DestinationTag? Fee? Flags? LastLedgerSequence? Memos? NetworkID? Sequence? Signers? SigningPubKey? SourceTag? TicketSequence? TransactionType TxnSignature? XChainBridge XChainClaimID

    Properties

    Account: string

    The unique address of the transaction sender.

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    Amount: Amount

    The amount to claim on the destination chain. This must match the amount attested to on the attestations associated with this XChainClaimID.

    Delegate?: string

    The delegate account that is sending the transaction.

    Destination: string

    The destination account on the destination chain. It must exist or the transaction will fail. However, if the transaction fails in this case, the sequence number and collected signatures won't be destroyed, and the transaction can be rerun with a different destination.

    DestinationTag?: number

    An integer destination tag.

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    Flags?: number | GlobalFlagsInterface

    Set of bit-flags for this transaction.

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    NetworkID?: number

    The network id of the transaction.

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    TransactionType: "XChainClaim"

    The type of transaction. Valid types include: Payment, OfferCreate, TrustSet, and many others.

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    XChainBridge: XChainBridge

    The bridge to use for the transfer.

    XChainClaimID: string | number

    The unique integer ID for the cross-chain transfer that was referenced in the corresponding XChainCommit transaction.

    Settings

    Member Visibility

    On This Page

    Properties