feat: hello-world namespace support for ADVZ VID scheme

CHANGELOG.md

@@ -36,6 +36,7 @@ and follow [semantic versioning](https://semver.org/) for our releases.
 - [#343](https://github.com/EspressoSystems/jellyfish/pull/343) Rescue parameter for `ark_bn254::Fq`
 - [#362](https://github.com/EspressoSystems/jellyfish/pull/362) Derive Eq, Hash at a bunch of places
 - [#381](https://github.com/EspressoSystems/jellyfish/pull/381) VID take iterator instead of slice
+- [#389](https://github.com/EspressoSystems/jellyfish/pull/389) Hello-world namespace support for ADVZ VID scheme
 
 ### Changed
 

primitives/benches/advz.rs

@@ -61,8 +61,11 @@ mod feature_gated {
         // run all benches for each payload_byte_lens
         for len in payload_byte_lens {
             // random payload data
-            let mut payload_bytes = vec![0u8; len];
-            rng.fill_bytes(&mut payload_bytes);
+            let payload_bytes = {
+                let mut payload_bytes = vec![0u8; len];
+                rng.fill_bytes(&mut payload_bytes);
+                payload_bytes
+            };
 
             let benchmark_group_name =
                 |op_name| format!("advz_{}_{}_{}KB", pairing_name, op_name, len / KB);

primitives/src/pcs/univariate_kzg/mod.rs

@@ -92,8 +92,9 @@ impl<E: Pairing> PolynomialCommitmentScheme for UnivariateKzgPCS<E> {
         poly: &Self::Polynomial,
     ) -> Result<Self::Commitment, PCSError> {
         let prover_param = prover_param.borrow();
-        let commit_time =
-            start_timer!(|| format!("Committing to polynomial of degree {} ", poly.degree()));
+        // let commit_time =
+        //     start_timer!(|| format!("Committing to polynomial of degree {} ",
+        // poly.degree()));
 
         if poly.degree() > prover_param.powers_of_g.len() {
             return Err(PCSError::InvalidParameters(format!(
@@ -105,15 +106,16 @@ impl<E: Pairing> PolynomialCommitmentScheme for UnivariateKzgPCS<E> {
 
         let (num_leading_zeros, plain_coeffs) = skip_leading_zeros_and_convert_to_bigints(poly);
 
-        let msm_time = start_timer!(|| "MSM to compute commitment to plaintext poly");
+        // let msm_time = start_timer!(|| "MSM to compute commitment to plaintext
+        // poly");
         let commitment = E::G1::msm_bigint(
             &prover_param.powers_of_g[num_leading_zeros..],
             &plain_coeffs,
         )
         .into_affine();
-        end_timer!(msm_time);
+        // end_timer!(msm_time);
 
-        end_timer!(commit_time);
+        // end_timer!(commit_time);
         Ok(Commitment(commitment))
     }
 
@@ -405,9 +407,10 @@ fn skip_leading_zeros_and_convert_to_bigints<F: PrimeField, P: DenseUVPolynomial
 }
 
 fn convert_to_bigints<F: PrimeField>(p: &[F]) -> Vec<F::BigInt> {
-    let to_bigint_time = start_timer!(|| "Converting polynomial coeffs to bigints");
+    // let to_bigint_time = start_timer!(|| "Converting polynomial coeffs to
+    // bigints");
     let coeffs = p.iter().map(|s| s.into_bigint()).collect::<Vec<_>>();
-    end_timer!(to_bigint_time);
+    // end_timer!(to_bigint_time);
     coeffs
 }
 

primitives/src/vid/mod.rs → primitives/src/vid.rs

@@ -7,41 +7,10 @@
 //! Trait and implementation for a Verifiable Information Retrieval (VID).
 /// See <https://arxiv.org/abs/2111.12323> section 1.3--1.4 for intro to VID semantics.
 use ark_serialize::{CanonicalDeserialize, CanonicalSerialize};
-use ark_std::{borrow::Borrow, error::Error, fmt::Debug, hash::Hash, string::String, vec::Vec};
+use ark_std::{error::Error, fmt::Debug, hash::Hash, string::String, vec::Vec};
 use displaydoc::Display;
 use serde::{Deserialize, Serialize};
 
-pub mod advz;
-
-/// The error type for `VidScheme` methods.
-#[derive(Display, Debug)]
-pub enum VidError {
-    /// invalid args: {0}
-    Argument(String),
-    /// internal error: {0}
-    Internal(anyhow::Error),
-}
-
-impl Error for VidError {}
-
-/// Convenience wrapper to convert any error into a [`VidError`].
-///
-/// Private fn so as not to expose error conversion API outside this crate
-/// as per [stackoverflow](https://stackoverflow.com/a/70057677).
-///
-/// # No-std support
-/// `no_std` mode requires `.map_err(vid)` to convert from a non-`anyhow` error
-/// as per [`anyhow` docs](https://docs.rs/anyhow/latest/anyhow/index.html#no-std-support),
-fn vid<E>(e: E) -> VidError
-where
-    E: ark_std::fmt::Display + Debug + Send + Sync + 'static,
-{
-    VidError::Internal(anyhow::anyhow!(e))
-}
-
-/// Convenience [`Result`] wrapper for [`VidError`].
-pub type VidResult<T> = Result<T, VidError>;
-
 /// VID: Verifiable Information Dispersal
 pub trait VidScheme {
     /// Payload commitment.
@@ -54,25 +23,27 @@ pub trait VidScheme {
     type Common: CanonicalSerialize + CanonicalDeserialize + Clone + Eq + PartialEq + Sync; // TODO https://github.com/EspressoSystems/jellyfish/issues/253
 
     /// Compute a payload commitment
-    fn commit_only<I>(&self, payload: I) -> VidResult<Self::Commit>
+    fn commit_only<B>(&self, payload: B) -> VidResult<Self::Commit>
     where
-        I: IntoIterator,
-        I::Item: Borrow<u8>;
+        B: AsRef<[u8]>;
 
     /// Compute shares to send to the storage nodes
-    fn disperse<I>(&self, payload: I) -> VidResult<VidDisperse<Self>>
+    fn disperse<B>(&self, payload: B) -> VidResult<VidDisperse<Self>>
     where
-        I: IntoIterator,
-        I::Item: Borrow<u8>;
+        B: AsRef<[u8]>;
 
     /// Verify a share. Used by both storage node and retrieval client.
     /// Why is return type a nested `Result`? See <https://sled.rs/errors>
     /// Returns:
     /// - VidResult::Err in case of actual error
     /// - VidResult::Ok(Result::Err) if verification fails
     /// - VidResult::Ok(Result::Ok) if verification succeeds
-    fn verify_share(&self, share: &Self::Share, common: &Self::Common)
-        -> VidResult<Result<(), ()>>;
+    fn verify_share(
+        &self,
+        share: &Self::Share,
+        common: &Self::Common,
+        commit: &Self::Commit,
+    ) -> VidResult<Result<(), ()>>;
 
     /// Recover payload from shares.
     /// Do not verify shares or check recovered payload against anything.
@@ -105,3 +76,38 @@ pub struct VidDisperse<V: VidScheme + ?Sized> {
     /// VID payload commitment.
     pub commit: V::Commit,
 }
+
+pub mod payload_prover;
+
+pub mod advz; // instantiation of `VidScheme`
+
+// BOILERPLATE: error handling
+
+/// The error type for `VidScheme` methods.
+#[derive(Display, Debug)]
+pub enum VidError {
+    /// invalid args: {0}
+    Argument(String),
+    /// internal error: {0}
+    Internal(anyhow::Error),
+}
+
+impl Error for VidError {}
+
+/// Convenience wrapper to convert any error into a [`VidError`].
+///
+/// Private fn so as not to expose error conversion API outside this crate
+/// as per [stackoverflow](https://stackoverflow.com/a/70057677).
+///
+/// # No-std support
+/// `no_std` mode requires `.map_err(vid)` to convert from a non-`anyhow` error
+/// as per [`anyhow` docs](https://docs.rs/anyhow/latest/anyhow/index.html#no-std-support),
+fn vid<E>(e: E) -> VidError
+where
+    E: ark_std::fmt::Display + Debug + Send + Sync + 'static,
+{
+    VidError::Internal(anyhow::anyhow!(e))
+}
+
+/// Convenience [`Result`] wrapper for [`VidError`].
+pub type VidResult<T> = Result<T, VidError>;