@aptos-labs/ts-sdk - v7.1.0
    Preparing search index...

    Type Alias InputEncryptedTransactionBuildOptions

    Options for building encrypted transactions (combined with sequence- or orderless-specific fields).

    type InputEncryptedTransactionBuildOptions = {
        claimedEntryFunction?: ClaimedEntryFunction | InputClaimedEntryFunction;
        encrypted?: boolean;
        feePayerAuthenticationKey?: AuthenticationKey | HexInput;
        secondarySignerAuthenticationKeys?: (
            AuthenticationKey
            | HexInput
            | undefined
        )[];
        senderAuthenticationKey?: AuthenticationKey | HexInput;
    }
    Index

    Properties

    Overrides claimed_entry_fun for encrypted transactions when a fee payer is set, the payload is multisig, or the payload is TransactionInnerPayload with a multisig address in TransactionExtraConfigV1. Ignored for plain encrypted single-signer transactions (none of the above).

    encrypted?: boolean

    When true, the transaction payload will be encrypted before submission. Requires the node to support encrypted transactions (encryption key present in ledger info).

    feePayerAuthenticationKey?: AuthenticationKey | HexInput

    For encrypted fee-payer transactions: the fee payer's authentication key. Optional when feePayerAddress is a non-zero sponsor — omitted values are fetched from chain and cached. Appended last in AAD signer_auth_keys, matching aptos-core TransactionAuthenticator::all_signer_auth_keys (after sender and secondaries). Accepts AuthenticationKey or a raw 32-byte hex string / Uint8Array.

    secondarySignerAuthenticationKeys?: (AuthenticationKey | HexInput | undefined)[]

    For encrypted multi-agent transactions: each secondary signer's authentication key, in the same order as secondarySignerAddresses on the transaction build input. Any entry left undefined (or the entire array omitted) will be fetched from chain and cached. Accepts AuthenticationKey or a raw 32-byte hex string / Uint8Array.

    senderAuthenticationKey?: AuthenticationKey | HexInput

    Authentication key for the primary sender. Optional: when omitted (and encrypted is true), the SDK fetches the sender's authentication_key from the fullnode and caches it for ~1 hour. Pass it explicitly to skip the lookup (useful right after a key rotation). Accepts an AuthenticationKey or a raw 32-byte hex string / Uint8Array. Must match the on-chain authenticator identity (aptos-core PayloadAssociatedData::V1.signer_auth_keys).