Merge pull request #235 from dalek-cryptography/merge-develop-into-main-without-yoloproofs

Merge develop branch into main, disabling R1CS proofs

Author: hdevalence

.travis.yml

@@ -6,17 +6,17 @@ rust:
 
 env:
   - TEST_COMMAND=test EXTRA_FLAGS='' FEATURES=''
-  - TEST_COMMAND=test EXTRA_FLAGS='' FEATURES='avx2_backend'
+  # Disabled for now along with the yoloproofs feature.
+  #- TEST_COMMAND=test EXTRA_FLAGS='' FEATURES='yoloproofs'
   # run cargo bench with a filter that matches no benchmarks.
   # this ensures the benchmarks build but doesn't run them on the CI server.
-  - TEST_COMMAND=bench EXTRA_FLAGS='"DONTRUNBENCHMARKS"' FEATURES='avx2_backend'
-
-before_script:
-  - rustup component add rustfmt-preview
+  - TEST_COMMAND=bench EXTRA_FLAGS='"DONTRUNBENCHMARKS"' FEATURES=''
 
 matrix:
   include:
-  - rust: nightly
+  - rust: nightly-2018-12-04
+    before_script:
+    - rustup component add rustfmt-preview
     script:
     - cargo fmt --all -- --check
 

Cargo.toml

@@ -12,16 +12,16 @@ keywords = ["cryptography", "ristretto", "zero-knowledge", "bulletproofs"]
 description = "A pure-Rust implementation of Bulletproofs using Ristretto"
 
 [dependencies]
-curve25519-dalek = { version = "1.0.0-pre.0", features = ["serde"] }
-subtle = "2.0.0-pre.0"
+curve25519-dalek = { version = "1", features = ["serde"] }
+subtle = "2"
 sha3 = "0.8"
 digest = "0.8"
-rand = "0.5"
+rand = "0.6"
 byteorder = "1"
 serde = "1"
 serde_derive = "1"
 failure = "0.1"
-merlin = "1.0.0-pre.0"
+merlin = "1"
 clear_on_drop = "0.2"
 
 [dev-dependencies]
@@ -31,8 +31,18 @@ bincode = "1"
 
 [features]
 avx2_backend = ["curve25519-dalek/avx2_backend"]
+# Disable the yoloproofs feature for the released crate, so that it's not possible for someone to publish a crate using R1CS proofs yet.
+# yoloproofs = []
 
 [[bench]]
-name = "bulletproofs"
+name = "range_proof"
+harness = false
+
+[[bench]]
+name = "r1cs"
 harness = false
+required-features = ["yoloproofs"]
 
+[[test]]
+name = "r1cs"
+required-features = ["yoloproofs"]

README.md

@@ -28,15 +28,22 @@ This library provides implementations of:
 
 * A programmable constraint system API for expressing rank-1
   constraint systems, and proving and verifying proofs of arbitrary
-  statements (under development in the `circuit` branch);
+  statements (unstable, under development with the `yoloproofs` feature);
 
-* Online multi-party computation for aggregated circuit proofs
+* Online multi-party computation for aggregated constraint system proofs
   (planned future work).
-  
+
 These proofs are implemented using [Merlin transcripts][doc_merlin],
 allowing them to be arbitrarily composed with other proofs without
 implementation changes.
 
+The development roadmap can be found in the
+[Milestones][gh_milestones] section of the [Github repo][gh_repo].
+
+The constraint system API is provided **FOR EXPERIMENTS ONLY**, and must be
+enabled by specifying the `yoloproofs` feature.  It is not covered by semver
+compatibility and is **SUBJECT TO CHANGE WITHOUT NOTICE**.
+
 ## Documentation
 
 The user-facing documentation for this functionality can be [found
@@ -48,9 +55,9 @@ the library's [internal documentation][doc_internal]:
 * how [the range proof protocol works][rp_notes];
 * how [the inner product proof protocol works][ipp_notes];
 * how [the aggregation protocol works][agg_notes];
-* how the Bulletproof circuit proofs work (under development);
+* how the Bulletproof constraint system proofs work (under development);
 * how the constraint system reduction works (under development);
-* how the aggregated circuit proofs work (future work).
+* how the aggregated constraint system proofs work (future work).
 
 ## Comparative Performance
 
@@ -70,12 +77,6 @@ relative speed compared to the fastest implementation.
 This crate also contains other benchmarks; see the *Tests and Benchmarks*
 section below for details.
 
-## WARNING
-
-This code is still research-quality.  It is not (yet) suitable for
-deployment.  The development roadmap can be found in the
-[Milestones][gh_milestones] section of the [Github repo][gh_repo].
-
 ## Example
 
 ```rust
@@ -137,6 +138,10 @@ Run benchmarks with `cargo bench`. This crate uses [criterion.rs][criterion] for
 
 ## Features
 
+The `yoloproofs` feature enables support for rank-1 constraint system proofs.
+It is **UNSTABLE AND UNSUITABLE FOR DEPLOYMENT**, and **PROVIDED FOR TESTING
+ONLY**.
+
 The `avx2_backend` feature enables `curve25519-dalek`'s AVX2 backend,
 which implements curve arithmetic using [parallel
 formulas][parallel_edwards].  To use it for Bulletproofs, the