Merge pull request #13 from ebfull/tidy-up

Tidy up the codebase (TODOs into github issues)

src/circuit/boolean.rs

@@ -257,7 +257,6 @@ impl<Var: Copy> Boolean<Var> {
         where E: Engine,
               CS: ConstraintSystem<E, Variable=Var>
     {
-        // TODO: this is just a cheap hack
         let c = Self::xor(&mut cs, a, b)?;
 
         Self::enforce_nand(&mut cs, &[c])
@@ -351,7 +350,6 @@ impl<Var: Copy> Boolean<Var> {
         assert!(bits.len() > 0);
         let mut bits = bits.iter();
 
-        // TODO: optimize
         let mut cur: Self = bits.next().unwrap().clone();
 
         let mut i = 0;
@@ -374,13 +372,11 @@ impl<Var: Copy> Boolean<Var> {
     {
         let res = Self::kary_and(&mut cs, bits)?;
 
-        // TODO: optimize
         match res {
             Boolean::Constant(false) => {
                 Ok(())
             },
             Boolean::Constant(true) => {
-                // TODO: more descriptive error
                 Err(SynthesisError::AssignmentMissing)
             },
             Boolean::Is(ref res) => {
@@ -457,9 +453,6 @@ impl<Var: Copy> Boolean<Var> {
                     current_run.truncate(0);
                 }
 
-                // TODO: this could be optimized with a k-ary operation
-                // (all zeros are required in the run if last_run is zero)
-
                 // If `last_run` is true, `a` must be false, or it would
                 // not be in the field.
                 //

src/circuit/mont.rs

@@ -44,8 +44,6 @@ impl<E: JubjubEngine, Var: Copy> MontgomeryPoint<E, Var> {
 
         assert!(tag.len() % 8 == 0);
 
-        // TODO: first block, personalization
-        //
         // Perform BLAKE2s hash
         let h = blake2s(cs.namespace(|| "blake2s"), tag)?;
 
@@ -164,7 +162,6 @@ impl<E: JubjubEngine, Var: Copy> MontgomeryPoint<E, Var> {
                     Ok(t0)
                 },
                 None => {
-                    // TODO: add a more descriptive error to bellman
                     Err(SynthesisError::AssignmentMissing)
                 }
             }

src/circuit/num.rs

@@ -272,7 +272,6 @@ impl<E: Engine, Var: Copy> AllocatedNum<E, Var> {
             let tmp = *self.value.get()?;
             
             if tmp.is_zero() {
-                // TODO: add a more descriptive error to bellman
                 Err(SynthesisError::AssignmentMissing)
             } else {
                 Ok(tmp.inverse().unwrap())

src/circuit/uint32.rs

@@ -180,7 +180,6 @@ impl<Var: Copy> UInt32<Var> {
         })
     }
 
-    // TODO: could optimize
     /// Perform modular addition of several `UInt32` objects.
     pub fn addmany<E, CS>(
         mut cs: CS,

src/group_hash.rs

@@ -15,7 +15,6 @@ pub fn group_hash<E: JubjubEngine>(
     // Check to see that scalar field is 255 bits
     assert!(E::Fr::NUM_BITS == 255);
 
-    // TODO: personalization/first block
     let mut h = Blake2s::new_keyed(&[], 32);
     h.process(tag);
     let mut h = h.fixed_result().to_vec();

src/jubjub/fs.rs

@@ -1222,19 +1222,3 @@ fn test_fs_root_of_unity() {
     );
     assert!(Fs::multiplicative_generator().sqrt().is_none());
 }
-
-// TODO
-/*
-#[test]
-fn fr_field_tests() {
-    ::tests::field::random_field_tests::<Fr>();
-    ::tests::field::random_sqrt_tests::<Fr>();
-    ::tests::field::random_frobenius_tests::<Fr, _>(Fr::char(), 13);
-    ::tests::field::from_str_tests::<Fr>();
-}
-
-#[test]
-fn fr_repr_tests() {
-    ::tests::repr::random_repr_tests::<FsRepr>();
-}
-*/

src/jubjub/tests.rs

@@ -1,8 +1,15 @@
-// TODO
+use super::{
-use super::*;
+    JubjubEngine,
+    JubjubParams,
+    PrimeOrder,
+    montgomery,
+    edwards
+};
 
 use pairing::{
     Field,
+    PrimeField,
+    SqrtField,
     LegendreSymbol
 };