What is tronweblibrary?

Tron Web - Developer Document

tronweblibrary aims to deliver a unified, seamless development experience influenced by Ethereum's Web3 implementation. We have taken the core ideas and expanded upon it 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.

Compatibility

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

You can access either version specifically from the dist folder.

tronweblibrary is also compatible with frontend frameworks such as:

• Angular
• React
• Vue.

You can also ship tronweblibrary in a Chrome extension.

Installation

Node.js

npm install tronweblibrary

or

yarn add tronweblibrary

Browser

First, don't use the release section of this repo, it has not updated in a long time.

Then easiest way to use tronweblibrary in a browser is to install it as above and copy the dist file to your working folder. For example:

cp node_modules/tronweblibrary/dist/tronweblibrary.js ./js/tronweblibrary.js

so that you can call it in your HTML page as

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

Testnet

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

https://api.shasta.trongrid.io

Get 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/quickstart

More details about Tron Quickstart on GitHub

Creating an Instance

First off, in your javascript file, define tronweblibrary:

const tronweblibrary = require('tronweblibrary')

The easiest way to instantiate tronweblibrary is to run

const tronweblibrary = new tronweblibrary({
    fullHost: 'https://api.trongrid.io',
    privateKey: '...'
})

but you can continue to use the old way:

const tronweblibrary = new tronweblibrary(fullNode, solidityNode, eventServer, privateKey)

Valid alternatives are:

const tronweblibrary = new tronweblibrary({
    fullHost: 'https://api.trongrid.io',
    eventServer: 'https://api.someotherevent.io'
  },
  privateKey: '...'
)

where fullHost defines fullNode and solidityNode while the eventServer is specified, and the privateKey is passed separately.

const tronweblibrary = new tronweblibrary({
    fullNode: 'https://api.trongrid.io',
    solidityNode: 'https://api/somesolidity.io'
    eventServer: 'https://api.somevent.io',
    privateKey: '...'
  }
)

similar to the old approach

A full example

The better way to understand how to work with Tron is to clone the MetaCoin example and follow the instructions at https://github.com/Tronbox-boxes/metacoin-box

Contributions

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 tronweblibrary dist files — npm run build
• run a local private network using Tron Quickstart
• run the tests — npm test:node
• push your changes and open a pull request

Recent History

2.3.1

• Adds support for not-tld domain, like http://localhost
• Improve the new format, allow passing the privateKey as a property in the option object

2.3.0

• Introduces new format to instantiate tronweblibrary, passing an options object instead that fullNode, solidityNode and eventServer as separate params
• Fixes bug in _watch which causes an ethernal update of the since parameter

Licence

tronweblibrary is distributed under a MIT licence.