API Reference

Complete API documentation for @tetherto/wdk-wallet-tron

Table of Contents

Class	Description	Methods
WalletManagerTron	Main class for managing Tron wallets. Extends WalletManager from @tetherto/wdk-wallet.	Constructor, Methods
WalletAccountTron	Individual Tron wallet account implementation. Extends WalletAccountReadOnlyTron and implements IWalletAccount.	Constructor, Methods, Properties
WalletAccountReadOnlyTron	Read-only Tron wallet account. Extends WalletAccountReadOnly from @tetherto/wdk-wallet.	Constructor, Methods

WalletManagerTron

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

Fee Rate Constants

const FEE_RATE_NORMAL_MULTIPLIER = 1.1
const FEE_RATE_FAST_MULTIPLIER = 2.0

Constructor

new WalletManagerTron(seed, config?)

Parameters:

• seed (string | Uint8Array): BIP-39 mnemonic seed phrase or seed bytes

• config (TronWalletConfig, optional): Configuration object

  • provider (string | TronWeb, optional): Tron RPC endpoint URL or TronWeb instance

  • transferMaxFee (number, optional): Maximum fee amount for transfer operations (in sun)

Example:

const wallet = new WalletManagerTron(seedPhrase, {
  provider: 'https://api.trongrid.io', // Tron RPC endpoint
  transferMaxFee: 10000000 // 10 TRX in sun
})

// Or with TronWeb instance
const tronWeb = new TronWeb({ fullHost: 'https://api.trongrid.io' })
const wallet2 = new WalletManagerTron(seedPhrase, {
  provider: tronWeb,
  transferMaxFee: 10000000
})

Methods

Method	Description	Returns	Throws
getAccount(index?)	Returns a wallet account at the specified index	Promise<WalletAccountTron>	-
getAccountByPath(path)	Returns a wallet account at the specified BIP-44 derivation path	Promise<WalletAccountTron>	-
getFeeRates()	Returns current fee rates from Tron network	Promise<{normal: number, fast: number}>	If no provider
dispose()	Disposes all wallet accounts, clearing private keys from memory	void	-

getAccount(index?)

Returns a wallet account at the specified index using Tron's BIP-44 derivation (m/44'/195').

Parameters:

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

Returns: Promise<WalletAccountTron> - The wallet account

Example:

// Get first account (m/44'/195'/0'/0/0)
const account = await wallet.getAccount(0)

// Get second account (m/44'/195'/0'/0/1)
const account1 = await wallet.getAccount(1)

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<WalletAccountTron> - The wallet account

Example:

// Full path: m/44'/195'/0'/0/1
const account = await wallet.getAccountByPath("0'/0/1")

getFeeRates()

Returns current fee rates from Tron network chain parameters.

Returns: Promise<{normal: number, fast: number}> - Fee rates in sun

• normal: Base fee × 1.1

• fast: Base fee × 2.0

Throws: Error if no TronWeb provider is configured

Example:

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

dispose()

Disposes all wallet accounts, clearing private keys from memory.

Example:

wallet.dispose()

WalletAccountTron

Represents an individual Tron wallet account. Extends WalletAccountReadOnlyTron and implements IWalletAccount.

Constants

const BIP_44_TRON_DERIVATION_PATH_PREFIX = "m/44'/195'"
const BANDWIDTH_PRICE = 1_000

Constructor

new WalletAccountTron(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 (TronWalletConfig, optional): Configuration object

Throws: Error if seed phrase is invalid (BIP-39 validation fails)

Example:

const account = new WalletAccountTron(seedPhrase, "0'/0/0", {
  provider: 'https://api.trongrid.io',
  transferMaxFee: 10000000 // 10 TRX in sun
})

Methods

Method	Description	Returns	Throws
getAddress()	Returns the account's Tron address	Promise<string>	-
sign(message)	Signs a message using the account's private key	Promise<string>	-
verify(message, signature)	Verifies a message signature	Promise<boolean>	-
sendTransaction(tx)	Sends a Tron transaction	Promise<{hash: string, fee: number}>	If no provider or fee exceeds max
quoteSendTransaction(tx)	Estimates the fee for a Tron transaction	Promise<{fee: number}>	If no provider
transfer(options)	Transfers TRC20 tokens to another address	Promise<{hash: string, fee: number}>	If no provider or fee exceeds max
quoteTransfer(options)	Estimates the fee for a TRC20 transfer	Promise<{fee: number}>	If no provider
getBalance()	Returns the native TRX balance (in sun)	Promise<number>	If no provider
getTokenBalance(tokenAddress)	Returns the balance of a specific TRC20 token	Promise<number>	If no provider
toReadOnlyAccount()	Returns a read-only copy of the account	Promise<WalletAccountReadOnlyTron>	-
dispose()	Disposes the wallet account, clearing private keys from memory	void	-

getAddress()

Returns the account's Tron address (starts with 'T').

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

Example:

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

sign(message)

Signs a message using Keccak-256 hash and secp256k1 signature.

Parameters:

• message (string): The message to sign (UTF-8 encoded)

Returns: Promise<string> - The message signature (hex string)

Example:

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

verify(message, signature)

Verifies a message signature using secp256k1.

Parameters:

• message (string): The original message

• signature (string): The signature to verify (hex string)

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

Example:

const isValid = await account.verify(message, signature)
console.log('Signature valid:', isValid)

sendTransaction(tx)

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

Parameters:

• tx (TronTransaction): The transaction object

  • to (string): Recipient Tron address (e.g., 'T...')

  • value (number): Amount in sun (1 TRX = 1,000,000 sun)

Returns: Promise<{hash: string, fee: number}> - Transaction hash and fee in sun

Throws:

• Error if no TronWeb provider is configured

• Error if fee exceeds transferMaxFee

Example:

const result = await account.sendTransaction({
  to: 'TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH', // Tron address
  value: 1000000 // 1 TRX in sun
})
console.log('Transaction hash:', result.hash)
console.log('Transaction fee:', result.fee, 'sun')

quoteSendTransaction(tx)

Estimates the bandwidth cost for a TRX transaction.

Parameters:

• tx (TronTransaction): The transaction object (same as sendTransaction)

Returns: Promise<{fee: number}> - Fee estimate in sun

Throws: Error if no TronWeb provider is configured

Example:

const quote = await account.quoteSendTransaction({
  to: 'TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH',
  value: 1000000
})
console.log('Estimated fee:', quote.fee, 'sun')

transfer(options)

Transfers TRC20 tokens using smart contract call.

Parameters:

• options (TransferOptions): Transfer options

  • token (string): TRC20 contract address (e.g., 'T...')

  • recipient (string): Recipient Tron address (e.g., 'T...')

  • amount (number | bigint): Amount in token's base units

Returns: Promise<{hash: string, fee: number}> - Transaction hash and fee in sun

Throws:

• Error if no TronWeb provider is configured

• Error if fee exceeds transferMaxFee

Example:

const result = await account.transfer({
  token: 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t', // USDT TRC20
  recipient: 'TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH',
  amount: 1000000 // 1 USDT (6 decimals)
})
console.log('Transfer hash:', result.hash)
console.log('Transfer fee:', result.fee, 'sun')

quoteTransfer(options)

Estimates the energy and bandwidth cost for a TRC20 token transfer.

Parameters:

• options (TransferOptions): Transfer options (same as transfer)

Returns: Promise<{fee: number}> - Fee estimate in sun (energy + bandwidth costs)

Throws: Error if no TronWeb provider is configured

Example:

const quote = await account.quoteTransfer({
  token: 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t',
  recipient: 'TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH',
  amount: 1000000
})
console.log('Transfer fee estimate:', quote.fee, 'sun')

getBalance()

Returns the native TRX balance.

Returns: Promise<number> - Balance in sun

Throws: Error if no TronWeb provider is configured

Example:

const balance = await account.getBalance()
console.log('TRX balance:', balance, 'sun')
console.log('TRX balance:', balance / 1000000, 'TRX')

getTokenBalance(tokenAddress)

Returns the balance of a specific TRC20 token.

Parameters:

• tokenAddress (string): The TRC20 contract address (e.g., 'T...')

Returns: Promise<number> - Token balance in base units

Throws: Error if no TronWeb provider is configured

Example:

const tokenBalance = await account.getTokenBalance('TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t')
console.log('USDT balance:', tokenBalance) // In 6 decimal units
console.log('USDT balance:', tokenBalance / 1000000, 'USDT')

toReadOnlyAccount()

Creates a read-only copy of the account.

Returns: Promise<WalletAccountReadOnlyTron> - Read-only account instance

Example:

const readOnlyAccount = await account.toReadOnlyAccount()

// Can check balances but cannot send transactions
const balance = await readOnlyAccount.getBalance()

dispose()

Disposes the wallet account, clearing private keys from memory using sodium_memzero.

Example:

account.dispose()

Properties

Property	Type	Description
index	number	The derivation path's index of this account
path	string	The full BIP-44 derivation path of this account
keyPair	{privateKey: Buffer, publicKey: Buffer}	The account's key pair (⚠️ Contains sensitive data)

Example:

console.log('Account index:', account.index) // 0, 1, 2, etc.
console.log('Account path:', account.path) // m/44'/195'/0'/0/0

// ⚠️ SENSITIVE: Handle with care
const { privateKey, publicKey } = account.keyPair
console.log('Public key length:', publicKey.length) // 33 bytes (compressed)
console.log('Private key length:', privateKey.length) // 32 bytes

⚠️ Security Note: The keyPair property contains sensitive cryptographic material. Never log, display, or expose the private key.

WalletAccountReadOnlyTron

Represents a read-only Tron wallet account that can query balances and estimate fees but cannot send transactions.

Constructor

new WalletAccountReadOnlyTron(address, config?)

Parameters:

• address (string): The account's Tron address

• config (Omit<TronWalletConfig, 'transferMaxFee'>, optional): Configuration object without transferMaxFee

Example:

const readOnlyAccount = new WalletAccountReadOnlyTron('TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH', {
  provider: 'https://api.trongrid.io'
})

Methods

Method	Description	Returns	Throws
getBalance()	Returns the native TRX balance (in sun)	Promise<number>	If no provider
getTokenBalance(tokenAddress)	Returns the balance of a specific TRC20 token	Promise<number>	If no provider
quoteSendTransaction(tx)	Estimates the fee for a TRX transaction	Promise<{fee: number}>	If no provider
quoteTransfer(options)	Estimates the fee for a TRC20 transfer	Promise<{fee: number}>	If no provider
getTransactionReceipt(hash)	Returns a transaction's receipt	Promise<TronTransactionReceipt | null>	If no provider

getBalance()

Returns the native TRX balance.

Returns: Promise<number> - Balance in sun

Throws: Error if no TronWeb provider is configured

Example:

const balance = await readOnlyAccount.getBalance()
console.log('TRX balance:', balance, 'sun')

getTokenBalance(tokenAddress)

Returns the balance of a specific TRC20 token.

Parameters:

• tokenAddress (string): The TRC20 contract address

Returns: Promise<number> - Token balance in base units

Throws: Error if no TronWeb provider is configured

Example:

const tokenBalance = await readOnlyAccount.getTokenBalance('TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t')
console.log('USDT balance:', tokenBalance)

quoteSendTransaction(tx)

Estimates the bandwidth cost for a TRX transaction.

Parameters:

• tx (TronTransaction): The transaction object

Returns: Promise<{fee: number}> - Fee estimate in sun

Throws: Error if no TronWeb provider is configured

quoteTransfer(options)

Estimates the energy and bandwidth cost for a TRC20 transfer.

Parameters:

• options (TransferOptions): Transfer options

Returns: Promise<{fee: number}> - Fee estimate in sun

Throws: Error if no TronWeb provider is configured

getTransactionReceipt(hash)

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

Parameters:

• hash (string): The transaction hash

Returns: Promise<TronTransactionReceipt | null> - Transaction receipt or null

Throws: Error if no TronWeb provider is configured

Types

TronWalletConfig

interface TronWalletConfig {
  provider?: string | TronWeb;        // Tron RPC URL or TronWeb instance
  transferMaxFee?: number;            // Maximum fee in sun
}

TronTransaction

interface TronTransaction {
  to: string;                         // Recipient Tron address
  value: number;                      // Amount in sun (1 TRX = 1,000,000 sun)
}

TransferOptions

interface TransferOptions {
  token: string;                      // TRC20 contract address
  recipient: string;                  // Recipient Tron address
  amount: number | bigint;            // Amount in token base units
}

TransactionResult

interface TransactionResult {
  hash: string;                       // Transaction hash
  fee: number;                        // Fee paid in sun
}

TransferResult

interface TransferResult {
  hash: string;                       // Transaction hash
  fee: number;                        // Fee paid in sun
}

Constants

// Tron-specific constants
const BIP_44_TRON_DERIVATION_PATH_PREFIX: string = "m/44'/195'";
const BANDWIDTH_PRICE: number = 1_000;

// Fee rate multipliers
const FEE_RATE_NORMAL_MULTIPLIER: number = 1.1;
const FEE_RATE_FAST_MULTIPLIER: number = 2.0;

Node.js Quickstart

Get started with WDK in a Node.js environment

React Native Quickstart

Build mobile wallets with React Native Expo

WDK Tron Wallet Usage

Get started with WDK's Tron Wallet Usage

WDK Tron Wallet Configuration

Get started with WDK's Tron Wallet Configuration

---

Need Help?

Discord Community

Connect with developers, ask questions, share your projects

Join Community

GitHub Issues

Report bugs, request features, and get technical help

Open an Issue

Email Contact

For sensitive or private matters, contact our team directly

Send an email