Kaptos/xyz.mcxross.kaptos.protocol/Transaction

Transaction

interface Transaction

An interface for reading and writing Aptos transactions.

Inheritors

Aptos

Transaction

Properties

buildTransaction

abstract val buildTransaction: Build

Provides methods for building various transaction types.

simulateTransaction

abstract val simulateTransaction: Simulate

Provides methods for simulating transactions.

submitTransaction

abstract val submitTransaction: Submit

Provides methods for submitting signed transactions.

Functions

buildSimpleTransaction

abstract suspend fun buildSimpleTransaction(sender: AccountAddressInput, options: InputGenerateTransactionOptions? = null, withFeePayer: Boolean = false, builder: InputEntryFunctionDataBuilder.() -> Unit): SimpleTransaction

execute

abstract suspend fun execute(signer: Account, options: InputGenerateTransactionOptions? = null, withFeePayer: Boolean = false, builder: InputEntryFunctionDataBuilder.() -> Unit): Result<PendingTransactionResponse, Exception>

getGasPriceEstimation

abstract suspend fun getGasPriceEstimation(): Result<GasEstimation, AptosSdkError>

Retrieves a gas price estimation from the network.

getTransactionByHash

abstract suspend fun getTransactionByHash(transactionHash: String): Result<TransactionResponse, AptosSdkError>

Retrieves a transaction by its hash.

getTransactionByVersion

abstract suspend fun getTransactionByVersion(ledgerVersion: Long): Result<TransactionResponse, AptosSdkError>

Retrieves a committed on-chain transaction by its version number.

getTransactions

abstract suspend fun getTransactions(options: PaginationArgs? = null): Result<List<TransactionResponse>, AptosSdkError>

Queries for a list of committed on-chain transactions.

isPendingTransaction

abstract suspend fun isPendingTransaction(transactionHash: HexInput): Boolean

Checks if a transaction is currently in a pending state.

publishPackageTransaction

abstract suspend fun publishPackageTransaction(account: AccountAddressInput, metadataBytes: HexInput, moduleBytecode: List<HexInput>, options: InputGenerateTransactionOptions = InputGenerateTransactionOptions()): SimpleTransaction

Builds a transaction to publish a new Move package.

sign

abstract fun sign(signer: Account, transaction: AnyRawTransaction): AccountAuthenticator

Signs a raw transaction with a signer's account.

signAndSubmitAsFeePayer

abstract suspend fun signAndSubmitAsFeePayer(feePayer: Account, senderAuthenticator: AccountAuthenticator, transaction: AnyRawTransaction): Result<PendingTransactionResponse, Exception>

Signs a transaction as the fee payer and submits it to the network.

signAndSubmitTransaction

abstract suspend fun signAndSubmitTransaction(signer: Account, transaction: AnyRawTransaction): Result<PendingTransactionResponse, Exception>

Signs and submits a single-signer transaction in one step.

signAsFeePayer

abstract fun signAsFeePayer(signer: Account, transaction: AnyRawTransaction): AccountAuthenticator

Signs a raw transaction as the fee payer.

waitForTransaction

abstract suspend fun waitForTransaction(transactionHash: HexInput, options: WaitForTransactionOptions = WaitForTransactionOptions()): Result<TransactionResponse, Exception>

Waits for a transaction to be successfully processed and included in the blockchain.