The repo contains boiler-plate code for benchmarking a chain. Provided an RPC URL to a chain that supports EVM and a TASK for which to evaluate the chain on. The module generates wallets and executes the provided tasks from all wallets concurrently and waits until all jobs are finished. After benchmarking the wallets generated during the process are saved in wallets.json and are re-used on next run.

Before running the benchmark script, kindly update benchmark.ts with appropriate:

• PROVIDER RPC URL: The url of the block chain's rpc on which you wish to deploy.
• FAUCET PVT KEY: The faucet responsible for providing any funds for gas or transactions to wallets.
• TASK: A function which will be invoked asynchronously with different wallets to benchmark the network. Kindly specify one or more contract calls that you wish to benchmark the network on.
• PRE_TASK: This function executes before the TASK and can be used to transfer any funds from faucet to any wallet or do something else.
• POST_TASK: The function executes after the benchmarking task and can be used to see status or state of contracts/users.

# to install dependencies
yarn 

# to start benchmarking script:
yarn start -t <num_transactions> -f <funding_amount> -b <benchmark_filepath>
e.g: yarn start -t 10 -f 0.001 -b .\benchmark_det_transfer.ts

It accepts following params:
Options:
      --help           Show help                                       [boolean]
      --version        Show version number                             [boolean]
  -b, --benchmarkFile  path of the benchmark file                     [required]
  -t, --transactions   number of transactions to execute
  -f, --fundingAmount  funding amount to be sent to users

• Refractor the code base and make proper classes/interfaces/types and push it to npm.