Browse Source

open source under MIT license

main
Charles Lu 1 year ago
parent
commit
22d9a191f7
48 changed files with 277 additions and 27 deletions
  1. +21
    -0
      LICENSE
  2. +6
    -0
      arithmetic/benches/bench.rs
  3. +6
    -0
      arithmetic/src/errors.rs
  4. +6
    -0
      arithmetic/src/lib.rs
  5. +6
    -0
      arithmetic/src/multilinear_polynomial.rs
  6. +6
    -0
      arithmetic/src/univariate_polynomial.rs
  7. +6
    -0
      arithmetic/src/util.rs
  8. +6
    -0
      arithmetic/src/virtual_polynomial.rs
  9. +6
    -0
      hyperplonk/benches/bench.rs
  10. +6
    -0
      hyperplonk/src/custom_gate.rs
  11. +6
    -0
      hyperplonk/src/errors.rs
  12. +6
    -0
      hyperplonk/src/lib.rs
  13. +6
    -0
      hyperplonk/src/mock.rs
  14. +6
    -0
      hyperplonk/src/prelude.rs
  15. +6
    -0
      hyperplonk/src/selectors.rs
  16. +6
    -0
      hyperplonk/src/snark.rs
  17. +6
    -0
      hyperplonk/src/structs.rs
  18. +6
    -0
      hyperplonk/src/utils.rs
  19. +6
    -0
      hyperplonk/src/witness.rs
  20. +6
    -0
      subroutines/benches/iop_bench.rs
  21. +6
    -0
      subroutines/benches/pcs_bench.rs
  22. +6
    -0
      subroutines/src/lib.rs
  23. +3
    -3
      subroutines/src/pcs/errors.rs
  24. +6
    -0
      subroutines/src/pcs/mod.rs
  25. +6
    -0
      subroutines/src/pcs/multilinear_kzg/batching.rs
  26. +3
    -3
      subroutines/src/pcs/multilinear_kzg/mod.rs
  27. +3
    -3
      subroutines/src/pcs/multilinear_kzg/srs.rs
  28. +3
    -3
      subroutines/src/pcs/multilinear_kzg/util.rs
  29. +3
    -3
      subroutines/src/pcs/prelude.rs
  30. +3
    -3
      subroutines/src/pcs/structs.rs
  31. +3
    -3
      subroutines/src/pcs/univariate_kzg/mod.rs
  32. +3
    -3
      subroutines/src/pcs/univariate_kzg/srs.rs
  33. +6
    -0
      subroutines/src/poly_iop/errors.rs
  34. +6
    -0
      subroutines/src/poly_iop/mod.rs
  35. +6
    -0
      subroutines/src/poly_iop/perm_check/mod.rs
  36. +6
    -0
      subroutines/src/poly_iop/perm_check/util.rs
  37. +6
    -0
      subroutines/src/poly_iop/prelude.rs
  38. +6
    -0
      subroutines/src/poly_iop/prod_check/mod.rs
  39. +6
    -0
      subroutines/src/poly_iop/prod_check/util.rs
  40. +6
    -0
      subroutines/src/poly_iop/structs.rs
  41. +6
    -0
      subroutines/src/poly_iop/sum_check/mod.rs
  42. +6
    -0
      subroutines/src/poly_iop/sum_check/prover.rs
  43. +6
    -0
      subroutines/src/poly_iop/sum_check/verifier.rs
  44. +6
    -0
      subroutines/src/poly_iop/utils.rs
  45. +6
    -0
      subroutines/src/poly_iop/zero_check/mod.rs
  46. +6
    -0
      transcript/src/errors.rs
  47. +6
    -0
      transcript/src/lib.rs
  48. +4
    -3
      util/src/lib.rs

+ 21
- 0
LICENSE

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2022 Espresso Systems (espressosys.com)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

+ 6
- 0
arithmetic/benches/bench.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
#[macro_use] #[macro_use]
extern crate criterion; extern crate criterion;

+ 6
- 0
arithmetic/src/errors.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Error module. //! Error module.
use ark_std::string::String; use ark_std::string::String;

+ 6
- 0
arithmetic/src/lib.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
mod errors; mod errors;
mod multilinear_polynomial; mod multilinear_polynomial;
mod univariate_polynomial; mod univariate_polynomial;

+ 6
- 0
arithmetic/src/multilinear_polynomial.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
use crate::{util::get_batched_nv, ArithErrors}; use crate::{util::get_batched_nv, ArithErrors};
use ark_ff::{Field, PrimeField}; use ark_ff::{Field, PrimeField};
use ark_poly::MultilinearExtension; use ark_poly::MultilinearExtension;

+ 6
- 0
arithmetic/src/univariate_polynomial.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
// TODO: remove // TODO: remove
#![allow(dead_code)] #![allow(dead_code)]

+ 6
- 0
arithmetic/src/util.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
use ark_ff::PrimeField; use ark_ff::PrimeField;
use ark_std::log2; use ark_std::log2;

+ 6
- 0
arithmetic/src/virtual_polynomial.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! This module defines our main mathematical object `VirtualPolynomial`; and //! This module defines our main mathematical object `VirtualPolynomial`; and
//! various functions associated with it. //! various functions associated with it.

+ 6
- 0
hyperplonk/benches/bench.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
use std::{fs::File, io, time::Instant}; use std::{fs::File, io, time::Instant};
use ark_bls12_381::{Bls12_381, Fr}; use ark_bls12_381::{Bls12_381, Fr};

+ 6
- 0
hyperplonk/src/custom_gate.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
use ark_std::cmp::max; use ark_std::cmp::max;
/// Customized gate is a list of tuples of /// Customized gate is a list of tuples of

+ 6
- 0
hyperplonk/src/errors.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Error module. //! Error module.
use arithmetic::ArithErrors; use arithmetic::ArithErrors;

+ 6
- 0
hyperplonk/src/lib.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Main module for the HyperPlonk SNARK. //! Main module for the HyperPlonk SNARK.
use ark_ec::PairingEngine; use ark_ec::PairingEngine;

+ 6
- 0
hyperplonk/src/mock.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
use arithmetic::identity_permutation; use arithmetic::identity_permutation;
use ark_ff::PrimeField; use ark_ff::PrimeField;
use ark_std::{log2, test_rng}; use ark_std::{log2, test_rng};

+ 6
- 0
hyperplonk/src/prelude.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
pub use crate::{ pub use crate::{
custom_gate::CustomizedGates, errors::HyperPlonkErrors, mock::MockCircuit, custom_gate::CustomizedGates, errors::HyperPlonkErrors, mock::MockCircuit,
selectors::SelectorColumn, witness::WitnessColumn, HyperPlonkSNARK, selectors::SelectorColumn, witness::WitnessColumn, HyperPlonkSNARK,

+ 6
- 0
hyperplonk/src/selectors.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
use crate::{build_mle, errors::HyperPlonkErrors}; use crate::{build_mle, errors::HyperPlonkErrors};
use ark_ff::PrimeField; use ark_ff::PrimeField;
use ark_poly::DenseMultilinearExtension; use ark_poly::DenseMultilinearExtension;

+ 6
- 0
hyperplonk/src/snark.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
use crate::{ use crate::{
errors::HyperPlonkErrors, errors::HyperPlonkErrors,
structs::{HyperPlonkIndex, HyperPlonkProof, HyperPlonkProvingKey, HyperPlonkVerifyingKey}, structs::{HyperPlonkIndex, HyperPlonkProof, HyperPlonkProvingKey, HyperPlonkVerifyingKey},

+ 6
- 0
hyperplonk/src/structs.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Main module for the HyperPlonk PolyIOP. //! Main module for the HyperPlonk PolyIOP.
use crate::{custom_gate::CustomizedGates, prelude::HyperPlonkErrors, selectors::SelectorColumn}; use crate::{custom_gate::CustomizedGates, prelude::HyperPlonkErrors, selectors::SelectorColumn};

+ 6
- 0
hyperplonk/src/utils.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
use crate::{ use crate::{
custom_gate::CustomizedGates, errors::HyperPlonkErrors, structs::HyperPlonkParams, custom_gate::CustomizedGates, errors::HyperPlonkErrors, structs::HyperPlonkParams,
witness::WitnessColumn, witness::WitnessColumn,

+ 6
- 0
hyperplonk/src/witness.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
use crate::{build_mle, errors::HyperPlonkErrors}; use crate::{build_mle, errors::HyperPlonkErrors};
use ark_ff::PrimeField; use ark_ff::PrimeField;
use ark_poly::DenseMultilinearExtension; use ark_poly::DenseMultilinearExtension;

+ 6
- 0
subroutines/benches/iop_bench.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
use arithmetic::{identity_permutation_mles, VPAuxInfo, VirtualPolynomial}; use arithmetic::{identity_permutation_mles, VPAuxInfo, VirtualPolynomial};
use ark_bls12_381::{Bls12_381, Fr}; use ark_bls12_381::{Bls12_381, Fr};
use ark_poly::{DenseMultilinearExtension, MultilinearExtension}; use ark_poly::{DenseMultilinearExtension, MultilinearExtension};

+ 6
- 0
subroutines/benches/pcs_bench.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
use ark_bls12_381::{Bls12_381, Fr}; use ark_bls12_381::{Bls12_381, Fr};
use ark_ff::UniformRand; use ark_ff::UniformRand;
use ark_poly::{DenseMultilinearExtension, MultilinearExtension}; use ark_poly::{DenseMultilinearExtension, MultilinearExtension};

+ 6
- 0
subroutines/src/lib.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
pub mod pcs; pub mod pcs;
pub mod poly_iop; pub mod poly_iop;

+ 3
- 3
subroutines/src/pcs/errors.rs

@ -1,8 +1,8 @@
// Copyright (c) 2022 Espresso Systems (espressosys.com)
// This file is part of the Jellyfish library.
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License // You should have received a copy of the MIT License
// along with the Jellyfish library. If not, see <https://mit-license.org/>.
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Error module. //! Error module.

+ 6
- 0
subroutines/src/pcs/mod.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
mod errors; mod errors;
mod multilinear_kzg; mod multilinear_kzg;
mod structs; mod structs;

+ 6
- 0
subroutines/src/pcs/multilinear_kzg/batching.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Sumcheck based batch opening and verify commitment. //! Sumcheck based batch opening and verify commitment.
// TODO: refactoring this code to somewhere else // TODO: refactoring this code to somewhere else
// currently IOP depends on PCS because perm check requires commitment. // currently IOP depends on PCS because perm check requires commitment.

+ 3
- 3
subroutines/src/pcs/multilinear_kzg/mod.rs

@ -1,8 +1,8 @@
// Copyright (c) 2022 Espresso Systems (espressosys.com)
// This file is part of the Jellyfish library.
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License // You should have received a copy of the MIT License
// along with the Jellyfish library. If not, see <https://mit-license.org/>.
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Main module for multilinear KZG commitment scheme //! Main module for multilinear KZG commitment scheme

+ 3
- 3
subroutines/src/pcs/multilinear_kzg/srs.rs

@ -1,8 +1,8 @@
// Copyright (c) 2022 Espresso Systems (espressosys.com)
// This file is part of the Jellyfish library.
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License // You should have received a copy of the MIT License
// along with the Jellyfish library. If not, see <https://mit-license.org/>.
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Implementing Structured Reference Strings for multilinear polynomial KZG //! Implementing Structured Reference Strings for multilinear polynomial KZG
use crate::pcs::{ use crate::pcs::{

+ 3
- 3
subroutines/src/pcs/multilinear_kzg/util.rs

@ -1,8 +1,8 @@
// Copyright (c) 2022 Espresso Systems (espressosys.com)
// This file is part of the Jellyfish library.
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License // You should have received a copy of the MIT License
// along with the Jellyfish library. If not, see <https://mit-license.org/>.
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Useful utilities for KZG PCS //! Useful utilities for KZG PCS
use ark_ff::PrimeField; use ark_ff::PrimeField;

+ 3
- 3
subroutines/src/pcs/prelude.rs

@ -1,8 +1,8 @@
// Copyright (c) 2022 Espresso Systems (espressosys.com)
// This file is part of the Jellyfish library.
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License // You should have received a copy of the MIT License
// along with the Jellyfish library. If not, see <https://mit-license.org/>.
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Prelude //! Prelude
pub use crate::pcs::{ pub use crate::pcs::{

+ 3
- 3
subroutines/src/pcs/structs.rs

@ -1,8 +1,8 @@
// Copyright (c) 2022 Espresso Systems (espressosys.com)
// This file is part of the Jellyfish library.
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License // You should have received a copy of the MIT License
// along with the Jellyfish library. If not, see <https://mit-license.org/>.
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
use ark_ec::PairingEngine; use ark_ec::PairingEngine;
use ark_serialize::{CanonicalDeserialize, CanonicalSerialize, Read, SerializationError, Write}; use ark_serialize::{CanonicalDeserialize, CanonicalSerialize, Read, SerializationError, Write};

+ 3
- 3
subroutines/src/pcs/univariate_kzg/mod.rs

@ -1,8 +1,8 @@
// Copyright (c) 2022 Espresso Systems (espressosys.com)
// This file is part of the Jellyfish library.
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License // You should have received a copy of the MIT License
// along with the Jellyfish library. If not, see <https://mit-license.org/>.
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Main module for univariate KZG commitment scheme //! Main module for univariate KZG commitment scheme

+ 3
- 3
subroutines/src/pcs/univariate_kzg/srs.rs

@ -1,8 +1,8 @@
// Copyright (c) 2022 Espresso Systems (espressosys.com)
// This file is part of the Jellyfish library.
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License // You should have received a copy of the MIT License
// along with the Jellyfish library. If not, see <https://mit-license.org/>.
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Implementing Structured Reference Strings for univariate polynomial KZG //! Implementing Structured Reference Strings for univariate polynomial KZG

+ 6
- 0
subroutines/src/poly_iop/errors.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Error module. //! Error module.
use crate::pcs::prelude::PCSError; use crate::pcs::prelude::PCSError;

+ 6
- 0
subroutines/src/poly_iop/mod.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
use ark_ff::PrimeField; use ark_ff::PrimeField;
use std::marker::PhantomData; use std::marker::PhantomData;

+ 6
- 0
subroutines/src/poly_iop/perm_check/mod.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Main module for the Permutation Check protocol //! Main module for the Permutation Check protocol
use self::util::computer_nums_and_denoms; use self::util::computer_nums_and_denoms;

+ 6
- 0
subroutines/src/poly_iop/perm_check/util.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! This module implements useful functions for the permutation check protocol. //! This module implements useful functions for the permutation check protocol.
use crate::poly_iop::errors::PolyIOPErrors; use crate::poly_iop::errors::PolyIOPErrors;

+ 6
- 0
subroutines/src/poly_iop/prelude.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
pub use crate::poly_iop::{ pub use crate::poly_iop::{
errors::PolyIOPErrors, perm_check::PermutationCheck, prod_check::ProductCheck, errors::PolyIOPErrors, perm_check::PermutationCheck, prod_check::ProductCheck,
structs::IOPProof, sum_check::SumCheck, utils::*, zero_check::ZeroCheck, PolyIOP, structs::IOPProof, sum_check::SumCheck, utils::*, zero_check::ZeroCheck, PolyIOP,

+ 6
- 0
subroutines/src/poly_iop/prod_check/mod.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Main module for the Product Check protocol //! Main module for the Product Check protocol
use crate::{ use crate::{

+ 6
- 0
subroutines/src/poly_iop/prod_check/util.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! This module implements useful functions for the product check protocol. //! This module implements useful functions for the product check protocol.
use crate::poly_iop::{errors::PolyIOPErrors, structs::IOPProof, zero_check::ZeroCheck, PolyIOP}; use crate::poly_iop::{errors::PolyIOPErrors, structs::IOPProof, zero_check::ZeroCheck, PolyIOP};

+ 6
- 0
subroutines/src/poly_iop/structs.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! This module defines structs that are shared by all sub protocols. //! This module defines structs that are shared by all sub protocols.
use arithmetic::VirtualPolynomial; use arithmetic::VirtualPolynomial;

+ 6
- 0
subroutines/src/poly_iop/sum_check/mod.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! This module implements the sum check protocol. //! This module implements the sum check protocol.
use crate::poly_iop::{ use crate::poly_iop::{

+ 6
- 0
subroutines/src/poly_iop/sum_check/prover.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Prover subroutines for a SumCheck protocol. //! Prover subroutines for a SumCheck protocol.
use super::SumCheckProver; use super::SumCheckProver;

+ 6
- 0
subroutines/src/poly_iop/sum_check/verifier.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Verifier subroutines for a SumCheck protocol. //! Verifier subroutines for a SumCheck protocol.
use super::{SumCheckSubClaim, SumCheckVerifier}; use super::{SumCheckSubClaim, SumCheckVerifier};

+ 6
- 0
subroutines/src/poly_iop/utils.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! useful macros. //! useful macros.
/// Takes as input a struct, and converts them to a series of bytes. All traits /// Takes as input a struct, and converts them to a series of bytes. All traits

+ 6
- 0
subroutines/src/poly_iop/zero_check/mod.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Main module for the ZeroCheck protocol. //! Main module for the ZeroCheck protocol.
use std::fmt::Debug; use std::fmt::Debug;

+ 6
- 0
transcript/src/errors.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Error module. //! Error module.
use ark_std::string::String; use ark_std::string::String;

+ 6
- 0
transcript/src/lib.rs

@ -1,3 +1,9 @@
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Module for PolyIOP transcript. //! Module for PolyIOP transcript.
//! TODO(ZZ): move this module to HyperPlonk where the transcript will also be //! TODO(ZZ): move this module to HyperPlonk where the transcript will also be
//! useful. //! useful.

+ 4
- 3
util/src/lib.rs

@ -1,7 +1,8 @@
// Copyright (c) 2022 Espresso Systems (espressosys.com)
// This file is part of the Jellyfish library.
// Copyright (c) 2023 Espresso Systems (espressosys.com)
// This file is part of the HyperPlonk library.
// You should have received a copy of the MIT License // You should have received a copy of the MIT License
// along with the Jellyfish library. If not, see <https://mit-license.org/>.
// along with the HyperPlonk library. If not, see <https://mit-license.org/>.
//! Utilities for parallel code. //! Utilities for parallel code.

Loading…
Cancel
Save