feat: enable evm interpreter (#1167)

* support evm interpreter

* require --zksync arg for --zk-evm-intepreter

Author: nbaztec

crates/chisel/src/executor.rs

@@ -212,7 +212,10 @@ impl SessionSource {
             Some(backend) => backend,
             None => {
                 let fork = self.config.evm_opts.get_fork(&self.config.foundry_config, env.clone());
-                let backend = Backend::spawn(fork, strategy.runner.new_backend_strategy())?;
+                let backend = Backend::spawn(
+                    fork,
+                    strategy.runner.new_backend_strategy(strategy.context.as_ref()),
+                )?;
                 self.config.backend = Some(backend.clone());
                 backend
             }

crates/cli/src/opts/build/zksync.rs

@@ -31,6 +31,18 @@ pub struct ZkSyncArgs {
     )]
     pub startup: Option<bool>,
 
+    /// Enable zkVM EVM intepreter
+    #[clap(
+        long = "zk-evm-interpreter",
+        display_order = 0,
+        value_name = "ENABLE_ZKVM_EVM_INTERPRETER",
+        num_args = 0..=1,
+        require_equals = true,
+        default_missing_value = "false",
+        requires = "startup",
+    )]
+    pub evm_interpreter: Option<bool>,
+
     #[clap(
         help = "Solc compiler path to use when compiling with zksolc",
         long = "zk-solc-path",
@@ -156,6 +168,7 @@ impl ZkSyncArgs {
 
         set_if_some!(self.compile, zksync.compile);
         set_if_some!(self.startup, zksync.startup);
+        set_if_some!(self.evm_interpreter, zksync.evm_interpreter);
         set_if_some!(self.solc_path.clone(), zksync.solc_path);
         set_if_some!(self.enable_eravm_extensions, zksync.enable_eravm_extensions);
         set_if_some!(self.llvm_options.clone(), zksync.llvm_options);

crates/cli/src/utils/mod.rs

@@ -115,8 +115,13 @@ pub fn get_provider(config: &Config) -> Result<RetryProvider> {
 
 pub fn get_executor_strategy(config: &Config) -> ExecutorStrategy {
     if config.zksync.should_compile() {
-        info!("using zksync strategy");
-        ExecutorStrategy::new_zksync()
+        if config.zksync.evm_interpreter {
+            info!("using zksync strategy (EVM-interpreter)");
+        } else {
+            info!("using zksync strategy");
+        }
+
+        ExecutorStrategy::new_zksync(config.zksync.evm_interpreter)
     } else {
         info!("using evm strategy");
         ExecutorStrategy::new_evm()

crates/config/src/zksync.rs

@@ -39,6 +39,9 @@ pub struct ZkSyncConfig {
     /// Start VM in zkVM mode
     pub startup: bool,
 
+    /// Whether to use EVM interpreter.
+    pub evm_interpreter: bool,
+
     /// The zkSolc instance to use if any.
     pub zksolc: Option<SolcReq>,
 
@@ -87,6 +90,7 @@ impl Default for ZkSyncConfig {
         Self {
             compile: false,
             startup: false,
+            evm_interpreter: false,
             zksolc: Default::default(),
             solc_path: Default::default(),
             hash_type: Default::default(),
@@ -110,6 +114,12 @@ impl ZkSyncConfig {
         self.compile && self.startup
     }
 
+    /// Returns true if zk mode is enabled, if tests should be run in zk mode, and if EVM
+    /// interpreter is enabled.
+    pub fn run_in_zk_evm_interpreter_mode(&self) -> bool {
+        self.run_in_zk_mode() && self.evm_interpreter
+    }
+
     /// Returns true if contracts should be compiled for zk
     pub fn should_compile(&self) -> bool {
         self.compile

crates/evm/evm/src/executors/strategy.rs

@@ -124,7 +124,7 @@ pub trait ExecutorStrategyRunner: Debug + Send + Sync + ExecutorStrategyExt {
         inspector: &mut InspectorStack,
     ) -> Result<ResultAndState>;
 
-    fn new_backend_strategy(&self) -> BackendStrategy;
+    fn new_backend_strategy(&self, ctx: &dyn ExecutorStrategyContext) -> BackendStrategy;
     fn new_cheatcode_inspector_strategy(
         &self,
         ctx: &dyn ExecutorStrategyContext,
@@ -260,7 +260,7 @@ impl ExecutorStrategyRunner for EvmExecutorStrategyRunner {
         backend.inspect(env, inspector, Box::new(()))
     }
 
-    fn new_backend_strategy(&self) -> BackendStrategy {
+    fn new_backend_strategy(&self, _ctx: &dyn ExecutorStrategyContext) -> BackendStrategy {
         BackendStrategy::new_evm()
     }
 

crates/evm/evm/src/executors/trace.rs

@@ -31,7 +31,8 @@ impl TracingExecutor {
         state_overrides: Option<StateOverride>,
         strategy: ExecutorStrategy,
     ) -> eyre::Result<Self> {
-        let db = Backend::spawn(fork, strategy.runner.new_backend_strategy())?;
+        let db =
+            Backend::spawn(fork, strategy.runner.new_backend_strategy(strategy.context.as_ref()))?;
 
         // configures a bare version of the evm executor: no cheatcode inspector is enabled,
         // tracing will be enabled only for the targeted transaction

crates/forge/src/multi_runner.rs

@@ -181,7 +181,10 @@ impl MultiContractRunner {
         trace!("running all tests");
 
         // The DB backend that serves all the data.
-        let db = Backend::spawn(self.fork.take(), self.strategy.runner.new_backend_strategy())?;
+        let db = Backend::spawn(
+            self.fork.take(),
+            self.strategy.runner.new_backend_strategy(self.strategy.context.as_ref()),
+        )?;
 
         let find_timer = Instant::now();
         let contracts = self.matching_contracts(filter).collect::<Vec<_>>();

crates/forge/tests/cli/config.rs

@@ -1069,6 +1069,7 @@ path = "out"
 [profile.default.zksync]
 compile = false
 startup = false
+evm_interpreter = false
 size_fallback = false
 enable_eravm_extensions = false
 force_evmla = false
@@ -1379,6 +1380,7 @@ exclude = []
   "zksync": {
     "compile": false,
     "startup": false,
+    "evm_interpreter": false,
     "zksolc": null,
     "solc_path": null,
     "hash_type": null,

crates/forge/tests/it/zk/evm_interpreter.rs

@@ -0,0 +1,16 @@
+//! Forge tests for zksync evm interpreter.
+
+use crate::{config::*, test_helpers::TEST_DATA_DEFAULT};
+use foundry_test_utils::Filter;
+use revm::primitives::hardfork::SpecId;
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_zk_evm_interpreter_create() {
+    let mut zk_config = TEST_DATA_DEFAULT.zk_test_data.as_ref().unwrap().zk_config.clone();
+    zk_config.verbosity = 5;
+    zk_config.zksync.evm_interpreter = true;
+    let runner = TEST_DATA_DEFAULT.runner_with_zksync_config(zk_config);
+    let filter = Filter::new("testCreate|testCall", "EvmInterpreterTest", ".*");
+
+    TestConfig::with_filter(runner, filter).spec_id(SpecId::SHANGHAI).run().await;
+}

crates/forge/tests/it/zk/mod.rs

@@ -7,6 +7,7 @@ mod contracts;
 mod create;
 mod create2;
 mod deploy;
+mod evm_interpreter;
 mod factory;
 mod factory_deps;
 mod fork;