Wallet Aptos API Reference

Exports

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

WalletManagerAptos

Creates and manages seed-derived Aptos accounts.

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

Methods

Method	Description	Returns
`getAccount(index?)`	Returns the account at `m/44'/637'/index'/0'/0'`.	`Promise<WalletAccountAptos>`
`getAccountByPath(path)`	Returns an account at a relative hardened path.	`Promise<WalletAccountAptos>`
`getFeeRates()`	Returns Aptos fee rates in octas per gas unit.	`Promise<FeeRates>`
`dispose()`	Clears managed account secret material.	`void`

WalletAccountAptos

Writable Aptos account with signing and transaction submission support.

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

Properties

Property	Description
`index`	Index parsed from the derivation path.
`path`	Full derivation path, including the `m/44'/637'` prefix.
`keyPair`	Public/private key byte-array views. Treat them as read-only. The private key is unavailable after `dispose()`.

Methods

Method	Description	Returns
`getAddress()`	Returns the Aptos account address.	`Promise<string>`
`getBalance()`	Returns the native APT balance in octas.	`Promise<bigint>`
`getTokenBalance(tokenAddress)`	Returns a fungible asset balance by metadata address.	`Promise<bigint>`
`quoteSendTransaction(tx)`	Estimates fee for a native APT transfer.	`Promise<{ fee: bigint }>`
`sendTransaction(tx)`	Signs and submits a native APT transfer.	`Promise<TransactionResult>`
`signTransaction(tx)`	Simulates and signs a native APT transfer without broadcasting. Requires a provider.	`Promise<SignedTransaction>`
`quoteTransfer(options)`	Estimates fee for a fungible asset transfer.	`Promise<{ fee: bigint }>`
`transfer(options)`	Signs and submits a fungible asset transfer.	`Promise<TransferResult>`
`getTransactionReceipt(hash)`	Looks up a pending or committed Aptos transaction.	`Promise<{ type: string; hash: string; success?: boolean; vm_status?: string } \| null>`
`sign(message)`	Signs a message with the account key.	`Promise<string>`
`verify(message, signature)`	Verifies a message signature.	`Promise<boolean>`
`toReadOnlyAccount()`	Returns a read-only account for the same address.	`Promise<WalletAccountReadOnlyAptos>`
`dispose()`	Clears private key material from memory.	`void`

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 receipt lookup. 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.

Method	Description	Returns
`getAddress()`	Returns the normalized Aptos address.	`Promise<string>`
`getBalance()`	Returns the native APT balance in octas.	`Promise<bigint>`
`getTokenBalance(tokenAddress)`	Returns a fungible asset balance by metadata address.	`Promise<bigint>`
`quoteSendTransaction(tx)`	Estimates fee for a native APT transfer.	`Promise<{ fee: bigint }>`
`quoteTransfer(options)`	Estimates fee for a fungible asset transfer.	`Promise<{ fee: bigint }>`
`getTransactionReceipt(hash)`	Looks up a pending or committed Aptos transaction.	`Promise<{ type: string; hash: string; success?: boolean; vm_status?: string } \| null>`
`verify(message, signature)`	Verifies a message signature. Requires the matching public key.	`Promise<boolean>`

Config Type

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

Field	Default and behavior
`provider`	No default. An array enables endpoint failover.
`chainId`	Fetched from ledger info on first use when omitted. A supplied value must match the provider network.
`retries`	`3` for a provider array.
`txnExpirationSecs`	`60`.
`transferMaxFee`	No default. Applies only to fungible asset `transfer()` and rejects fees at or above the cap.

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
}

getTransactionReceipt() has 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
}

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.

signTransaction() does not broadcast, but it is not an offline operation. It signs native APT transfers only. Use transfer() for fungible asset transfers.

transferMaxFee does not protect native sendTransaction() or signTransaction() calls. Quote native transfers and enforce an application-level limit when required.

Usage

Create accounts, read balances, transfer funds, and sign messages.

Configuration

Provider, network, fee, and derivation path options.

Wallet Aptos API Reference

Usage

Configuration

On this page