Merge branch 'main' into develop

Author: hdevalence

CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+Entries are listed in reverse chronological order.
+
+## 1.0.1
+
+* Tweaks to crate metadata.
+* Minor documentation changes.
+* Adds a regression test for deserialize-and-verify for proofs created using
+  v1.0.0, to ensure they continue to verify in future versions.
+
+## 1.0.0
+
+* Minor tweaks to the prerelease version.  
+* Preliminary support for R1CS proofs, but this feature is hard-disabled in the
+  published crate.
+
+## 1.0.0-pre.0
+
+Initial prerelease version, supporting single and aggregated range proofs, and
+multiparty proof aggregation.
+

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "bulletproofs"
-version = "1.0.0"
-authors = ["Cathie Yun <cathie@chain.com>", 
+version = "1.0.1"
+authors = ["Cathie Yun <cathieyun@gmail.com>", 
            "Henry de Valence <[email protected]>",
            "Oleg Andreev <[email protected]>"]
 readme = "README.md"
@@ -28,11 +28,19 @@ clear_on_drop = "0.2"
 hex = "0.3"
 criterion = "0.2"
 bincode = "1"
+rand_chacha = "0.1"
 
 [features]
 avx2_backend = ["curve25519-dalek/avx2_backend"]
 yoloproofs = []
 
+[[test]]
+name = "range_proof"
+
+[[test]]
+name = "r1cs"
+required-features = ["yoloproofs"]
+
 [[bench]]
 name = "range_proof"
 harness = false
@@ -41,7 +49,3 @@ harness = false
 name = "r1cs"
 harness = false
 required-features = ["yoloproofs"]
-
-[[test]]
-name = "r1cs"
-required-features = ["yoloproofs"]

README.md

@@ -42,7 +42,12 @@ The development roadmap can be found in the
 
 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**.
+compatibility and is **SUBJECT TO CHANGE WITHOUT NOTICE**.  
+
+Currently, the `yoloproofs` feature is disabled in the published version of the
+crate, so it can only be used by specifying a git dependency on the `develop`
+branch.  This means that it is not possible to publish a crate using the R1CS
+API, because it is **FOR EXPERIMENTS ONLY**.
 
 ## Documentation
 
@@ -61,10 +66,10 @@ the library's [internal documentation][doc_internal]:
 
 ## Comparative Performance
 
-The following table gives comparative timings for proving and
-verification of a 64-bit rangeproof on an i7-7800X with Turbo Boost
-disabled.  Times are in microseconds (lower is better), with the
-relative speed compared to the fastest implementation.
+The following table gives comparative timings for proving and verification of a
+64-bit rangeproof on an Intel Skylake-X i7-7800X (@3.5GHz, Turbo Boost
+disabled).  Times are in microseconds (lower is better), with the relative
+speed compared to the fastest implementation.
 
 | Implementation | Group            | Proving (μs) |       rel | Verification (μs) |       rel |
 |----------------|------------------|-------------:|----------:|------------------:|----------:|
@@ -74,12 +79,22 @@ relative speed compared to the fastest implementation.
 | libsecp-endo   | secp256k1        |        16800 | **2.30x** |              2080 | **2.00x** |
 | Monero         | ed25519 (unsafe) |        53300 | **7.30x** |              4810 | **4.63x** |
 
+Use of the `curve25519-dalek` IFMA backend gives another 1.5x speedup on a
+Cannonlake i3-8121U, increasing the verification speedup **3x** over libsecp
+and **7x** over Monero, but these processors are not yet generally available.
+
 This crate also contains other benchmarks; see the *Tests and Benchmarks*
-section below for details.
+section below for details on how to run them all.
 
 ## Example
 
+The following example shows how to create and verify a 32-bit rangeproof.
+
 ```rust
+# // The #-commented lines are hidden in Rustdoc but not in raw
+# // markdown rendering, and contain boilerplate code so that the
+# // code in the README.md is actually run as part of the test suite.
+#
 # extern crate rand;
 # use rand::thread_rng;
 #
@@ -133,8 +148,8 @@ assert!(
 
 ## Tests and Benchmarks
 
-Run tests with `cargo test`.
-Run benchmarks with `cargo bench`. This crate uses [criterion.rs][criterion] for benchmarks. 
+Run tests with `cargo test`.  Run benchmarks with `cargo bench`.  This crate
+uses [criterion.rs][criterion] for benchmarks. 
 
 ## Features
 

src/generators.rs

@@ -266,7 +266,6 @@ impl<'a> BulletproofGensShare<'a> {
 
 #[cfg(test)]
 mod tests {
-    extern crate hex;
     use super::*;
 
     #[test]

src/inner_product_proof.rs

@@ -394,12 +394,11 @@ pub fn inner_product(a: &[Scalar], b: &[Scalar]) -> Scalar {
 mod tests {
     use super::*;
 
-    use rand::OsRng;
     use sha3::Sha3_512;
     use util;
 
     fn test_helper_create(n: usize) {
-        let mut rng = OsRng::new().unwrap();
+        let mut rng = rand::thread_rng();
 
         use generators::BulletproofGens;
         let bp_gens = BulletproofGens::new(n, 1);