sonobe/frontends/README.md
frontends/README.mdRaw
1# frontends
2
3This crate contains *experimental frontends* for Sonobe.
4The recommended frontend is to directly use [arkworks](https://github.com/arkworks-rs) to define the FCircuit, just following the [`FCircuit` trait](https://github.com/privacy-scaling-explorations/sonobe/blob/main/folding-schemes/src/frontend/mod.rs).
5
6## Experimental frontends
7> Warning: the following frontends are experimental and some computational and time overhead is expected when using them compared to directly using the [arkworks frontend](https://github.com/privacy-scaling-explorations/sonobe/blob/main/folding-schemes/src/frontend/mod.rs).
8
9Available experimental frontends:
10- [Circom](https://github.com/iden3/circom), iden3, 0Kims Association. Supported version`<=v2.1.9`.
11- [Noir](https://github.com/noir-lang/noir), Aztec.
12- [Noname](https://github.com/zksecurity/noname), zkSecurity. Partially supported.
13
14
15Documentation about frontend interface and experimental frontends: https://privacy-scaling-explorations.github.io/sonobe-docs/usage/frontend.html
16
17## Implementing new frontends
18Support for new frontends can be added (even from outside this repo) by implementing the [`FCircuit` trait](https://github.com/privacy-scaling-explorations/sonobe/blob/main/folding-schemes/src/frontend/mod.rs).