Go to file
Jack Grigg 87beee32f4 dev: Add CircuitCost tool with proof size measurement 2021-07-20 03:17:56 +01:00
.github Merge pull request #316 from zcash/zk-changes-again 2021-07-14 16:19:06 -06:00
benches Switch 5 to 3 in benchmark. 2021-07-13 09:15:30 -06:00
book Merge pull request #320 from daira/book-zk-changes 2021-07-12 20:35:20 +01:00
examples Fix examples broken by verifier API changes. 2021-07-14 09:47:53 -06:00
src dev: Add CircuitCost tool with proof size measurement 2021-07-20 03:17:56 +01:00
tests dev: Add CircuitCost tool with proof size measurement 2021-07-20 03:17:56 +01:00
.gitignore Add book/Makefile for local HTML generation. 2020-12-26 15:33:59 +00:00
CHANGELOG.md Initialize the changelog 2021-01-22 23:54:31 +00:00
COPYING Changing TGPPL references to BOSL 2021-04-16 08:33:10 -07:00
Cargo.toml Use global rayon threadpool. 2021-07-03 15:17:03 +01:00
Contributor_Agreement Correct numbering and add missing sections 2020-10-25 09:42:25 -07:00
LICENSE-BOSL Changing TGPPL references to BOSL 2021-04-16 08:33:10 -07:00
README.md Use global rayon threadpool. 2021-07-03 15:17:03 +01:00
katex-header.html Initial commit 2020-08-22 14:15:39 -06:00
rust-toolchain Bump MSRV to 1.51.0 2021-06-02 00:03:06 +01:00

README.md

halo2 Crates.io

IMPORTANT: This library is being actively developed and should not be used in production software.

Documentation

Minimum Supported Rust Version

Requires Rust 1.51 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 for parallel computation. The RAYON_NUM_THREADS environment variable can be used to set the number of threads.

License

Copyright 2020-2021 The Electric Coin Company.

You may use this package under the Bootstrap Open Source Licence, version 1.0, or at your option, any later version. See the file LICENSE-BOSL for the terms of the Bootstrap Open Source Licence, version 1.0.

The purpose of the BOSL is to allow commercial improvements to the package while ensuring that all improvements are open source. See here for why the BOSL exists.