AptosQuickApi class

A high-level API class that provides quick access to core Aptos functionalities, including account management, transaction signing, and transaction handling.

This class combines multiple helper mixins:

Mixed-in types

Constructors

AptosQuickApi.new({required AptosProvider provider})
Creates an instance of AptosQuickApi.
const

Properties

hashCode int
The hash code for this object.
no setterinherited
provider AptosProvider
The Aptos provider used for making network requests.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

accountIsActive(AptosAddress address) Future<bool>
Checks if an account is active based on the provided address. Returns true if the account exists, otherwise false.
inherited
buildTransaction({required AptosAddress sender, required AptosTransactionPayload transactionPayload, AptosApiBuildTransactionParams? params}) Future<AptosRawTransaction>
Builds a raw transaction with the provided parameters.
inherited
callFunction<T>(AptosTransactionEntryFunction entry, {BigInt? ledgerVersion}) Future<List<T>>
Executes a view function from an Aptos module.
inherited
createBatchTransferTransaction({required AptosAddress sender, required List<AptosTransferParams> transfers, AptosApiBuildTransactionParams? params}) Future<AptosRawTransaction>
Creates a batch transfer transaction to send Aptos tokens to multiple recipients.
inherited
createPublishModuleTransaction({required AptosAddress sender, required List<int> metadataBytes, required List<List<int>> moduleBytes, AptosApiBuildTransactionParams? params}) Future<AptosRawTransaction>
Creates a transaction to publish a new module to the Aptos blockchain.
inherited
createScriptTransaction({required AptosAddress sender, required List<int> byteCode, required List<AptosScriptArguments> arguments, List<AptosTypeTag> typeArgs = const [], AptosApiBuildTransactionParams? params}) Future<AptosRawTransaction>
Creates a script transaction to execute custom bytecode on the Aptos blockchain.
inherited
createSimpleTransaction({required AptosAddress sender, required AptosModuleId moduleId, required String functionName, required List<AptosEntryFunctionArguments> arguments, List<AptosTypeTag> typeArgs = const [], AptosApiBuildTransactionParams? params}) Future<AptosRawTransaction>
Creates a simple transaction that calls a function from a specific Aptos module.
inherited
createTransferTransaction({required AptosAddress sender, required AptosTransferParams transferParams, AptosApiBuildTransactionParams? params}) Future<AptosRawTransaction>
Creates a raw transaction for transferring Aptos tokens from the sender to the specified transferParams.
inherited
getAccountData(AptosAddress address) Future<AptosApiAccountData>
Retrieves account data for the given address.
inherited
getAccountSequence(AptosAddress address) Future<BigInt>
Retrieves the current sequence number for the specified address.
inherited
getChainId() Future<int>
Retrieves the chain ID of the current Aptos network.
inherited
getGasPrice() Future<BigInt>
Retrieves the current estimated gas price from the Aptos network.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
signTransaction({required AptosAccount<AptosAccountPublicKey, AptosAccountAuthenticator, AptosSignature> account, required AptosRawTransaction transaction, AptosAccount<AptosAccountPublicKey, AptosAccountAuthenticator, AptosSignature>? feePayerAccount, List<AptosAccount<AptosAccountPublicKey, AptosAccountAuthenticator, AptosSignature>>? secondarySignerAccounts}) AptosSignedTransaction
Signs an Aptos raw transaction with the provided account.
inherited
submitTransaction(AptosSignedTransaction transaction) Future<AptosApiPendingTransaction>
Submits a signed transaction to the Aptos network.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited