Skip to content
This repository was archived by the owner on Jul 5, 2024. It is now read-only.

Commit 0e7e274

Browse files
add back README old
1 parent c45395e commit 0e7e274

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README-old.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Circuits for zkEVM
2+
3+
[![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)
4+
5+
Check out the work in progress [specification](https://github.com/privacy-scaling-explorations/zkevm-specs) to learn how it works.
6+
7+
8+
## Getting started
9+
10+
To run the same tests as the CI, please use: `make test-all`.
11+
12+
## Running benchmarks
13+
14+
There are currently several benchmarks to run in the workspace in regards to the circuits.
15+
All use the `DEGREE` env var to specify the degree of the `K` parameter that you want
16+
to use for your circuit in the bench process.
17+
- Keccak Circuit prover benches. -> `DEGREE=16 make packed_multi_keccak_bench`
18+
- EVM Circuit prover benches. -> `DEGREE=18 make evm_bench`.
19+
- State Circuit prover benches. -> `DEGREE=18 make state_bench`
20+
- MPT Circuit prover benches. -> `DEGREE=15 make mpt_bench`
21+
22+
You can also run all benchmarks by running: `make circuit_benches DEGREE=18`.
23+
24+
## GH Actions Benchmark Results
25+
26+
Circuit Benchmark Results are accessible here: https://grafana.zkevm-testnet.org/d/vofy8DAVz/circuit-benchmarks?orgId=1
27+
28+
- circuit_benchmarks panel displays:
29+
- overall test result
30+
- timers and system statistics
31+
- url for downloading prover log and sys stat files
32+
- clickable sysstats_url element that loads the memory and cpu utilization profiles for the given test

0 commit comments

Comments
 (0)