From 6e784deda8e333da2f714139c05ee532a913d888 Mon Sep 17 00:00:00 2001 From: Alex Vlasov Date: Wed, 6 Mar 2019 18:16:09 +0100 Subject: [PATCH] update readme for 0.2.0 version --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index ead922f..1db9bc1 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,22 @@ 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. +## 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