@tetherto/wdk-wallet-tron

Note: This package is currently in beta. Please test thoroughly in development environments before using in production.

A simple and secure package to manage BIP-44 wallets for the Tron blockchain. This package provides a clean API for creating, managing, and interacting with Tron wallets using BIP-39 seed phrases and Tron-specific derivation paths.

🔍 About WDK

This module is part of the WDK (Wallet Development Kit) project, which empowers developers to build secure, non-custodial wallets with unified blockchain access, stateless architecture, and complete user control.

For detailed documentation about the complete WDK ecosystem, visit docs.wallet.tether.io.

🌟 Features

Tron Derivation Paths: Support for BIP-44 standard derivation paths for Tron
Multi-Account Management: Create and manage multiple accounts from a single seed phrase
Transaction Management: Send transactions and get fee estimates
TRC20 Support: Query native TRX and TRC20 token balances using smart contract interactions

⬇️ Installation

To install the @tetherto/wdk-wallet-tron package, follow these instructions:

You can install it using npm:

npm install @tetherto/wdk-wallet-tron

🚀 Quick Start

Importing from `@tetherto/wdk-wallet-tron`

Creating a New Wallet

import WalletManagerTron, { WalletAccountTron, WalletAccountReadOnlyTron } from '@tetherto/wdk-wallet-tron'

// Use a BIP-39 seed phrase (replace with your own secure phrase)
const seedPhrase = 'test only example nut use this real life secret phrase must random'

// Create wallet manager with Tron RPC provider
const wallet = new WalletManagerTron(seedPhrase, {
  provider: 'https://api.trongrid.io', // or any other Tron RPC provider
  transferMaxFee: 10000000n // Optional: Maximum fee in sun
})

// Get a full access account
const account = await wallet.getAccount(0)

// Convert to a read-only account
const readOnlyAccount = await account.toReadOnlyAccount()

Managing Multiple Accounts

import WalletManagerTron from '@tetherto/wdk-wallet-tron'

// Assume wallet is already created
// Get the first account (index 0)
const account = await wallet.getAccount(0)
const address = await account.getAddress()
console.log('Account 0 address:', address)

// Get the second account (index 1)
const account1 = await wallet.getAccount(1)
const address1 = await account1.getAddress()
console.log('Account 1 address:', address1)

// Get account by custom derivation path
// Full path will be m/44'/195'/0'/0/5
const customAccount = await wallet.getAccountByPath("0'/0/5")
const customAddress = await customAccount.getAddress()
console.log('Custom account address:', customAddress)

// Note: All addresses are Tron addresses (T...)
// All accounts inherit the provider configuration from the wallet manager

Checking Balances

Owned Account

For accounts where you have the seed phrase and full access:

import WalletManagerTron from '@tetherto/wdk-wallet-tron'

// Assume wallet and account are already created
// Get native TRX balance (in sun)
const balance = await account.getBalance()
console.log('Native TRX balance:', balance, 'sun') // 1 TRX = 1000000 sun

// Get TRC20 token balance
const tokenContract = 'T...'; // TRC20 contract address
const tokenBalance = await account.getTokenBalance(tokenContract);
console.log('TRC20 token balance:', tokenBalance);

// Note: Provider is required for balance checks
// Make sure wallet was created with a provider configuration

Read-Only Account

For addresses where you don't have the seed phrase:

import { WalletAccountReadOnlyTron } from '@tetherto/wdk-wallet-tron'

// Create a read-only account
const readOnlyAccount = new WalletAccountReadOnlyTron('T...', { // Tron address
  provider: 'https://api.trongrid.io' // Required for balance checks
})

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

// Check TRC20 token balance using contract
const tokenBalance = await readOnlyAccount.getTokenBalance('T...') // TRC20 contract address
console.log('TRC20 token balance:', tokenBalance)

// Note: TRC20 balance checks use the standard balanceOf(address) function
// Make sure the contract address is correct and implements the TRC20 standard

Sending Transactions

Send TRX and estimate fees using WalletAccountTron. Ensure connection to TronWeb.

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

// Get transaction fee estimate
const quote = await account.quoteSendTransaction({
  to: 'T...',
  value: 1000000n
});
console.log('Estimated fee:', quote.fee, 'sun');

Token Transfers

Transfer TRC20 tokens and estimate fees using WalletAccountTron. Uses standard TRC20 transfer function.

// Transfer TRC20 tokens
const transferResult = await account.transfer({
  token: 'T...',      // TRC20 contract address
  recipient: 'T...',  // Recipient's Tron address
  amount: 1000000n     // Amount in TRC20's base units (use BigInt for large numbers)
});
console.log('Transfer hash:', transferResult.hash);
console.log('Transfer fee:', transferResult.fee, 'sun');

// Quote token transfer fee
const transferQuote = await account.quoteTransfer({
  token: 'T...',      // TRC20 contract address
  recipient: 'T...',  // Recipient's Tron address
  amount: 1000000n     // Amount in TRC20's base units
})
console.log('Transfer fee estimate:', transferQuote.fee, 'sun')

Message Signing and Verification

Sign messages using WalletAccountTron. Verify messages using WalletAccountReadOnlyTron (or WalletAccountTron which extends it).

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

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

Fee Management

Retrieve current fee rates using WalletManagerTron.

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

Memory Management

Clear sensitive data from memory using dispose methods in WalletAccountTron and WalletManagerTron.

// Dispose wallet accounts to clear private keys from memory
account.dispose()

// Dispose entire wallet manager
wallet.dispose()

📚 API Reference

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` from `@tetherto/wdk-wallet`.	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.

Constructor

new WalletManagerTron(seed, config)

Parameters:

seed (string | Uint8Array): BIP-39 mnemonic seed phrase or seed bytes
config (object, optional): Configuration object
- provider (string, optional): Tron RPC endpoint URL (e.g., 'https://api.trongrid.io')
- transferMaxFee (number | bigint, optional): Maximum fee amount for transfer operations (in sun)

Example:

const wallet = new WalletManagerTron(seedPhrase, {
  provider: 'https://api.trongrid.io',
  transferMaxFee: '10000000' // Maximum fee in sun
})

Methods

Method	Description	Returns
`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 for transactions	`Promise<{normal: bigint, fast: bigint}>`
`dispose()`	Disposes all wallet accounts, clearing private keys from memory	`void`

`getAccount(index)`

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

Parameters:

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

Returns: Promise<WalletAccountTron> - The Tron wallet account

Example:

const account = await wallet.getAccount(0)
const address = await account.getAddress()
console.log('Tron account address:', address)

`getAccountByPath(path)`

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

Parameters:

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

Returns: Promise<WalletAccountTron> - The Tron wallet account

Example:

const account = await wallet.getAccountByPath("0'/0/1")
const address = await account.getAddress()
console.log('Custom path address:', address)

`getFeeRates()`

Returns current fee rates for Tron transactions from the network.

Returns: Promise<{normal: bigint, fast: bigint}> - Object containing fee rates in sun

normal: Standard fee rate for normal confirmation speed
fast: Higher fee rate for faster confirmation

Example:

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

// Use in transaction
const result = await account.sendTransaction({
  to: 'TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH',
  value: 1000000n // 1 TRX in sun
})

`dispose()`

Disposes all Tron wallet accounts and clears sensitive data from memory.

Returns: void

Example:

wallet.dispose()
// All accounts and private keys are now securely wiped from memory

WalletAccountTron

Represents an individual wallet account. Implements IWalletAccount from @tetherto/wdk-wallet.

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 (object, optional): Configuration object
- provider (string): Tron RPC endpoint URL
- transferMaxFee (number | bigint, optional): Maximum fee amount for transfer operations (in sun)

Methods

Method	Description	Returns
`getAddress()`	Returns the account's address	`Promise<string>`
`sign(message)`	Signs a message using the account's private key	`Promise<string>`
`sendTransaction(tx)`	Sends a Tron transaction	`Promise<{hash: string, fee: bigint}>`
`quoteSendTransaction(tx)`	Estimates the fee for a Tron transaction	`Promise<{fee: bigint}>`
`transfer(options)`	Transfers TRC20 tokens to another address	`Promise<{hash: string, fee: bigint}>`
`quoteTransfer(options)`	Estimates the fee for a TRC20 transfer	`Promise<{fee: bigint}>`
`getBalance()`	Returns the native TRX balance (in sun)	`Promise<bigint>`
`getTokenBalance(tokenAddress)`	Returns the balance of a specific TRC20 token	`Promise<bigint>`
`dispose()`	Disposes the wallet account, clearing private keys from memory	`void`

`getAddress()`

Returns the account's Tron address.

Returns: Promise<string> - The Tron address

Example:

const address = await account.getAddress()
console.log('Tron address:', address) // TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH

`sign(message)`

Signs a message using the account's private key.

Parameters:

message (string): Message to sign

Returns: Promise<string> - Signature as hex string

Example:

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

`sendTransaction(tx)`

Sends a Tron transaction and broadcasts it to the network.

Parameters:

tx (object): The transaction object
- to (string): Recipient Tron address (e.g., 'T...')
- value (number | bigint): Amount in sun (1 TRX = 1,000,000 sun)

Returns: Promise<{hash: string, fee: bigint}> - Object containing hash and fee (in sun)

Example:

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

`quoteSendTransaction(tx)`

Estimates the fee for a Tron transaction without broadcasting it.

Parameters:

tx (object): Same as sendTransaction parameters
- to (string): Recipient Tron address
- value (number | bigint): Amount in sun

Returns: Promise<{fee: bigint}> - Object containing estimated fee (in sun)

Example:

const quote = await account.quoteSendTransaction({
  to: 'TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH',
  value: 1000000n // 1 TRX in sun
})
console.log('Estimated fee:', quote.fee, 'sun')
console.log('Estimated fee in TRX:', Number(quote.fee) / 1e6)

`transfer(options)`

Transfers TRC20 tokens to another address and broadcasts the transaction.

Parameters:

options (object): Transfer options
- to (string): Recipient Tron address
- tokenAddress (string): TRC20 token contract address
- value (number | bigint): Amount in token's smallest unit

Returns: Promise<{hash: string, fee: bigint}> - Object containing hash and fee (in sun)

Example:

const result = await account.transfer({
  to: 'TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH',
  tokenAddress: 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t', // USDT TRC20
  value: 1000000n // 1 USDT (6 decimals)
})
console.log('Transfer hash:', result.hash)
console.log('Gas fee:', result.fee, 'sun')

`quoteTransfer(options)`

Estimates the fee for a TRC20 token transfer without broadcasting it.

Parameters:

options (object): Same as transfer parameters
- to (string): Recipient Tron address
- tokenAddress (string): TRC20 token contract address
- value (number | bigint): Amount in token's smallest unit

Returns: Promise<{fee: bigint}> - Object containing estimated fee (in sun)

Example:

const quote = await account.quoteTransfer({
  to: 'TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH',
  tokenAddress: 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t', // USDT TRC20
  value: 1000000n // 1 USDT (6 decimals)
})
console.log('Estimated transfer fee:', quote.fee, 'sun')

`getBalance()`

Returns the account's native TRX balance in sun.

Returns: Promise<bigint> - Balance in sun

Example:

const balance = await account.getBalance()
console.log('TRX balance:', balance, 'sun')
console.log('Balance in TRX:', Number(balance) / 1e6)

`getTokenBalance(tokenAddress)`

Returns the balance of a specific TRC20 token.

Parameters:

tokenAddress (string): The TRC20 token contract address

Returns: Promise<bigint> - Token balance in token's smallest unit

Example:

// Get USDT TRC20 balance (6 decimals)
const usdtBalance = await account.getTokenBalance('TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t')
console.log('USDT balance:', Number(usdtBalance) / 1e6)

`dispose()`

Disposes the wallet account, securely erasing the private key from memory.

Returns: void

Example:

account.dispose()
// Private key is now securely wiped from memory

Properties

Property	Type	Description
`index`	`number`	The derivation path's index of this account
`path`	`string`	The full derivation path of this account
`keyPair`	`object`	The account's key pair (⚠️ Contains sensitive data)

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

WalletAccountReadOnlyTron

Represents a read-only wallet account.

Constructor

new WalletAccountReadOnlyTron(address, config)

Parameters:

address (string): The account's Tron address
config (object, optional): Configuration object
- provider (string): Tron RPC endpoint URL

Methods

Method	Description	Returns
`verify(message, signature)`	Verifies a message signature	`Promise<boolean>`
`getBalance()`	Returns the native TRX balance (in sun)	`Promise<bigint>`
`getTokenBalance(tokenAddress)`	Returns the balance of a specific TRC20 token	`Promise<bigint>`
`quoteSendTransaction(tx)`	Estimates the fee for a Tron transaction	`Promise<{fee: bigint}>`
`quoteTransfer(options)`	Estimates the fee for a TRC20 transfer	`Promise<{fee: bigint}>`

`verify(message, signature)`

Verifies a message signature using the account's address.

Parameters:

message (string): Original message
signature (string): Signature as hex string

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

Example:

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

`getBalance()`

Returns the account's native TRX balance in sun.

Returns: Promise<bigint> - Balance in sun

Example:

const balance = await readOnlyAccount.getBalance()
console.log('TRX balance:', balance, 'sun')
console.log('Balance in TRX:', Number(balance) / 1e6)

`getTokenBalance(tokenAddress)`

Returns the balance of a specific TRC20 token.

Parameters:

tokenAddress (string): The TRC20 token contract address

Returns: Promise<bigint> - Token balance in token's smallest unit

Example:

// Get USDT TRC20 balance (6 decimals)
const usdtBalance = await readOnlyAccount.getTokenBalance('TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t')
console.log('USDT balance:', Number(usdtBalance) / 1e6)

`quoteSendTransaction(tx)`

Estimates the fee for a Tron transaction without broadcasting it.

Parameters:

tx (object): The transaction object
- to (string): Recipient Tron address (e.g., 'T...')
- value (number | bigint): Amount in sun

Returns: Promise<{fee: bigint}> - Object containing estimated fee (in sun)

Example:

const quote = await readOnlyAccount.quoteSendTransaction({
  to: 'TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH',
  value: 1000000n // 1 TRX in sun
})
console.log('Estimated fee:', quote.fee, 'sun')
console.log('Estimated fee in TRX:', Number(quote.fee) / 1e6)

`quoteTransfer(options)`

Estimates the fee for a TRC20 token transfer without broadcasting it.

Parameters:

options (object): Transfer options
- to (string): Recipient Tron address
- tokenAddress (string): TRC20 token contract address
- value (number | bigint): Amount in token's smallest unit

Returns: Promise<{fee: bigint}> - Object containing estimated fee (in sun)

Example:

const quote = await readOnlyAccount.quoteTransfer({
  to: 'TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH',
  tokenAddress: 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t', // USDT TRC20
  value: 1000000n // 1 USDT (6 decimals)
})
console.log('Estimated transfer fee:', quote.fee, 'sun')
console.log('Estimated fee in TRX:', Number(quote.fee) / 1e6)

🌐 Supported Networks

This package works with the Tron blockchain, including:

Tron Mainnet
Tron Shasta Testnet

🔒 Security Considerations

Seed Phrase Security: Always store your seed phrase securely and never share it
Private Key Management: The package handles private keys internally with memory safety features
Provider Security: Use trusted RPC endpoints and consider running your own node for production
Transaction Validation: Always validate transaction details before signing
Memory Cleanup: Use the dispose() method to clear private keys from memory when done
Fee Limits: Set transferMaxFee in config to prevent excessive transaction fees
Gas Estimation: Always estimate gas before sending transactions
Contract Interactions: Verify contract addresses and token decimals before transfers

🛠️ Development

Building

# Install dependencies
npm install

# Build TypeScript definitions
npm run build:types

# Lint code
npm run lint

# Fix linting issues
npm run lint:fix

Testing

# Run tests
npm test

# Run tests with coverage
npm run test:coverage

📜 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

🆘 Support

For support, please open an issue on the GitHub repository.

Name		Name	Last commit message	Last commit date
Latest commit History 93 Commits
.github		.github
src		src
types		types
.editorconfig		.editorconfig
.gitignore		.gitignore
.npmignore		.npmignore
.npmrc		.npmrc
AGENTS.md		AGENTS.md
LICENSE		LICENSE
README.md		README.md
bare.js		bare.js
index.js		index.js
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

Folders and files

Latest commit

History

Repository files navigation

@tetherto/wdk-wallet-tron

🔍 About WDK

🌟 Features

⬇️ Installation

🚀 Quick Start

Importing from @tetherto/wdk-wallet-tron

Creating a New Wallet

Managing Multiple Accounts

Checking Balances

Owned Account

Read-Only Account

Sending Transactions

Token Transfers

Message Signing and Verification

Fee Management

Memory Management

📚 API Reference

Table of Contents

WalletManagerTron

Constructor

Methods

getAccount(index)

getAccountByPath(path)

getFeeRates()

dispose()

WalletAccountTron

Constructor

Methods

getAddress()

sign(message)

sendTransaction(tx)

quoteSendTransaction(tx)

transfer(options)

quoteTransfer(options)

getBalance()

getTokenBalance(tokenAddress)

dispose()

Properties

WalletAccountReadOnlyTron

Constructor

Methods

verify(message, signature)

getBalance()

getTokenBalance(tokenAddress)

quoteSendTransaction(tx)

quoteTransfer(options)

🌐 Supported Networks

🔒 Security Considerations

🛠️ Development

Building

Testing

📜 License

🤝 Contributing

🆘 Support

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 4

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Importing from `@tetherto/wdk-wallet-tron`

`getAccount(index)`

`getAccountByPath(path)`

`getFeeRates()`

`dispose()`

`getAddress()`

`sign(message)`

`sendTransaction(tx)`

`quoteSendTransaction(tx)`

`transfer(options)`

`quoteTransfer(options)`

`getBalance()`

`getTokenBalance(tokenAddress)`

`dispose()`

`verify(message, signature)`

`getBalance()`

`getTokenBalance(tokenAddress)`

`quoteSendTransaction(tx)`

`quoteTransfer(options)`

Packages