Wallet Aptos API Reference

Exports

import WalletManagerAptos, {
  WalletAccountAptos,
  WalletAccountReadOnlyAptos,
  type AptosTransactionInfo,
  type WaitForTransactionOptions
} from '@tetherto/wdk-wallet-aptos'

WalletManagerAptos

Creates and manages seed-derived Aptos accounts.

new WalletManagerAptos(
  seed: string | Uint8Array,
  config?: AptosWalletConfig
)

Methods

WalletAccountAptos

Writable Aptos account with signing and transaction submission support.

new WalletAccountAptos(
  seed: string | Uint8Array,
  path: string,
  config?: AptosWalletConfig
)

Properties

Methods

WalletAccountReadOnlyAptos

Read-only account for address-based reads and verification.

new WalletAccountReadOnlyAptos(
  address: string,
  config?: AptosWalletConfig,
  publicKey?: Uint8Array
)

An address-only instance supports balance reads and transaction tracking. quoteSendTransaction(), quoteTransfer(), and verify() require the matching public key because an Aptos address cannot be reversed into an Ed25519 public key. toReadOnlyAccount() supplies that key automatically.

Config Type

type AptosWalletConfig = {
  provider?: string | string[]
  chainId?: number
  retries?: number
  txnExpirationSecs?: number
  transferMaxFee?: number | bigint
}

Transaction Types

type AptosTransaction = {
  to: string
  value: number | bigint
}

type TransferOptions = {
  token: string
  recipient: string
  amount: number | bigint
}

token is an Aptos fungible asset metadata address.

Result Types

type TransactionResult = {
  hash: string
  fee: bigint
}

type TransferResult = {
  hash: string
  fee: bigint
}

Transaction Tracking

Use getTransaction() for one normalized lookup or waitForTransaction() to poll. Both methods accept a transaction hash after trimming whitespace; the remaining value must be 0x followed by 64 hexadecimal characters.

type AptosTransactionInfo = TransactionReceipt & {
  transaction: AptosReceiptShape
}

type TransactionReceipt = {
  hash: string
  finality: 'pending' | 'confirmed' | 'final' | 'dropped'
  success?: boolean
  block?: number
  fee?: bigint
}

A mempool transaction returns finality: 'pending'. Any committed Aptos transaction returns finality: 'final'; this module does not emit an intermediate confirmed state or dropped. For committed transactions, block is the numeric transaction version, fee is gas_used * gas_unit_price, and success reports VM execution outcome. A final receipt can therefore still have success: false.

An invalid hash throws ValueError; a valid but unknown hash throws NoSuchElementError. waitForTransaction() treats not-found as transient, polls every 4 seconds by default, and times out after 60 seconds unless overridden. Its default confirmed target is satisfied when Aptos reports the transaction as final.

const receipt = await account.waitForTransaction(result.hash, {
  target: 'final',
  timeout: 120000
})

if (receipt.success === false) {
  console.error('Transaction failed:', receipt.transaction.vm_status)
}

getTransactionReceipt() is retained as a deprecated raw lookup with three observable states. The package root does not export an AptosTransactionReceipt type; the released declaration uses type: string. The following is the portable declared shape:

type AptosReceiptShape = {
  type: string
  hash: string
  success?: boolean
  vm_status?: string
  version?: string
  gas_used?: string
  gas_unit_price?: string
}

• null: the fullnode does not know the hash.
• An observed type of pending_transaction: accepted into the mempool; success and vm_status are absent.
• An observed type of user_transaction: committed; inspect success and vm_status to determine execution outcome.

Signed Transaction

signTransaction(tx) returns a JSON-form signed transaction accepted by the Aptos REST API. It includes sender, sequence number, gas fields, payload, and Ed25519 signature. Before signing, the module uses the configured provider to simulate the transaction and obtain sequence, gas, and chain data. A failed simulation prevents signing.