From 61727c55fab35d62c5ebc96b548c1b0c2900f6a6 Mon Sep 17 00:00:00 2001 From: Irakliy Khaburzaniya Date: Thu, 9 May 2024 14:01:02 -0700 Subject: [PATCH] updated readme files --- README.md | 6 +++++- prover/README.md | 1 + 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5ea336174..ab83d04a4 100644 --- a/README.md +++ b/README.md @@ -31,11 +31,15 @@ Winterfell is a fully-functional, multi-threaded STARK prover and verifier with **WebAssembly support.** The library is written in pure Rust and can be compiled to WebAssembly. The `std` standard library is enabled as feature by default for both prover and verifier crates. For WASM targets, one can compile with default features disabled by using `--no-default-features` flag. +**Async prover.** The library supports both sync and async variants of the `Prover` trait. By default, the sync version is exported. The async version of the trait can be enabled via the `async` feature flag. + #### Planned features Over time, we hope extend the library with additional features: -**Perfect zero-knowledge.** The current implementation provides succinct proofs but NOT perfect zero-knowledge. This means that, in its current form, the library may not be suitable for use cases where proofs must not leak any info about secret inputs. +**Perfect zero-knowledge.** The current implementation provides succinct proofs but NOT perfect zero-knowledge. This means that, in its current form, the library may not be suitable for use cases where proofs must not leak any info about secret inputs. + +**Auxiliary GKR proofs.** It will be possible to attach auxiliary GKR-based proofs to the base STARK proofs. This will enable powerful new ways of defining constraints and optimizing prover performance. ### Project structure The project is organized into several crates like so: diff --git a/prover/README.md b/prover/README.md index 9b5d2ea91..9c77a9e59 100644 --- a/prover/README.md +++ b/prover/README.md @@ -50,6 +50,7 @@ This crate can be compiled with the following features: * `std` - enabled by default and relies on the Rust standard library. * `concurrent` - implies `std` and also enables multi-threaded proof generation. * `no_std` - does not rely on the Rust standard library and enables compilation to WebAssembly. +* `async` - converts all functions defined by the `Prover` trait into `async` functions. To compile with `no_std`, disable default features via `--no-default-features` flag.