Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a user guide in the README #57

Merged
merged 4 commits into from
Dec 12, 2023
Merged

Add a user guide in the README #57

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4333fbe
first draft
ChihChengLiang Dec 8, 2023
c9cb89c
GPT editing
ChihChengLiang Dec 8, 2023
d2cf143
Update README.md
ChihChengLiang Dec 12, 2023
ab8b79d
highlight proof aggregation
ChihChengLiang Dec 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# SNARK Verifier

Generic (S)NARK verifier.

## User Guide

This project is tailored for verifying [Halo2](https://github.com/privacy-scaling-explorations/halo2)-generated proofs on Ethereum.

Additionally, within this repository, there is an example provided for verifying an aggregated proof, which serves as proof for multiple other proofs. You can test it by executing `cargo run --example evm-verifier-with-accumulator`.

As this effort is continuously evolving, there are multiple repository variants to choose from. For optimal results:

- For production use, it is recommended to use [axiom’s fork](https://github.com/axiom-crypto/snark-verifier), which has been audited.
- In the future, consider using [halo2-solidity-verifier](https://github.com/privacy-scaling-explorations/halo2-solidity-verifier). However, please note the following:
ChihChengLiang marked this conversation as resolved.
Show resolved Hide resolved
- The plan is to phase out snark-verifier and shift focus to halo2-solidity-verifier
- Keep in mind halo2-solidity-verifier is currently unaudited and has certain limitations, refer to the project README for details.
- snark-verifier may encounter issues generating Solidity code due to hitting the contract size limit with large circuits, a problem addressed by halo2-solidity-verifier.
Loading