flood is a load testing tool for benchmarking EVM nodes over RPC https://github.com/paradigmxyz/flood
  • Python 99.4%
  • Dockerfile 0.6%
Find a file
History 2023-06-07 13:17:22 +02:00
.github Update tests.yml 2023-06-06 14:10:09 -07:00
assets ci: add tests/lint & issue/pr templates (#11) 2023-06-06 10:04:40 -07:00
examples add example scripts in /examples 2023-06-06 14:21:17 -07:00
flood feat: add debug_traceTransaction test 2023-06-07 13:17:22 +02:00
tests skip node tests if env vars unset 2023-06-06 14:04:49 -07:00
.gitignore initial commit 2023-05-05 21:56:57 -07:00
CONTRIBUTING.md add LICENSE files and CONTRIBUTING.md 2023-06-04 13:22:48 -07:00
Dockerfile rename to flood 2023-06-01 17:40:40 +00:00
LICENSE-APACHE add LICENSE files and CONTRIBUTING.md 2023-06-04 13:22:48 -07:00
LICENSE-MIT add LICENSE files and CONTRIBUTING.md 2023-06-04 13:22:48 -07:00
pyproject.toml apply ruff linting 2023-06-06 13:44:44 -07:00
README.md docs: add tg 2023-06-06 10:16:53 -07:00

🌊🌊 flood 🌊🌊

flood is a load testing tool for benchmarking EVM nodes over RPC

CI status Telegram Chat

For each RPC method, flood measures how load affects metrics such as:

  1. throughput
  2. latency (mean, P50, P90, P95, P99, max)
  3. error rate

flood makes it easy to compare the performance of:

  • different node clients (e.g. geth vs erigon vs reth)
  • different hardware/software configurations (e.g. local vs cloud vs low memory vs RAID-0)
  • different RPC providers (e.g. Alchemy vs Quicknode vs Infura)

flood can generate tables, figures, and reports for easy sharing of results (example report here)

Installation

Prerequisites

Install vegeta:

  • on mac: brew update && brew install vegeta
  • on linux: go install github.com/tsenart/vegeta/v12@v12.8.4

After installation, make sure vegeta is on your $PATH. Running vegeta -h should output a path. If it does not, you probably have not set up go to install items to your $PATH. You may need to add something like export PATH=$PATH:~/go/bin/ to your terminal config file (e.g. ~/.profile).

flood also requires python >= 3.7

Installing flood

pip install paradigm-flood

Typing flood help in your terminal should show help output. If it does not, you probably have not set up pip to install items to your $PATH. You may need to add something like export PATH=$PATH:~/.local/bin to your terminal config file (e.g. ~/.profile). Alternatively, you can avoid setting up your $PATH and just type python3 -m flood instead of flood.

Usage

run test

flood eth_getBlockByNumber NODE1_NAME=NODE1_URL NODE2_NAME=NODE2_URL --rates 10 100 1000 --duration 30

orchestrate tests on remote nodes

flood eth_getBlockByNumber NODE1_NAME=NODE1_URL:localhost:8545 NODE2_NAME=NODE2_URL:localhost:8545

create report

flood report tests/test1_output tests/test2_output

Code Layout

  • flood/cli: command line interface
  • flood/generators: utilities for generating rpc calls with parameterized distributions
  • flood/tests: implementations of load tests and equality tests
  • flood/user_io: utiltiies for parsing user io

Contributing

Contributions are welcome in the form of issues, PR's, and commentary. Check out the contributor guide in CONTRIBUTING.md.