Go to file
Sean Bowe a4d3c328b9
halo2_proofs: rename variables for consistency
This changes variable names in the multiopen and commitment opening implementations
and the book's protocol description to keep names and indicies consistent with one
another.

Co-Authored-By: Jack Grigg <jack@electriccoin.co>
2022-02-09 13:37:50 -07:00
.github CI: Pin nightly version in book workflow 2022-02-04 01:23:32 +00:00
book halo2_proofs: rename variables for consistency 2022-02-09 13:37:50 -07:00
halo2 Recreate `halo2` as an empty library crate 2022-01-20 18:50:43 +00:00
halo2_gadgets Fix typos 2022-02-03 18:01:22 +02:00
halo2_proofs halo2_proofs: rename variables for consistency 2022-02-09 13:37:50 -07:00
.gitignore Migrate to `halo2_gadgets` crate in subdir 2022-01-27 23:08:01 +00:00
COPYING Migrate to `halo2_gadgets` crate in subdir 2022-01-27 23:08:01 +00:00
Cargo.toml Integrate `halo2_gadgets` into the workspace 2022-01-27 23:32:04 +00:00
Contributor_Agreement Correct numbering and add missing sections 2020-10-25 09:42:25 -07:00
LICENSE-BOSL Migrate to `halo2_gadgets` crate in subdir 2022-01-27 23:08:01 +00:00
README.md Migrate to `halo2_gadgets` crate in subdir 2022-01-27 23:08:01 +00:00
katex-header.html Migrate to `halo2_gadgets` crate in subdir 2022-01-27 23:08:01 +00:00
rust-toolchain Migrate to `halo2_gadgets` crate in subdir 2022-01-27 23:08:01 +00:00

README.md

halo2 Crates.io

IMPORTANT: This library is in beta, 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 COPYING for more details, and 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.