API Reference

API Reference

Table of Contents

WalletManagerTon

The main class for managing TON wallets.
Extends WalletManager from @tetherto/wdk-wallet.

Constructor

new WalletManagerTon(seed, config)

Parameters:

• seed (string | Uint8Array): BIP-39 mnemonic seed phrase or seed bytes
• config (object): Configuration object
  • tonClient (object | TonClient): TON client configuration or instance
    • url (string): TON Center API URL (e.g., 'https://toncenter.com/api/v3')
    • secretKey (string, optional): API key for TON Center
  • transferMaxFee (number, optional): Maximum fee amount for transfer operations (in nanotons)

Example:

const wallet = new WalletManagerTon(seedPhrase, {
  tonClient: {
    url: 'https://toncenter.com/api/v3',
    secretKey: 'your-api-key'
  },
  transferMaxFee: 1000000000 // Maximum fee in nanotons (1 TON)
})

Methods

getAccount(index)

Returns a wallet account at the specified index.

Parameters:

• index (number, optional): The index of the account to get (default: 0)

Returns: Promise\<WalletAccountTon\> - The wallet account

Example:

const account = await wallet.getAccount(0)

getAccountByPath(path)

Returns a wallet account at the specified BIP-44 derivation path.

Parameters:

• path (string): The derivation path (e.g., "0'/0/0")

Returns: Promise\<WalletAccountTon\> - The wallet account

Example:

const account = await wallet.getAccountByPath("0'/0/1")

getFeeRates()

Returns current fee rates for normal and fast transactions.

Returns: Promise\<FeeRates\> - Object containing normal and fast fee rates

Example:

const feeRates = await wallet.getFeeRates()
console.log('Normal fee rate:', feeRates.normal, 'nanotons')
console.log('Fast fee rate:', feeRates.fast, 'nanotons')

dispose()

Disposes all wallet accounts, clearing private keys from memory.

Example:

wallet.dispose()

Properties

seed

The wallet's seed phrase.

Type: string | Uint8Array

Example:

console.log('Seed phrase:', wallet.seed)

WalletAccountTon

Individual TON wallet account implementation. Extends WalletAccountReadOnlyTon and implements IWalletAccount.

Constructor

new WalletAccountTon(seed, path, config)

Parameters:

• seed (string | Uint8Array): BIP-39 mnemonic seed phrase or seed bytes
• path (string): BIP-44 derivation path (e.g., "0'/0/0")
• config (object): Configuration object
  • tonClient (object | TonClient): TON client configuration or instance
    • url (string): TON Center API URL
    • secretKey (string, optional): API key for TON Center
  • transferMaxFee (number, optional): Maximum fee amount for transfer operations

Example:

const account = new WalletAccountTon(seedPhrase, "0'/0/0", {
  tonClient: {
    url: 'https://toncenter.com/api/v3',
    secretKey: 'your-api-key'
  },
  transferMaxFee: 10000000 // Maximum fee in nanotons (e.g., 0.01 TON)
})

Methods

verify(message, signature)

Verifies a message signature.

Parameters:

• message (string): The original message
• signature (string): The signature to verify

Returns: Promise\<boolean\> - True if the signature is valid

Example:

const readOnlyAccount = new WalletAccountReadOnlyTon(publicKey, { tonClient: { url: '...' } })
const isValid = await readOnlyAccount.verify('Hello, World!', signature)
console.log('Signature valid:', isValid)

getAddress()

Returns the account's address.

Returns: Promise\<string\> - The account's TON address

Example:

const address = await account.getAddress()
console.log('Account address:', address)

sign(message)

Signs a message using the account's private key.

Parameters:

• message (string): The message to sign

Returns: Promise\<string\> - The message signature

Example:

const signature = await account.sign('Hello, World!')
console.log('Signature:', signature)

signTransaction(tx)

Signs a transaction offline and returns the signed external-message body without broadcasting it. Use this to build a transaction on a signing device and broadcast it elsewhere. Added in v1.0.0-beta.8.

Parameters:

• tx (object): The transaction object (same shape as sendTransaction)
  • to (string): Recipient TON address (e.g., 'EQ...')
  • value (number | bigint): Amount in nanotons (1 TON = 1,000,000,000 nanotons)
  • bounceable (boolean, optional): Whether the destination address is bounceable
  • body (string | Cell, optional): Optional message body

Returns: Promise\<Cell\> - The signed external-message body as a TON Cell. Call cell.toBoc().toString('base64') to obtain a wire-format payload ready for broadcast.

Example:

const cell = await account.signTransaction({
  to: 'EQ...', // TON address
  value: 1000000000 // 1 TON in nanotons
});
const boc = cell.toBoc().toString('base64');
console.log('Signed payload:', boc);

sendTransaction(tx)

Sends a TON transaction and returns the result with hash and fee.

Parameters:

• tx (object): The transaction object
  • to (string): Recipient TON address (e.g., 'EQ...')
  • value (number): Amount in nanotons (1 TON = 1,000,000,000 nanotons)
  • bounceable (boolean, optional): Whether the address is bounceable (TON-specific, optional)

Returns: Promise\<{hash: string, fee: number}\> - Object containing hash and fee (in nanotons)

Example:

const result = await account.sendTransaction({
  to: 'EQ...', // TON address
  value: 1000000000 // 1 TON in nanotons
});
console.log('Transaction hash:', result.hash);
console.log('Transaction fee:', result.fee, 'nanotons');

quoteSendTransaction(tx)

Estimates the fee for a transaction.

Parameters:

• tx (object): The transaction object (same as sendTransaction)
  • to (string): Recipient TON address (e.g., 'EQ...')
  • value (number): Amount in nanotons (1 TON = 1,000,000,000 nanotons)
  • bounceable (boolean, optional): Whether the address is bounceable (TON-specific, optional)

Returns: Promise\<{fee: number}\> - Object containing fee estimate (in nanotons)

Example:

const quote = await account.quoteSendTransaction({
  to: 'EQ...', // TON address
  value: 1000000000 // 1 TON in nanotons
});
console.log('Estimated fee:', quote.fee, 'nanotons');

transfer(options)

Transfers Jettons (TON tokens) to another address.

Parameters:

• options (object): Transfer options
  • token (string): Jetton master contract address (TON format, e.g., 'EQ...')
  • recipient (string): Recipient TON address (e.g., 'EQ...')
  • amount (number): Amount in Jetton's base units

Returns: Promise\<{hash: string, fee: number}\> - Object containing hash and fee (in nanotons)

Example:

const result = await account.transfer({
  token: 'EQ...',      // Jetton master contract address
  recipient: 'EQ...',  // Recipient's TON address
  amount: 1000000000    // Amount in Jetton's base units
});
console.log('Transfer hash:', result.hash);
console.log('Transfer fee:', result.fee, 'nanotons');

quoteTransfer(options)

Estimates the fee for a Jetton (TON token) transfer.

Parameters:

• options (object): Transfer options (same as transfer)
  • token (string): Jetton master contract address (TON format, e.g., 'EQ...')
  • recipient (string): Recipient TON address (e.g., 'EQ...')
  • amount (number): Amount in Jetton's base units

Returns: Promise\<{fee: number}\> - Object containing fee estimate (in nanotons)

Example:

const quote = await account.quoteTransfer({
  token: 'EQ...',      // Jetton master contract address
  recipient: 'EQ...',  // Recipient's TON address
  amount: 1000000000    // Amount in Jetton's base units
});
console.log('Transfer fee estimate:', quote.fee, 'nanotons');

getBalance()

Returns the native TON balance (in nanotons).

Returns: Promise\<bigint\> - Balance in nanotons

Example:

const balance = await account.getBalance();
console.log('Balance:', balance, 'nanotons');

getTokenBalance(tokenAddress)

Returns the balance of a specific Jetton (TON token).

Parameters:

• tokenAddress (string): The Jetton master contract address (TON format, e.g., 'EQ...')

Returns: Promise\<bigint\> - Token balance in base units

Example:

const tokenBalance = await account.getTokenBalance('EQ...');
console.log('Token balance:', tokenBalance, 'nanotons');

getTransactionReceipt(hash)

Returns a transaction's receipt if it has been mined.

Parameters:

• hash (string): The transaction hash

Returns: Promise\<TonTransactionReceipt | null\> - Transaction receipt or null if not yet mined

Example:

const receipt = await account.getTransactionReceipt('EQ...')
console.log('Transaction confirmed:', receipt.success)

toReadOnlyAccount()

Returns a read-only copy of the account. The read-only account exposes balance and verification methods without holding the private key. The instance is cached, so repeated calls return the same read-only account.

Returns: Promise\<WalletAccountReadOnlyTon\> - The read-only account

Example:

const readOnlyAccount = await account.toReadOnlyAccount()
const address = await readOnlyAccount.getAddress()

dispose()

Disposes the wallet account, clearing private keys from memory.

Example:

account.dispose()

Properties

The key pair arrays are bound to the wallet account: any external change to them is reflected in the account's internal state. Treat the key pair as a read-only view and never mutate its contents.

Example:

const { publicKey, privateKey } = account.keyPair
console.log('Public key length:', publicKey.length)
console.log('Private key length:', privateKey.length)

WalletAccountReadOnlyTon

Read-only TON wallet account.

Constructor

new WalletAccountReadOnlyTon(publicKey, config)

Parameters:

• publicKey (string): The account's public key (hex or base64)
• config (object): Configuration object (same as WalletManagerTon)

Methods

getAddress()

Returns the account's address.

Returns: Promise\<string\> - The account's TON address

getBalance()

Returns the native TON balance.

Returns: Promise\<bigint\> - Balance in nanotons

getTokenBalance(tokenAddress)

Returns the balance of a specific Jetton.

Parameters:

• tokenAddress (string): The Jetton master contract address

Returns: Promise\<bigint\> - Token balance

verify(message, signature)

Verifies a message signature.

Parameters:

• message (string): The original message
• signature (string): The signature to verify

Returns: Promise\<boolean\> - True if the signature is valid

Example:

const isValid = await readOnlyAccount.verify('Hello, World!', signature)
console.log('Signature valid:', isValid)

getTransactionReceipt(hash)

Returns a transaction's receipt if it has been mined.

Parameters:

• hash (string): The transaction hash

Returns: Promise\<TonTransactionReceipt | null\> - Transaction receipt or null if not yet mined

Example:

const receipt = await readOnlyAccount.getTransactionReceipt('EQ...')
console.log('Transaction confirmed:', receipt.success)

Types

TonTransaction

interface TonTransaction {
  /**
   * Recipient's TON address in base64 format
   * @example 'EQD4FPq...'
   */
  to: string;

  /**
   * Amount to send in nanotons (1 TON = 1,000,000,000 nanotons)
   * @example 1000000000 // 1 TON
   */
  value: number | bigint;

  /**
   * If set, overrides the bounceability of the transaction
   */
  bounceable?: boolean;

  /**
   * Optional message body
   */
  body?: string | Cell;
}

TransferOptions

interface TransferOptions {
  /**
   * Jetton master contract address
   * @example 'EQD4FPq...'
   */
  token: string;

  /**
   * Recipient's TON address
   * @example 'EQD4FPq...'
   */
  recipient: string;

  /**
   * Amount in Jetton's base units
   * @example 1000000000 // Amount depends on token decimals
   */
  amount: number;
}

TransactionResult

interface TransactionResult {
  /**
   * Transaction hash in base64 format
   * @example 'EQD4FPq...'
   */
  hash: string;

  /**
   * Transaction fee in nanotons
   * @example 100000 // 0.0001 TON
   */
  fee: number;
}

FeeRates

interface FeeRates {
  /**
   * Fee rate for normal priority transactions (in nanotons)
   * @example 100000000 // 0.1 TON
   */
  normal: number;

  /**
   * Fee rate for high priority transactions (in nanotons)
   * @example 200000000 // 0.2 TON
   */
  fast: number;
}

KeyPair

interface KeyPair {
  /**
   * Ed25519 public key
   */
  publicKey: Uint8Array;

  /**
   * Ed25519 private key (sensitive data; null after the account is disposed)
   * @security Never expose or log this value
   */
  privateKey: Uint8Array | null;
}

TonWalletConfig

interface TonWalletConfig {
  /**
   * TON Center client configuration, a TonClient instance, or an array of
   * either. When an array is provided, connection errors cause the wallet to
   * fail over to the next client in the list.
   */
  tonClient?: TonClientConfig | TonClient | Array<TonClientConfig | TonClient>;

  /**
   * Number of additional retry attempts after the initial call fails, used
   * only when tonClient is an array. Total attempts = 1 + retries.
   * @default 3
   */
  retries?: number;

  /**
   * Maximum allowed fee for transfers (in nanotons)
   * @example 1000000000 // 1 TON
   */
  transferMaxFee?: number | bigint;
}

interface TonClientConfig {
  /**
   * TON Center API endpoint
   * @example 'https://toncenter.com/api/v3'
   */
  url: string;

  /**
   * Optional API key for higher rate limits
   */
  secretKey?: string;
}

Need Help?