@@ -32,11 +32,18 @@ This library provides implementations of:
3232
3333* Online multi-party computation for aggregated constraint system proofs
3434 (planned future work).
35-
35+
3636These proofs are implemented using [ Merlin transcripts] [ doc_merlin ] ,
3737allowing them to be arbitrarily composed with other proofs without
3838implementation changes.
3939
40+ The development roadmap can be found in the
41+ [ Milestones] [ gh_milestones ] section of the [ Github repo] [ gh_repo ] .
42+
43+ The constraint system API is provided ** FOR EXPERIMENTS ONLY** , and must be
44+ enabled by specifying the ` yoloproofs ` feature. It is not covered by semver
45+ compatibility and is ** SUBJECT TO CHANGE WITHOUT NOTICE** .
46+
4047## Documentation
4148
4249The user-facing documentation for this functionality can be [ found
@@ -70,12 +77,6 @@ relative speed compared to the fastest implementation.
7077This crate also contains other benchmarks; see the * Tests and Benchmarks*
7178section below for details.
7279
73- ## WARNING
74-
75- This code is still research-quality. It is not (yet) suitable for
76- deployment. The development roadmap can be found in the
77- [ Milestones] [ gh_milestones ] section of the [ Github repo] [ gh_repo ] .
78-
7980## Example
8081
8182``` rust
@@ -137,6 +138,10 @@ Run benchmarks with `cargo bench`. This crate uses [criterion.rs][criterion] for
137138
138139## Features
139140
141+ The ` yoloproofs ` feature enables support for rank-1 constraint system proofs.
142+ It is ** UNSTABLE AND UNSUITABLE FOR DEPLOYMENT** , and ** PROVIDED FOR TESTING
143+ ONLY** .
144+
140145The ` avx2_backend ` feature enables ` curve25519-dalek ` 's AVX2 backend,
141146which implements curve arithmetic using [ parallel
142147formulas] [ parallel_edwards ] . To use it for Bulletproofs, the
0 commit comments