[WIP] Changes required for Bridge circuits

halo2/katex-header.html → .github/katex-header.html

@@ -12,4 +12,4 @@
             ]
         });
     });
-</script>
+</script>

.github/scripts/run-examples.sh

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+# Get the list of examples from "examples" dir & Cargo.toml
+EXAMPLES_WITH_FEATURES=$(awk '/^\[\[example\]\]/ { getline; name=$3; name=substr(name, 2, length(name)-2); getline; if ($1 == "required-features") { features=$NF; gsub(/["\[\]]/, "", features); print name "#" features } }' ./halo2_proofs/Cargo.toml)
+EXAMPLES_WITHOUT_FEATURES=$(ls ./halo2_proofs/examples/*.rs | xargs -n1 basename -s .rs)
+
+# Remove examples with features listed in Cargo.toml from examples without features
+EXAMPLES_WITHOUT_FEATURES=$(echo "$EXAMPLES_WITHOUT_FEATURES" | grep -vFx "$(echo "$EXAMPLES_WITH_FEATURES" | cut -d '#' -f 1)")
+
+# Combine examples with and without features
+EXAMPLES=$(echo "$EXAMPLES_WITH_FEATURES $EXAMPLES_WITHOUT_FEATURES" | tr ' ' '\n' | sort -u | tr '\n' ' ')
+
+# Run the examples
+for example in $EXAMPLES; do
+    if [ "$(echo "$example" | grep '#')" ]; then
+        name=$(echo $example | cut -d '#' -f 1)
+        features=$(echo $example | cut -d '#' -f 2)
+        cargo run --package halo2_proofs --example $name --features $features
+    else
+        cargo run --package halo2_proofs --example $example
+    fi
+done

.github/scripts/wasm-target-test-build.sh

@@ -0,0 +1,27 @@
+#!/bin/sh
+
+GIT_ROOT=$(pwd)
+
+cd /tmp
+
+# create test project
+cargo new foobar
+cd foobar
+
+# set rust-toolchain same as "halo2"
+cp "${GIT_ROOT}/rust-toolchain" .
+
+# add wasm32-* targets
+rustup target add wasm32-unknown-unknown wasm32-wasi
+
+# add dependencies
+cargo add --path "${GIT_ROOT}/halo2_proofs" --features batch,dev-graph,gadget-traces,lookup-any-sanity-checks
+cargo add getrandom --features js --target wasm32-unknown-unknown
+
+# test build for wasm32-* targets
+cargo build --release --target wasm32-unknown-unknown
+cargo build --release --target wasm32-wasi
+
+# delete test project
+cd ../
+rm -rf foobar

.github/workflows/ci.yml

@@ -17,10 +17,9 @@ jobs:
         os: [ubuntu-latest, windows-latest, macOS-latest]
         include:
           - feature_set: basic
-            features: batch,dev-graph,gadget-traces
+            features: --features batch,dev-graph,gadget-traces
           - feature_set: all
-            features: batch,dev-graph,gadget-traces,test-dev-graph,thread-safe-region,sanity-checks,circuit-params
-
+            features: --all-features
     steps:
       - uses: actions/checkout@v3
       - uses: actions-rs/toolchain@v1
@@ -30,7 +29,18 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --verbose --release --workspace --no-default-features --features "${{ matrix.features }}"
+          args: --verbose --release --workspace --no-default-features ${{ matrix.features }}
+
+  examples:
+    name: Run the examples
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions-rs/toolchain@v1
+      - name: Run examples
+        run: |
+          .github/scripts/run-examples.sh
 
   build:
     name: Build target ${{ matrix.target }}
@@ -46,13 +56,12 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           override: false
+          default: true
       - name: Add target
         run: rustup target add ${{ matrix.target }}
-      - name: cargo build
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --no-default-features --features batch,dev-graph,gadget-traces --target ${{ matrix.target }}
+      - name: Run script file
+        run: |
+          .github/scripts/wasm-target-test-build.sh
 
   bitrot:
     name: Bitrot check

.github/workflows/docs-ghpages.yml

@@ -16,9 +16,17 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions-rs/toolchain@v1
         with:
-          toolchain: nightly
+          toolchain: nightly-2024-05-17
           override: true
 
+      - name: Copy the html file to workspace crates
+        run: |
+          for cargo_toml in $(find . -name Cargo.toml); do
+            crate_dir=$(dirname $cargo_toml)
+            cp .github/katex-header.html $crate_dir
+            echo "Copied html file to $crate_dir"
+          done
+
       - name: Build latest rustdocs
         uses: actions-rs/cargo@v1
         with:
@@ -33,8 +41,16 @@ jobs:
           cp -R ./target/doc ./docs
           echo "<meta http-equiv=\"refresh\" content=\"0; url=halo2_proofs\">" > ./docs/index.html
 
+      - name: Delete the html files copied to every crate
+        run: |
+          for cargo_toml in $(find . -name Cargo.toml); do
+            crate_dir=$(dirname $cargo_toml)
+            rm -f $crate_dir/katex-header.html
+            echo "Deleted html file in $crate_dir"
+          done
+
       - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./docs

.gitignore

@@ -4,3 +4,6 @@ Cargo.lock
 .vscode
 **/*.html
 .DS_Store
+
+layout.png
+serialization-test.pk

Cargo.toml

@@ -2,4 +2,10 @@
 members = [
     "halo2",
     "halo2_proofs",
+    "halo2_frontend",
+    "halo2_middleware",
+    "halo2_backend",
+    "halo2_debug",
+    "p3_frontend",
 ]
+resolver = "2"

README.md

@@ -1,7 +1,15 @@
-# halo2 [![Crates.io](https://img.shields.io/crates/v/halo2.svg)](https://crates.io/crates/halo2) #
+# halo2
 
 ## [Documentation](https://privacy-scaling-explorations.github.io/halo2/halo2_proofs)
 
+This repository contains the [halo2](https://github.com/zcash/halo2) fork from
+PSE and includes contributions from the community.
+
+We use the `main` branch for development, which means it may contain
+unstable/unfinished features.  For end-users we recomend 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

book/src/user/experimental-features.md

@@ -138,3 +138,38 @@ For some use cases that want to keep configured `ConstraintSystem` unchanged the
 ## `Evaluator` and `evaluate_h`
 
 They are introduced to improve quotient computation speed and memory usage for circuit with complicated `Expression`.
+
+## Modular design (frontend-backend split)
+
+The halo2 implementation has been split into two separate parts: the frontend
+and the backend, following these definitions:
+- frontend: allows the user to specify the circuit logic and its satisfying
+  witness. It must provide a way to translate this logic into a low level
+  arithmetization format specified in the middleware module.
+- backend: the proving system implementation that receives the middleware
+  circuit arithmetization and performs the following tasks:
+  - Generate the setup (proving and verifying keys)
+  - Generate a proof (with witness as input)
+  - Verify a proof
+
+A note on naming: "halo2" can mean different things:
+- halo2 proof system, the protocol
+- halo2 proof system implementation, the backend
+- halo2 circuit library, the frontend (includes the halo2 circuit API, the
+  layouter, the selector to fixed column transformation, etc.)
+- halo2 full-stack, the proof system full stack (the combination of the backend
+  and frontend)
+
+Currently the backend implements the "original" halo2 proof system extended
+with the features discussed in this document.  Nevertheless, the public
+interface that the backend uses is generic for plonkish arithmetization.  This
+allows for alternative frontend implementations as well as alternative plonkish
+proof system implementations.  The middleware contains the type definitions
+used to connect the frontend and backend.
+
+Summary of crates:
+- `halo2_frontend`: library used to define circuits and calculate their witness.
+- `halo2_backend`: implementation of the halo2 proof system (the protocol).
+- `halo2_middleware`: type definitions used to interface the backend with the frontend.
+- `halo2_proofs`: legacy API built by re-exporting from the frontend and
+  backend as well as function wrappers.

codecov.yml

@@ -0,0 +1,8 @@
+ignore:
+    - halo2_proofs/benches
+    - halo2_proofs/examples
+    - halo2_proofs/tests
+    - halo2_frontend/src/dev/graph
+    - halo2_frontend/src/dev/graph.rs
+    - halo2_frontend/src/dev/costs.rs
+    - halo2_frontend/src/dev/cost_model.rs

halo2/Cargo.toml

@@ -5,11 +5,11 @@ authors = [
     "Jack Grigg <[email protected]>",
 ]
 edition = "2021"
-rust-version = "1.56.1"
+rust-version = "1.73.0"
 description = "[BETA] Fast zero-knowledge proof-carrying data implementation with no trusted setup"
 license = "MIT OR Apache-2.0"
-repository = "https://github.com/zcash/halo2"
-documentation = "https://docs.rs/halo2"
+repository = "https://github.com/privacy-scaling-explorations/halo2"
+documentation = "https://privacy-scaling-explorations.github.io/halo2/"
 readme = "../README.md"
 categories = ["cryptography"]
 keywords = ["halo", "proofs", "recursive", "zkp", "zkSNARKs"]
@@ -19,7 +19,7 @@ all-features = true
 rustdoc-args = ["--cfg", "docsrs", "--html-in-header", "katex-header.html"]
 
 [dependencies]
-halo2_proofs = { version = "0.3", path = "../halo2_proofs", default-features = false }
+halo2_proofs = { version = "0.4", path = "../halo2_proofs", default-features = false }
 
 [lib]
 bench = false

halo2_backend/Cargo.toml

@@ -0,0 +1,62 @@
+[package]
+name = "halo2_backend"
+version = "0.4.0"
+authors = [
+    "Sean Bowe <[email protected]>",
+    "Ying Tong Lai <[email protected]>",
+    "Daira Hopwood <[email protected]>",
+    "Jack Grigg <[email protected]>",
+    "Privacy Scaling Explorations team",
+]
+edition = "2021"
+rust-version = "1.73.0"
+description = """
+Halo2 backend implementation.  This package implements the halo2 proof system which includes setup (key generation), proving and verifying.
+"""
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/privacy-scaling-explorations/halo2"
+documentation = "https://privacy-scaling-explorations.github.io/halo2/"
+readme = "README.md"
+categories = ["cryptography"]
+keywords = ["halo", "proofs", "zkp", "zkSNARKs"]
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs", "--html-in-header", "katex-header.html"]
+
+[dependencies]
+backtrace = { version = "0.3", optional = true }
+ff = "0.13"
+group = "0.13"
+halo2curves = { version = "0.7.0", default-features = false }
+rand_core = { version = "0.6", default-features = false }
+tracing = "0.1"
+blake2b_simd = "1"
+sha3 = "0.9.1"
+rand_chacha = "0.3"
+serde = { version = "1", optional = true, features = ["derive"] }
+serde_derive = { version = "1", optional = true}
+rayon = "1.8"
+halo2_middleware = { path = "../halo2_middleware" }
+num-bigint = "0.4.6"
+
+[dev-dependencies]
+assert_matches = "1.5"
+criterion = "0.3"
+gumdrop = "0.8"
+proptest = "1"
+rand_core = { version = "0.6", default-features = false, features = ["getrandom"] }
+serde_json = "1"
+
+[target.'cfg(all(target_arch = "wasm32", target_os = "unknown"))'.dev-dependencies]
+getrandom = { version = "0.2", features = ["js"] }
+
+[features]
+default = ["batch", "bits"]
+bits = ["halo2curves/bits"]
+sanity-checks = []
+batch = ["rand_core/getrandom"]
+derive_serde = ["halo2curves/derive_serde"]
+
+[lib]
+bench = false