Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pnyda committed Jan 16, 2025
1 parent 8dd84a1 commit a29e10e
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
# halo2ccs
Convert a Plonkish circuit in [Halo2](https://zcash.github.io/halo2/) into a [CCS](https://eprint.iacr.org/2023/552) circuit in [sonobe](https://github.com/privacy-scaling-explorations/sonobe).

[rustdoc](https://pnyda.github.io/halo2ccs)
[rustdoc](https://pnyda.github.io/halo2-ccs-plus/halo2ccs)

This crate works on [my fork of halo2](https://github.com/pnyda/halo2/tree/ccs) because some of the private members needed to be accessible from external crate. If you wish to convert your circuit you have to add to Cargo.toml
```toml
[dependencies]
halo2_proofs = { git = "https://github.com/pnyda/halo2.git", branch = "ccs" }
halo2_gadgets = { git = "https://github.com/pnyda/halo2.git", branch = "ccs" }
```

If you need to switch dependencies of dependencies at once then you can use:
```toml
[patch.crates-io]
halo2_proofs = { git = "https://github.com/pnyda/halo2.git", branch = "ccs" }
halo2_gadgets = { git = "https://github.com/pnyda/halo2.git", branch = "ccs" }
```

0 comments on commit a29e10e

Please sign in to comment.