Transaction

interface Transaction

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

Inheritors

Functions

Link copied to clipboard

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

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard

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

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

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

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
abstract suspend fun signTransaction(message: ByteArray, signer: Account): Result<ByteArray, E>

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

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