README.md

Documentation Map

Fast Path

• To understand the full benchmark flow, read Benchmark Execution.
• To understand exactly what JSON ere-hosts accepts, read Benchmark Execution Inputs.
• To understand exactly what files and JSON ere-hosts writes, read Benchmark Execution Output.
• To understand how legacy generated fixtures are produced, read Fixture Generation.

Guides

• Fixture Generation: when to use witness-generator-cli, direct EEST fixtures, RPC fixtures, and raw-input fixtures.
• Benchmark Execution: common ere-hosts commands, action model, proof verification, and operational notes.
• Benchmark Execution Inputs: input discovery, fixture filtering, legacy generated fixture schema, and direct EEST blockchain_tests schema.
• Benchmark Execution Output: metrics directory layout, BenchmarkRun JSON, hardware metadata, proof handling, and input dumps.
• Witness Generator CLI: Docker usage and binary-local notes for witness-generator-cli.

The zkevm-metrics crate API documentation lives in crates/metrics/README.md. The CLI metrics files written by ere-hosts are documented in Benchmark Execution Output.