https://github.com/privacy-scaling-explorations/halo2
https://github.com/privacy-scaling-explorations/halo2
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/privacy-scaling-explorations/halo2
- Owner: privacy-scaling-explorations
- License: other
- Fork: true (zcash/halo2)
- Created: 2021-10-15T10:57:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-16T08:49:21.000Z (about 1 year ago)
- Last Synced: 2024-04-17T19:19:03.320Z (about 1 year ago)
- Language: Rust
- Homepage: https://privacy-scaling-explorations.github.io/halo2/
- Size: 30.6 MB
- Stars: 177
- Watchers: 10
- Forks: 110
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: COPYING.md
Awesome Lists containing this project
- awesome-zkevm - Halo2 for PSE and Scroll
- awesome-halo2 - PSE's halo2 version with KZG instead IPA
- awesome-ethereum-rust - halo2
- awesome-zkevm - Halo2在PSE和Scroll中的应用
- awesome-zkevm - Halo2在PSE和Scroll中的应用
README
# halo2 [](https://codecov.io/github/privacy-scaling-explorations/halo2)
## [Documentation](https://privacy-scaling-explorations.github.io/halo2/halo2_proofs)
PSE-Halo2 is [halo2](https://github.com/zcash/halo2) fork by
[PSE](https://pse.dev) and includes contributions from the community.
PSE-Halo2 modified, extended, and eventually [re-architected](https://github.com/privacy-scaling-explorations/halo2/pull/254) the [original Halo2 implementation by Zcash](https://github.com/zcash/halo2) - an instantiation of the PLONK proof system.
The original IPA backend was swapped with KZG for cost-effective Ethereum L1 verifiability, and comes with a Solidity verifier. Support for many [additional curves](https://github.com/privacy-scaling-explorations/halo2curves) and other [experimental features](https://github.com/kilic/tetris) were added, and the system was eventually re-architected by [splitting the front- and backends](https://github.com/privacy-scaling-explorations/halo2/pull/254).
PSE-Halo2 is in maintenance mode starting January 2025, which means:
- Bugs reported will be fixed
- PRs with non-trivial but **narrow-scope** additions or fixes will be reviewed
- Feature-add PRs or wide-scope changes to the architecture **will not be reviewed**. To extend PSE-Halo2 with significant features we recommend [Axiom's fork](https://github.com/axiom-crypto/halo2) instead.
We use the `main` branch for development, which means it may contain
unstable/unfinished features. For end-users we recommend using the tag releases
which can be seen as curated checkpoints with some level of guarantee of
stability.
For experimental features `privacy-scaling-explorations/halo2` fork adds, please refer to [`experimental-features.md`](./book/src/user/experimental-features.md).
## Minimum Supported Rust Version
Requires Rust **1.65.0** or higher.
Minimum supported Rust version can be changed in the future, but it will be done with a
minor version bump.
## Controlling parallelism
`halo2` currently uses [rayon](https://github.com/rayon-rs/rayon) for parallel computation. The `RAYON_NUM_THREADS` environment variable can be used to set the number of threads.
When compiling to WASM-targets, notice that since version `1.7`, `rayon` will fallback automatically (with no need to handle features) to require `getrandom` in order to be able to work. For more info related to WASM-compilation.
See: [Rayon: Usage with WebAssembly](https://github.com/rayon-rs/rayon#usage-with-webassembly) for more
## License
Licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.