Test contracts

Framework

TronBox comes standard with an automated testing framework to make testing your contracts a breeze. This framework lets you write simple and manageable tests in JavaScript, for exercising your contracts from the outside world, just like your application.

Location

All test files should be located in the ./test directory. TronBox will only run test files with the .js file extensions. All other files are ignored.

Command

To run all tests, simply run:

Terminal

tronbox test

Alternatively, you can specify a path to a specific file you want to run, e.g.,

Terminal

tronbox test ./path/to/test/file.js

Using TRE

To test our contracts more easily, we need to connect to a blockchain network. After v3.0.0 came out, TronBox provides a TronBox Runtime Environment (TRE) private chain that can be used for testing. Please note that this blockchain is in our local system and does not connect to the TRON main network.

You can start and interact with the blockchain by using the TronBox Runtime Environment (TRE), which is designed to build a complete private chain for development on TRON.

Steps are as follows:

1. Pull images from the Docker:

Terminal

docker pull tronbox/tre

2. Start the TronBox Runtime Environment (TRE) and run the following commands:

Terminal

docker run -it -p 9090:9090 --rm --name tron tronbox/tre

Startup output includes the following (private keys and the mnemonic are omitted):

Terminal

----------------------------------

TronBox Runtime Environment v2.0.0

----------------------------------
06:48:14 INFO  Available Accounts
==================

(0) TWtvhFs3cpvzmgWmX9Qwi1g6jmL4uH65RA (10000 TRX)
(1) TQTatyThj2jHMroMcaanSUb4o8t23WiCCU (10000 TRX)
(2) TDFqvxvk3MrwGZuyeofhbmRUiMJrBkjybo (10000 TRX)
(3) TJe4jF5XunL8TZwp1fXZ5zEGnWzSFrT7us (10000 TRX)
(4) TFoguFPAeFCBVrnyQN2FqQruSsYYxCpBGh (10000 TRX)
(5) TZ1PmukAMr4ekPSnRDS9qc23gKkiLQsKR8 (10000 TRX)
(6) TTsFfxDKNRuY16y78WTuDj8wV7r84cebsS (10000 TRX)
(7) TMZZekv1R8c6tQuGdQxJYKcTrC3zrTga3w (10000 TRX)
(8) TPdt3WfK3Lt3my79XWqKbYQdc5gyPrjXP9 (10000 TRX)
(9) TQxA1qEcmopaU7kuJk6DtF5pJjyKZZGNPc (10000 TRX)

Private Keys
==================

(0) ...PRIVATE_KEY_HERE...
(1) ...PRIVATE_KEY_HERE...
(2) ...PRIVATE_KEY_HERE...
(3) ...PRIVATE_KEY_HERE...
(4) ...PRIVATE_KEY_HERE...
(5) ...PRIVATE_KEY_HERE...
(6) ...PRIVATE_KEY_HERE...
(7) ...PRIVATE_KEY_HERE...
(8) ...PRIVATE_KEY_HERE...
(9) ...PRIVATE_KEY_HERE...

HD Wallet
==================
Mnemonic:      ... MNEMONIC_HERE ...
Base HD Path:  m/44'/60'/0'/0/{account_index}

Here we see ten accounts (and their private keys) that can be used to interact with the blockchain.

Keep this terminal running. Wait until TRE prints Available Accounts and finishes funding the test accounts.

3. Open another terminal, change to your project directory, and deploy:

Terminal

tronbox migrate

We will see the following output:

Terminal

Using network 'development'.

Running migration: 1_initial_migration.js
  Deploying Migrations...
  Migrations:
    (base58) TVbadXqMTap8D2rNjyf353Rc2jD82kWKac
    (hex) 41d74b6b5c04a4a8ec9dd60127d354540d40270889
Saving successful migration to network...
Saving artifacts...
Running migration: 2_deploy_contracts.js
  Deploying ConvertLib...
  ConvertLib:
    (base58) TGcA7gVte4sw45FVXg7tkA7Y4MVYKWvgT5
    (hex) 4148cdbc805388241d397bc9e3da63cc1371e21b30
  Linking ConvertLib to MetaCoin
  Deploying MetaCoin...
  MetaCoin:
    (base58) TLQnf4xrHjn2t983AutNZKzJwisJEyM18k
    (hex) 417287c03e5db15b58b8d3c111302815b6d10c0235
Saving successful migration to network...
Saving artifacts...

Here shows the network, addresses of your deployed contracts, and transactions statuses.

After starting TronBox Runtime Environment (TRE), you can use the following advanced features in unit testing.

TIP

NOTE: You can use tronWrap in unit testing.

• tre_setAccountBalance: To set account balance.

JavaScript

const address = 'TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL';
const balance = '0x3e8';
const result = await tronWrap.send('tre_setAccountBalance', [address, balance]);
console.log(result);

• tre_setAccountCode: To set account code (It's recommended to set it as runtime bytecode, because setting it to the creation code of the contract will cause an exception in executing the contract).

JavaScript

const address = 'TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL';
const data = '0xbaddad42';
const result = await tronWrap.send('tre_setAccountCode', [address, data]);
console.log(result);

• tre_setAccountStorageAt: To set account storage.

JavaScript

const address = 'TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL';
const slot = '0x0000000000000000000000000000000000000000000000000000000000000005';
const data = '0xbaddad42';
const result = await tronWrap.send('tre_setAccountStorageAt', [address, slot, data]);
console.log(result);

• tre_mine: Immediately mine the specified number of blocks, and the blocks parameter specifies the additionally mined blocks. The parameter range is (0, 100] (if the parameter is not given, the default is 1).

JavaScript

const result = await tronWrap.send('tre_mine', [{ blocks: 5 }]);
console.log(result);

• tre_unlockedAccounts: Unlock accounts. Transactions sent from unlocked accounts do not require private key signatures.

JavaScript

const result = await tronWrap.send('tre_unlockedAccounts', [['TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL']]);
console.log(result);

• tre_blockTime: To set the auto-mining time. If the parameter is 0, auto-mining is stoped, and a block will mine after receiving a transaction.

JavaScript

const result = await tronWrap.send('tre_blockTime', [3]);
console.log(result);

• debug_traceTransaction: Returns all traces of a given transaction.

JavaScript

const txid = 'f6b72dda65682b858c1c1980710aad7955fbf6db91c66840da0f852fc3cc694b';
const result = await tronWrap.send('debug_traceTransaction', [txid]);
console.log(result);

• debug_storageRangeAt: Returns the contract storage for the specified range.

JavaScript

const result = await tronWrap.send('debug_storageRangeAt', [0, 0, contractAddress, '0x01', 1]);
console.log(result);