tronprotocol
What is TronWeb?
TronWeb aims to deliver a unified, seamless development experience influenced by Ethereum's Web3 implementation. We have taken the core ideas and expanded upon them to unlock the functionality of TRON's unique feature set along with offering new tools for integrating DApps in the browser, Node.js and IoT devices.
To better support its use in TypeScript projects, we have rewritten the entire library in TypeScript. And to make the TronWeb API more secure and consistent, there are some breaking changes. Please check out 6.x API documentation for detailed changes so you can start using the new TypeScript version of TronWeb early. Any questions or feedback are welcome here.
Project scope
Any new TRON feature will be incorporated into TronWeb. Changes to the API to improve quality-of-life are in-scope for the project. We will not necessarily maintain feature parity with Web3.js going forward as this is a separate project, not a synchronized fork.
HomePage
Compatibility
- Version built for Node.js v14 and above
- Version built for browsers with more than 0.25% market share
You can access either version specifically from the dist folder.
TronWeb is also compatible with frontend frameworks such as:
- Angular
- React
- Vue.
You can also ship TronWeb in a Chrome extension.
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 tronwebor
yarn add tronwebBrowser
The easiest way to use TronWeb in a browser is to install it as above and copy the dist file to your working folder. For example:
cp node_modules/tronweb/dist/TronWeb.js ./js/tronweb.jsso that you can call it in your HTML page as
<script src="./js/tronweb.js"><script>This project is also published on NPM and you can access CDN mirrors of this release (please use sub-resource integrity for any <script> includes).
Testnet
Shasta is the official Tron testnet. To use it use the following endpoint:
https://api.shasta.trongrid.ioGet some Shasta TRX at https://www.trongrid.io/shasta and play with it. Anything you do should be explorable on https://shasta.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 9090:9090 \
-e "defaultBalance=100000" \
-e "showQueryString=true" \
-e "showBody=true" \
-e "formatJson=true" \
--name tron \
trontools/quickstartMore details about Tron Quickstart on GitHub
Creating an Instance
First of all, in your typescript file, define TronWeb:
import { TronWeb, utils as TronWebUtils, Trx, TransactionBuilder, Contract, Event, Plugin } from 'tronweb';Please note that this is not the same as v5.x. If you want to dive into more differences, check out migration guide
When you instantiate TronWeb you can define
- fullNode
- solidityNode
- eventServer
- privateKey
you can also set a
- fullHost
which works as a jolly. If you do so, though, the more precise specification has priority. Supposing you are using a server which provides everything, like TronGrid, you can instantiate TronWeb as:
const tronWeb = new TronWeb({
fullHost: 'https://api.trongrid.io',
headers: { "TRON-PRO-API-KEY": 'your api key' },
privateKey: 'your private key'
})For retro-compatibility, though, you can continue to use the old approach, where any parameter is passed separately:
const tronWeb = new TronWeb(fullNode, solidityNode, eventServer, privateKey)
tronWeb.setHeader({ "TRON-PRO-API-KEY": 'your api key' });If you are, for example, using a server as full and solidity node, and another server for the events, you can set it as:
const tronWeb = new TronWeb({
fullHost: 'https://api.trongrid.io',
eventServer: 'https://api.someotherevent.io',
privateKey: 'your private key'
}
)If you are using different servers for anything, you can do
const tronWeb = new TronWeb({
fullNode: 'https://some-node.tld',
solidityNode: 'https://some-other-node.tld',
eventServer: 'https://some-event-server.tld',
privateKey: 'your private key'
}
)FAQ
- Cannot destructure property 'Transaction' of 'globalThis.TronWebProto' as it is undefined.
This is a problem caused by webpack as it doesn't load cjs file correctly. To solve this problem, you need to add a new rule like below:
{
test: /\.cjs$/,
type: 'javascript/auto'
}For more questions, please refer to TronWeb Doc.
Integrity Check
The package files will be signed using a GPG key pair, and the correctness of the signature will be verified using the following public key:
pub: 4371 AB85 E5A5 8FAA 88AD 7FDF 9945 DBCA 8C4B B810
uid: dev@tronweb.networkContributions
In order to contribute you can
- fork this repo and clone it locally
- install the dependencies —
npm i - do your changes to the code
- build the TronWeb dist files —
npm run build:all - run a local private network using Tron Quickstart
- run the tests —
npm run test - push your changes and open a pull request
Contact the team at https://cn.developers.tron.network/docs/online-technical-support
Licence
TronWeb is distributed under a MIT licence.