reduce errors

halo2_gadgets/src/ecc_opt.rs

@@ -1 +1,3 @@
+//! Optimized ECC gadgets.
+
 pub mod chip;

halo2_gadgets/src/sinsemilla.rs

@@ -647,8 +647,6 @@ pub(crate) mod tests {
             meta.enable_constant(constants);
 
             let table_idx = meta.lookup_table_column();
-            #[cfg(feature = "zsa")]
-            let table_range_check_tag = meta.lookup_table_column();
             let lagrange_coeffs = [
                 meta.fixed_column(),
                 meta.fixed_column(),

halo2_gadgets/src/sinsemilla/chip.rs

@@ -79,6 +79,8 @@ where
     F: FixedPoints<pallas::Affine>,
     Commit: CommitDomains<pallas::Affine, F, Hash>,
 {
+    /// The `LookupConfigType` associated type defines the configuration type used by
+    /// the implementing structure for lookup operations.
     type LookupConfigType;
 
     /// Returns a reference to the `SinsemillaConfigCommon` instance.
@@ -111,6 +113,7 @@ where
     /// Configures constraints in the constraint system `meta` using the value 'y_q'
     /// This function sets up various gates within the circuit to enforce the correct relationships
     /// between variables according to elliptic curve arithmetic and the Sinsemilla hash function.
+    #[allow(non_snake_case)]
     fn configure_from_y_q(&self, meta: &mut ConstraintSystem<pallas::Base>) {
         let two = pallas::Base::from(2);
 
@@ -230,12 +233,23 @@ where
     F: FixedPoints<pallas::Affine>,
     Commit: CommitDomains<pallas::Affine, F, Hash>,
 {
+    /// A type that holds any general chip state that needs to be loaded at the start of
+    /// [`Circuit::synthesize`]. This might simply be `()` for some chips.
     type Loaded;
-
+    /// The `RangeCheckConfigType` associated type defines the configuration type used by
+    /// the implementing structure for lookup range check operations.
     type RangeCheckConfigType;
+
+    /// The `SinsemillaConfigType` associated type defines the configuration type used by
+    /// the implementing structure for Sinsemilla hash operations.
     type SinsemillaConfigType: SinsemillaConfigProps<Hash, Commit, F>;
+
+    /// The `LookupType` defines the number of column used in implementation.
+    /// It is (TableColumn, TableColumn, TableColumn) in the Vanilla version
+    /// It is (TableColumn, TableColumn, TableColumn, TableColumn) in the Optimized version
     type LookupType;
 
+    /// Returns a reference to the `SinsemillaConfigCommon` instance.
     fn base(&self) -> &SinsemillaConfigCommon<Hash, Commit, F>;
 
     /// Reconstructs this chip from the given config.

halo2_gadgets/src/sinsemilla/chip/hash_to_point.rs

@@ -1,5 +1,5 @@
 use super::super::{CommitDomains, HashDomains, SinsemillaInstructions};
-use super::{NonIdentityEccPoint, SinsemillaChip, SinsemillaChipProps, SinsemillaConfigProps};
+use super::{NonIdentityEccPoint, SinsemillaChip};
 use crate::{
     ecc::FixedPoints,
     sinsemilla::primitives::{self as sinsemilla, lebs2ip_k, INV_TWO_POW_K, SINSEMILLA_S},
@@ -15,7 +15,6 @@ use group::ff::{PrimeField, PrimeFieldBits};
 use pasta_curves::{arithmetic::CurveAffine, pallas};
 
 use crate::sinsemilla::primitives::{K, S_PERSONALIZATION};
-use crate::utilities::lookup_range_check::LookupRangeCheck;
 use group::prime::PrimeCurveAffine;
 use group::Curve;
 use pasta_curves::arithmetic::CurveExt;
@@ -126,6 +125,9 @@ where
     /// [Specification](https://p.z.cash/halo2-0.1:sinsemilla-constraints?partial).
     #[allow(non_snake_case)]
     #[allow(clippy::type_complexity)]
+    /// TODO: remove this function, the first step is to remove hash_to_point_with_private_init in SinsemillaInstructions
+    /// How can we enable hash_to_point_with_private_init in SinsemillaInstructions for the optimized version,
+    /// while disabling hash_to_point_with_private_init in SinsemillaInstructions for the orchard version?
     pub(crate) fn hash_message_with_private_init(
         &self,
         region: &mut Region<'_, pallas::Base>,
@@ -150,6 +152,11 @@ where
     }
 
     #[allow(non_snake_case)]
+    /// Assign the coordinates of the initial public point `Q`
+    ///
+    /// | offset | x_A | q_sinsemilla4 | fixed_y_q |
+    /// --------------------------------------
+    /// |   0    | x_Q |   1           |   y_Q     |
     fn public_initialization_vanilla(
         &self,
         region: &mut Region<'_, pallas::Base>,
@@ -198,6 +205,7 @@ where
     /// --------------------------------------
     /// |   0    |     | y_Q |               |
     /// |   1    | x_Q |     |         1     |
+    /// TODO: remove this function, the first step is to remove hash_to_point_with_private_init in SinsemillaInstructions
     fn private_initialization(
         &self,
         region: &mut Region<'_, pallas::Base>,

halo2_gadgets/src/sinsemilla_opt.rs

@@ -1,2 +1,4 @@
+//! Optimized Sinsemilla gadgets.
+
 pub mod chip;
 pub mod merkle;

halo2_gadgets/src/utilities/cond_swap.rs

@@ -28,6 +28,8 @@ pub trait CondSwapInstructions<F: Field>: UtilitiesInstructions<F> {
         swap: Value<bool>,
     ) -> Result<(Self::Var, Self::Var), Error>;
 
+    /// Given an input `(choice, left, right)` where `choice` is a boolean flag,
+    /// returns `left` if `choice` is not set and `right` if `choice` is set.
     fn mux(
         &self,
         layouter: &mut impl Layouter<F>,

halo2_gadgets/src/utilities/lookup_range_check.rs

@@ -328,8 +328,8 @@ impl<F: PrimeFieldBits, const K: usize> LookupRangeCheck<F, K> for LookupRangeCh
 
             // In the short range check, the word is directly witnessed.
             let short_lookup = {
-                let short_word = z_cur.clone();
-                let q_short = one.clone() - q_running;
+                let short_word = z_cur;
+                let q_short = one - q_running;
 
                 q_short * short_word
             };

halo2_gadgets/src/utilities_opt.rs

@@ -1,4 +1,5 @@
-//! Utility gadgets.
-// TODO: after ecc_opt
+//! Optimized Utility gadgets.
+//!
+// TODO: cond_swap after ecc_opt
 //pub mod cond_swap;
 pub mod lookup_range_check;