pandoras-box

Overview

pandoras-box is a command-line interface (CLI) tool for running stress tests on Ethereum-compatible blockchain networks, such as Ethereum, Polygon, Hyperledger, and others. It is designed to be an essential tool for Ethereum client developers looking to test the performance of their blockchain under high load.

Key features

• 🚀 Batch transactions to make stress testing easier to orchestrate
• 🛠 Multiple stress testing modes: EOA, ERC20, and ERC721
• 💰 Distributed transaction stress testing through subaccounts
• 💸 Automatic subaccount fund top-up
• 📊 Detailed statistics calculation
• 📈 Output cycle run results to a file

Usage example

To run a stress test with pandoras-box, you will need to have Node.js and npm / yarn installed on your system.

1. Install pandoras-box using npm / yarn:

npm install -g pandoras-box

2. Run the stress test by specifying the options for the test:

pandoras-box -url http://127.0.0.1:10002 -m "erupt oven loud noise rug proof sunset gas table era dizzy vault" -t 100 -b 5000 -o ./myOutput.json

This will run a stress test on the Ethereum-compatible blockchain network with a JSON-RPC endpoint at http://127.0.0.1:10002, using the mnemonic erupt oven loud noise rug proof sunset gas table era dizzy vault to generate the subaccounts. The test will send out 100 transactions in maximum batches of 5000, and the results will be output to a file called myOutput.json.

For any stress test run, there need to be funds on a specific address. The address that is in charge of funds distribution to subaccounts is the first address with index 0 in the specified mnemonic. Make sure this address has an appropriate amount of funds before running the stress test.

pandoras-box supports the following options:

Usage: pandoras-box [options]

A small and simple stress testing tool for Ethereum-compatible blockchain clients

Options:
  -V, --version                        output the version number
  -url, --json-rpc <json-rpc-address>  The URL of the JSON-RPC for the client
  -m, --mnemonic <mnemonic>            The mnemonic used to generate spam accounts
  -s, -sub-accounts <sub-accounts>     The number of sub-accounts that will send out transactions (default: "10")
  -t, --transactions <transactions>    The total number of transactions to be emitted (default: "2000")
  --mode <mode>                        The mode for the stress test. Possible modes: [EOA, ERC20, ERC721] (default: "EOA")
  -o, --output <output-path>           The output path for the results JSON
  -b, --batch <batch>                  The batch size of JSON-RPC transactions (default: "20")
  -h, --help                           display help for command

Installing locally

pandoras-box can be installed locally using the git repository. A recent version of Node.js and yarn is required.

1. Clone the git repository

git clone https://github.com/madz-lab/pandoras-box.git

2. Build the source (from the repository root)

yarn build

The yarn build command will compile the TypeScript files locally into the bin folder, and run a chmod command for enabling execution.

3. Link the command (from the repository root)

yarn link

The yarn link command will link the index.js file to the pandoras-box command, so it can be executed from anywhere. Local code can now be modified, and built again - changes made will be reflected on future command runs.

Modes

EOA

The EOA mode is pretty straightforward - it is a simple value transfer mode between regular Ethereum accounts. This mode sends out transactions with a certain value transfer between subaccounts.

ERC20

The ERC20 mode deploys an ERC20 token to the blockchain network being tested before starting the cycle run. When the cycle run begins, the transactions that are sent out are ERC20 token transfers between subaccounts.

ERC721

The ERC721 mode deploys an ERC721 NFT contract to the blockchain network being tested before starting the cycle run. When the cycle run begins, the transactions that are sent out are ERC721 NFT mints.