Kaptos/xyz.mcxross.kaptos.api/Transaction

Transaction

class Transaction(val config: AptosConfig) : Transaction

A class for reading and writing Aptos transactions.

Constructors

Transaction

constructor(config: AptosConfig)

Properties

buildTransaction

open override val buildTransaction: Build

Provides methods for building various transaction types.

config

val config: AptosConfig

AptosConfig object for configuration.

simulateTransaction

open override val simulateTransaction: Simulate

Provides methods for simulating transactions.

submitTransaction

open override val submitTransaction: Submit

Provides methods for submitting signed transactions.

Functions

buildSimpleTransaction

open suspend override fun buildSimpleTransaction(sender: AccountAddressInput, options: InputGenerateTransactionOptions?, withFeePayer: Boolean, builder: InputEntryFunctionDataBuilder.() -> Unit): SimpleTransaction

execute

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

getGasPriceEstimation

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

Retrieves a gas price estimation from the network.

getTransactionByHash

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

Retrieves a transaction by its hash.

getTransactionByVersion

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

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

getTransactions

open suspend override fun getTransactions(options: PaginationArgs?): Result<List<TransactionResponse>, AptosSdkError>

Queries for a list of committed on-chain transactions.

isPendingTransaction

open suspend override fun isPendingTransaction(transactionHash: HexInput): Boolean

Checks if a transaction is currently in a pending state.

publishPackageTransaction

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

Builds a transaction to publish a new Move package.

sign

open override fun sign(signer: Account, transaction: AnyRawTransaction): AccountAuthenticator

Signs a raw transaction with a signer's account.

signAndSubmitAsFeePayer

open suspend override 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

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

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

signAsFeePayer

open override fun signAsFeePayer(signer: Account, transaction: AnyRawTransaction): AccountAuthenticator

Signs a raw transaction as the fee payer.

waitForTransaction

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

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