Introduction

release note

Introduction

TronWeb aims to deliver a unified, seamless development experience for TRON developers. 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.

Getting Started

Live code editor

TronWeb doc provides a live code editor for developers to write and execute TRON smart contract code. You can write your code in the editor and see the results in real time. You can also see the logs of the contract deployment and function calls.

import { TronWeb } from 'tronweb';
const tronWeb = new TronWeb({
  fullHost: 'https://api.nileex.io',
});
(async () => {
  console.log(await tronWeb.trx.getCurrentBlock());
})()

Output:

Installation

Node.js

npm install tronweb

or

yarn add tronweb

Browser

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.js

so that you can call it in your HTML page as

<script src="./js/tronweb.js"></script>

Note: TronWeb depends on Buffer and crypto. So please polyfill them manually.

Instantiation

Then, in your JavaScript file, define TronWeb:

const { TronWeb } = require('tronweb');

Note: Starting from version 6.0.0, TronWeb supports both CommonJS and ES Modules (ESM) to ensure compatibility with different JavaScript environments. Use const { TronWeb } = require('tronweb') to load the CommonJS version. Use import { TronWeb } from 'tronweb' to load the ESM version. This allows seamless integration whether you're working in a traditional Node.js project or using modern build tools like Vite, Webpack, or Rollup.

When you instantiate TronWeb you can set

• fullHost

Supposing you are using a server that 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'
});

Like infura API Key, you can sign up for TronGrid and create your API key on the dashboard to access TRON Network data.

Note

• Do not expose your private key in any web browser environment.
• You can instantiate TronWeb without privateKey, if you only need to use some utils functions such as TronWeb.utils
• If you only want to query information from the TRON Network blockchain without signing a transaction, you have two options:
  • Pass a placeholder private key (e.g. 01) when instantiating TronWeb. This is a convenient way to avoid passing an address manually in each API call.
  • Instantiate TronWeb without any private key. In this case, you need to pass the required address explicitly in the corresponding method parameters when calling on-chain APIs such as triggerConstantContract, getTransactionInfo.

Compatibility

• Version built for Node.js v14 and above
• Version built for browsers with more than 0.25% market share

TronWeb is also compatible with frontend frameworks such as:

• Angular
• React
• Vue

You can also ship TronWeb in a Chrome extension such as TronLink extension

Interact with TRON wallets

To make it easier for DApp developers to connect with TRON wallets, the community provides a set of wallet adapters compatible with the TRON ecosystem. These adapters currently support TronLink Extension (Chrome and Firefox), TronLink APP (Android/iOS), Ledger, Walletconnnect and etc.

These adapters offer a unified API for interacting with different TRON-compatible wallets, enabling seamless integration across both desktop and mobile environments.

The wallet adapters are maintained by the community under the tronweb3/tronwallet-adapter project on GitHub.