cmd/workload: add README

This commit is contained in:
Felix Lange 2025-02-26 15:22:10 +01:00
parent ae024ba2a8
commit 9422f025ee

26
cmd/workload/README.md Normal file
View file

@ -0,0 +1,26 @@
## Workload Testing Tool
This tool performs RPC calls against a live node. It has tests for the Sepolia testnet and
Mainnet.
To run the tests against a Sepolia node, use:
```shell
> ./workload test --sepolia http://host:8545
```
To run a specific test, use the `--run` flag to filter the test cases. Filtering works
similar to the `go test` command. For example, to run only tests for `eth_getBlockByHash`
and `eth_getBlockByNumber`, use this command:
```
> ./workload test --sepolia --run History/getBlockBy http://host:8545
```
### Regenerating tests
There are also commands for generating tests. To create filter tests, run:
```shell
> ./workload filtergen http://host:8545
```