1. halo2
2. 1. Concepts
3. 1. 1.1. Proof systems
   2. 1.2. PLONKish Arithmetization
   3. 1.3. Chips
   4. 1.4. Gadgets
4. 2. User Documentation
5. 1. 2.1. Developer tools
   2. 2.2. A simple example
   3. 2.3. Lookup tables
   4. 2.4. Gadgets
   5. 2.5. Tips and tricks
   6. 2.6. WASM Guide
6. 3. Developer Documentation
7. 1. 3.1. Feature development
8. 4. Design
9. 1. 4.1. Proving system
   2. 1. 4.1.1. Lookup argument
      2. 4.1.2. Permutation argument
      3. 4.1.3. Circuit commitments
      4. 4.1.4. Vanishing argument
      5. 4.1.5. Multipoint opening argument
      6. 4.1.6. Inner product argument
      7. 4.1.7. Comparison to other work
   3. 4.2. Protocol Description
   4. 4.3. Implementation
   5. 1. 4.3.1. Proofs
      2. 4.3.2. Fields
      3. 4.3.3. Selector combining
   6. 4.4. Gadgets
   7. 1. 4.4.1. Elliptic curve cryptography
      2. 1. 4.4.1.1. Witnessing points
         2. 4.4.1.2. Incomplete and complete addition
         3. 4.4.1.3. Fixed-base scalar multiplication
         4. 4.4.1.4. Variable-base scalar multiplication
      3. 4.4.2. Sinsemilla
      4. 1. 4.4.2.1. MerkleCRH
      5. 4.4.3. Decomposition
      6. 4.4.4. SHA-256
      7. 1. 4.4.4.1. 16-bit table chip
10. 5. Background Material
11. 1. 5.1. Fields
    2. 5.2. Polynomials
    3. 5.3. Cryptographic groups
    4. 5.4. Elliptic curves
    5. 5.5. Polynomial commitment using inner product argument
    6. 5.6. Recursion

Usage

This repository contains the halo2_proofs and halo2_gadgets crates, which should be used directly.

Minimum Supported Rust Version

Requires Rust 1.60 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.

You can disable rayon by disabling the "multicore" feature. Warning! Halo2 will lose access to parallelism if you disable the "multicore" feature. This will significantly degrade performance.

License

Licensed under either of

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.