Class TRON

connected

name

provider

rpc_url

signer

wallet

Static ReadonlySUN_PER_TRX

connect

• connect(): Promise<boolean>

• Connects to the RPC provider

  Returns Promise<boolean>

  A boolean indicating if the connection was successful

connectWallet

• connectWallet(privateKey): Promise<TronWeb>

• Connects to a wallet using a private key

  Parameters

  • privateKey: string

    The private key of the wallet

  Returns Promise<TronWeb>

  The wallet object

createWallet

• createWallet(_password): Promise<{
      address: string;
      privateKey: string;
  }>

• Creates a new TRON wallet

  Parameters

  • _password: string

    Password parameter (reserved for future encryption support)

  Returns Promise<{
      address: string;
      privateKey: string;
  }>

  Object containing the wallet address and private key

  Note

  Currently returns unencrypted private key. Password parameter is accepted for interface compatibility but not yet used for encryption.

disconnect

• disconnect(): Promise<boolean>

• Disconnects from the RPC provider and the wallet

  Returns Promise<boolean>

  A boolean indicating if the disconnection was successful

getAddress

• getAddress(): string

• Returns the address of the connected wallet

  Returns string

getBalance

• getBalance(address): Promise<string>

• Gets the balance of a wallet

  Parameters

  • address: string

    The wallet address

  Returns Promise<string>

  The balance of the wallet as a string

getEmptyTransaction

• getEmptyTransaction(): any

• Creates a skeleton transaction

  Returns any

getInfo

• getInfo(): Promise<any>

• Gets various infos

  Returns Promise<any>

getPublicKey

• getPublicKey(): string

• Returns the public key of the connected wallet (if available).

  Returns string

  The public key as a hex string, or undefined if not available

preparePay

• preparePay(receiver, amount, options?): Promise<any>

• Prepare a TRX transfer transaction

  Parameters

  • receiver: string

    Recipient address (base58 format)
  • amount: string

    Amount in SUN (1 TRX = 1,000,000 SUN)
  • Optionaloptions: {
        privateKey?: string;
    }

    Options including optional privateKey

    • OptionalprivateKey?: string

  Returns Promise<any>

  Signed transaction ready to broadcast

preparePays

• preparePays(payments, options?): Promise<any[]>

• Prepare multiple TRX transfer transactions

  Parameters

  • payments: IPayOptions[]

    Array of payments with address and amount (in SUN)
  • Optionaloptions: {
        privateKey?: string;
    }

    Options including optional privateKey

    • OptionalprivateKey?: string

  Returns Promise<any[]>

  Array of signed transactions

prepareTransfer

• prepareTransfer<T, Options>(this, receiver, amount, options?): Promise<Awaited<ReturnType<T["preparePays"]>>[number]>

• Creates a signed transaction to transfer default chain currency

  Type Parameters

  • T extends DefaultChain
  • Options extends {}

  Parameters

  • this: T
  • receiver: string

    The receiver's address
  • amount: string

    The amount to transfer
  • Optionaloptions: Options

    Options

  Returns Promise<Awaited<ReturnType<T["preparePays"]>>[number]>

  The signed transaction

prepareTransfers

• prepareTransfers<T, Options>(this, payments, options?): Promise<Awaited<ReturnType<T["preparePays"]>>>

• Creatthis.provider = new JsonRpcProvider(this.rpc_url)es a list of signed transactions to transfer default chain currency

  Type Parameters

  • T extends DefaultChain
  • Options extends {}

  Parameters

  • this: T
  • payments: IPayOptions[]

    A list of transfers to prepare
  • Optionaloptions: Options

    Options

  Returns Promise<Awaited<ReturnType<T["preparePays"]>>>

  An ordered list of signed transactions

sendTransaction

• sendTransaction(signedTx): Promise<TransactionResponse>

• Broadcast a signed transaction to the network

  Parameters

  • signedTx: any

    The signed transaction

  Returns Promise<TransactionResponse>

  Transaction response with result and hash

setRpc

• setRpc(rpc_url): void

• Sets the RPC URL only. Use await instance.connect() to connect to the rpc provider

  Parameters

  • rpc_url: string

  Returns void

signMessage

• signMessage(message, options?): Promise<string>

• Signs a message using the connected wallet

  Parameters

  • message: string

    The message to sign
  • Optionaloptions: {
        privateKey?: string;
    }

    Options

    • OptionalprivateKey?: string

  Returns Promise<string>

  The signed message

signTransaction

• signTransaction(tx): Promise<any>

• Signs a transaction using the connected wallet

  Parameters

  • tx: any

    The transaction to sign

  Returns Promise<any>

  The signed transaction

signTransactions

• signTransactions(transactions, options?): Promise<any[]>

• Signs a list of transactions using the connected wallet. The transaction nonce is incremented for each transaction in order of appearance.

  Parameters

  • transactions: any[]

    A list of transactions to sign
  • Optionaloptions: {
        privateKey?: string;
    }

    Options

    • OptionalprivateKey?: string

  Returns Promise<any[]>

verifyMessage

• verifyMessage(message, signature, publicKey): Promise<boolean>

• Verifies a message using the connected wallet

  Parameters

  • message: string

    The message to verify
  • signature: string

    The signature to verify
  • publicKey: string

  Returns Promise<boolean>

  A boolean indicating if the message was verified

Staticcreate

• create<T>(this, rpc_url?): Promise<T>

• Creates a new instance of this sdk

  Type Parameters

  • T extends DefaultChain

  Parameters

  • this: (new (rpc_url: string) => T)
    • • new (rpc_url): T

      • Parameters

        • rpc_url: string

        Returns T

  • rpc_url: string = ""

    The RPC URL

  Returns Promise<T>

  The sdk instance connected to the RPC provider

StaticsunToTrx

• sunToTrx(sun): string

• Convert SUN to TRX with full precision preservation

  Parameters

  • sun: bigint

    Amount in SUN as bigint

  Returns string

  Amount in TRX as a decimal string (e.g., "123.456789")

  Note

  This method returns a string to preserve precision for large values. For display purposes, you may want to parse this with a BigNumber library.

StatictrxToSun

• trxToSun(trx): bigint

• Convert TRX to SUN

  Parameters

  • trx: string | number

    Amount in TRX

  Returns bigint

  Amount in SUN as bigint