xrpl
    Preparing search index...

    Interface ConfidentialSendParams

    Inputs for prepareConfidentialSend.

    interface ConfidentialSendParams {
        account: string;
        amount: bigint;
        confidentialState?: ConfidentialSpendingState;
        credentialIDs?: string[];
        destination: string;
        destinationKey?: string;
        destinationTag?: number;
        ledgerIndex?: LedgerIndex;
        mptIssuanceID: string;
        outstandingDelta?: bigint;
        senderKeypair: ConfidentialKeypair;
        sequence?: number;
    }

    Hierarchy

    • BaseConfidentialParams
      • ConfidentialSendParams
    Index

    Properties

    account amount confidentialState? credentialIDs? destination destinationKey? destinationTag? ledgerIndex? mptIssuanceID outstandingDelta? senderKeypair sequence?

    Properties

    account: string

    The sender's classic XRPL address.

    amount: bigint

    The confidential MPT amount being transferred.

    confidentialState?: ConfidentialSpendingState

    Advanced: predicted spending balance + version to prove against, overriding live ledger state. Set by prepareConfidentialBatch to chain multiple same-(account, token) transactions in one Batch; unset for a standalone send.

    credentialIDs?: string[]

    Optional credential IDs to satisfy the destination's deposit auth.

    destination: string

    The destination's classic XRPL address.

    destinationKey?: string

    Advanced: the destination's ElGamal public key, overriding the on-ledger lookup. Set by prepareConfidentialBatch when an earlier same-batch Convert registers the destination's key (so it is not yet on-ledger); unset for a standalone send, which reads it from the destination's MPToken.

    destinationTag?: number

    Optional destination tag.

    ledgerIndex?: LedgerIndex

    Advanced: the ledger index to read confidential state (balance, version, issuer/auditor keys) from, so a single proof is built from one coherent ledger snapshot. Defaults to the latest validated ledger. prepareConfidentialBatch sets it so every inner shares one ledger; standalone callers normally omit it.

    mptIssuanceID: string

    The 24-byte hex MPTokenIssuanceID.

    outstandingDelta?: bigint

    Advanced: extra headroom for the balance-decrypt search bound over the issuance's on-ledger ConfidentialOutstandingAmount. Set by prepareConfidentialBatch to the in-batch Convert total, so a balance topped up earlier in the same Batch stays decryptable; unset otherwise.

    senderKeypair: ConfidentialKeypair

    The sender's ElGamal keypair.

    sequence?: number

    Optional explicit sequence number. When omitted the builder queries the account's current sequence. The returned transaction pins Sequence, so it must be submitted without re-deriving the sequence (the proof is bound to it).

    Settings

    Member Visibility

    On This Page

    Properties