Skip to content

Commit

Permalink
updated readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
irakliyk committed May 9, 2024
1 parent d5407da commit 61727c5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions prover/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 61727c5

Please sign in to comment.