Transaction

Defines the API for building, simulating, executing, and querying transactions on the Sui network.

Functions

Runs a special developer-focused inspection of a transaction block.

abstract suspend fun dryRunTransactionBlock(txBytes: String, option: ExecuteTransactionBlockResponseOptions = ExecuteTransactionBlockResponseOptions()): Result<DryRunTransactionBlockQuery.Data?, SuiError>

Simulates the execution of a transaction block without committing it to the network.

abstract suspend fun executeTransactionBlock(txBytes: String, signatures: List<String>, option: ExecuteTransactionBlockResponseOptions = ExecuteTransactionBlockResponseOptions()): Result<ExecuteTransactionBlockMutation.Data?, SuiError>

Submits a pre-signed transaction block to the Sui network for execution.

abstract suspend fun getTotalTransactionBlocks(): Result<GetTotalTransactionBlocksQuery.Data?, SuiError>

Fetches the total number of transaction blocks processed by the network.

abstract suspend fun getTransactionBlock(digest: String, options: TransactionBlockResponseOptions = TransactionBlockResponseOptions()): Result<GetTransactionBlockQuery.Data?, SuiError>

Fetches the details of a specific transaction block by its digest.

abstract suspend fun paginateTransactionBlockLists(digest: String, hasMoreEvents: Boolean, hasMoreBalanceChanges: Boolean, hasMoreObjectChanges: Boolean, afterEvents: String? = null, afterBalanceChanges: String? = null, afterObjectChanges: String? = null): Result<PaginateTransactionBlockListsQuery.Data?, SuiError>

Fetches paginated lists of components within a specific transaction block.

abstract suspend fun queryTransactionBlocks(filter: TransactionBlockFilter = TransactionBlockFilter(), options: TransactionBlockResponseOptions = TransactionBlockResponseOptions()): Result<QueryTransactionBlocksQuery.Data?, SuiError>

Fetches a paginated list of transaction blocks matching a specified filter.

abstract suspend fun signAndExecuteTransactionBlock(signer: Account, ptb: ProgrammableTransaction, gasBudget: ULong, options: ExecuteTransactionBlockResponseOptions = ExecuteTransactionBlockResponseOptions()): Result<ExecuteTransactionBlockMutation.Data?, SuiError>

A convenience method that signs and executes a transaction block in a single step.

Creates a cryptographic signature for a given message using a signer's private key.

abstract suspend fun waitForTransaction(digest: String, options: TransactionBlockResponseOptions = TransactionBlockResponseOptions(), timeout: Long = 5000, pollInterval: Long): Result<GetTransactionBlockQuery.Data?, SuiError>