Type Alias SimulateTransactionResult<Include>

Type Declaration

• {
      $kind: "Transaction";
      commandResults: Include extends { commandResults: true }
          ? CommandResult[]
          : undefined;
      FailedTransaction?: never;
      gasPaymentMocked: boolean;
      Transaction: SuiClientTypes.Transaction<Include>;
  }

  • $kind: "Transaction"

  • commandResults: Include extends { commandResults: true } ? CommandResult[] : undefined

  • OptionalFailedTransaction?: never

  • gasPaymentMocked: boolean

    true when the transaction had no gas payment, so the node simulated it with a mocked gas coin instead of the sender's funds. Gas costs and transaction logic are still exercised, but anything drawn from the gas coin (tx.gas, including SUI from tx.coin()) was funded by the mocked coin rather than the sender. false when gas was paid with real coins or from the sender's address balance.

  • Transaction: SuiClientTypes.Transaction<Include>

• {
      $kind: "FailedTransaction";
      commandResults: Include extends { commandResults: true }
          ? CommandResult[]
          : undefined;
      FailedTransaction: SuiClientTypes.Transaction<Include>;
      gasPaymentMocked: boolean;
      Transaction?: never;
  }

  • $kind: "FailedTransaction"

  • commandResults: Include extends { commandResults: true } ? CommandResult[] : undefined

  • FailedTransaction: SuiClientTypes.Transaction<Include>

  • gasPaymentMocked: boolean

    true when the transaction had no gas payment, so the node simulated it with a mocked gas coin instead of the sender's funds. Gas costs and transaction logic are still exercised, but anything drawn from the gas coin (tx.gas, including SUI from tx.coin()) was funded by the mocked coin rather than the sender. false when gas was paid with real coins or from the sender's address balance.

  • OptionalTransaction?: never