chore: feature gate revm and alloy imports (#1572)

Previously we were very sloppy with enabling of features:
`openvm-native-recursion` was always enabling the `snark-verifier`
feature "revm" which imports a fixed version of revm only used for
testing purposes. Since revm version changes rather frequently, this can
cause Cargo dependency conflicts if someone wants to use the SDK with
another version of revm.

I've added new features "evm-prove" and "evm-verify" to
`openvm-native-recursion`, `openvm-sdk`, `cargo-openvm` so that
- "evm-prove" allows for generation of EVM halo2 proofs, which just
enables some additional features in `snark-verifier` but no additional
other dependencies.
- "evm-verify" allows for revm simulation of EVM contract calls to
verify halo2 proofs. This includes imports of `revm` and some `alloy`
crates, with fixed versions. If you enable this feature (on by default),
the revm and alloy versions will be fixed in the cargo tree.

Also added some re-exported features to SDK and CLI, and switched
default memory allocator to `jemalloc` since that's what we mostly use.

Author: jonathanpwang

.github/workflows/lints.yml

@@ -45,8 +45,8 @@ jobs:
         run: |
           # list of features generated using:
           # echo -e "\033[1;32mAll unique features across workspace:\033[0m" && cargo metadata --format-version=1 --no-deps | jq -r '.packages[].features | to_entries[] | .key' | sort -u | sed 's/^/• /'
-          cargo clippy --all-targets --all --tests --features "aggregation bench-metrics bls12_381 bn254 default entrypoint export-getrandom export-libm function-span getrandom halo2-compiler halo2curves heap-embedded-alloc k256 mimalloc nightly-features panic-handler parallel rust-runtime static-verifier std test-utils unstable" -- -D warnings
-          cargo clippy --all-targets --all --tests --no-default-features --features "jemalloc jemalloc-prof" -- -D warnings
+          cargo clippy --all-targets --all --tests --features "aggregation bench-metrics bls12_381 bn254 default entrypoint evm-prove evm-verify export-getrandom export-libm function-span getrandom halo2-compiler halo2curves heap-embedded-alloc k256 jemalloc jemalloc-prof nightly-features panic-handler parallel rust-runtime static-verifier std test-utils unstable" -- -D warnings
+          cargo clippy --all-targets --all --tests --no-default-features --features "mimalloc" -- -D warnings
 
       - name: Run fmt, clippy for guest
         run: |

benchmarks/execute/Cargo.toml

@@ -30,9 +30,8 @@ tracing-subscriber = { version = "0.3.17", features = ["std", "env-filter"] }
 criterion = { version = "0.5", features = ["html_reports"] }
 
 [features]
-default = ["mimalloc"]
+default = ["jemalloc"]
 profiling = ["openvm-sdk/profiling"]
-aggregation = []
 mimalloc = ["openvm-circuit/mimalloc"]
 jemalloc = ["openvm-circuit/jemalloc"]
 jemalloc-prof = ["openvm-circuit/jemalloc-prof"]

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
+openvm-sdk = { workspace = true, features = ["evm-verify"] }
 openvm-stark-backend.workspace = true
 openvm-stark-sdk.workspace = true
 openvm-transpiler.workspace = true
@@ -43,11 +43,10 @@ tracing.workspace = true
 [dev-dependencies]
 
 [features]
-default = ["parallel", "mimalloc", "bench-metrics"]
+default = ["parallel", "jemalloc", "bench-metrics"]
 bench-metrics = ["openvm-native-recursion/bench-metrics"]
 profiling = ["openvm-sdk/profiling"]
 aggregation = []
-static-verifier = ["openvm-native-recursion/static-verifier"]
 parallel = ["openvm-native-recursion/parallel"]
 mimalloc = ["openvm-circuit/mimalloc"]
 jemalloc = ["openvm-circuit/jemalloc"]

benchmarks/prove/src/bin/fib_e2e.rs

@@ -10,7 +10,7 @@ use openvm_rv32im_transpiler::{
     Rv32ITranspilerExtension, Rv32IoTranspilerExtension, Rv32MTranspilerExtension,
 };
 use openvm_sdk::{
-    commit::commit_app_exe, prover::ContinuationProver, DefaultStaticVerifierPvHandler, Sdk, StdIn,
+    commit::commit_app_exe, prover::EvmHalo2Prover, DefaultStaticVerifierPvHandler, Sdk, StdIn,
 };
 use openvm_stark_sdk::{
     bench::run_with_metric_collection, config::baby_bear_poseidon2::BabyBearPoseidon2Engine,
@@ -58,7 +58,7 @@ async fn main() -> Result<()> {
     let mut stdin = StdIn::default();
     stdin.write(&n);
     run_with_metric_collection("OUTPUT_PATH", || {
-        let mut e2e_prover = ContinuationProver::<_, BabyBearPoseidon2Engine>::new(
+        let mut e2e_prover = EvmHalo2Prover::<_, BabyBearPoseidon2Engine>::new(
             &halo2_params_reader,
             app_pk,
             app_committed_exe,

benchmarks/prove/src/bin/kitchen_sink.rs

@@ -10,7 +10,7 @@ use openvm_ecc_circuit::{WeierstrassExtension, P256_CONFIG, SECP256K1_CONFIG};
 use openvm_native_recursion::halo2::utils::{CacheHalo2ParamsReader, DEFAULT_PARAMS_DIR};
 use openvm_pairing_circuit::{PairingCurve, PairingExtension};
 use openvm_sdk::{
-    commit::commit_app_exe, config::SdkVmConfig, prover::ContinuationProver,
+    commit::commit_app_exe, config::SdkVmConfig, prover::EvmHalo2Prover,
     DefaultStaticVerifierPvHandler, Sdk, StdIn,
 };
 use openvm_stark_sdk::{
@@ -80,7 +80,7 @@ fn main() -> Result<()> {
     )?;
 
     run_with_metric_collection("OUTPUT_PATH", || -> Result<()> {
-        let mut prover = ContinuationProver::<_, BabyBearPoseidon2Engine>::new(
+        let mut prover = EvmHalo2Prover::<_, BabyBearPoseidon2Engine>::new(
             &halo2_params_reader,
             app_pk,
             app_committed_exe,

crates/cli/Cargo.toml

@@ -19,7 +19,7 @@ vergen = { version = "8", default-features = false, features = [
 [dependencies]
 openvm-build = { workspace = true }
 openvm-transpiler = { workspace = true }
-openvm-native-recursion = { workspace = true, features = ["static-verifier"] }
+openvm-native-recursion = { workspace = true }
 openvm-sdk = { workspace = true }
 openvm-stark-sdk.workspace = true
 openvm-stark-backend.workspace = true
@@ -39,5 +39,16 @@ toml = { workspace = true }
 bitcode.workspace = true
 
 [features]
-default = []
+default = ["parallel", "jemalloc", "evm-verify", "bench-metrics"]
+evm-prove = ["openvm-sdk/evm-prove"]
+evm-verify = ["evm-prove", "openvm-sdk/evm-verify"]
 bench-metrics = ["openvm-sdk/bench-metrics"]
+# for guest profiling:
+profiling = ["openvm-sdk/profiling"]
+# performance features:
+# (rayon is always imported because of halo2, so "parallel" feature is redundant)
+parallel = ["openvm-sdk/parallel"]
+mimalloc = ["openvm-sdk/mimalloc"]
+jemalloc = ["openvm-sdk/jemalloc"]
+jemalloc-prof = ["openvm-sdk/jemalloc-prof"]
+nightly-features = ["openvm-sdk/nightly-features"]

crates/cli/src/bin/cargo-openvm.rs

@@ -1,7 +1,4 @@
-use cargo_openvm::{
-    commands::{BuildCmd, EvmProvingSetupCmd, KeygenCmd, ProveCmd, RunCmd, VerifyCmd},
-    OPENVM_VERSION_MESSAGE,
-};
+use cargo_openvm::{commands::*, OPENVM_VERSION_MESSAGE};
 use clap::{Parser, Subcommand};
 use eyre::Result;
 use openvm_stark_sdk::config::setup_tracing_with_log_level;
@@ -27,6 +24,7 @@ pub enum VmCliCommands {
     Keygen(KeygenCmd),
     Prove(ProveCmd),
     Run(RunCmd),
+    #[cfg(feature = "evm-verify")]
     Setup(EvmProvingSetupCmd),
     Verify(VerifyCmd),
 }
@@ -41,6 +39,7 @@ async fn main() -> Result<()> {
         VmCliCommands::Run(cmd) => cmd.run(),
         VmCliCommands::Keygen(cmd) => cmd.run(),
         VmCliCommands::Prove(cmd) => cmd.run(),
+        #[cfg(feature = "evm-verify")]
         VmCliCommands::Setup(cmd) => cmd.run().await,
         VmCliCommands::Verify(cmd) => cmd.run(),
     }

crates/cli/src/commands/mod.rs

@@ -10,7 +10,9 @@ pub use prove::*;
 mod run;
 pub use run::*;
 
+#[cfg(feature = "evm-verify")]
 mod setup;
+#[cfg(feature = "evm-verify")]
 pub use setup::*;
 
 mod verify;

crates/cli/src/commands/prove.rs

@@ -2,23 +2,21 @@ use std::{path::PathBuf, sync::Arc};
 
 use clap::Parser;
 use eyre::Result;
-use openvm_native_recursion::halo2::utils::CacheHalo2ParamsReader;
 use openvm_sdk::{
     commit::AppExecutionCommit,
-    config::{AggregationTreeConfig, SdkVmConfig},
-    fs::{
-        read_agg_pk_from_file, read_app_pk_from_file, read_exe_from_file, write_app_proof_to_file,
-        write_evm_proof_to_file,
-    },
+    config::SdkVmConfig,
+    fs::{read_app_pk_from_file, read_exe_from_file, write_app_proof_to_file},
     keygen::AppProvingKey,
     NonRootCommittedExe, Sdk, StdIn,
 };
+#[cfg(feature = "evm-prove")]
+use openvm_sdk::{
+    config::AggregationTreeConfig,
+    fs::{read_agg_pk_from_file, write_evm_proof_to_file},
+};
 
 use crate::{
-    default::{
-        DEFAULT_AGG_PK_PATH, DEFAULT_APP_EXE_PATH, DEFAULT_APP_PK_PATH, DEFAULT_APP_PROOF_PATH,
-        DEFAULT_EVM_PROOF_PATH, DEFAULT_PARAMS_DIR,
-    },
+    default::*,
     input::{read_to_stdin, Input},
 };
 
@@ -44,6 +42,7 @@ enum ProveSubCommand {
         #[arg(long, action, help = "Path to output proof", default_value = DEFAULT_APP_PROOF_PATH)]
         output: PathBuf,
     },
+    #[cfg(feature = "evm-prove")]
     Evm {
         #[arg(long, action, help = "Path to app proving key", default_value = DEFAULT_APP_PK_PATH)]
         app_pk: PathBuf,
@@ -64,7 +63,7 @@ enum ProveSubCommand {
 
 impl ProveCmd {
     pub fn run(&self) -> Result<()> {
-        let mut sdk = Sdk::new();
+        let sdk = Sdk::new();
         match &self.command {
             ProveSubCommand::App {
                 app_pk,
@@ -77,13 +76,17 @@ impl ProveCmd {
                 let app_proof = sdk.generate_app_proof(app_pk, committed_exe, input)?;
                 write_app_proof_to_file(app_proof, output)?;
             }
+            #[cfg(feature = "evm-prove")]
             ProveSubCommand::Evm {
                 app_pk,
                 exe,
                 input,
                 output,
                 agg_tree_config,
             } => {
+                use openvm_native_recursion::halo2::utils::CacheHalo2ParamsReader;
+
+                let mut sdk = sdk;
                 sdk.set_agg_tree_config(*agg_tree_config);
                 let params_reader = CacheHalo2ParamsReader::new(DEFAULT_PARAMS_DIR);
                 let (app_pk, committed_exe, input) =

crates/cli/src/commands/verify.rs

@@ -3,17 +3,11 @@ use std::path::PathBuf;
 use clap::Parser;
 use eyre::Result;
 use openvm_sdk::{
-    fs::{
-        read_app_proof_from_file, read_app_vk_from_file, read_evm_halo2_verifier_from_folder,
-        read_evm_proof_from_file,
-    },
+    fs::{read_app_proof_from_file, read_app_vk_from_file},
     Sdk,
 };
 
-use crate::default::{
-    DEFAULT_APP_PROOF_PATH, DEFAULT_APP_VK_PATH, DEFAULT_EVM_HALO2_VERIFIER_PATH,
-    DEFAULT_EVM_PROOF_PATH,
-};
+use crate::default::*;
 
 #[derive(Parser)]
 #[command(name = "verify", about = "Verify a proof")]
@@ -31,6 +25,7 @@ enum VerifySubCommand {
         #[arg(long, action, help = "Path to app proof", default_value = DEFAULT_APP_PROOF_PATH)]
         proof: PathBuf,
     },
+    #[cfg(feature = "evm-verify")]
     Evm {
         #[arg(long, action, help = "Path to EVM proof", default_value = DEFAULT_EVM_PROOF_PATH)]
         proof: PathBuf,
@@ -46,7 +41,12 @@ impl VerifyCmd {
                 let app_proof = read_app_proof_from_file(proof)?;
                 sdk.verify_app_proof(&app_vk, &app_proof)?;
             }
+            #[cfg(feature = "evm-verify")]
             VerifySubCommand::Evm { proof } => {
+                use openvm_sdk::fs::{
+                    read_evm_halo2_verifier_from_folder, read_evm_proof_from_file,
+                };
+
                 let evm_verifier = read_evm_halo2_verifier_from_folder(DEFAULT_EVM_HALO2_VERIFIER_PATH).map_err(|e| {
                     eyre::eyre!("Failed to read EVM verifier: {}\nPlease run 'cargo openvm evm-proving-setup' first", e)
                 })?;