Merge pull request #216 from dalek-cryptography/feature-gate-r1cs

Feature-gate R1CS code behind 'yoloproofs' feature

Author: hdevalence

.travis.yml

@@ -6,10 +6,10 @@ rust:
 
 env:
   - TEST_COMMAND=test EXTRA_FLAGS='' FEATURES=''
-  - TEST_COMMAND=test EXTRA_FLAGS='' FEATURES='avx2_backend'
+  - 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'
+  - TEST_COMMAND=bench EXTRA_FLAGS='"DONTRUNBENCHMARKS"' FEATURES=''
 
 before_script:
   - rustup component add rustfmt-preview

Cargo.toml

@@ -31,11 +31,12 @@ bincode = "1"
 
 [features]
 avx2_backend = ["curve25519-dalek/avx2_backend"]
+yoloproofs = []
 
 [[bench]]
 name = "range_proof"
 harness = false
 
-[[bench]]
-name = "r1cs"
-harness = false
+#[[bench]]
+#name = "r1cs"
+#harness = false

README.md

@@ -28,9 +28,9 @@ 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],
@@ -48,9 +48,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
 

src/errors.rs

@@ -94,6 +94,7 @@ pub enum MPCError {
 }
 
 /// Represents an error during the proving or verifying of a constraint system.
+#[cfg(feature = "yoloproofs")]
 #[derive(Fail, Copy, Clone, Debug, Eq, PartialEq)]
 pub enum R1CSError {
     /// Occurs when there are insufficient generators for the proof.

src/lib.rs

@@ -55,4 +55,5 @@ pub mod range_proof_mpc {
     pub use range_proof::party;
 }
 
+#[cfg(feature = "yoloproofs")]
 pub mod r1cs;

src/util.rs

@@ -10,6 +10,7 @@ pub struct VecPoly1(pub Vec<Scalar>, pub Vec<Scalar>);
 
 /// Represents a degree-3 vector polynomial
 /// \\(\mathbf{a} + \mathbf{b} \cdot x + \mathbf{c} \cdot x^2 + \mathbf{d} \cdot x^3 \\).
+#[cfg(feature = "yoloproofs")]
 pub struct VecPoly3(
     pub Vec<Scalar>,
     pub Vec<Scalar>,
@@ -22,6 +23,7 @@ pub struct Poly2(pub Scalar, pub Scalar, pub Scalar);
 
 /// Represents a degree-6 scalar polynomial, without the zeroth degree
 /// \\(a \cdot x + b \cdot x^2 + c \cdot x^3 + d \cdot x^4 + e \cdot x^5 + f \cdot x^6\\)
+#[cfg(feature = "yoloproofs")]
 pub struct Poly6 {
     pub t1: Scalar,
     pub t2: Scalar,
@@ -102,6 +104,7 @@ impl VecPoly1 {
     }
 }
 
+#[cfg(feature = "yoloproofs")]
 impl VecPoly3 {
     pub fn zero(n: usize) -> Self {
         VecPoly3(
@@ -152,6 +155,7 @@ impl Poly2 {
     }
 }
 
+#[cfg(feature = "yoloproofs")]
 impl Poly6 {
     pub fn eval(&self, x: Scalar) -> Scalar {
         x * (self.t1 + x * (self.t2 + x * (self.t3 + x * (self.t4 + x * (self.t5 + x * self.t6)))))
@@ -177,6 +181,7 @@ impl Drop for Poly2 {
     }
 }
 
+#[cfg(feature = "yoloproofs")]
 impl Drop for VecPoly3 {
     fn drop(&mut self) {
         for e in self.0.iter_mut() {
@@ -194,6 +199,7 @@ impl Drop for VecPoly3 {
     }
 }
 
+#[cfg(feature = "yoloproofs")]
 impl Drop for Poly6 {
     fn drop(&mut self) {
         self.t1.clear();