xrpl
    Preparing search index...

    Interface XChainAccountCreateCommit

    The XChainAccountCreateCommit transaction creates a new account on one of the chains a bridge connects, which serves as the bridge entrance for that chain.

    WARNING: This transaction should only be executed if the witness attestations will be reliably delivered to the destination chain. If the signatures aren't delivered, then account creation will be blocked until attestations are received. This can be used maliciously; to disable this transaction on XRP-XRP bridges, the bridge's MinAccountCreateAmount shouldn't be present.

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

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

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

    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, in XRP, to use for account creation. This must be greater than or equal to the MinAccountCreateAmount specified in the Bridge ledger object.

    Delegate?: string

    The delegate account that is sending the transaction.

    Destination: string

    The destination account on the destination chain.

    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.

    SignatureReward: Amount

    The amount, in XRP, to be used to reward the witness servers for providing signatures. This must match the amount on the Bridge ledger object.

    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: "XChainAccountCreateCommit"

    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 create accounts for.

    Settings

    Member Visibility

    On This Page

    Properties