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

Commit

Permalink
add back README old
Browse files Browse the repository at this point in the history
  • Loading branch information
ChihChengLiang committed Jul 5, 2024
1 parent c45395e commit 0e7e274
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README-old.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 0e7e274

Please sign in to comment.