phase2-bn254/bellman/README.md
Kobi Gurkan c08803f3be Add 'bellman/' from commit '1aff83c6ec670a1e4722f079351c55c79e2e6ef5'
git-subtree-dir: bellman
git-subtree-mainline: 1ac4b55786c97b4304d94153b2378a6843312f43
git-subtree-split: 1aff83c6ec670a1e4722f079351c55c79e2e6ef5
2019-09-02 15:34:51 +03:00

3.5 KiB

bellman "Community edition"

Originally developed for ZCash, with extensions from us to make it a little more pleasant. Uses our "community edition" pairing for Ethereum's BN256 curve. Now published as bellman_ce on crate.io to allow ease of use.

Features

There are two available features to be used in production and are stable and will not be changed in terms of API. Those are Groth16 proof system implementation.

  • multicore feature (enabled by default) is intended to be run on PC and in environments that have support of a full std including threading.
  • singlecore feature is mainly intended for WASM systems, where non-compatible external crates are removed, along with all the multithreading.

Due to request to have a maintainable repo with WASM compatibility those features were implemented during the implementation of GM17 and SONIC proof systems. That's why there are two more features that are incomplete and will have breaking changes in a future. Those are for interested enthusiasts.

  • gm17 - is incomplete and most likely will get attention after putting SONIC to completeness.
  • sonic - 90% complete. Original implementation of helped protocol is integrated with API similar to the Groth16, along with wrapping adapters to use existing circuits without any changes. unhelped version is not yet complete, but all cryptographical primitives are implemented and tested. Right now it's a priority.

Future progress

It's intended to add GM17 proof system and SONIC proof system.

Features

There are two available features to be used in production and are stable and will not be changed in terms of API. Those are Groth16 proof system implementation.

  • multicore feature (enabled by default) is intended to be run on PC and in environments that have support of a full std including threading.
  • singlecore feature is mainly intended for WASM systems, where non-compatible external crates are removed, along with all the multithreading.

Due to request to have a maintainable repo with WASM compatibility those features were implemented during the implementation of GM17 and SONIC proof systems. That's why there are two more features that are incomplete and will have breaking changes in a future. Those are for interested enthusiasts.

  • gm17 - is incomplete and most likely will get attention after putting SONIC to completeness.
  • sonic - 90% complete. Original implementation of helped protocol is integrated with API similar to the Groth16, along with wrapping adapters to use existing circuits without any changes. unhelped version is not yet complete, but all cryptographical primitives are implemented and tested. Right now it's a priority.

Future progress

It's intended to add GM17 proof system and SONIC proof system.

License

Licensed under either of

at your option.

Code Examples:

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.