Circuit tools

gadgets/src/util.rs

@@ -138,6 +138,63 @@ pub mod select {
     }
 }
 
+/// Returns the power of number using straigtforward multiplications
+pub mod pow {
+    use crate::util::Expr;
+    use eth_types::Field;
+    use halo2_proofs::plonk::Expression;
+
+    use super::Scalar;
+
+    /// Returns the `when_true` expression when the selector is true, else
+    /// returns the `when_false` expression.
+    pub fn expr<F: Field>(value: Expression<F>, exponent: usize) -> Expression<F> {
+        let mut result = 1.expr();
+        for _ in 0..exponent {
+            result = result * value.expr();
+        }
+        result
+    }
+
+    /// Returns the `when_true` value when the selector is true, else returns
+    /// the `when_false` value.
+    pub fn value<F: Field>(value: F, exponent: usize) -> F {
+        let mut result = 1.scalar();
+        for _ in 0..exponent {
+            result *= value;
+        }
+        result
+    }
+}
+
+/// Trait that implements functionality to get a scalar from
+/// commonly used types.
+pub trait Scalar<F: Field> {
+    /// Returns a scalar for the type.
+    fn scalar(&self) -> F;
+}
+
+/// Implementation trait `Scalar` for type able to be casted to u64
+#[macro_export]
+macro_rules! impl_scalar {
+    ($type:ty) => {
+        impl<F: eth_types::Field> $crate::util::Scalar<F> for $type {
+            #[inline]
+            fn scalar(&self) -> F {
+                F::from(*self as u64)
+            }
+        }
+    };
+    ($type:ty, $method:path) => {
+        impl<F: eth_types::Field> $crate::util::Scalar<F> for $type {
+            #[inline]
+            fn scalar(&self) -> F {
+                F::from($method(self) as u64)
+            }
+        }
+    };
+}
+
 /// Trait that implements functionality to get a constant expression from
 /// commonly used types.
 pub trait Expr<F: Field> {
@@ -149,6 +206,7 @@ pub trait Expr<F: Field> {
 #[macro_export]
 macro_rules! impl_expr {
     ($type:ty) => {
+        $crate::impl_scalar!($type);
         impl<F: eth_types::Field> $crate::util::Expr<F> for $type {
             #[inline]
             fn expr(&self) -> Expression<F> {
@@ -157,6 +215,7 @@ macro_rules! impl_expr {
         }
     };
     ($type:ty, $method:path) => {
+        $crate::impl_scalar!($type, $method);
         impl<F: eth_types::Field> $crate::util::Expr<F> for $type {
             #[inline]
             fn expr(&self) -> Expression<F> {
@@ -170,28 +229,41 @@ impl_expr!(bool);
 impl_expr!(u8);
 impl_expr!(u64);
 impl_expr!(usize);
+impl_expr!(isize);
 impl_expr!(OpcodeId, OpcodeId::as_u8);
 
-impl<F: Field> Expr<F> for Expression<F> {
+impl<F: Field> Scalar<F> for i32 {
+    #[inline]
+    fn scalar(&self) -> F {
+        F::from(self.unsigned_abs() as u64) * if self.is_negative() { -F::ONE } else { F::ONE }
+    }
+}
+
+impl<F: Field> Scalar<F> for &F {
+    #[inline]
+    fn scalar(&self) -> F {
+        *(*self)
+    }
+}
+
+impl<F: Field> Expr<F> for i32 {
     #[inline]
     fn expr(&self) -> Expression<F> {
-        self.clone()
+        Expression::Constant(self.scalar())
     }
 }
 
-impl<F: Field> Expr<F> for &Expression<F> {
+impl<F: Field> Expr<F> for Expression<F> {
     #[inline]
     fn expr(&self) -> Expression<F> {
-        (*self).clone()
+        self.clone()
     }
 }
 
-impl<F: Field> Expr<F> for i32 {
+impl<F: Field> Expr<F> for &Expression<F> {
     #[inline]
     fn expr(&self) -> Expression<F> {
-        Expression::Constant(
-            F::from(self.unsigned_abs() as u64) * if self.is_negative() { -F::ONE } else { F::ONE },
-        )
+        (*self).clone()
     }
 }
 

zkevm-circuits/Cargo.toml

@@ -35,6 +35,7 @@ num-bigint = { version = "0.4" }
 rand_chacha = "0.3"
 snark-verifier = { git = "https://github.com/privacy-scaling-explorations/snark-verifier", tag = "v2023_04_20", default-features = false, features = ["loader_halo2", "system_halo2"] }
 cli-table = { version = "0.4", optional = true }
+num_enum = "0.5.7"
 
 [dev-dependencies]
 bus-mapping = { path = "../bus-mapping", features = ["test"] }

zkevm-circuits/src/bytecode_circuit/dev.rs

@@ -51,6 +51,7 @@ impl<F: Field> Circuit<F> for BytecodeCircuit<F> {
             &mut layouter,
             self.bytecodes.iter().map(|b| &b.bytes),
             &challenges,
+            true,
         )?;
         self.synthesize_sub(&config, &challenges, &mut layouter)?;
         Ok(())

zkevm-circuits/src/circuit_tools.rs

@@ -0,0 +1,8 @@
+//! Circuit utilities
+#![allow(missing_docs)]
+#[macro_use]
+pub mod constraint_builder;
+pub mod cached_region;
+pub mod cell_manager;
+pub mod gadgets;
+pub mod memory;