Transaction

interface Transaction

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

Inheritors

Functions

Link copied to clipboard
abstract suspend fun devInspectTransactionBlock(txBytes: String, options: <Error class: unknown class> = ExecuteTransactionBlockResponseOptions()): <Error class: unknown class><DevInspectTransactionBlockQuery.Data?, <Error class: unknown class>>

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

Link copied to clipboard
abstract suspend fun dryRunTransactionBlock(txBytes: String, option: <Error class: unknown class> = ExecuteTransactionBlockResponseOptions()): <Error class: unknown class><DryRunTransactionBlockQuery.Data?, <Error class: unknown class>>

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: <Error class: unknown class> = ExecuteTransactionBlockResponseOptions()): <Error class: unknown class><ExecuteTransactionBlockMutation.Data?, <Error class: unknown class>>

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

Link copied to clipboard
abstract suspend fun getTotalTransactionBlocks(): <Error class: unknown class><GetTotalTransactionBlocksQuery.Data?, <Error class: unknown class>>

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

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

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): <Error class: unknown class><PaginateTransactionBlockListsQuery.Data?, <Error class: unknown class>>

Fetches paginated lists of components within a specific transaction block.

Link copied to clipboard
abstract suspend fun queryTransactionBlocks(filter: TransactionBlockFilter = TransactionBlockFilter(), options: <Error class: unknown class> = TransactionBlockResponseOptions()): <Error class: unknown class><QueryTransactionBlocksQuery.Data?, <Error class: unknown class>>

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

Link copied to clipboard
abstract suspend fun signAndExecuteTransactionBlock(signer: <Error class: unknown class>, ptb: <Error class: unknown class>, gasBudget: <Error class: unknown class>, options: <Error class: unknown class> = ExecuteTransactionBlockResponseOptions()): <Error class: unknown class><ExecuteTransactionBlockMutation.Data?, <Error class: unknown class>>

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: <Error class: unknown class>): <Error class: unknown class><ByteArray, <Error class: unknown class>>

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

Link copied to clipboard
abstract suspend fun sponsoredTransaction(ptb: <Error class: unknown class>, sender: <Error class: unknown class>, expiration: <Error class: unknown class> = TransactionExpiration.None): <Error class: unknown class><<Error class: unknown class>, <Error class: unknown class>>
abstract suspend fun sponsoredTransaction(ptb: <Error class: unknown class>, sender: String, expiration: <Error class: unknown class> = TransactionExpiration.None): <Error class: unknown class><<Error class: unknown class>, <Error class: unknown class>>
Link copied to clipboard
abstract suspend fun waitForTransaction(digest: String, options: <Error class: unknown class> = TransactionBlockResponseOptions(), timeout: Long = 5000, pollInterval: Long): <Error class: unknown class><GetTransactionBlockQuery.Data?, <Error class: unknown class>>