WriteApi

The WriteApi provides methods for executing and testing transactions on the Sui network. All methods are in the sui namespace.

Methods

executeTransactionBlock

Executes a signed transaction and waits for results based on the request type.

Base64

required

BCS serialized transaction data bytes without its type tag, as base64-encoded string

Base64[]

required

List of signatures (flag || signature || pubkey bytes) as base64-encoded strings. Each signature is committed to the intent message of the transaction data

SuiTransactionBlockResponseOptions

Options for specifying the content to be returned

ExecuteTransactionRequestType

The request type, derived from SuiTransactionBlockResponseOptions if None

Show request types

WaitForEffectsCert: Waits for TransactionEffectsCert and returns. This mode is a proxy for transaction finality
WaitForLocalExecution: Waits for TransactionEffectsCert and ensures the node executed the transaction locally before returning. If the node fails to execute locally in a timely manner, confirmed_local_execution is set to false

SuiTransactionBlockResponse

The transaction execution result

curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "sui_executeTransactionBlock",
    "params": [
      "AAACA...",
      ["AQA..."],
      {
        "showInput": true,
        "showEffects": true,
        "showEvents": true
      },
      "WaitForLocalExecution"
    ]
  }'

devInspectTransactionBlock

Runs the transaction in dev-inspect mode. This allows nearly any transaction (or Move call) with any arguments. Detailed results are provided, including both the transaction effects and any return values.

Dev inspect does not validate ownership, visibility, or other constraints. Use this for debugging and testing only.

SuiAddress

required

The sender address

Base64

required

BCS encoded TransactionKind (as opposed to TransactionData, which includes gasBudget and gasPrice)

BigInt<u64>

Gas price to use. Gas is not charged, but gas usage is still calculated. Defaults to reference gas price

BigInt<u64>

The epoch to perform the call. Will be set from the system state object if not provided

DevInspectArgs

Additional arguments including gas_budget, gas_objects, gas_sponsor and skip_checks

Show additional_args fields

BigInt<u64>

Gas budget for the transaction

ObjectID[]

Specific gas objects to use

Gas sponsor address

boolean

Skip additional validation checks

DevInspectResults

The inspection results, including return values and effects

Show response fields

TransactionEffects

Transaction effects

SuiEvent[]

Events emitted

ExecutionResult[]

Execution results for each command

string

Error message if execution failed

curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "sui_devInspectTransactionBlock",
    "params": [
      "0x...",
      "AAACA...",
      null,
      null,
      {
        "gas_budget": "10000000"
      }
    ]
  }'

dryRunTransactionBlock

Returns transaction execution effects including the gas cost summary, without committing the effects to the chain.

Unlike dev-inspect, dry run validates all transaction constraints (ownership, signatures, etc.) as if executing on-chain.

Base64

required

BCS serialized transaction data bytes as base64-encoded string

DryRunTransactionBlockResponse

The dry run results

Show response fields

TransactionEffects

Transaction effects that would occur

SuiEvent[]

Events that would be emitted

ObjectChange[]

Object changes that would occur

BalanceChange[]

Balance changes that would occur

TransactionData

The input transaction data

curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "sui_dryRunTransactionBlock",
    "params": [
      "AAACA..."
    ]
  }'

Dev Inspect vs Dry Run

Feature	devInspectTransactionBlock	dryRunTransactionBlock
Validates ownership	No	Yes
Validates signatures	No	Yes
Checks visibility	No	Yes
Allows any inputs	Yes	No
Gas charged	No	No
Use case	Debugging, testing	Pre-flight validation

Usage Example with Rust SDK

use sui_sdk::SuiClientBuilder;
use sui_types::transaction::TransactionData;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default()
        .build("https://fullnode.mainnet.sui.io:443")
        .await?;
    
    // Build transaction data
    let tx_data: TransactionData = /* ... */;
    
    // Dry run before executing
    let dry_run = sui.read_api()
        .dry_run_transaction_block(tx_data.clone())
        .await?;
    
    println!("Gas cost: {:?}", dry_run.effects.gas_used());
    
    Ok(())
}

JSON-RPC API

Rust SDK

GraphQL API

Framework

Methods

executeTransactionBlock

devInspectTransactionBlock

dryRunTransactionBlock

Dev Inspect vs Dry Run

Usage Example with Rust SDK

​Methods

​executeTransactionBlock

​devInspectTransactionBlock

​dryRunTransactionBlock

​Dev Inspect vs Dry Run

​Usage Example with Rust SDK

Methods

executeTransactionBlock

devInspectTransactionBlock

dryRunTransactionBlock

Dev Inspect vs Dry Run

Usage Example with Rust SDK