pwc-sdk-wallet 0.7.8 → 0.8.0

package/README.md

@@ -31,6 +31,7 @@ A comprehensive, secure, and user-friendly wallet SDK for React Native applicati
 - [Account Management](#account-management)
    - [Add New HD Account](#add-new-hd-account)
    - [Add New Solana Account](#add-new-solana-account)
+   - [Add New TRON Account](#add-new-tron-account)
    - [Import Account](#import-account)
    - [Get Accounts](#get-accounts)
 - [Balance & Token Functions](#balance--token-functions)
@@ -45,6 +46,9 @@ A comprehensive, secure, and user-friendly wallet SDK for React Native applicati
    - [Send Native Token](#send-native-token)
    - [Send Token](#send-token)
    - [Send SPL Token (Solana)](#send-spl-token-solana)
+   - [Send TRX (TRON)](#send-trx-tron)
+   - [Send TRC-20 Token (TRON)](#send-trc-20-token-tron)
+   - [Popular TRON TRC-20 Tokens](#popular-tron-trc-20-tokens)
    - [Export Mnemonic](#export-mnemonic)
 
 ### 🔄 Multi-Transfer Operations
@@ -1469,7 +1473,7 @@ console.log('ERC-1155 transfer gas:', erc1155TransferGas.toString());
 
 - 🔐 **Secure HD Wallet Management**: BIP-44 compliant hierarchical deterministic wallets
 - 🎯 **Vanity Address Generation**: Generate wallets with custom address prefixes
-- 🔗 **Multi-Chain Support**: Ethereum, BSC, Polygon, Arbitrum, Optimism, Base, and Solana
+- 🔗 **Multi-Chain Support**: Ethereum, BSC, Polygon, Arbitrum, Optimism, Base, Solana, and TRON
 - 🚀 **Multi-Transfer Operations**: Batch send tokens to multiple recipients
 - 🔧 **Custom Chain Support**: Add custom chains and override built-in configurations
 - 📱 **React Native Optimized**: Designed specifically for mobile applications
@@ -1536,6 +1540,13 @@ const { vault, encryptedVault } = await Vault.createFromMnemonic(
   'solana'
 );
 
+// For TRON
+const { vault, encryptedVault } = await Vault.createFromMnemonic(
+  existingMnemonic, 
+  'your-secure-password', 
+  'tron'
+);
+
 // Get wallet accounts
 const accounts = vault.getAccounts();
 console.log('Imported wallet addresses:', accounts.map(acc => acc.address));
@@ -1784,10 +1795,17 @@ console.log('New account address:', newAccount.address);
 #### Add New Solana Account
 ```typescript
 // Add a new Solana account
-const newSolanaAccount = vault.addSolanaAccount();
+const newSolanaAccount = await vault.addNewSolanaAccount();
 console.log('New Solana account:', newSolanaAccount.address);
 ```
 
+#### Add New TRON Account
+```typescript
+// Add a new TRON account
+const newTronAccount = vault.addNewTronAccount();
+console.log('New TRON account:', newTronAccount.address);
+```
+
 #### Import Account
 ```typescript
 // Import an existing account with private key
@@ -1809,6 +1827,14 @@ console.log('All accounts:', accounts.map(acc => acc.address));
 // Get native token balance (ETH, BNB, MATIC, etc.)
 const balance = await vault.getNativeBalance(address, '1'); // Ethereum
 console.log('ETH Balance:', ethers.formatEther(balance));
+
+// Get SOL balance on Solana
+const solBalance = await vault.getNativeBalance(address, 'solana');
+console.log('SOL Balance:', solBalance.toString(), 'lamports');
+
+// Get TRX balance on TRON
+const trxBalance = await vault.getNativeBalance(address, 'tron');
+console.log('TRX Balance:', trxBalance.toString(), 'SUN');
 ```
 
 #### Get Token Balance
@@ -1829,9 +1855,17 @@ console.log('Token:', tokenInfo.name, '(', tokenInfo.symbol, ')');
 
 #### Send Native Token
 ```typescript
-// Send native tokens (ETH, BNB, etc.)
-const tx = await vault.sendNativeToken(from, to, amount, '1');
+// Send native tokens (ETH, BNB, etc.) on EVM chains
+const tx = await vault.sendNativeToken(from, to, amount, '1'); // Ethereum
 console.log('Transaction hash:', tx.hash);
+
+// Send SOL on Solana
+const solTx = await vault.sendNativeToken(from, to, amount, 'solana');
+console.log('Solana transaction hash:', solTx.hash);
+
+// Send TRX on TRON
+const trxTx = await vault.sendNativeToken(from, to, amount, 'tron');
+console.log('TRON transaction hash:', trxTx.hash);
 ```
 
 #### Send Token
@@ -1917,6 +1951,96 @@ const USDC_DEVNET = '4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU';
 const USDT_DEVNET = 'Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB';
 ```
 
+#### Send TRX (TRON)
+```typescript
+// Send native TRX
+const tx = await vault.sendTRX(from, to, '1.5');
+console.log('Transaction hash:', tx.hash);
+
+// Get TRX balance
+const balance = await vault.getTRXBalance(address);
+console.log('TRX Balance:', TronChainService.sunToTrx(balance.toString()));
+```
+
+#### Send TRC-20 Token (TRON)
+```typescript
+// Send USDT on TRON
+const usdtTx = await vault.sendTRC20Token(
+  'TYourAddress...',
+  'TRecipient...',
+  '100', // 100 USDT
+  'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t' // USDT contract address
+);
+
+// Send USDC on TRON
+const usdcTx = await vault.sendTRC20Token(
+  'TYourAddress...',
+  'TRecipient...',
+  '50', // 50 USDC
+  'TEkxiTehnzSmSe2XqrBj4w32RUN966rdz8' // USDC contract address
+);
+
+// Get TRC-20 token balance
+const usdtBalance = await vault.getTRC20TokenBalance(
+  'TYourAddress...',
+  'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t'
+);
+console.log('USDT Balance:', usdtBalance.toString());
+
+// Get TRC-20 token information
+const tokenInfo = await vault.getTRC20TokenInfo(
+  'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t'
+);
+console.log('Token:', tokenInfo.name, '(', tokenInfo.symbol, ')');
+console.log('Decimals:', tokenInfo.decimals);
+
+// Estimate TRX transfer fee
+const trxFee = await vault.estimateTRXTransferFee(
+  'TYourAddress...',
+  'TRecipient...',
+  '1.5'
+);
+console.log('Estimated TRX fee:', TronChainService.sunToTrx(trxFee.toString()), 'TRX');
+
+// Estimate TRC-20 transfer fee
+const tokenFee = await vault.estimateTRC20TransferFee(
+  'TYourAddress...',
+  'TRecipient...',
+  '100',
+  'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t'
+);
+console.log('Estimated token fee:', TronChainService.sunToTrx(tokenFee.toString()), 'TRX');
+```
+
+#### Popular TRON TRC-20 Tokens
+
+**Mainnet Token Addresses:**
+```typescript
+// USDT (Tether USD)
+const USDT_TRC20 = 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t';
+
+// USDC (USD Coin)
+const USDC_TRC20 = 'TEkxiTehnzSmSe2XqrBj4w32RUN966rdz8';
+
+// USDD (Decentralized USD)
+const USDD_TRC20 = 'TPYmHEhy5n8TCEfYGqW2rPxsghSfzghPDn';
+
+// JST (JUST)
+const JST_TRC20 = 'TCFLL5dx5ZJdKnWuesXxi1VPwjLVmWZZy9';
+
+// WIN (WINkLink)
+const WIN_TRC20 = 'TLa2f6VPqDgRE67v1736s7bJ8Ray5wYjU7';
+```
+
+**Shasta Testnet Token Addresses (for testing):**
+```typescript
+// USDT Shasta
+const USDT_SHASTA = 'TG3XXyExBkPp9nzdajDZsozEu1kkaAzc3X';
+
+// USDC Shasta
+const USDC_SHASTA = 'TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBZ';
+```
+
 #### Export Mnemonic
 ```typescript
 // Export the mnemonic phrase (requires password)
@@ -1977,7 +2101,8 @@ console.log('Token transfers completed:', result.successfulCount);
 ```typescript
 import { Vault, type VaultConfig } from 'pwc-wallet-sdk';
 
-const config: VaultConfig = {
+// Example: EVM chains config
+const evmConfig: VaultConfig = {
   rpcUrls: {
     '1': 'https://your-eth-rpc.com',
     '56': 'https://your-bsc-rpc.com',
@@ -2002,9 +2127,37 @@ const config: VaultConfig = {
     enableBatchProcessing: true,
   }
 };
+
+// Example: Solana config
+const solanaConfig: VaultConfig = {
+  rpcUrls: {
+    'solana': 'https://your-solana-rpc.com',
+    'solana-devnet': 'https://your-devnet-rpc.com'
+  },
+  explorerUrls: {
+    'solana': 'https://solscan.io',
+    'solana-devnet': 'https://solscan.io?cluster=devnet'
+  },
+  defaultChainId: 'solana'
+};
+
+// Example: TRON config
+const tronConfig: VaultConfig = {
+  rpcUrls: {
+    'tron': 'https://your-tron-rpc.com',
+    'tron-shasta': 'https://your-shasta-rpc.com'
+  },
+  explorerUrls: {
+    'tron': 'https://tronscan.org',
+    'tron-shasta': 'https://shasta.tronscan.org'
+  },
+  defaultChainId: 'tron'
+};
 ```
 
 #### Usage Example (Recommended for Mobile Apps)
+
+**For EVM Chains:**
 ```typescript
 import { Vault, type VaultConfig } from 'pwc-wallet-sdk';
 const appConfig: VaultConfig = {
@@ -2017,12 +2170,63 @@ const appConfig: VaultConfig = {
 const { vault, encryptedVault } = await Vault.createNew(password, 'evm', appConfig);
 
 // Pass config when loading existing vault
-const vault = await Vault.load('password, encryptedVault, appConfig);
+const vault = await Vault.load(password, encryptedVault, appConfig);
 
 // All operations will use the config automatically
 await vault.sendToken(from, to, amount, tokenAddress, '1');
 ```
 
+**For Solana:**
+```typescript
+import { Vault, type VaultConfig } from 'pwc-wallet-sdk';
+
+// Configure Solana RPC URLs
+const solanaConfig: VaultConfig = {
+  rpcUrls: {
+    'solana': 'https://your-solana-rpc.com', // Mainnet
+    'solana-devnet': 'https://your-devnet-rpc.com' // Devnet (optional)
+  },
+  explorerUrls: {
+    'solana': 'https://solscan.io',
+    'solana-devnet': 'https://solscan.io?cluster=devnet'
+  },
+  defaultChainId: 'solana' // Optional: set default chain
+};
+
+// Create Solana vault with config
+const { vault, encryptedVault } = await Vault.createNew('password', 'solana', solanaConfig);
+
+// Or from mnemonic
+const { vault, encryptedVault } = await Vault.createFromMnemonic(
+  mnemonic, 
+  'password', 
+  'solana', 
+  solanaConfig
+);
+
+// All Solana operations will use the configured RPC URLs
+const balance = await vault.getNativeBalance(address, 'solana');
+const tx = await vault.sendSPLToken(from, to, amount, tokenAddress);
+```
+
+**For TRON:**
+```typescript
+import { Vault, type VaultConfig } from 'pwc-wallet-sdk';
+
+const tronConfig: VaultConfig = {
+  rpcUrls: {
+    'tron': 'https://your-tron-rpc.com',
+    'tron-shasta': 'https://your-shasta-rpc.com' // Testnet (optional)
+  },
+  explorerUrls: {
+    'tron': 'https://tronscan.org',
+    'tron-shasta': 'https://shasta.tronscan.org'
+  }
+};
+
+const { vault, encryptedVault } = await Vault.createNew('password', 'tron', tronConfig);
+```
+
 #### Alternative: Global Config (Advanced)
 You can also set config globally for all vaults:
 ```typescript

package/dist/Vault.d.ts

@@ -4,7 +4,7 @@ import { Recipient, MultiTransferResult } from './types/multiTransfer';
 import { NFTDetailExtended, NFTBalance, NFTOptions } from './types/nft';
 export interface Account {
     address: string;
-    type: 'HD' | 'Simple' | 'Solana';
+    type: 'HD' | 'Simple' | 'Solana' | 'Tron';
     name: string;
 }
 export interface TransactionResponse {
@@ -51,11 +51,11 @@ export declare class Vault {
     /**
      * Creates a new Vault with a fresh mnemonic.
      * @param password - The password used to encrypt the vault data
-     * @param chainType - The type of blockchain to support ('evm' for Ethereum-compatible chains or 'solana' for Solana). Defaults to 'evm'
+     * @param chainType - The type of blockchain to support ('evm' for Ethereum-compatible chains, 'solana' for Solana, or 'tron' for TRON). Defaults to 'evm'
      * @returns Promise resolving to an object containing the created vault instance and its encrypted data
      * @throws Error if mnemonic generation or keyring initialization fails
      */
-    static createNew(password: string, chainType?: 'evm' | 'solana', config?: VaultConfig): Promise<{
+    static createNew(password: string, chainType?: 'evm' | 'solana' | 'tron', config?: VaultConfig): Promise<{
         vault: Vault;
         encryptedVault: EncryptedData;
     }>;
@@ -63,11 +63,11 @@ export declare class Vault {
      * Creates a new Vault from an existing mnemonic phrase.
      * @param mnemonic - The existing mnemonic phrase (12, 15, 18, 21, or 24 words)
      * @param password - The password used to encrypt the vault data
-     * @param chainType - The type of blockchain to support ('evm' for Ethereum-compatible chains or 'solana' for Solana). Defaults to 'evm'
+     * @param chainType - The type of blockchain to support ('evm' for Ethereum-compatible chains, 'solana' for Solana, or 'tron' for TRON). Defaults to 'evm'
      * @returns Promise resolving to an object containing the created vault instance and its encrypted data
      * @throws Error if mnemonic is invalid or keyring initialization fails
      */
-    static createFromMnemonic(mnemonic: string, password: string, chainType?: 'evm' | 'solana', config?: VaultConfig): Promise<{
+    static createFromMnemonic(mnemonic: string, password: string, chainType?: 'evm' | 'solana' | 'tron', config?: VaultConfig): Promise<{
         vault: Vault;
         encryptedVault: EncryptedData;
     }>;
@@ -91,6 +91,12 @@ export declare class Vault {
      * @throws Error if no Solana keyring is available in the vault
      */
     addNewSolanaAccount(): Promise<Account>;
+    /**
+     * Adds a new TRON account derived from the TRON keyring.
+     * @returns Promise resolving to the newly created TRON account information
+     * @throws Error if no TRON keyring is available in the vault
+     */
+    addNewTronAccount(): Promise<Account>;
     /**
      * Imports an account from a private key and adds it to the vault.
      * @param privateKey - The private key to import (hex string without '0x' prefix for EVM, base58 for Solana)
@@ -130,6 +136,14 @@ export declare class Vault {
      * @throws Error if the address is not found in any keyring
      */
     getPrivateKeyFor(address: string): Promise<string>;
+    /**
+     * Gets the native token balance (ETH, SOL, TRX, etc.) for a specific address.
+     * @param address - The account address to check balance for
+     * @param chainId - The ID of the blockchain (e.g., '1' for Ethereum, 'solana' for Solana, 'tron' for TRON)
+     * @returns Promise resolving to the native token balance as a bigint
+     * @throws Error if the balance query fails or chain configuration not found
+     */
+    getNativeBalance(address: string, chainId: ChainId): Promise<bigint>;
     /**
      * Gets the token balance for a specific account and token contract.
      * @param accountAddress - The account address to check balance for
@@ -580,4 +594,82 @@ export declare class Vault {
      * ```
      */
     sendNativeToken(fromAddress: string, to: string, amount: string, chainId: ChainId): Promise<TransactionResponse>;
+    /**
+     * Sends TRX (native TRON token) to another address.
+     * @param fromAddress - The sender's TRON address
+     * @param to - The recipient's TRON address
+     * @param amount - The amount of TRX to send as a string (e.g., "1.5")
+     * @returns Promise resolving to the transaction response with hash and details
+     * @throws Error if the transaction fails or recipient address is invalid
+     *
+     * @example
+     * ```typescript
+     * // Send 1.5 TRX
+     * const tx = await vault.sendTRX(from, to, '1.5');
+     * console.log('Transaction hash:', tx.hash);
+     * ```
+     */
+    sendTRX(fromAddress: string, to: string, amount: string): Promise<TransactionResponse>;
+    /**
+     * Sends TRC-20 tokens on TRON blockchain.
+     * @param fromAddress - The sender's TRON address
+     * @param to - The recipient's TRON address
+     * @param amount - The amount of tokens to send as a string
+     * @param tokenAddress - The TRC-20 token contract address
+     * @returns Promise resolving to the transaction response with hash and details
+     * @throws Error if insufficient balance, invalid addresses, or transaction fails
+     *
+     * @example
+     * ```typescript
+     * // Send USDT on TRON
+     * const tx = await vault.sendTRC20Token(
+     *   'TYourAddress...',
+     *   'TRecipient...',
+     *   '100', // 100 USDT
+     *   'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t' // USDT contract address
+     * );
+     * ```
+     */
+    sendTRC20Token(fromAddress: string, to: string, amount: string, tokenAddress: string): Promise<TransactionResponse>;
+    /**
+     * Gets TRX balance for a specific address on TRON.
+     * @param address - The TRON address to check balance for
+     * @returns Promise resolving to the TRX balance as a bigint in SUN
+     * @throws Error if the balance query fails
+     */
+    getTRXBalance(address: string): Promise<bigint>;
+    /**
+     * Gets TRC-20 token balance for a specific address on TRON.
+     * @param address - The TRON address to check balance for
+     * @param tokenAddress - The TRC-20 token contract address
+     * @returns Promise resolving to the token balance as a bigint
+     * @throws Error if the balance query fails
+     */
+    getTRC20TokenBalance(address: string, tokenAddress: string): Promise<bigint>;
+    /**
+     * Gets TRC-20 token information.
+     * @param tokenAddress - The TRC-20 token contract address
+     * @returns Promise resolving to the token information
+     * @throws Error if the token query fails
+     */
+    getTRC20TokenInfo(tokenAddress: string): Promise<Token>;
+    /**
+     * Estimates the transaction fee for a TRX transfer.
+     * @param fromAddress - The sender's TRON address
+     * @param to - The recipient's TRON address
+     * @param amount - The amount of TRX to send
+     * @returns Promise resolving to the estimated fee in SUN
+     * @throws Error if the estimation fails
+     */
+    estimateTRXTransferFee(fromAddress: string, to: string, amount: string): Promise<bigint>;
+    /**
+     * Estimates the transaction fee for a TRC-20 token transfer.
+     * @param fromAddress - The sender's TRON address
+     * @param to - The recipient's TRON address
+     * @param amount - The amount of tokens to send
+     * @param tokenAddress - The TRC-20 token contract address
+     * @returns Promise resolving to the estimated fee in SUN
+     * @throws Error if the estimation fails
+     */
+    estimateTRC20TransferFee(fromAddress: string, to: string, amount: string, tokenAddress: string): Promise<bigint>;
 }