xrpl
    Preparing search index...

    Interface ConfidentialConvertParams

    Inputs for prepareConfidentialConvert.

    interface ConfidentialConvertParams {
        account: string;
        amount: bigint;
        holderKeypair: ConfidentialKeypair;
        ledgerIndex?: LedgerIndex;
        mptIssuanceID: string;
        registerKey?: boolean;
        sequence?: number;
    }

    Hierarchy

    • BaseConfidentialParams
      • ConfidentialConvertParams
    Index

    Properties

    account amount holderKeypair ledgerIndex? mptIssuanceID registerKey? sequence?

    Properties

    account: string

    The converting holder's classic XRPL address.

    amount: bigint

    The public MPT amount being moved into the confidential balance.

    holderKeypair: ConfidentialKeypair

    The holder's ElGamal keypair.

    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.

    registerKey?: boolean

    Whether to register the holder's encryption key on this transaction. By default the builder registers it exactly when the ledger has no holder key yet — required on the first conversion, rejected as a duplicate on later ones — so this normally never needs to be set explicitly.

    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