Documentation
    Preparing search index...

    Interface GraphQLSimulateTransactionOptions<Include>

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

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    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.

    Defaults to true (checks enabled).

    doGasSelection?: boolean

    Overrides whether the server selects gas payment during simulation.

    When not set, gas selection is enabled only when the transaction's gas payment is explicitly set to an empty list ([]), which indicates gas is paid from the sender's address balance. Transactions with gas coins set are simulated as-is, and transactions without a gas payment are simulated with a mocked gas coin.

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