feat: Add feature gating for halo2 imports in SDK and CLI crates (#1731)

devin-ai-integration[bot] · jonathanpwang · web-flow · commit 1c4a696a038a · 2025-06-14T14:16:42.000-07:00
## Feature Gating for Halo2 Imports - INT-4112 This PR implements feature gating for all halo2 imports in the openvm-sdk and openvm-cli crates, making EVM proving/verification capabilities optional. This allows users who only need STARK functionality to compile without pulling in halo2 dependencies, improving compile times and reducing binary size. ### Changes Made #### SDK Dependencies (crates/sdk/Cargo.toml) - Made `snark-verifier` and `snark-verifier-sdk` optional dependencies - Removed forced `static-verifier` feature from `openvm-native-recursion` - Updated `evm-prove` feature definition to properly include halo2 dependencies: - `openvm-native-recursion/evm-prove` - `openvm-native-recursion/static-verifier` - `dep:snark-verifier` - `dep:snark-verifier-sdk` #### Feature Gating in SDK Source Files - **lib.rs**: Added `#[cfg(any(feature = "evm-prove", feature = "evm-verify"))]` to `agg_keygen` function - **keygen/mod.rs**: Feature-gated `Halo2ProvingKey` struct and related imports, added conditional compilation to `AggProvingKey.halo2_pk` field - **keygen/static_verifier.rs**: Feature-gated entire module with halo2-related functionality - **types.rs**: Added feature gates to all EVM-related types (`EvmHalo2Verifier`, `EvmProof`, etc.) - **fs.rs**: Feature-gated halo2 file I/O functions and imports #### CLI Updates (crates/cli/Cargo.toml) - Removed `evm-verify` from default features - Default features now: `["parallel", "jemalloc", "bench-metrics"]` #### CLI Source Updates (crates/cli/src/util.rs) - Feature-gated `read_agg_halo2_pk_from_file` import - Feature-gated `read_default_agg_pk()` function ### Verification All compilation scenarios have been tested and pass successfully: **SDK Crate:** - ✅ `cargo check --no-default-features` (STARK-only compilation) - ✅ `cargo check --features evm-prove` (EVM proving enabled) - ✅ `cargo check --features evm-verify` (EVM verification enabled) **CLI Crate:** - ✅ `cargo check --no-default-features` (STARK-only compilation) - ✅ `cargo check --features evm-verify` (EVM verification enabled) ### Impact - **STARK-only users**: Can now compile without halo2 dependencies, resulting in faster compile times and smaller binaries - **EVM users**: No breaking changes - existing functionality remains available when EVM features are enabled - **Backward compatibility**: Maintained through proper feature flag design ### Link to Devin run https://app.devin.ai/sessions/8bb6a0cf896e4b98972d872fffcb68bd **Requested by:** Jonathan Wang --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Jonathan Wang <jpw@intrinsictech.xyz> Co-authored-by: Jonathan Wang <31040440+jonathanpwang@users.noreply.github.com>
diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml
@@ -82,6 +82,9 @@ jobs:
           else
             RUN_E2E=${{ github.event.inputs.run-benchmark-e2e || 'false' }}
           fi
+          if [[ "$RUN_E2E" == "true" ]]; then
+            FEATURE_FLAGS="evm,${FEATURE_FLAGS}"
+          fi
           if [[ "${{ github.event.inputs.aggregation }}" == "true" ]]; then
             FEATURE_FLAGS="aggregation,${FEATURE_FLAGS}"
           fi
diff --git a/.github/workflows/sdk.yml b/.github/workflows/sdk.yml
@@ -96,5 +96,4 @@ jobs:
         working-directory: crates/sdk
         run: |
           export RUST_BACKTRACE=1
-          cargo nextest run --cargo-profile=fast --test-threads=2 --features parallel
-
+          cargo nextest run --cargo-profile=fast --test-threads=2 --features parallel,evm-verify
diff --git a/benchmarks/guest/kitchen-sink/Cargo.toml b/benchmarks/guest/kitchen-sink/Cargo.toml
@@ -9,18 +9,16 @@ openvm = { path = "../../../crates/toolchain/openvm", default-features = false,
     "std",
 ] }
 openvm-algebra-guest = { path = "../../../extensions/algebra/guest", default-features = false }
-openvm-ecc-guest = { path = "../../../extensions/ecc/guest", default-features = false, features = [
-    "k256",
-    "p256",
-] }
-openvm-pairing-guest = { path = "../../../extensions/pairing/guest", default-features = false, features = [
+openvm-ecc-guest = { path = "../../../extensions/ecc/guest", default-features = false }
+openvm-pairing = { path = "../../../guest-libs/pairing/", features = [
     "bn254",
     "bls12_381",
 ] }
-openvm-pairing = { path = "../../../guest-libs/pairing/", features = ["bn254", "bls12_381"] }
 openvm-keccak256 = { path = "../../../guest-libs/keccak256/", default-features = false }
 openvm-sha2 = { path = "../../../guest-libs/sha2/", default-features = false }
-openvm-ruint = { path = "../../../guest-libs/ruint/", default-features = false }
+openvm-k256 = { path = "../../../guest-libs/k256/", package = "k256" }
+openvm-p256 = { path = "../../../guest-libs/p256/", package = "p256" }
+openvm-ruint = { path = "../../../guest-libs/ruint/", package = "ruint", default-features = false }
 hex = { version = "0.4.3", default-features = false, features = ["alloc"] }
 serde = "1.0"
 
diff --git a/benchmarks/guest/kitchen-sink/src/main.rs b/benchmarks/guest/kitchen-sink/src/main.rs
@@ -1,3 +1,5 @@
+extern crate alloc;
+
 use std::hint::black_box;
 
 use openvm_algebra_guest::IntMod;
@@ -6,20 +8,17 @@ use openvm_ruint::aliases::U256;
 use openvm_sha2::sha256;
 #[allow(unused_imports)]
 use {
-    openvm_ecc_guest::{
-        k256::{Secp256k1Coord, Secp256k1Point, Secp256k1Scalar},
-        p256::{P256Coord, P256Point, P256Scalar},
-        weierstrass::WeierstrassPoint,
-        CyclicGroup,
-    },
+    openvm_ecc_guest::{weierstrass::WeierstrassPoint, CyclicGroup},
+    openvm_k256::{Secp256k1Coord, Secp256k1Point, Secp256k1Scalar},
+    openvm_p256::{P256Coord, P256Point, P256Scalar},
     openvm_pairing::{
         bls12_381::{
             Bls12_381Fp, Bls12_381Fp2, Bls12_381G1Affine, Bls12_381Scalar,
             G2Affine as Bls12_381G2Affine,
         },
         bn254::{Bn254, Bn254Fp, Bn254Fp2, Bn254G1Affine, Bn254Scalar, G2Affine as Bn254G2Affine},
+        PairingCheck,
     },
-    openvm_pairing_guest::pairing::PairingCheck,
 };
 
 // Note: these will all currently be represented as bytes32 even though they could be smaller
diff --git a/benchmarks/prove/Cargo.toml b/benchmarks/prove/Cargo.toml
@@ -10,7 +10,7 @@ license.workspace = true
 [dependencies]
 openvm-benchmarks-utils.workspace = true
 openvm-circuit.workspace = true
-openvm-sdk = { workspace = true, features = ["evm-verify"] }
+openvm-sdk.workspace = true
 openvm-stark-backend.workspace = true
 openvm-stark-sdk.workspace = true
 openvm-transpiler.workspace = true
@@ -44,14 +44,27 @@ tracing.workspace = true
 
 [features]
 default = ["parallel", "jemalloc", "bench-metrics"]
-bench-metrics = ["openvm-native-recursion/bench-metrics"]
+bench-metrics = ["openvm-sdk/bench-metrics"]
 profiling = ["openvm-sdk/profiling"]
-aggregation = []
-parallel = ["openvm-native-recursion/parallel"]
-mimalloc = ["openvm-circuit/mimalloc"]
-jemalloc = ["openvm-circuit/jemalloc"]
-jemalloc-prof = ["openvm-circuit/jemalloc-prof"]
-nightly-features = ["openvm-circuit/nightly-features"]
+aggregation = []                                    # runs leaf aggregation benchmarks
+evm = ["openvm-sdk/evm-verify"]
+parallel = ["openvm-sdk/parallel"]
+mimalloc = ["openvm-sdk/mimalloc"]
+jemalloc = ["openvm-sdk/jemalloc"]
+jemalloc-prof = ["openvm-sdk/jemalloc-prof"]
+nightly-features = ["openvm-sdk/nightly-features"]
 
 [package.metadata.cargo-shear]
 ignored = ["derive_more"]
+
+[[bin]]
+name = "fib_e2e"
+path = "src/bin/fib_e2e.rs"
+# TODO: cfg run benchmark with prove stark if no evm feature
+required-features = ["evm"]
+
+[[bin]]
+name = "kitchen_sink"
+path = "src/bin/kitchen_sink.rs"
+# TODO: cfg run benchmark with prove stark if no evm feature
+required-features = ["evm"]
diff --git a/ci/scripts/bench.py b/ci/scripts/bench.py
@@ -17,7 +17,7 @@ def run_cargo_command(
 ):
     # Command to run (for best performance but slower builds, use --profile maxperf)
     command = [
-        "cargo", "run", "--no-default-features", "--bin", bin_name, "--profile", profile, "--features", ",".join(feature_flags), "--"
+        "cargo", "run", "--no-default-features", "-p", "openvm-benchmarks-prove", "--bin", bin_name, "--profile", profile, "--features", ",".join(feature_flags), "--"
     ]
 
     if app_log_blowup is not None:
diff --git a/crates/cli/src/util.rs b/crates/cli/src/util.rs
@@ -5,19 +5,14 @@ use std::{
 
 use eyre::Result;
 use openvm_build::{get_in_scope_packages, get_workspace_packages};
-use openvm_sdk::{
-    config::{AppConfig, SdkVmConfig},
-    fs::{read_agg_halo2_pk_from_file, read_agg_stark_pk_from_file},
-    keygen::AggProvingKey,
-};
+use openvm_sdk::config::{AppConfig, SdkVmConfig};
+#[cfg(feature = "evm-prove")]
+use openvm_sdk::{fs::read_agg_stark_pk_from_file, keygen::AggProvingKey};
 use serde::de::DeserializeOwned;
 
 use crate::{
     commands::RunCargoArgs,
-    default::{
-        default_agg_halo2_pk_path, default_agg_stark_pk_path, default_app_config,
-        DEFAULT_APP_PK_NAME, DEFAULT_APP_VK_NAME,
-    },
+    default::{default_app_config, DEFAULT_APP_PK_NAME, DEFAULT_APP_VK_NAME},
 };
 
 pub(crate) fn read_to_struct_toml<T: DeserializeOwned>(path: impl AsRef<Path>) -> Result<T> {
@@ -38,9 +33,11 @@ pub fn read_config_toml_or_default(config: impl AsRef<Path>) -> Result<AppConfig
     }
 }
 
+#[cfg(feature = "evm-prove")]
 pub fn read_default_agg_pk() -> Result<AggProvingKey> {
-    let agg_stark_pk = read_agg_stark_pk_from_file(default_agg_stark_pk_path())?;
-    let halo2_pk = read_agg_halo2_pk_from_file(default_agg_halo2_pk_path())?;
+    let agg_stark_pk = read_agg_stark_pk_from_file(crate::default::default_agg_stark_pk_path())?;
+    let halo2_pk =
+        openvm_sdk::fs::read_agg_halo2_pk_from_file(crate::default::default_agg_halo2_pk_path())?;
     Ok(AggProvingKey {
         agg_stark_pk,
         halo2_pk,
diff --git a/crates/continuations/Cargo.toml b/crates/continuations/Cargo.toml
@@ -8,17 +8,18 @@ repository.workspace = true
 license.workspace = true
 
 [dependencies]
-openvm-native-compiler = { workspace = true }
-openvm-native-recursion = { workspace = true, features = ["static-verifier"] }
-openvm-stark-backend = { workspace = true }
-openvm-stark-sdk = { workspace = true }
-openvm-circuit = { workspace = true }
+openvm-native-compiler.workspace = true
+openvm-native-recursion.workspace = true
+openvm-stark-backend.workspace = true
+openvm-stark-sdk.workspace = true
+openvm-circuit.workspace = true
 
-derivative = { workspace = true }
-serde = { workspace = true }
+derivative.workspace = true
+serde.workspace = true
 static_assertions.workspace = true
 
 [features]
 default = ["parallel"]
 parallel = ["openvm-circuit/parallel"]
+static-verifier = ["openvm-native-recursion/static-verifier"]
 test-utils = ["openvm-circuit/test-utils"]
diff --git a/crates/continuations/src/lib.rs b/crates/continuations/src/lib.rs
@@ -7,6 +7,7 @@ use openvm_stark_sdk::{
     p3_baby_bear::BabyBear,
 };
 
+#[cfg(feature = "static-verifier")]
 pub mod static_verifier;
 pub mod verifier;
 
diff --git a/crates/sdk/Cargo.toml b/crates/sdk/Cargo.toml
@@ -24,7 +24,7 @@ openvm-pairing-circuit = { workspace = true }
 openvm-pairing-transpiler = { workspace = true }
 openvm-native-circuit = { workspace = true }
 openvm-native-compiler = { workspace = true }
-openvm-native-recursion = { workspace = true, features = ["static-verifier"] }
+openvm-native-recursion = { workspace = true }
 openvm-native-transpiler = { workspace = true }
 openvm-rv32im-circuit = { workspace = true }
 openvm-rv32im-transpiler = { workspace = true }
@@ -51,17 +51,22 @@ clap = { workspace = true, features = ["derive"] }
 serde_with = { workspace = true, features = ["hex"] }
 serde_json.workspace = true
 thiserror.workspace = true
-snark-verifier = { workspace = true }
-snark-verifier-sdk.workspace = true
+snark-verifier = { workspace = true, optional = true }
+snark-verifier-sdk = { workspace = true, optional = true }
 tempfile.workspace = true
 hex.workspace = true
 forge-fmt = { workspace = true, optional = true }
 rrs-lib = { workspace = true }
 num-bigint = { workspace = true }
 
 [features]
-default = ["parallel", "jemalloc", "evm-verify"]
-evm-prove = ["openvm-native-recursion/evm-prove"]
+default = ["parallel", "jemalloc"]
+evm-prove = [
+    "openvm-continuations/static-verifier",
+    "openvm-native-recursion/evm-prove",
+    "dep:snark-verifier",
+    "dep:snark-verifier-sdk",
+]
 evm-verify = [
     "evm-prove",
     "openvm-native-recursion/evm-verify",
@@ -83,3 +88,8 @@ mimalloc = ["openvm-circuit/mimalloc"]
 jemalloc = ["openvm-circuit/jemalloc"]
 jemalloc-prof = ["openvm-circuit/jemalloc-prof"]
 nightly-features = ["openvm-circuit/nightly-features"]
+
+[[example]]
+name = "sdk_evm"
+path = "examples/sdk_evm.rs"
+required-features = ["evm-verify"]
diff --git a/crates/sdk/src/fs.rs b/crates/sdk/src/fs.rs
@@ -1,19 +1,25 @@
 use std::{
-    fs::{create_dir_all, read, read_to_string, write, File},
+    fs::{create_dir_all, read, write, File},
     path::Path,
 };
 
 use eyre::{Report, Result};
 use openvm_circuit::arch::{instructions::exe::VmExe, ContinuationVmProof, VmConfig};
 use openvm_continuations::verifier::root::types::RootVmVerifierInput;
+#[cfg(feature = "evm-prove")]
 use openvm_native_recursion::halo2::wrapper::EvmVerifierByteCode;
 use serde::{de::DeserializeOwned, Serialize};
 
 use crate::{
     codec::{Decode, Encode},
-    keygen::{AggStarkProvingKey, AppProvingKey, AppVerifyingKey, Halo2ProvingKey},
+    keygen::{AggStarkProvingKey, AppProvingKey, AppVerifyingKey},
+    F, SC,
+};
+#[cfg(feature = "evm-prove")]
+use crate::{
+    keygen::Halo2ProvingKey,
     types::{EvmHalo2Verifier, EvmProof},
-    F, OPENVM_VERSION, SC,
+    OPENVM_VERSION,
 };
 
 pub const EVM_HALO2_VERIFIER_INTERFACE_NAME: &str = "IOpenVmHalo2Verifier.sol";
@@ -82,23 +88,30 @@ pub fn write_agg_stark_pk_to_file<P: AsRef<Path>>(pk: &AggStarkProvingKey, path:
     write_to_file_bitcode(&path, pk)
 }
 
+#[cfg(feature = "evm-prove")]
 pub fn read_agg_halo2_pk_from_file<P: AsRef<Path>>(path: P) -> Result<Halo2ProvingKey> {
     read_from_file_bitcode(&path)
 }
 
+#[cfg(feature = "evm-prove")]
 pub fn write_agg_halo2_pk_to_file<P: AsRef<Path>>(pk: &Halo2ProvingKey, path: P) -> Result<()> {
     write_to_file_bitcode(&path, pk)
 }
 
+#[cfg(feature = "evm-prove")]
 pub fn read_evm_proof_from_file<P: AsRef<Path>>(path: P) -> Result<EvmProof> {
     read_from_file_json(&path)
 }
 
+#[cfg(feature = "evm-prove")]
 pub fn write_evm_proof_to_file<P: AsRef<Path>>(proof: EvmProof, path: P) -> Result<()> {
     write_to_file_json(&path, proof)
 }
 
+#[cfg(feature = "evm-prove")]
 pub fn read_evm_halo2_verifier_from_folder<P: AsRef<Path>>(folder: P) -> Result<EvmHalo2Verifier> {
+    use std::fs::read_to_string;
+
     let folder = folder
         .as_ref()
         .join("src")
@@ -136,6 +149,7 @@ pub fn read_evm_halo2_verifier_from_folder<P: AsRef<Path>>(folder: P) -> Result<
 /// ```
 ///
 /// If the relevant directories do not exist, they will be created.
+#[cfg(feature = "evm-prove")]
 pub fn write_evm_halo2_verifier_to_folder<P: AsRef<Path>>(
     verifier: EvmHalo2Verifier,
     folder: P,
diff --git a/crates/sdk/src/keygen/mod.rs b/crates/sdk/src/keygen/mod.rs
@@ -6,17 +6,11 @@ use openvm_circuit::{
     arch::{VirtualMachine, VmComplexTraceHeights, VmConfig},
     system::{memory::dimensions::MemoryDimensions, program::trace::VmCommittedExe},
 };
-use openvm_continuations::{
-    static_verifier::StaticVerifierPvHandler,
-    verifier::{
-        internal::InternalVmVerifierConfig, leaf::LeafVmVerifierConfig, root::RootVmVerifierConfig,
-    },
+use openvm_continuations::verifier::{
+    internal::InternalVmVerifierConfig, leaf::LeafVmVerifierConfig, root::RootVmVerifierConfig,
 };
 use openvm_native_circuit::NativeConfig;
 use openvm_native_compiler::ir::DIGEST_SIZE;
-use openvm_native_recursion::halo2::{
-    utils::Halo2ParamsReader, verifier::Halo2VerifierProvingKey, wrapper::Halo2WrapperProvingKey,
-};
 use openvm_stark_backend::{
     config::Val,
     p3_field::{FieldExtensionAlgebra, PrimeField32, TwoAdicField},
@@ -37,10 +31,19 @@ use openvm_stark_sdk::{
 };
 use serde::{Deserialize, Serialize};
 use tracing::info_span;
+#[cfg(feature = "evm-prove")]
+use {
+    crate::config::AggConfig,
+    openvm_continuations::static_verifier::StaticVerifierPvHandler,
+    openvm_native_recursion::halo2::{
+        utils::Halo2ParamsReader, verifier::Halo2VerifierProvingKey,
+        wrapper::Halo2WrapperProvingKey,
+    },
+};
 
 use crate::{
     commit::babybear_digest_to_bn254,
-    config::{AggConfig, AggStarkConfig, AppConfig},
+    config::{AggStarkConfig, AppConfig},
     keygen::perm::AirIdPermutation,
     prover::vm::types::VmProvingKey,
     NonRootCommittedExe, RootSC, F, SC,
@@ -49,6 +52,7 @@ use crate::{
 pub mod asm;
 pub(crate) mod dummy;
 pub mod perm;
+#[cfg(feature = "evm-prove")]
 pub mod static_verifier;
 
 #[derive(Clone, Serialize, Deserialize)]
@@ -65,6 +69,7 @@ pub struct AppVerifyingKey {
     pub memory_dimensions: MemoryDimensions,
 }
 
+#[cfg(feature = "evm-prove")]
 #[derive(Clone, Serialize, Deserialize)]
 pub struct AggProvingKey {
     pub agg_stark_pk: AggStarkProvingKey,
@@ -80,6 +85,7 @@ pub struct AggStarkProvingKey {
 }
 
 /// Attention: the size of this struct is VERY large, usually >10GB.
+#[cfg(feature = "evm-prove")]
 #[derive(Clone, Serialize, Deserialize)]
 pub struct Halo2ProvingKey {
     /// Static verifier to verify a stark proof of the root verifier.
@@ -406,6 +412,7 @@ impl RootVerifierProvingKey {
     }
 }
 
+#[cfg(feature = "evm-prove")]
 impl AggProvingKey {
     /// Attention:
     /// - This function is very expensive. Usually it requires >64GB memory and takes >10 minutes.
diff --git a/crates/sdk/src/lib.rs b/crates/sdk/src/lib.rs
diff --git a/crates/sdk/src/types.rs b/crates/sdk/src/types.rs
diff --git a/crates/sdk/tests/integration_test.rs b/crates/sdk/tests/integration_test.rs

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ def run_cargo_command(`
`17`	`17`	`):`
`18`	`18`	`# Command to run (for best performance but slower builds, use --profile maxperf)`
`19`	`19`	`command = [`
`20`		`- "cargo", "run", "--no-default-features", "--bin", bin_name, "--profile", profile, "--features", ",".join(feature_flags), "--"`
	`20`	`+ "cargo", "run", "--no-default-features", "-p", "openvm-benchmarks-prove", "--bin", bin_name, "--profile", profile, "--features", ",".join(feature_flags), "--"`
`21`	`21`	`]`
`22`	`22`
`23`	`23`	`if app_log_blowup is not None:`