From 0e7e274573e7e1f2051d6eb70d043448945219a7 Mon Sep 17 00:00:00 2001 From: ChihChengLiang Date: Fri, 5 Jul 2024 16:41:25 +0800 Subject: [PATCH] add back README old --- README-old.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README-old.md diff --git a/README-old.md b/README-old.md new file mode 100644 index 0000000000..0a3f9d0afe --- /dev/null +++ b/README-old.md @@ -0,0 +1,32 @@ +# Circuits for zkEVM + +[![CI checks](https://github.com/privacy-scaling-explorations/zkevm-circuits/actions/workflows/ci.yml/badge.svg)](https://github.com/privacy-scaling-explorations/zkevm-circuits/actions/workflows/ci.yml) + +Check out the work in progress [specification](https://github.com/privacy-scaling-explorations/zkevm-specs) to learn how it works. + + +## Getting started + +To run the same tests as the CI, please use: `make test-all`. + +## Running benchmarks + +There are currently several benchmarks to run in the workspace in regards to the circuits. +All use the `DEGREE` env var to specify the degree of the `K` parameter that you want +to use for your circuit in the bench process. +- Keccak Circuit prover benches. -> `DEGREE=16 make packed_multi_keccak_bench` +- EVM Circuit prover benches. -> `DEGREE=18 make evm_bench`. +- State Circuit prover benches. -> `DEGREE=18 make state_bench` +- MPT Circuit prover benches. -> `DEGREE=15 make mpt_bench` + +You can also run all benchmarks by running: `make circuit_benches DEGREE=18`. + +## GH Actions Benchmark Results + +Circuit Benchmark Results are accessible here: https://grafana.zkevm-testnet.org/d/vofy8DAVz/circuit-benchmarks?orgId=1 + +- circuit_benchmarks panel displays: + - overall test result + - timers and system statistics + - url for downloading prover log and sys stat files + - clickable sysstats_url element that loads the memory and cpu utilization profiles for the given test