API Reference
Complete API documentation for @tetherto/wdk-wallet-tron-gasfree
Table of Contents
Main class for managing gas-free Tron wallets. Extends WalletManagerTron.
Individual gas-free Tron wallet account implementation. Extends WalletAccountReadOnlyTronGasfree.
WalletManagerTronGasfree
The main class for managing gas-free Tron wallets.
Constructor
new WalletManagerTronGasfree(seed, config)Parameters:
seed(string | Uint8Array): BIP-39 mnemonic seed phrase or seed bytesconfig(object): Configuration objectchainId(string): The blockchain's idprovider(string): Tron RPC endpoint URLgasFreeProvider(string): Gas-free service endpointgasFreeApiKey(string): API key for gas-free providergasFreeApiSecret(string): API secret for gas-free providerserviceProvider(string): Service provider Tron addressverifyingContract(string): Gas-free verifying contract addresstransferMaxFee(number, optional): Maximum fee for transfer operations
Example:
const wallet = new WalletManagerTronGasfree(seedPhrase, {
chainId: '728126428',
provider: 'https://api.trongrid.io',
gasFreeProvider: 'https://gasfree.provider.url',
gasFreeApiKey: 'your-api-key',
gasFreeApiSecret: 'your-api-secret',
serviceProvider: 'T...',
verifyingContract: 'T...',
transferMaxFee: 10000000 // Optional
})Methods
getAccount(index)
Returns a wallet account at the specified index
Promise<WalletAccountTronGasfree>
getAccountByPath(path)
Returns a wallet account at the specified BIP-44 derivation path
Promise<WalletAccountTronGasfree>
getFeeRates()
Returns current fee rates for normal and fast transactions
Promise<{normal: number, fast: number}>
dispose()
Disposes all wallet accounts, clearing private keys from memory
void
getAccount(index)
Returns a gas-free wallet account at the specified index.
Parameters:
index(number, optional): The index of the account to get (default: 0)
Returns: Promise<WalletAccountTronGasfree> - The wallet account
Example:
const account = await wallet.getAccount(0)getAccountByPath(path)
Returns a gas-free wallet account at the specified BIP-44 derivation path.
Parameters:
path(string): The derivation path (e.g., "0'/0/0")
Returns: Promise<WalletAccountTronGasfree> - The wallet account
Example:
const account = await wallet.getAccountByPath("0'/0/1")getFeeRates()
Returns current fee rates for normal and fast transactions.
Returns: Promise<{normal: number, fast: number}> - Object containing fee rates in sun
normal: Fee rate for normal priority transactionsfast: Fee rate for high priority transactions
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. This method should be called when you're done using the wallet to ensure sensitive data is removed.
Example:
wallet.dispose()WalletAccountTronGasfree
Individual gas-free Tron wallet account implementation.
Constructor
new WalletAccountTronGasfree(seed, path, config)Parameters:
seed(string | Uint8Array): BIP-39 mnemonic seed phrase or seed bytespath(string): BIP-44 derivation path (e.g., "0'/0/0")config(object): Same configuration object as WalletManagerTronGasfree
Methods
getAddress()
Returns the account's address
Promise<string>
getBalance()
Returns the native TRX balance (in sun)
Promise<number>
getTokenBalance(tokenAddress)
Returns the balance of a specific TRC20 token
Promise<number>
transfer(options)
Transfers TRC20 tokens to another address
Promise<{hash: string, fee: number}>
quoteTransfer(options)
Estimates the fee for a TRC20 transfer
Promise<{fee: number}>
sign(message)
Signs a message using the account's private key
Promise<string>
verify(message, signature)
Verifies a message signature
Promise<boolean>
dispose()
Disposes the wallet account, clearing private keys from memory
void
getAddress()
Returns the account's gas-free Tron address.
Returns: Promise<string> - The account's Tron address
Example:
const address = await account.getAddress()
console.log('Account address:', address)getBalance()
Returns the native TRX balance in sun units.
Returns: Promise<number> - Balance in sun
Example:
const balance = await account.getBalance()
console.log('TRX Balance:', balance, 'sun')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
Example:
const tokenBalance = await account.getTokenBalance('T...')
console.log('Token balance:', tokenBalance)transfer(options)
Transfers TRC20 tokens to another address using the gas-free service.
Parameters:
options(TransferOptions): Transfer optionstoken(string): TRC20 contract addressrecipient(string): Recipient's Tron addressamount(number): Amount in token base units
Returns: Promise<{hash: string, fee: number}> - Object containing transaction hash and fee paid in token base units
Example:
const result = await account.transfer({
token: 'T...', // TRC20 contract address
recipient: 'T...', // Recipient's address
amount: 1000000 // Amount in token base units
})
console.log('Transaction hash:', result.hash)
console.log('Fee paid:', result.fee, 'token base units')quoteTransfer(options)
Estimates the fee for a TRC20 token transfer.
Parameters:
options(TransferOptions): Transfer options (same as transfer method)
Returns: Promise<{fee: number}> - Estimated fee in token base units
Example:
const quote = await account.quoteTransfer({
token: 'T...',
recipient: 'T...',
amount: 1000000
})
console.log('Estimated fee:', quote.fee, 'token base units')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)verify(message, signature)
Verifies a message signature.
Parameters:
message(string): The original messagesignature(string): The signature to verify
Returns: Promise<boolean> - True if the signature is valid
Example:
const isValid = await account.verify('Hello, World!', signature)
console.log('Signature valid:', isValid)dispose()
Disposes the wallet account, clearing private keys from memory.
Example:
account.dispose()WalletAccountReadOnlyTronGasfree
Read-only gas-free Tron wallet account.
Constructor
new WalletAccountReadOnlyTronGasfree(address, config)Parameters:
address(string): The account's Tron addressconfig(object): Configuration objectchainId(string): The blockchain's idprovider(string): Tron RPC endpoint URLgasFreeProvider(string): Gas-free service endpointgasFreeApiKey(string): API key for gas-free providergasFreeApiSecret(string): API secret for gas-free providerserviceProvider(string): Service provider Tron addressverifyingContract(string): Gas-free verifying contract address
Methods
getAddress()
Returns the account's address
Promise<string>
getBalance()
Returns the native TRX balance (in sun)
Promise<number>
getTokenBalance(tokenAddress)
Returns the balance of a specific TRC20 token
Promise<number>
quoteTransfer(options)
Estimates the fee for a TRC20 transfer
Promise<{fee: number}>
getAddress()
Returns the account's gas-free Tron address.
Returns: Promise<string> - The account's Tron address
Example:
const address = await readOnlyAccount.getAddress()
console.log('Account address:', address)getBalance()
Returns the native TRX balance in sun units.
Returns: Promise<number> - Balance in sun
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 (e.g., 'T...')
Returns: Promise<number> - Token balance in base units
Example:
const tokenBalance = await readOnlyAccount.getTokenBalance('T...')
console.log('Token balance:', tokenBalance)quoteTransfer(options)
Estimates the fee for a TRC20 token transfer without requiring private keys.
Parameters:
options(TransferOptions): Transfer optionstoken(string): TRC20 contract addressrecipient(string): Recipient's Tron addressamount(number): Amount in token base units
Returns: Promise<{fee: number}> - Estimated fee in token base units
Example:
const quote = await readOnlyAccount.quoteTransfer({
token: 'T...',
recipient: 'T...',
amount: 1000000
})
console.log('Estimated fee:', quote.fee, 'token base units')Types
TransferOptions
Configuration options for token transfers.
interface TransferOptions {
/**
* The TRC20 token contract address
* @example 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t' // USDT contract
*/
token: string;
/**
* The recipient's Tron address
* @example 'TJYeasTPa6gpEEfQa7s9CqqqgvYh6JtpAR'
*/
recipient: string;
/**
* Amount to transfer in token base units
* @example 1000000 // 1 USDT (6 decimals)
*/
amount: number;
}TransferResult
Result object returned by transfer operations.
interface TransferResult {
/**
* The transaction hash
* @example '0x123...'
*/
hash: string;
/**
* Fee paid in token base units
* @example 1000 // Fee in token base units
*/
fee: number;
}FeeRates
Fee rate information for transactions.
interface FeeRates {
/**
* Fee rate for normal priority transactions (in sun)
* @example 1000
*/
normal: number;
/**
* Fee rate for high priority transactions (in sun)
* @example 2000
*/
fast: number;
}TronGasfreeWalletConfig
Configuration options for wallet initialization.
interface TronGasfreeWalletConfig {
/**
* The blockchain's ID
* @example '728126428' // Tron Mainnet
*/
chainId: string;
/**
* Tron RPC endpoint URL or TronWeb instance
* @example 'https://api.trongrid.io'
*/
provider: string | TronWeb;
/**
* Gas-free service endpoint
* @example 'https://gasfree.trongrid.io'
*/
gasFreeProvider: string;
/**
* API key for gas-free provider
*/
gasFreeApiKey: string;
/**
* API secret for gas-free provider
*/
gasFreeApiSecret: string;
/**
* Service provider Tron address
* @example 'T...'
*/
serviceProvider: string;
/**
* Gas-free verifying contract address
* @example 'T...'
*/
verifyingContract: string;
/**
* Maximum fee for transfer operations (in token base units)
* @optional
* @example 10000000
*/
transferMaxFee?: number;
}KeyPair
Account key pair information.
interface KeyPair {
/**
* Public key as buffer
*/
publicKey: Buffer;
/**
* Private key as buffer (sensitive data)
*/
privateKey: Buffer;
}