tron-grpc

What is TronGRPC?

TronGRPC is a powerful GRPC client implementation for the TRON blockchain, developed by TronSave and SaveWallet. It provides a streamlined interface for interacting with TRON's GRPC services, making it easier to build and integrate TRON-based applications.

The library offers a unified, seamless development experience for interacting with the TRON blockchain through GRPC. Built with TypeScript, it provides type-safe interactions and modern development features while maintaining high performance and reliability.

Project scope

TronGRPC aims to provide comprehensive coverage of TRON's GRPC services while maintaining a clean, developer-friendly API. The project focuses on delivering:

• Full TRON GRPC protocol support
• Type-safe interactions
• Simplified integration for Node.js applications
• High performance and reliability
• Comprehensive documentation and examples

Any questions or feedback are welcome here.

HomePage

TronSave

SaveWallet

TronTools

Compatibility

• Version built for Node.js v20 and above

Recent History

For recent history, see the CHANGELOG. You can check it out for:

• New features
• Dependencies update
• Bug fix

Installation

Node.js

npm install --save tron-grpc google-protobuf tslib

or

yarn add tron-grpc google-protobuf tslib

Creating an Instance

Default Tron GRPC Client using mainnet Trongrid: grpc.trongrid.io:50051

import { TronGrpcClient } from 'tron-grpc';
const tronclient = new TronGrpcClient()
const account = await tronclient.getAccount('TRxxxxxxxxxxx');

If you using Nile testnet

const tronclient = new TronGrpcClient('grpc.nile.trongrid.io:50051')

GRPC Supported Methods

Account Methods

• [x] getAccount - Get account information
• [x] getAccountBalance - Get account balance at a specific block
• [x] getAccountNet - Get account bandwidth information
• [x] getAccountResource - Get account resource information
• [x] createAccount - Create a new account
• [x] updateAccount - Update account name
• [x] accountPermissionUpdate - Update account permissions
• [ ] getAccountById - Get account by ID

Transaction Methods

• [x] createTransaction - Create a TRX transfer transaction
• [x] getTransaction - Get transaction by ID
• [x] getTransactionInfo - Get transaction info by ID
• [x] getTransactionById - Get transaction details by ID
• [x] getTransactionInfoByBlockNum - Get all transaction info in a block
• [x] getTransactionCountByBlockNum - Get transaction count in a block
• [x] broadcastTransaction - Broadcast signed transaction
• [x] getTransactionSignWeight - Get transaction sign weight
• [x] getTransactionApprovedList - Get transaction approved list
• [ ] getTransactionFromPending - Get transaction from pending pool
• [ ] getTransactionListFromPending - Get all transactions from pending pool

Block Methods

• [x] getNowBlock - Get current block
• [x] getBlockByNum - Get block by number
• [x] getBlockById - Get block by ID
• [x] getBlockByLimitNext - Get blocks between start and end
• [x] getBlockByLatestNum - Get latest N blocks
• [x] getBlock - Get block by number with details option
• [x] getBlockBalanceTrace - Get block balance changes

Smart Contract Methods

• [x] getContract - Get contract code
• [x] getContractInfo - Get contract information
• [x] triggerContract - Trigger smart contract
• [x] triggerConstantContract - Trigger constant contract (view/pure)
• [x] estimateEnergy - Estimate energy cost for contract call
• [x] updateSetting - Update contract consume_user_resource_percent
• [x] updateEnergyLimit - Update contract origin_energy_limit
• [x] clearContractABI - Clear contract ABI
• [x] deployContract - Deploy new smart contract

Resource Methods

• [x] freezeBalanceV2 - Freeze TRX for resources (V2)
• [x] unfreezeBalance - Unfreeze TRX (legacy)
• [x] unfreezeBalanceV2 - Unfreeze TRX (V2)
• [x] withdrawExpireUnfreeze - Withdraw expired unfrozen TRX
• [x] getDelegatedResourceV2 - Get resource delegation info
• [x] delegateResource - Delegate resources to another account
• [x] unDelegateResource - Undelegate resources
• [x] cancelAllUnfreezeV2 - Cancel all unfreezing transactions
• [ ] getResourceUsage - Get account resource usage details
• [x] getDelegatedResourceAccountIndex - Get delegated resource index
• [x] getDelegatedResourceAccountIndexV2 - Get delegated resource index V2

Asset Methods

• [x] transferAsset - Transfer TRC10 tokens
• [x] updateAsset - Update TRC10 token parameters
• [x] getAssetIssueByAccount - Get account's TRC10 tokens
• [ ] createAssetIssue - Create new TRC10 token
• [ ] participateAssetIssue - Participate in TRC10 token sale
• [ ] getAssetIssueByName - Get TRC10 token by name
• [ ] getAssetIssueListByName - Get TRC10 tokens by name
• [ ] getAssetIssueById - Get TRC10 token by ID
• [ ] getAssetIssueList - Get all TRC10 tokens
• [ ] getPaginatedAssetIssueList - Get paginated TRC10 tokens

Witness (Super Representative) Methods

• [x] createWitness - Apply for Super Representative
• [x] updateWitness - Update SR URL
• [x] voteWitness - Vote for SR
• [x] getListWitnesses - Get all SR list
• [x] updateBrokerage - Update SR brokerage
• [x] getBrokerageInfo - Get SR brokerage info
• [x] getRewardInfo - Get SR rewards
• [ ] withdrawBalance - Withdraw SR rewards

Network Methods

• [x] listNodes - List all nodes
• [x] getNodeInfo - Get node information
• [x] getBandwidthPrices - Get bandwidth prices
• [x] getEnergyPrices - Get energy prices
• [x] getMemoFee - Get memo fee
• [x] getBurnTrx - Get burned TRX amount
• [x] getChainParameters - Get chain parameters
• [x] totalTransaction - Get total transaction count
• [x] getNextMaintenanceTime - Get next maintenance time
• [ ] getConnectedNodes - Get connected node list
• [ ] getBlockProduction - Get block production stats
• [ ] getNodeMetrics - Get node performance metrics
• [ ] getNetworkResources - Get network resource status

Proposal Methods

• [x] getProposalList - Get all proposals
• [x] getPaginatedProposalList - Get paginated proposals
• [x] getProposalById - Get proposal by ID
• [ ] createProposal - Create new network proposal
• [ ] approveProposal - Approve network proposal
• [ ] deleteProposal - Delete network proposal

Resource Query Methods

• [x] getCanDelegatedMaxSize - Get max delegatable size
• [x] getAvailableUnfreezeCount - Get available unfreeze count
• [x] getCanWithdrawUnfreezeAmount - Get withdrawable unfreeze amount

Market Methods

• [ ] getMarketOrderById - Get market order by ID
• [ ] getMarketOrderByAccount - Get market orders by account
• [ ] getMarketPriceByPair - Get market price by pair
• [ ] getMarketOrderListByPair - Get market orders by pair
• [ ] getMarketPairList - Get all market pairs

Exchange Methods

• [ ] getExchangeById - Get exchange by ID
• [ ] getExchangeByAccount - Get exchanges by account
• [ ] getExchangeList - Get all exchanges
• [ ] getPaginatedExchangeList - Get paginated exchanges
• [ ] createExchange - Create new exchange
• [ ] injectExchange - Inject capital into exchange
• [ ] withdrawExchange - Withdraw capital from exchange
• [ ] tradeExchange - Trade on exchange

Testnet

Nile is the official Tron testnet. To use it use the following endpoint:

grpc.nile.trongrid.io:50051

Get some Nile TRX at faucet and play with it. Anything you do should be explorer on nile.tronscan.org

Your local private network for heavy testing

You can set up your own private network, running Tron Quickstart. To do it you must install Docker and, when ready, run a command like

docker run -it --rm \
  -p 50051:50051 \
  -e "defaultBalance=100000" \
  -e "showQueryString=true" \
  -e "showBody=true" \
  -e "formatJson=true" \
  --name tron \
  trontools/quickstart

More details about Tron Quickstart on GitHub

FAQ

Contact

mail: [e-mail]