Add CanonicalSerialize and CanonicalDeserialize to Path and CRH outputs and relax Path visibility (#48)

weikengchen · web-flow · commit 3a83d9ff29f5 · 2021-06-03T18:36:23.000-07:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -19,6 +19,7 @@ ark-ff = { version = "^0.2.0", default-features = false }
 ark-ec = { version = "^0.2.0", default-features = false }
 ark-std = { version = "^0.2.0", default-features = false }
 ark-relations = { version = "^0.2.0", default-features = false }
+ark-serialize = { version = "^0.2.0", default-features = false, features = [ "derive" ] }
 
 blake2 = { version = "0.9", default-features = false }
 digest = "0.9"
diff --git a/src/crh/injective_map/mod.rs b/src/crh/injective_map/mod.rs
@@ -9,12 +9,20 @@ use ark_ec::{
     twisted_edwards_extended::{GroupAffine as TEAffine, GroupProjective as TEProjective},
     ProjectiveCurve,
 };
+use ark_serialize::{CanonicalDeserialize, CanonicalSerialize};
 
 #[cfg(feature = "r1cs")]
 pub mod constraints;
 
 pub trait InjectiveMap<C: ProjectiveCurve> {
-    type Output: ToBytes + Clone + Eq + Hash + Default + Debug;
+    type Output: ToBytes
+        + Clone
+        + Eq
+        + Hash
+        + Default
+        + Debug
+        + CanonicalSerialize
+        + CanonicalDeserialize;
 
     fn injective_map(ge: &C::Affine) -> Result<Self::Output, CryptoError>;
 }
diff --git a/src/crh/mod.rs b/src/crh/mod.rs
@@ -11,6 +11,7 @@ use crate::Error;
 
 #[cfg(feature = "r1cs")]
 pub mod constraints;
+use ark_serialize::{CanonicalDeserialize, CanonicalSerialize};
 #[cfg(feature = "r1cs")]
 pub use constraints::*;
 
@@ -19,7 +20,14 @@ pub use constraints::*;
 pub trait CRH {
     const INPUT_SIZE_BITS: usize;
 
-    type Output: ToBytes + Clone + Eq + core::fmt::Debug + Hash + Default;
+    type Output: ToBytes
+        + Clone
+        + Eq
+        + core::fmt::Debug
+        + Hash
+        + Default
+        + CanonicalSerialize
+        + CanonicalDeserialize;
     type Parameters: Clone + Default;
 
     fn setup<R: Rng>(r: &mut R) -> Result<Self::Parameters, Error>;
@@ -32,7 +40,14 @@ pub trait TwoToOneCRH {
     /// The bit size of the right input.
     const RIGHT_INPUT_SIZE_BITS: usize;
 
-    type Output: ToBytes + Clone + Eq + core::fmt::Debug + Hash + Default;
+    type Output: ToBytes
+        + Clone
+        + Eq
+        + core::fmt::Debug
+        + Hash
+        + Default
+        + CanonicalSerialize
+        + CanonicalDeserialize;
     type Parameters: Clone + Default;
 
     fn setup<R: Rng>(r: &mut R) -> Result<Self::Parameters, Error>;
diff --git a/src/encryption/elgamal/constraints.rs b/src/encryption/elgamal/constraints.rs
@@ -228,3 +228,75 @@ where
         })
     }
 }
+
+#[cfg(test)]
+mod test {
+    use crate::encryption::constraints::AsymmetricEncryptionGadget;
+    use ark_std::{test_rng, UniformRand};
+
+    use ark_ed_on_bls12_381::{constraints::EdwardsVar, EdwardsProjective as JubJub, Fq};
+
+    use crate::encryption::elgamal::{constraints::ElGamalEncGadget, ElGamal, Randomness};
+    use crate::encryption::AsymmetricEncryptionScheme;
+    use ark_r1cs_std::prelude::*;
+    use ark_relations::r1cs::ConstraintSystem;
+
+    #[test]
+    fn test_elgamal_gadget() {
+        let rng = &mut test_rng();
+
+        type MyEnc = ElGamal<JubJub>;
+        type MyGadget = ElGamalEncGadget<JubJub, EdwardsVar>;
+
+        // compute primitive result
+        let parameters = MyEnc::setup(rng).unwrap();
+        let (pk, _) = MyEnc::keygen(&parameters, rng).unwrap();
+        let msg = JubJub::rand(rng).into();
+        let randomness = Randomness::rand(rng);
+        let primitive_result = MyEnc::encrypt(&parameters, &pk, &msg, &randomness).unwrap();
+
+        // construct constraint system
+        let cs = ConstraintSystem::<Fq>::new_ref();
+        let randomness_var =
+            <MyGadget as AsymmetricEncryptionGadget<MyEnc, Fq>>::RandomnessVar::new_witness(
+                ark_relations::ns!(cs, "gadget_randomness"),
+                || Ok(&randomness),
+            )
+            .unwrap();
+        let parameters_var =
+            <MyGadget as AsymmetricEncryptionGadget<MyEnc, Fq>>::ParametersVar::new_constant(
+                ark_relations::ns!(cs, "gadget_parameters"),
+                &parameters,
+            )
+            .unwrap();
+        let msg_var =
+            <MyGadget as AsymmetricEncryptionGadget<MyEnc, Fq>>::PlaintextVar::new_witness(
+                ark_relations::ns!(cs, "gadget_message"),
+                || Ok(&msg),
+            )
+            .unwrap();
+        let pk_var =
+            <MyGadget as AsymmetricEncryptionGadget<MyEnc, Fq>>::PublicKeyVar::new_witness(
+                ark_relations::ns!(cs, "gadget_public_key"),
+                || Ok(&pk),
+            )
+            .unwrap();
+
+        // use gadget
+        let result_var =
+            MyGadget::encrypt(&parameters_var, &msg_var, &randomness_var, &pk_var).unwrap();
+
+        // check that result equals expected ciphertext in the constraint system
+        let expected_var =
+            <MyGadget as AsymmetricEncryptionGadget<MyEnc, Fq>>::OutputVar::new_input(
+                ark_relations::ns!(cs, "gadget_expected"),
+                || Ok(&primitive_result),
+            )
+            .unwrap();
+        expected_var.enforce_equal(&result_var).unwrap();
+
+        assert_eq!(primitive_result.0, result_var.c1.value().unwrap());
+        assert_eq!(primitive_result.1, result_var.c2.value().unwrap());
+        assert!(cs.is_satisfied().unwrap());
+    }
+}
diff --git a/src/encryption/elgamal/mod.rs b/src/encryption/elgamal/mod.rs
@@ -103,3 +103,32 @@ where
         Ok(m)
     }
 }
+
+#[cfg(test)]
+mod test {
+    use ark_std::{test_rng, UniformRand};
+
+    use ark_ed_on_bls12_381::EdwardsProjective as JubJub;
+
+    use crate::encryption::elgamal::{ElGamal, Randomness};
+    use crate::encryption::AsymmetricEncryptionScheme;
+
+    #[test]
+    fn test_elgamal_encryption() {
+        let rng = &mut test_rng();
+
+        // setup and key generation
+        let parameters = ElGamal::<JubJub>::setup(rng).unwrap();
+        let (pk, sk) = ElGamal::<JubJub>::keygen(&parameters, rng).unwrap();
+
+        // get a random msg and encryption randomness
+        let msg = JubJub::rand(rng).into();
+        let r = Randomness::rand(rng);
+
+        // encrypt and decrypt the message
+        let cipher = ElGamal::<JubJub>::encrypt(&parameters, &pk, &msg, &r).unwrap();
+        let check_msg = ElGamal::<JubJub>::decrypt(&parameters, &sk, &cipher).unwrap();
+
+        assert_eq!(msg, check_msg);
+    }
+}
diff --git a/src/encryption/mod.rs b/src/encryption/mod.rs
@@ -36,94 +36,3 @@ pub trait AsymmetricEncryptionScheme {
         ciphertext: &Self::Ciphertext,
     ) -> Result<Self::Plaintext, Error>;
 }
-
-#[cfg(test)]
-mod test {
-    use crate::encryption::constraints::AsymmetricEncryptionGadget;
-    use ark_std::{test_rng, UniformRand};
-
-    use ark_ed_on_bls12_381::{constraints::EdwardsVar, EdwardsProjective as JubJub, Fq};
-
-    use crate::encryption::elgamal::{constraints::ElGamalEncGadget, ElGamal, Randomness};
-    use crate::encryption::AsymmetricEncryptionScheme;
-    use ark_r1cs_std::prelude::*;
-    use ark_relations::r1cs::ConstraintSystem;
-
-    #[test]
-    fn test_elgamal_encryption() {
-        let rng = &mut test_rng();
-
-        // setup and key generation
-        let parameters = ElGamal::<JubJub>::setup(rng).unwrap();
-        let (pk, sk) = ElGamal::<JubJub>::keygen(&parameters, rng).unwrap();
-
-        // get a random msg and encryption randomness
-        let msg = JubJub::rand(rng).into();
-        let r = Randomness::rand(rng);
-
-        // encrypt and decrypt the message
-        let cipher = ElGamal::<JubJub>::encrypt(&parameters, &pk, &msg, &r).unwrap();
-        let check_msg = ElGamal::<JubJub>::decrypt(&parameters, &sk, &cipher).unwrap();
-
-        assert_eq!(msg, check_msg);
-    }
-
-    #[test]
-    fn test_elgamal_gadget() {
-        let rng = &mut test_rng();
-
-        type MyEnc = ElGamal<JubJub>;
-        type MyGadget = ElGamalEncGadget<JubJub, EdwardsVar>;
-
-        // compute primitive result
-        let parameters = MyEnc::setup(rng).unwrap();
-        let (pk, _) = MyEnc::keygen(&parameters, rng).unwrap();
-        let msg = JubJub::rand(rng).into();
-        let randomness = Randomness::rand(rng);
-        let primitive_result = MyEnc::encrypt(&parameters, &pk, &msg, &randomness).unwrap();
-
-        // construct constraint system
-        let cs = ConstraintSystem::<Fq>::new_ref();
-        let randomness_var =
-            <MyGadget as AsymmetricEncryptionGadget<MyEnc, Fq>>::RandomnessVar::new_witness(
-                ark_relations::ns!(cs, "gadget_randomness"),
-                || Ok(&randomness),
-            )
-            .unwrap();
-        let parameters_var =
-            <MyGadget as AsymmetricEncryptionGadget<MyEnc, Fq>>::ParametersVar::new_constant(
-                ark_relations::ns!(cs, "gadget_parameters"),
-                &parameters,
-            )
-            .unwrap();
-        let msg_var =
-            <MyGadget as AsymmetricEncryptionGadget<MyEnc, Fq>>::PlaintextVar::new_witness(
-                ark_relations::ns!(cs, "gadget_message"),
-                || Ok(&msg),
-            )
-            .unwrap();
-        let pk_var =
-            <MyGadget as AsymmetricEncryptionGadget<MyEnc, Fq>>::PublicKeyVar::new_witness(
-                ark_relations::ns!(cs, "gadget_public_key"),
-                || Ok(&pk),
-            )
-            .unwrap();
-
-        // use gadget
-        let result_var =
-            MyGadget::encrypt(&parameters_var, &msg_var, &randomness_var, &pk_var).unwrap();
-
-        // check that result equals expected ciphertext in the constraint system
-        let expected_var =
-            <MyGadget as AsymmetricEncryptionGadget<MyEnc, Fq>>::OutputVar::new_input(
-                ark_relations::ns!(cs, "gadget_expected"),
-                || Ok(&primitive_result),
-            )
-            .unwrap();
-        expected_var.enforce_equal(&result_var).unwrap();
-
-        assert_eq!(primitive_result.0, result_var.c1.value().unwrap());
-        assert_eq!(primitive_result.1, result_var.c2.value().unwrap());
-        assert!(cs.is_satisfied().unwrap());
-    }
-}
diff --git a/src/merkle_tree/mod.rs b/src/merkle_tree/mod.rs
@@ -3,6 +3,7 @@
 use crate::crh::TwoToOneCRH;
 use crate::CRH;
 use ark_ff::ToBytes;
+use ark_serialize::{CanonicalDeserialize, CanonicalSerialize, Read, SerializationError, Write};
 use ark_std::vec::Vec;
 
 #[cfg(feature = "r1cs")]
@@ -30,12 +31,13 @@ pub type LeafParam<P> = <<P as Config>::LeafHash as CRH>::Parameters;
 ///    [I] J
 /// ```
 ///  Suppose we want to prove I, then `leaf_sibling_hash` is J, `auth_path` is `[C,D]`
+#[derive(Clone, CanonicalSerialize, CanonicalDeserialize)]
 pub struct Path<P: Config> {
-    pub(crate) leaf_sibling_hash: LeafDigest<P>,
+    pub leaf_sibling_hash: LeafDigest<P>,
     /// The sibling of path node ordered from higher layer to lower layer (does not include root node).
-    pub(crate) auth_path: Vec<TwoToOneDigest<P>>,
+    pub auth_path: Vec<TwoToOneDigest<P>>,
     /// stores the leaf index of the node
-    pub(crate) leaf_index: usize,
+    pub leaf_index: usize,
 }
 
 impl<P: Config> Path<P> {
