Documentation
    Preparing search index...

    Interface SimulateTransactionOptions<Include>

    interface SimulateTransactionOptions<
        Include extends SimulateTransactionInclude = {},
    > {
        checksEnabled?: boolean;
        include?: Include & SimulateTransactionInclude;
        signal?: AbortSignal;
        transaction: Uint8Array<ArrayBufferLike> | Transaction;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    checksEnabled?: boolean

    When set to false, disables transaction validation checks during simulation. This allows inspecting non-public/non-entry Move functions and other transactions that would normally fail validation. Disabling checks also disables gas selection, so a transaction with an empty gas payment is simulated with a mocked gas coin.

    Defaults to true (checks enabled).

    signal?: AbortSignal
    transaction: Uint8Array<ArrayBufferLike> | Transaction