Add test

Merge remote-tracking branch 'origin/main' into bugfix/function-signature
Refactor the input handling logic (#48 )
2026-04-22 20:47:58 +00:00 · 2025-07-21 12:15:27 +03:00 · 2025-07-21 12:13:24 +03:00 · 2025-07-21 09:01:52 +00:00 · 2025-07-18 16:37:15 +03:00 · 2025-07-18 12:08:13 +00:00
30 changed files with 3476 additions and 990 deletions
@@ -3,3 +3,7 @@
 .DS_Store
 node_modules
 /*.json
 # We do not want to commit any log files that we produce from running the code locally so this is 
 # added to the .gitignore file.
 *.log
@@ -67,9 +67,9 @@ checksum = "683d7910e743518b0e34f1186f92494becacb047c7b6bf616c96772180fef923"
 [[package]]
 name = "alloy"
-version = "1.0.9"
+version = "1.0.20"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0093d23bf026b580c1f66ed3a053d8209c104a446c5264d3ad99587f6edef24e"
+checksum = "ae58d888221eecf621595e2096836ce7cfc37be06bfa39d7f64aa6a3ea4c9e5b"
 dependencies = [
 "alloy-consensus",
 "alloy-contract",
@@ -162,9 +162,9 @@ dependencies = [
 [[package]]
 name = "alloy-core"
-version = "1.1.2"
+version = "1.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a3c5a28f166629752f2e7246b813cdea3243cca59aab2d4264b1fd68392c10eb"
+checksum = "ad31216895d27d307369daa1393f5850b50bbbd372478a9fa951c095c210627e"
 dependencies = [
 "alloy-dyn-abi",
 "alloy-json-abi",
@@ -175,9 +175,9 @@ dependencies = [
 [[package]]
 name = "alloy-dyn-abi"
-version = "1.1.2"
+version = "1.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "18cc14d832bc3331ca22a1c7819de1ede99f58f61a7d123952af7dde8de124a6"
+checksum = "7b95b3deca680efc7e9cba781f1a1db352fa1ea50e6384a514944dcf4419e652"
 dependencies = [
 "alloy-json-abi",
 "alloy-primitives",
@@ -336,7 +336,7 @@ dependencies = [
 "derive_more 2.0.1",
 "foldhash",
 "hashbrown 0.15.3",
- "indexmap 2.9.0",
+ "indexmap 2.10.0",
 "itoa",
 "k256",
 "keccak-asm",
@@ -597,7 +597,7 @@ dependencies = [
 "alloy-sol-macro-input",
 "const-hex",
 "heck",
- "indexmap 2.9.0",
+ "indexmap 2.10.0",
 "proc-macro-error2",
 "proc-macro2",
 "quote",
@@ -2400,7 +2400,7 @@ dependencies = [
 "futures-core",
 "futures-sink",
 "http",
- "indexmap 2.9.0",
+ "indexmap 2.10.0",
 "slab",
 "tokio",
 "tokio-util",
@@ -2842,9 +2842,9 @@ dependencies = [
 [[package]]
 name = "indexmap"
-version = "2.9.0"
+version = "2.10.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cea70ddb795996207ad57735b50c5982d8844f38ba9ee5f1aedcfb708a2aa11e"
+checksum = "fe4cd85333e22411419a0bcae1297d25e58c9443848b11dc6a86fefe8c78a661"
 dependencies = [
 "equivalent",
 "hashbrown 0.15.3",
@@ -3962,6 +3962,7 @@ dependencies = [
 "alloy",
 "anyhow",
 "clap",
 "indexmap 2.10.0",
 "rayon",
 "revive-dt-compiler",
 "revive-dt-config",
@@ -3984,6 +3985,7 @@ dependencies = [
 "alloy-primitives",
 "alloy-sol-types",
 "anyhow",
 "revive-dt-node-interaction",
 "semver 1.0.26",
 "serde",
 "serde_json",
@@ -3998,10 +4000,12 @@ dependencies = [
 "anyhow",
 "revive-dt-config",
 "revive-dt-node-interaction",
 "serde",
 "serde_json",
 "sp-core",
 "sp-runtime",
 "temp-dir",
 "tokio",
 "tracing",
 ]
@@ -4011,6 +4015,7 @@ version = "0.1.0"
 dependencies = [
 "alloy",
 "anyhow",
 "futures",
 "once_cell",
 "tokio",
 "tracing",
@@ -4503,7 +4508,7 @@ dependencies = [
 "chrono",
 "hex",
 "indexmap 1.9.3",
- "indexmap 2.9.0",
+ "indexmap 2.10.0",
 "serde",
 "serde_derive",
 "serde_json",
@@ -5392,7 +5397,7 @@ version = "0.22.26"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "310068873db2c5b3e7659d2cc35d21855dbafa50d1ce336397c666e3cb08137e"
 dependencies = [
- "indexmap 2.9.0",
+ "indexmap 2.10.0",
 "serde",
 "serde_spanned",
 "toml_datetime",
@@ -25,6 +25,7 @@ alloy-primitives = "1.2.1"
 alloy-sol-types = "1.2.1"
 anyhow = "1.0"
 clap = { version = "4", features = ["derive"] }
 futures = { version = "0.3.31" }
 hex = "0.4.3"
 reqwest = { version = "0.12.15", features = ["blocking", "json"] }
 once_cell = "1.21"
@@ -50,6 +51,7 @@ tracing-subscriber = { version = "0.3.19", default-features = false, features =
    "json",
    "env-filter",
 ] }
 indexmap = { version = "2.10.0", default-features = false }
 # revive compiler
 revive-solc-json-interface = { git = "https://github.com/paritytech/revive", rev = "3389865af7c3ff6f29a586d82157e8bc573c1a8e" }
@@ -68,6 +70,9 @@ features = [
    "rpc-types",
    "signer-local",
    "std",
    "network",
    "serde",
    "rpc-types-eth",
 ]
 [profile.bench]
@@ -0,0 +1,326 @@
 {
    "modes": [
        "Y >=0.8.9",
        "E",
        "I"
    ],
    "cases": [
        {
            "name": "first",
            "inputs": [
                {
                    "instance": "WBTC_1",
                    "method": "#deployer",
                    "calldata": [
                        "0x40",
                        "0x80",
                        "4",
                        "0x5742544300000000000000000000000000000000000000000000000000000000",
                        "14",
                        "0x5772617070656420425443000000000000000000000000000000000000000000"
                    ],
                    "expected": [
                        "WBTC_1.address"
                    ]
                },
                {
                    "instance": "WBTC_2",
                    "method": "#deployer",
                    "calldata": [
                        "0x40",
                        "0x80",
                        "4",
                        "0x5742544300000000000000000000000000000000000000000000000000000000",
                        "14",
                        "0x5772617070656420425443000000000000000000000000000000000000000000"
                    ],
                    "expected": [
                        "WBTC_2.address"
                    ]
                },
                {
                    "instance": "Mooniswap",
                    "method": "#deployer",
                    "calldata": [
                        "0x0000000000000000000000000000000000000000000000000000000000000060",
                        "0x00000000000000000000000000000000000000000000000000000000000000c0",
                        "0x0000000000000000000000000000000000000000000000000000000000000100",
                        "0x0000000000000000000000000000000000000000000000000000000000000002",
                        "WBTC_1.address",
                        "WBTC_2.address",
                        "4",
                        "0x5742544300000000000000000000000000000000000000000000000000000000",
                        "14",
                        "0x5772617070656420425443000000000000000000000000000000000000000000"
                    ],
                    "expected": {
                        "return_data": [
                            "Mooniswap.address"
                        ],
                        "events": [
                            {
                                "topics": [
                                    "0x8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0",
                                    "0x0000000000000000000000000000000000000000000000000000000000000000",
                                    "0xdeadbeef01000000000000000000000000000000"
                                ],
                                "values": []
                            }
                        ],
                        "exception": false
                    }
                },
                {
                    "instance": "WBTC_1",
                    "method": "_mint",
                    "calldata": [
                        "0xdeadbeef00000000000000000000000000000042",
                        "1000000000"
                    ],
                    "expected": {
                        "return_data": [],
                        "events": [
                            {
                                "topics": [
                                    "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                                    "0x0000000000000000000000000000000000000000000000000000000000000000",
                                    "0xdeadbeef00000000000000000000000000000042"
                                ],
                                "values": [
                                    "1000000000"
                                ]
                            }
                        ],
                        "exception": false
                    }
                },
                {
                    "instance": "WBTC_2",
                    "method": "_mint",
                    "calldata": [
                        "0xdeadbeef00000000000000000000000000000042",
                        "1000000000"
                    ],
                    "expected": {
                        "return_data": [],
                        "events": [
                            {
                                "topics": [
                                    "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                                    "0x0000000000000000000000000000000000000000000000000000000000000000",
                                    "0xdeadbeef00000000000000000000000000000042"
                                ],
                                "values": [
                                    "1000000000"
                                ]
                            }
                        ],
                        "exception": false
                    }
                },
                {
                    "instance": "WBTC_1",
                    "caller": "0xdeadbeef00000000000000000000000000000042",
                    "method": "approve",
                    "calldata": [
                        "Mooniswap.address",
                        "500000000"
                    ],
                    "expected": {
                        "return_data": [
                            "0x0000000000000000000000000000000000000000000000000000000000000001"
                        ],
                        "events": [
                            {
                                "topics": [
                                    "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
                                    "0xdeadbeef00000000000000000000000000000042",
                                    "Mooniswap.address"
                                ],
                                "values": [
                                    "500000000"
                                ]
                            }
                        ],
                        "exception": false
                    }
                },
                {
                    "instance": "WBTC_2",
                    "caller": "0xdeadbeef00000000000000000000000000000042",
                    "method": "approve",
                    "calldata": [
                        "Mooniswap.address",
                        "500000000"
                    ],
                    "expected": {
                        "return_data": [
                            "0x0000000000000000000000000000000000000000000000000000000000000001"
                        ],
                        "events": [
                            {
                                "topics": [
                                    "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
                                    "0xdeadbeef00000000000000000000000000000042",
                                    "Mooniswap.address"
                                ],
                                "values": [
                                    "500000000"
                                ]
                            }
                        ],
                        "exception": false
                    }
                },
                {
                    "instance": "Mooniswap",
                    "caller": "0xdeadbeef00000000000000000000000000000042",
                    "method": "deposit",
                    "calldata": [
                        "0x0000000000000000000000000000000000000000000000000000000000000040",
                        "0x00000000000000000000000000000000000000000000000000000000000000a0",
                        "0x0000000000000000000000000000000000000000000000000000000000000002",
                        "10000000",
                        "10000000",
                        "0x0000000000000000000000000000000000000000000000000000000000000002",
                        "1000000",
                        "1000000"
                    ],
                    "expected": {
                        "return_data": [
                            "10000000"
                        ],
                        "events": [
                            {
                                "topics": [
                                    "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                                    "0x0000000000000000000000000000000000000000000000000000000000000000",
                                    "Mooniswap.address"
                                ],
                                "values": [
                                    "1000"
                                ]
                            },
                            {
                                "topics": [
                                    "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                                    "0xdeadbeef00000000000000000000000000000042",
                                    "Mooniswap.address"
                                ],
                                "values": [
                                    "10000000"
                                ]
                            },
                            {
                                "topics": [
                                    "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
                                    "0xdeadbeef00000000000000000000000000000042",
                                    "Mooniswap.address"
                                ],
                                "values": [
                                    "490000000"
                                ]
                            },
                            {
                                "topics": [
                                    "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                                    "0xdeadbeef00000000000000000000000000000042",
                                    "Mooniswap.address"
                                ],
                                "values": [
                                    "10000000"
                                ]
                            },
                            {
                                "topics": [
                                    "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
                                    "0xdeadbeef00000000000000000000000000000042",
                                    "Mooniswap.address"
                                ],
                                "values": [
                                    "490000000"
                                ]
                            },
                            {
                                "topics": [
                                    "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                                    "0x0000000000000000000000000000000000000000000000000000000000000000",
                                    "0xdeadbeef00000000000000000000000000000042"
                                ],
                                "values": [
                                    "10000000"
                                ]
                            },
                            {
                                "topics": [
                                    "0x2da466a7b24304f47e87fa2e1e5a81b9831ce54fec19055ce277ca2f39ba42c4",
                                    "0xdeadbeef00000000000000000000000000000042"
                                ],
                                "values": [
                                    "10000000"
                                ]
                            }
                        ],
                        "exception": false
                    }
                },
                {
                    "instance": "Mooniswap",
                    "caller": "0xdeadbeef00000000000000000000000000000042",
                    "method": "swap",
                    "calldata": [
                        "WBTC_1.address",
                        "WBTC_2.address",
                        "5000",
                        "5000",
                        "0"
                    ]
                }
            ],
            "expected": {
                "return_data": [
                    "5000"
                ],
                "events": [
                    {
                        "topics": [
                            "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                            "0xdeadbeef00000000000000000000000000000042",
                            "Mooniswap.address"
                        ],
                        "values": [
                            "5000"
                        ]
                    },
                    {
                        "topics": [
                            "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
                            "0xdeadbeef00000000000000000000000000000042",
                            "Mooniswap.address"
                        ],
                        "values": [
                            "489995000"
                        ]
                    }
                ],
                "exception": false
            }
        }
    ],
    "contracts": {
        "Mooniswap": "Mooniswap.sol:Mooniswap",
        "WBTC_1": "ERC20/ERC20.sol:ERC20",
        "WBTC_2": "ERC20/ERC20.sol:ERC20",
        "VirtualBalance": "Mooniswap.sol:VirtualBalance",
        "Math": "math/Math.sol:Math"
    },
    "libraries": {
        "Mooniswap.sol": {
            "VirtualBalance": "VirtualBalance"
        },
        "math/Math.sol": {
            "Math": "Math"
        }
    },
    "group": "Real life"
 }
@@ -44,9 +44,12 @@ pub trait SolidityCompiler {
 pub struct CompilerInput<T: PartialEq + Eq + Hash> {
    pub extra_options: T,
    pub input: SolcStandardJsonInput,
    pub allow_paths: Vec<PathBuf>,
    pub base_path: Option<PathBuf>,
 }
 /// The generic compilation output configuration.
 #[derive(Debug)]
 pub struct CompilerOutput<T: PartialEq + Eq + Hash> {
    /// The solc standard JSON input.
    pub input: CompilerInput<T>,
@@ -83,8 +86,8 @@ where
 pub struct Compiler<T: SolidityCompiler> {
    input: SolcStandardJsonInput,
    extra_options: T::Options,
-    allow_paths: Vec<String>,
+    allow_paths: Vec<PathBuf>,
-    base_path: Option<String>,
+    base_path: Option<PathBuf>,
 }
 impl Default for Compiler<solc::Solc> {
@@ -145,12 +148,12 @@ where
        self
    }
-    pub fn allow_path(mut self, path: String) -> Self {
+    pub fn allow_path(mut self, path: PathBuf) -> Self {
        self.allow_paths.push(path);
        self
    }
-    pub fn base_path(mut self, base_path: String) -> Self {
+    pub fn base_path(mut self, base_path: PathBuf) -> Self {
        self.base_path = Some(base_path);
        self
    }
@@ -159,6 +162,8 @@ where
        T::new(solc_path).build(CompilerInput {
            extra_options: self.extra_options,
            input: self.input,
            allow_paths: self.allow_paths,
            base_path: self.base_path,
        })
    }
@@ -11,6 +11,7 @@ use revive_dt_config::Arguments;
 use revive_solc_json_interface::SolcStandardJsonOutput;
 /// A wrapper around the `resolc` binary, emitting PVM-compatible bytecode.
 #[derive(Debug)]
 pub struct Resolc {
    /// Path to the `resolc` executable
    resolc_path: PathBuf,
@@ -19,17 +20,32 @@ pub struct Resolc {
 impl SolidityCompiler for Resolc {
    type Options = Vec<String>;
    #[tracing::instrument(level = "debug", ret)]
    fn build(
        &self,
        input: CompilerInput<Self::Options>,
    ) -> anyhow::Result<CompilerOutput<Self::Options>> {
-        let mut child = Command::new(&self.resolc_path)
+        let mut command = Command::new(&self.resolc_path);
-            .arg("--standard-json")
+        command
            .args(&input.extra_options)
            .stdin(Stdio::piped())
            .stdout(Stdio::piped())
            .stderr(Stdio::piped())
-            .spawn()?;
+            .arg("--standard-json");
        if let Some(ref base_path) = input.base_path {
            command.arg("--base-path").arg(base_path);
        }
        if !input.allow_paths.is_empty() {
            command.arg("--allow-paths").arg(
                input
                    .allow_paths
                    .iter()
                    .map(|path| path.display().to_string())
                    .collect::<Vec<_>>()
                    .join(","),
            );
        }
        let mut child = command.spawn()?;
        let stdin_pipe = child.stdin.as_mut().expect("stdin must be piped");
        serde_json::to_writer(stdin_pipe, &input.input)?;
@@ -55,13 +71,65 @@ impl SolidityCompiler for Resolc {
            });
        }
-        let parsed: SolcStandardJsonOutput = serde_json::from_slice(&stdout).map_err(|e| {
+        let mut parsed =
            serde_json::from_slice::<SolcStandardJsonOutput>(&stdout).map_err(|e| {
                anyhow::anyhow!(
                    "failed to parse resolc JSON output: {e}\nstderr: {}",
                    String::from_utf8_lossy(&stderr)
                )
            })?;
        // Detecting if the compiler output contained errors and reporting them through logs and
        // errors instead of returning the compiler output that might contain errors.
        for error in parsed.errors.iter().flatten() {
            if error.severity == "error" {
                tracing::error!(?error, ?input, "Encountered an error in the compilation");
                anyhow::bail!("Encountered an error in the compilation: {error}")
            }
        }
        // We need to do some post processing on the output to make it in the same format that solc
        // outputs. More specifically, for each contract, the `.metadata` field should be replaced
        // with the `.metadata.solc_metadata` field which contains the ABI and other information
        // about the compiled contracts. We do this because we do not want any downstream logic to
        // need to differentiate between which compiler is being used when extracting the ABI of the
        // contracts.
        if let Some(ref mut contracts) = parsed.contracts {
            for (contract_path, contracts_map) in contracts.iter_mut() {
                for (contract_name, contract_info) in contracts_map.iter_mut() {
                    let Some(metadata) = contract_info.metadata.take() else {
                        continue;
                    };
                    // Get the `solc_metadata` in the metadata of the contract.
                    let Some(solc_metadata) = metadata
                        .get("solc_metadata")
                        .and_then(|metadata| metadata.as_str())
                    else {
                        tracing::error!(
                            contract_path,
                            contract_name,
                            metadata = serde_json::to_string(&metadata).unwrap(),
                            "Encountered a contract compiled with resolc that has no solc_metadata"
                        );
                        anyhow::bail!(
                            "Contract {} compiled with resolc that has no solc_metadata",
                            contract_name
                        );
                    };
                    // Replace the original metadata with the new solc_metadata.
                    contract_info.metadata =
                        Some(serde_json::Value::String(solc_metadata.to_string()));
                }
            }
        }
        tracing::debug!(
            output = %serde_json::to_string(&parsed).unwrap(),
            "Compiled successfully"
        );
        Ok(CompilerOutput {
            input,
            output: parsed,
@@ -9,7 +9,9 @@ use std::{
 use crate::{CompilerInput, CompilerOutput, SolidityCompiler};
 use revive_dt_config::Arguments;
 use revive_dt_solc_binaries::download_solc;
 use revive_solc_json_interface::SolcStandardJsonOutput;
 #[derive(Debug)]
 pub struct Solc {
    solc_path: PathBuf,
 }
@@ -17,16 +19,32 @@ pub struct Solc {
 impl SolidityCompiler for Solc {
    type Options = ();
    #[tracing::instrument(level = "debug", ret)]
    fn build(
        &self,
        input: CompilerInput<Self::Options>,
    ) -> anyhow::Result<CompilerOutput<Self::Options>> {
-        let mut child = Command::new(&self.solc_path)
+        let mut command = Command::new(&self.solc_path);
        command
            .stdin(Stdio::piped())
            .stdout(Stdio::piped())
            .stderr(Stdio::piped())
-            .arg("--standard-json")
+            .arg("--standard-json");
-            .spawn()?;
+
        if let Some(ref base_path) = input.base_path {
            command.arg("--base-path").arg(base_path);
        }
        if !input.allow_paths.is_empty() {
            command.arg("--allow-paths").arg(
                input
                    .allow_paths
                    .iter()
                    .map(|path| path.display().to_string())
                    .collect::<Vec<_>>()
                    .join(","),
            );
        }
        let mut child = command.spawn()?;
        let stdin = child.stdin.as_mut().expect("should be piped");
        serde_json::to_writer(stdin, &input.input)?;
@@ -42,9 +60,31 @@ impl SolidityCompiler for Solc {
            });
        }
        let parsed =
            serde_json::from_slice::<SolcStandardJsonOutput>(&output.stdout).map_err(|e| {
                anyhow::anyhow!(
                    "failed to parse resolc JSON output: {e}\nstderr: {}",
                    String::from_utf8_lossy(&output.stdout)
                )
            })?;
        // Detecting if the compiler output contained errors and reporting them through logs and
        // errors instead of returning the compiler output that might contain errors.
        for error in parsed.errors.iter().flatten() {
            if error.severity == "error" {
                tracing::error!(?error, ?input, "Encountered an error in the compilation");
                anyhow::bail!("Encountered an error in the compilation: {error}")
            }
        }
        tracing::debug!(
            output = %String::from_utf8_lossy(&output.stdout).to_string(),
            "Compiled successfully"
        );
        Ok(CompilerOutput {
            input,
-            output: serde_json::from_slice(&output.stdout)?,
+            output: parsed,
            error: None,
        })
    }
@@ -1,4 +1,4 @@
-//! The global configuration used accross all revive differential testing crates.
+//! The global configuration used across all revive differential testing crates.
 use std::{
    fmt::Display,
@@ -23,6 +23,7 @@ revive-dt-report = { workspace = true }
 alloy = { workspace = true }
 anyhow = { workspace = true }
 clap = { workspace = true }
 indexmap = { workspace = true }
 tracing = { workspace = true }
 tracing-subscriber = { workspace = true }
 rayon = { workspace = true }
@@ -0,0 +1,73 @@
 use std::{borrow::Cow, collections::HashSet, path::PathBuf};
 /// An iterator that finds files of a certain extension in the provided directory. You can think of
 /// this a glob pattern similar to: `${path}/**/*.md`
 pub struct FilesWithExtensionIterator {
    /// The set of allowed extensions that that match the requirement and that should be returned
    /// when found.
    allowed_extensions: HashSet<Cow<'static, str>>,
    /// The set of directories to visit next. This iterator does BFS and so these directories will
    /// only be visited if we can't find any files in our state.
    directories_to_search: Vec<PathBuf>,
    /// The set of files matching the allowed extensions that were found. If there are entries in
    /// this vector then they will be returned when the [`Iterator::next`] method is called. If not
    /// then we visit one of the next directories to visit.
    files_matching_allowed_extensions: Vec<PathBuf>,
 }
 impl FilesWithExtensionIterator {
    pub fn new(root_directory: PathBuf) -> Self {
        Self {
            allowed_extensions: Default::default(),
            directories_to_search: vec![root_directory],
            files_matching_allowed_extensions: Default::default(),
        }
    }
    pub fn with_allowed_extension(
        mut self,
        allowed_extension: impl Into<Cow<'static, str>>,
    ) -> Self {
        self.allowed_extensions.insert(allowed_extension.into());
        self
    }
 }
 impl Iterator for FilesWithExtensionIterator {
    type Item = PathBuf;
    fn next(&mut self) -> Option<Self::Item> {
        if let Some(file_path) = self.files_matching_allowed_extensions.pop() {
            return Some(file_path);
        };
        let directory_to_search = self.directories_to_search.pop()?;
        // Read all of the entries in the directory. If we failed to read this dir's entires then we
        // elect to just ignore it and look in the next directory, we do that by calling the next
        // method again on the iterator, which is an intentional decision that we made here instead
        // of panicking.
        let Ok(dir_entries) = std::fs::read_dir(directory_to_search) else {
            return self.next();
        };
        for entry in dir_entries.flatten() {
            let entry_path = entry.path();
            if entry_path.is_dir() {
                self.directories_to_search.push(entry_path)
            } else if entry_path.is_file()
                && entry_path.extension().is_some_and(|ext| {
                    self.allowed_extensions
                        .iter()
                        .any(|allowed| ext.eq_ignore_ascii_case(allowed.as_ref()))
                })
            {
                self.files_matching_allowed_extensions.push(entry_path)
            }
        }
        self.next()
    }
 }
@@ -1,39 +1,58 @@
 //! The test driver handles the compilation and execution of the test cases.
 use std::collections::HashMap;
 use std::marker::PhantomData;
 use alloy::json_abi::JsonAbi;
-use alloy::primitives::Bytes;
+use alloy::network::{Ethereum, TransactionBuilder};
 use alloy::rpc::types::TransactionReceipt;
 use alloy::rpc::types::trace::geth::GethTrace;
 use alloy::rpc::types::{TransactionInput, TransactionReceipt};
 use alloy::{
-    primitives::{Address, TxKind, map::HashMap},
+    primitives::Address,
    rpc::types::{
        TransactionRequest,
        trace::geth::{AccountState, DiffMode},
    },
 };
-use revive_dt_compiler::{Compiler, CompilerInput, SolidityCompiler};
+use anyhow::Context;
 use indexmap::IndexMap;
 use revive_dt_compiler::{Compiler, SolidityCompiler};
 use revive_dt_config::Arguments;
 use revive_dt_format::case::CaseIdx;
 use revive_dt_format::input::Method;
 use revive_dt_format::metadata::{ContractInstance, ContractPathAndIdentifier};
 use revive_dt_format::{input::Input, metadata::Metadata, mode::SolcMode};
 use revive_dt_node_interaction::EthereumNode;
 use revive_dt_report::reporter::{CompilationTask, Report, Span};
 use revive_solc_json_interface::SolcStandardJsonOutput;
 use serde_json::Value;
-use std::collections::HashMap as StdHashMap;
+use std::fmt::Debug;
 use tracing::Level;
 use crate::Platform;
-
+use crate::common::*;
 type Contracts<T> = HashMap<
    CompilerInput<<<T as Platform>::Compiler as SolidityCompiler>::Options>,
    SolcStandardJsonOutput,
 >;
 pub struct State<'a, T: Platform> {
    /// The configuration that the framework was started with.
    ///
    /// This is currently used to get certain information from it such as the solc mode and other
    /// information used at runtime.
    config: &'a Arguments,
    /// The [`Span`] used in reporting.
    span: Span,
-    contracts: Contracts<T>,
+
-    deployed_contracts: StdHashMap<String, Address>,
+    /// A vector of all of the compiled contracts. Each call to [`build_contracts`] adds a new entry
-    deployed_abis: StdHashMap<String, JsonAbi>,
+    /// to this vector.
    ///
    /// [`build_contracts`]: State::build_contracts
    contracts: Vec<SolcStandardJsonOutput>,
    /// This map stores the contracts deployments that have been made for each case within a
    /// metadata file. Note, this means that the state can't be reused between different metadata
    /// files.
    deployed_contracts: HashMap<CaseIdx, HashMap<ContractInstance, (Address, JsonAbi)>>,
    phantom: PhantomData<T>,
 }
 impl<'a, T> State<'a, T>
@@ -46,7 +65,7 @@ where
            span,
            contracts: Default::default(),
            deployed_contracts: Default::default(),
-            deployed_abis: Default::default(),
+            phantom: Default::default(),
        }
    }
@@ -69,14 +88,13 @@ where
            anyhow::bail!("unsupported solc version: {:?}", &mode.solc_version);
        };
-        let mut compiler = Compiler::<T::Compiler>::new()
+        let compiler = Compiler::<T::Compiler>::new()
-            .base_path(metadata.directory()?.display().to_string())
+            .allow_path(metadata.directory()?)
            .solc_optimizer(mode.solc_optimize());
-        for (file, _contract) in metadata.contract_sources()?.values() {
+        let compiler = FilesWithExtensionIterator::new(metadata.directory()?)
-            tracing::debug!("contract source {}", file.display());
+            .with_allowed_extension("sol")
-            compiler = compiler.with_source(file)?;
+            .try_fold(compiler, |compiler, path| compiler.with_source(&path))?;
        }
        let mut task = CompilationTask {
            json_input: compiler.input(),
@@ -91,9 +109,9 @@ where
            Ok(output) => {
                task.json_output = Some(output.output.clone());
                task.error = output.error;
-                self.contracts.insert(output.input, output.output);
+                self.contracts.push(output.output);
-                if let Some(last_output) = self.contracts.values().last() {
+                if let Some(last_output) = self.contracts.last() {
                    if let Some(contracts) = &last_output.contracts {
                        for (file, contracts_map) in contracts {
                            for contract_name in contracts_map.keys() {
@@ -118,29 +136,194 @@ where
        }
    }
-    pub fn execute_input(
+    pub fn handle_input(
        &mut self,
        metadata: &Metadata,
        case_idx: CaseIdx,
        input: &Input,
        node: &T::Blockchain,
    ) -> anyhow::Result<(TransactionReceipt, GethTrace, DiffMode)> {
        let deployment_receipts =
            self.handle_contract_deployment(metadata, case_idx, input, node)?;
        self.handle_input_execution(case_idx, input, deployment_receipts, node)
    }
    /// Handles the contract deployment for a given input performing it if it needs to be performed.
    fn handle_contract_deployment(
        &mut self,
        metadata: &Metadata,
        case_idx: CaseIdx,
        input: &Input,
        node: &T::Blockchain,
    ) -> anyhow::Result<HashMap<ContractInstance, TransactionReceipt>> {
        let span = tracing::debug_span!(
            "Handling contract deployment",
            ?case_idx,
            instance = ?input.instance
        );
        let _guard = span.enter();
        let mut instances_we_must_deploy = IndexMap::<ContractInstance, bool>::new();
        for instance in input.find_all_contract_instances().into_iter() {
            if !self
                .deployed_contracts
                .entry(case_idx)
                .or_default()
                .contains_key(&instance)
            {
                instances_we_must_deploy.entry(instance).or_insert(false);
            }
        }
        if let Method::Deployer = input.method {
            instances_we_must_deploy.swap_remove(&input.instance);
            instances_we_must_deploy.insert(input.instance.clone(), true);
        }
        tracing::debug!(
            instances_to_deploy = instances_we_must_deploy.len(),
            "Computed the number of required deployments for input"
        );
        let mut receipts = HashMap::new();
        for (instance, deploy_with_constructor_arguments) in instances_we_must_deploy.into_iter() {
            // What we have at this moment is just a contract instance which is kind of like a variable
            // name for an actual underlying contract. So, we need to resolve this instance to the info
            // of the contract that it belongs to.
            let Some(ContractPathAndIdentifier {
                contract_source_path,
                contract_ident,
            }) = metadata.contract_sources()?.remove(&instance)
            else {
                tracing::error!("Contract source not found for instance");
                anyhow::bail!("Contract source not found for instance {:?}", instance)
            };
            let compiled_contract = self.contracts.iter().find_map(|output| {
                output
                    .contracts
                    .as_ref()?
                    .get(&contract_source_path.display().to_string())
                    .and_then(|source_file_contracts| {
                        source_file_contracts.get(contract_ident.as_ref())
                    })
            });
            let Some(code) = compiled_contract
                .and_then(|contract| contract.evm.as_ref().and_then(|evm| evm.bytecode.as_ref()))
            else {
                tracing::error!(
                    contract_source_path = contract_source_path.display().to_string(),
                    contract_ident = contract_ident.as_ref(),
                    "Failed to find bytecode for contract"
                );
                anyhow::bail!("Failed to find bytecode for contract {:?}", instance)
            };
            // TODO: When we want to do linking it would be best to do it at this stage here. We have
            // the context from the metadata files and therefore know what needs to be linked and in
            // what order it needs to happen.
            let mut code = match alloy::hex::decode(&code.object) {
                Ok(code) => code,
                Err(error) => {
                    tracing::error!(
                        ?error,
                        contract_source_path = contract_source_path.display().to_string(),
                        contract_ident = contract_ident.as_ref(),
                        "Failed to hex-decode byte code - This could possibly mean that the bytecode requires linking"
                    );
                    anyhow::bail!("Failed to hex-decode the byte code {}", error)
                }
            };
            if deploy_with_constructor_arguments {
                let encoded_input = input
                    .encoded_input(self.deployed_contracts.entry(case_idx).or_default(), node)?;
                code.extend(encoded_input.to_vec());
            }
            let tx = {
                let tx = TransactionRequest::default().from(input.caller);
                TransactionBuilder::<Ethereum>::with_deploy_code(tx, code)
            };
            let receipt = match node.execute_transaction(tx) {
                Ok(receipt) => receipt,
                Err(error) => {
                    tracing::error!(
                        node = std::any::type_name::<T>(),
                        ?error,
                        "Contract deployment transaction failed."
                    );
                    return Err(error);
                }
            };
            let Some(address) = receipt.contract_address else {
                tracing::error!("Contract deployment transaction didn't return an address");
                anyhow::bail!("Contract deployment didn't return an address");
            };
            tracing::info!(
                instance_name = ?instance,
                instance_address = ?address,
                "Deployed contract"
            );
            let Some(Value::String(metadata)) =
                compiled_contract.and_then(|contract| contract.metadata.as_ref())
            else {
                tracing::error!("Contract does not have a metadata field");
                anyhow::bail!("Contract does not have a metadata field");
            };
            let Ok(metadata) = serde_json::from_str::<Value>(metadata) else {
                tracing::error!(%metadata, "Failed to parse solc metadata into a structured value");
                anyhow::bail!("Failed to parse solc metadata into a structured value {metadata}");
            };
            let Some(abi) = metadata.get("output").and_then(|value| value.get("abi")) else {
                tracing::error!(%metadata, "Failed to access the .output.abi field of the solc metadata");
                anyhow::bail!(
                    "Failed to access the .output.abi field of the solc metadata {metadata}"
                );
            };
            let Ok(abi) = serde_json::from_value::<JsonAbi>(abi.clone()) else {
                tracing::error!(%metadata, "Failed to deserialize ABI into a structured format");
                anyhow::bail!("Failed to deserialize ABI into a structured format {metadata}");
            };
            self.deployed_contracts
                .entry(case_idx)
                .or_default()
                .insert(instance.clone(), (address, abi));
            receipts.insert(instance.clone(), receipt);
        }
        Ok(receipts)
    }
    /// Handles the execution of the input in terms of the calls that need to be made.
    fn handle_input_execution(
        &mut self,
        case_idx: CaseIdx,
        input: &Input,
        deployment_receipts: HashMap<ContractInstance, TransactionReceipt>,
        node: &T::Blockchain,
    ) -> anyhow::Result<(TransactionReceipt, GethTrace, DiffMode)> {
        tracing::trace!("Calling execute_input for input: {input:?}");
-        let nonce = node.fetch_add_nonce(input.caller)?;
+        let receipt = match input.method {
-
+            // This input was already executed when `handle_input` was called. We just need to
-        tracing::debug!(
+            // lookup the transaction receipt in this case and continue on.
-            "Nonce calculated on the execute contract, calculated nonce {}, for contract {}, having address {} on node: {}",
+            Method::Deployer => deployment_receipts
-            &nonce,
+                .get(&input.instance)
-            &input.instance,
+                .context("Failed to find deployment receipt")?
-            &input.caller,
+                .clone(),
-            std::any::type_name::<T>()
+            Method::Fallback | Method::FunctionName(_) => {
-        );
+                let tx = match input
-
+                    .legacy_transaction(self.deployed_contracts.entry(case_idx).or_default(), node)
-        let tx = match input.legacy_transaction(
+                {
            self.config.network_id,
            nonce,
            &self.deployed_contracts,
            &self.deployed_abis,
        ) {
                    Ok(tx) => {
                        tracing::debug!("Legacy transaction data: {tx:#?}");
                        tx
@@ -153,28 +336,30 @@ where
                tracing::trace!("Executing transaction for input: {input:?}");
-        let receipt = match node.execute_transaction(tx) {
+                match node.execute_transaction(tx) {
                    Ok(receipt) => receipt,
                    Err(err) => {
                        tracing::error!(
                            "Failed to execute transaction when executing the contract: {}, {:?}",
-                    &input.instance,
+                            &*input.instance,
                            err
                        );
                        return Err(err);
                    }
                }
            }
        };
        tracing::trace!(
            "Transaction receipt for executed contract: {} - {:?}",
-            &input.instance,
+            &*input.instance,
            receipt,
        );
        let trace = node.trace_transaction(receipt.clone())?;
        tracing::trace!(
            "Trace result for contract: {} - {:?}",
-            &input.instance,
+            &*input.instance,
            trace
        );
@@ -182,160 +367,6 @@ where
        Ok((receipt, trace, diff))
    }
    pub fn deploy_contracts(&mut self, input: &Input, node: &T::Blockchain) -> anyhow::Result<()> {
        tracing::debug!(
            "Deploying contracts {}, having address {} on node: {}",
            &input.instance,
            &input.caller,
            std::any::type_name::<T>()
        );
        for output in self.contracts.values() {
            let Some(contract_map) = &output.contracts else {
                tracing::debug!(
                    "No contracts in output — skipping deployment for this input {}",
                    &input.instance
                );
                continue;
            };
            for contracts in contract_map.values() {
                for (contract_name, contract) in contracts {
                    tracing::debug!(
                        "Contract name is: {:?} and the input name is: {:?}",
                        &contract_name,
                        &input.instance
                    );
                    let bytecode = contract
                        .evm
                        .as_ref()
                        .and_then(|evm| evm.bytecode.as_ref())
                        .map(|b| b.object.clone());
                    let Some(code) = bytecode else {
                        tracing::error!("no bytecode for contract {contract_name}");
                        continue;
                    };
                    let nonce = node.fetch_add_nonce(input.caller)?;
                    tracing::debug!(
                        "Calculated nonce {}, for contract {}, having address {} on node: {}",
                        &nonce,
                        &input.instance,
                        &input.caller,
                        std::any::type_name::<T>()
                    );
                    let tx = TransactionRequest {
                        from: Some(input.caller),
                        to: Some(TxKind::Create),
                        gas_price: Some(5_000_000),
                        gas: Some(5_000_000),
                        chain_id: Some(self.config.network_id),
                        nonce: Some(nonce),
                        input: TransactionInput::new(Bytes::from(code.into_bytes())),
                        ..Default::default()
                    };
                    let receipt = match node.execute_transaction(tx) {
                        Ok(receipt) => receipt,
                        Err(err) => {
                            tracing::error!(
                                "Failed to execute transaction when deploying the contract on node : {:?}, {:?}, {:?}",
                                std::any::type_name::<T>(),
                                &contract_name,
                                err
                            );
                            return Err(err);
                        }
                    };
                    tracing::debug!(
                        "Deployment tx sent for {} with nonce {} → tx hash: {:?}, on node: {:?}",
                        contract_name,
                        nonce,
                        receipt.transaction_hash,
                        std::any::type_name::<T>(),
                    );
                    tracing::trace!(
                        "Deployed transaction receipt for contract: {} - {:?}, on node: {:?}",
                        &contract_name,
                        receipt,
                        std::any::type_name::<T>(),
                    );
                    let Some(address) = receipt.contract_address else {
                        tracing::error!(
                            "contract {contract_name} deployment did not return an address"
                        );
                        continue;
                    };
                    self.deployed_contracts
                        .insert(contract_name.clone(), address);
                    tracing::trace!(
                        "deployed contract `{}` at {:?}, on node {:?}",
                        contract_name,
                        address,
                        std::any::type_name::<T>()
                    );
                    if let Some(Value::String(metadata_json_str)) = &contract.metadata {
                        tracing::trace!(
                            "metadata found for contract {contract_name}, {metadata_json_str}"
                        );
                        match serde_json::from_str::<serde_json::Value>(metadata_json_str) {
                            Ok(metadata_json) => {
                                if let Some(abi_value) =
                                    metadata_json.get("output").and_then(|o| o.get("abi"))
                                {
                                    match serde_json::from_value::<JsonAbi>(abi_value.clone()) {
                                        Ok(parsed_abi) => {
                                            tracing::trace!(
                                                "ABI found in metadata for contract {}",
                                                &contract_name
                                            );
                                            self.deployed_abis
                                                .insert(contract_name.clone(), parsed_abi);
                                        }
                                        Err(err) => {
                                            anyhow::bail!(
                                                "Failed to parse ABI from metadata for contract {}: {}",
                                                contract_name,
                                                err
                                            );
                                        }
                                    }
                                } else {
                                    anyhow::bail!(
                                        "No ABI found in metadata for contract {}",
                                        contract_name
                                    );
                                }
                            }
                            Err(err) => {
                                anyhow::bail!(
                                    "Failed to parse metadata JSON string for contract {}: {}",
                                    contract_name,
                                    err
                                );
                            }
                        }
                    } else {
                        anyhow::bail!("No metadata found for contract {}", contract_name);
                    }
                }
            }
        }
        tracing::debug!("Available contracts: {:?}", self.deployed_contracts.keys());
        Ok(())
    }
 }
 pub struct Driver<'a, Leader: Platform, Follower: Platform> {
@@ -390,67 +421,161 @@ where
        }
    }
-    pub fn execute(&mut self, span: Span) -> anyhow::Result<()> {
+    // A note on this function and the choice of how we handle errors that happen here. This is not
    // a doc comment since it's a comment for the maintainers of this code and not for the users of
    // this code.
    //
    // This function does a few things: it builds the contracts for the various SOLC modes needed.
    // It deploys the contracts to the chain, and it executes the various inputs that are specified
    // for the test cases.
    //
    // In most functions in the codebase, it's fine to just say "If we encounter an error just
    // bubble it up to the caller", but this isn't a good idea to do here and we need an elaborate
    // way to report errors all while being graceful and continuing execution where we can. For
    // example, if one of the inputs of one of the cases fail to execute, then we should not just
    // bubble that error up immediately. Instead, we should note it down and continue to the next
    // case as the next case might succeed.
    //
    // Therefore, this method returns an `ExecutionResult` object, and not just a normal `Result`.
    // This object is fully typed to contain information about what exactly in the execution was a
    // success and what failed.
    //
    // The above then allows us to have better logging and better information in the caller of this
    // function as we have a more detailed view of what worked and what didn't.
    pub fn execute(&mut self, span: Span) -> ExecutionResult {
        // This is the execution result object that all of the execution information will be
        // collected into and returned at the end of the execution.
        let mut execution_result = ExecutionResult::default();
        let tracing_span = tracing::info_span!("Handling metadata file");
        let _guard = tracing_span.enter();
        for mode in self.metadata.solc_modes() {
            let tracing_span = tracing::info_span!("With solc mode", solc_mode = ?mode);
            let _guard = tracing_span.enter();
            let mut leader_state = State::<L>::new(self.config, span);
            leader_state.build_contracts(&mode, self.metadata)?;
            let mut follower_state = State::<F>::new(self.config, span);
            follower_state.build_contracts(&mode, self.metadata)?;
-            for (case_idx, case) in self.metadata.cases.iter().enumerate() {
+            // We build the contracts. If building the contracts for the metadata file fails then we
-                // Creating a tracing span to know which case within the metadata is being executed
+            // have no other option but to keep note of this error and move on to the next solc mode
-                // and which one we're getting logs for.
+            // and NOT just bail out of the execution as a whole.
-                let tracing_span = tracing::span!(
+            let build_result = tracing::info_span!("Building contracts").in_scope(|| {
-                    Level::INFO,
+                match leader_state.build_contracts(&mode, self.metadata) {
-                    "Executing case",
+                    Ok(_) => {
-                    case = case.name,
+                        tracing::debug!(target = ?Target::Leader, "Contract building succeeded");
                        execution_result.add_successful_build(Target::Leader, mode.clone());
                    },
                    Err(error) => {
                        tracing::error!(target = ?Target::Leader, ?error, "Contract building failed");
                        execution_result.add_failed_build(Target::Leader, mode.clone(), error);
                        return Err(());
                    }
                }
                match follower_state.build_contracts(&mode, self.metadata) {
                    Ok(_) => {
                        tracing::debug!(target = ?Target::Follower, "Contract building succeeded");
                        execution_result.add_successful_build(Target::Follower, mode.clone());
                    },
                    Err(error) => {
                        tracing::error!(target = ?Target::Follower, ?error, "Contract building failed");
                        execution_result.add_failed_build(Target::Follower, mode.clone(), error);
                        return Err(());
                    }
                }
                Ok(())
            });
            if build_result.is_err() {
                // Note: We skip to the next solc mode as there's nothing that we can do at this
                // point, the building has failed. We do NOT bail out of the execution as a whole.
                continue;
            }
            // For cases if one of the inputs fail then we move on to the next case and we do NOT
            // bail out of the whole thing.
            'case_loop: for (case_idx, case) in self.metadata.cases.iter().enumerate() {
                let tracing_span = tracing::info_span!(
                    "Handling case",
                    case_name = case.name,
                    case_idx = case_idx
                );
                let _guard = tracing_span.enter();
-                for input in &case.inputs {
+                let case_idx = CaseIdx::new_from(case_idx);
                    tracing::debug!("Starting deploying contract {}", &input.instance);
                    if let Err(err) = leader_state.deploy_contracts(input, self.leader_node) {
                        tracing::error!("Leader deployment failed for {}: {err}", input.instance);
                        continue;
                    } else {
                        tracing::debug!("Leader deployment succeeded for {}", &input.instance);
                    }
-                    if let Err(err) = follower_state.deploy_contracts(input, self.follower_node) {
+                // For inputs if one of the inputs fail we move on to the next case (we do not move
-                        tracing::error!("Follower deployment failed for {}: {err}", input.instance);
+                // on to the next input as it doesn't make sense. It depends on the previous one).
-                        continue;
+                for (input_idx, input) in case.inputs.iter().enumerate() {
-                    } else {
+                    let tracing_span = tracing::info_span!("Handling input", input_idx);
-                        tracing::debug!("Follower deployment succeeded for {}", &input.instance);
+                    let _guard = tracing_span.enter();
                    }
-                    tracing::debug!("Starting executing contract {}", &input.instance);
+                    let execution_result =
-
+                        tracing::info_span!("Executing input", contract_name = ?input.instance)
-                    let (leader_receipt, _, leader_diff) =
+                            .in_scope(|| {
-                        match leader_state.execute_input(input, self.leader_node) {
+                                let (leader_receipt, _, leader_diff) = match leader_state
                                    .handle_input(self.metadata, case_idx, input, self.leader_node)
                                {
                                    Ok(result) => result,
-                            Err(err) => {
+                                    Err(error) => {
                                        tracing::error!(
-                                    "Leader execution failed for {}: {err}",
+                                            target = ?Target::Leader,
-                                    input.instance
+                                            ?error,
                                            "Contract execution failed"
                                        );
-                                continue;
+                                        execution_result.add_failed_case(
                                            Target::Leader,
                                            mode.clone(),
                                            case.name
                                                .as_deref()
                                                .unwrap_or("no case name")
                                                .to_owned(),
                                            case_idx,
                                            input_idx,
                                            anyhow::Error::msg(format!("{error}")),
                                        );
                                        return Err(error);
                                    }
                                };
-                    let (follower_receipt, _, follower_diff) =
+                                let (follower_receipt, _, follower_diff) = match follower_state
-                        match follower_state.execute_input(input, self.follower_node) {
+                                    .handle_input(
                                        self.metadata,
                                        case_idx,
                                        input,
                                        self.follower_node,
                                    ) {
                                    Ok(result) => result,
-                            Err(err) => {
+                                    Err(error) => {
                                        tracing::error!(
-                                    "Follower execution failed for {}: {err}",
+                                            target = ?Target::Follower,
-                                    input.instance
+                                            ?error,
                                            "Contract execution failed"
                                        );
-                                continue;
+                                        execution_result.add_failed_case(
                                            Target::Follower,
                                            mode.clone(),
                                            case.name
                                                .as_deref()
                                                .unwrap_or("no case name")
                                                .to_owned(),
                                            case_idx,
                                            input_idx,
                                            anyhow::Error::msg(format!("{error}")),
                                        );
                                        return Err(error);
                                    }
                                };
                                Ok((leader_receipt, leader_diff, follower_receipt, follower_diff))
                            });
                    let Ok((leader_receipt, leader_diff, follower_receipt, follower_diff)) =
                        execution_result
                    else {
                        // Noting it again here: if something in the input fails we do not move on
                        // to the next input, we move to the next case completely.
                        continue 'case_loop;
                    };
                    if leader_diff == follower_diff {
                        tracing::debug!("State diffs match between leader and follower.");
                    } else {
@@ -473,9 +598,237 @@ where
                        );
                    }
                }
                // Note: Only consider the case as having been successful after we have processed
                // all of the inputs and completed the entire loop over the input.
                execution_result.add_successful_case(
                    Target::Leader,
                    mode.clone(),
                    case.name.clone().unwrap_or("no case name".to_owned()),
                    case_idx,
                );
                execution_result.add_successful_case(
                    Target::Follower,
                    mode.clone(),
                    case.name.clone().unwrap_or("no case name".to_owned()),
                    case_idx,
                );
            }
        }
-        Ok(())
+        execution_result
    }
 }
 #[derive(Debug, Default)]
 pub struct ExecutionResult {
    pub results: Vec<Box<dyn ExecutionResultItem>>,
    pub successful_cases_count: usize,
    pub failed_cases_count: usize,
 }
 impl ExecutionResult {
    pub fn new() -> Self {
        Self {
            results: Default::default(),
            successful_cases_count: Default::default(),
            failed_cases_count: Default::default(),
        }
    }
    pub fn add_successful_build(&mut self, target: Target, solc_mode: SolcMode) {
        self.results
            .push(Box::new(BuildResult::Success { target, solc_mode }));
    }
    pub fn add_failed_build(&mut self, target: Target, solc_mode: SolcMode, error: anyhow::Error) {
        self.results.push(Box::new(BuildResult::Failure {
            target,
            solc_mode,
            error,
        }));
    }
    pub fn add_successful_case(
        &mut self,
        target: Target,
        solc_mode: SolcMode,
        case_name: String,
        case_idx: CaseIdx,
    ) {
        self.successful_cases_count += 1;
        self.results.push(Box::new(CaseResult::Success {
            target,
            solc_mode,
            case_name,
            case_idx,
        }));
    }
    pub fn add_failed_case(
        &mut self,
        target: Target,
        solc_mode: SolcMode,
        case_name: String,
        case_idx: CaseIdx,
        input_idx: usize,
        error: anyhow::Error,
    ) {
        self.failed_cases_count += 1;
        self.results.push(Box::new(CaseResult::Failure {
            target,
            solc_mode,
            case_name,
            case_idx,
            error,
            input_idx,
        }));
    }
 }
 pub trait ExecutionResultItem: Debug {
    /// Converts this result item into an [`anyhow::Result`].
    fn as_result(&self) -> Result<(), &anyhow::Error>;
    /// Provides information on whether the provided result item is of a success or failure.
    fn is_success(&self) -> bool;
    /// Provides information of the target that this result is for.
    fn target(&self) -> &Target;
    /// Provides information on the [`SolcMode`] mode that we being used for this result item.
    fn solc_mode(&self) -> &SolcMode;
    /// Provides information on the case name and number that this result item pertains to. This is
    /// [`None`] if the error doesn't belong to any case (e.g., if it's a build error outside of any
    /// of the cases.).
    fn case_name_and_index(&self) -> Option<(&str, &CaseIdx)>;
    /// Provides information on the input number that this result item pertains to. This is [`None`]
    /// if the error doesn't belong to any input (e.g., if it's a build error outside of any of the
    /// inputs.).
    fn input_index(&self) -> Option<usize>;
 }
 #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub enum Target {
    Leader,
    Follower,
 }
 #[derive(Debug)]
 pub enum BuildResult {
    Success {
        target: Target,
        solc_mode: SolcMode,
    },
    Failure {
        target: Target,
        solc_mode: SolcMode,
        error: anyhow::Error,
    },
 }
 impl ExecutionResultItem for BuildResult {
    fn as_result(&self) -> Result<(), &anyhow::Error> {
        match self {
            Self::Success { .. } => Ok(()),
            Self::Failure { error, .. } => Err(error)?,
        }
    }
    fn is_success(&self) -> bool {
        match self {
            Self::Success { .. } => true,
            Self::Failure { .. } => false,
        }
    }
    fn target(&self) -> &Target {
        match self {
            Self::Success { target, .. } | Self::Failure { target, .. } => target,
        }
    }
    fn solc_mode(&self) -> &SolcMode {
        match self {
            Self::Success { solc_mode, .. } | Self::Failure { solc_mode, .. } => solc_mode,
        }
    }
    fn case_name_and_index(&self) -> Option<(&str, &CaseIdx)> {
        None
    }
    fn input_index(&self) -> Option<usize> {
        None
    }
 }
 #[derive(Debug)]
 pub enum CaseResult {
    Success {
        target: Target,
        solc_mode: SolcMode,
        case_name: String,
        case_idx: CaseIdx,
    },
    Failure {
        target: Target,
        solc_mode: SolcMode,
        case_name: String,
        case_idx: CaseIdx,
        input_idx: usize,
        error: anyhow::Error,
    },
 }
 impl ExecutionResultItem for CaseResult {
    fn as_result(&self) -> Result<(), &anyhow::Error> {
        match self {
            Self::Success { .. } => Ok(()),
            Self::Failure { error, .. } => Err(error)?,
        }
    }
    fn is_success(&self) -> bool {
        match self {
            Self::Success { .. } => true,
            Self::Failure { .. } => false,
        }
    }
    fn target(&self) -> &Target {
        match self {
            Self::Success { target, .. } | Self::Failure { target, .. } => target,
        }
    }
    fn solc_mode(&self) -> &SolcMode {
        match self {
            Self::Success { solc_mode, .. } | Self::Failure { solc_mode, .. } => solc_mode,
        }
    }
    fn case_name_and_index(&self) -> Option<(&str, &CaseIdx)> {
        match self {
            Self::Success {
                case_name,
                case_idx,
                ..
            }
            | Self::Failure {
                case_name,
                case_idx,
                ..
            } => Some((case_name, case_idx)),
        }
    }
    fn input_index(&self) -> Option<usize> {
        match self {
            CaseResult::Success { .. } => None,
            CaseResult::Failure { input_idx, .. } => Some(*input_idx),
        }
    }
 }
@@ -1,13 +1,14 @@
 //! The revive differential testing core library.
 //!
 //! This crate defines the testing configuration and
-//! provides a helper utilty to execute tests.
+//! provides a helper utility to execute tests.
 use revive_dt_compiler::{SolidityCompiler, revive_resolc, solc};
 use revive_dt_config::TestingPlatform;
 use revive_dt_node::{geth, kitchensink::KitchensinkNode};
 use revive_dt_node_interaction::EthereumNode;
 pub mod common;
 pub mod driver;
 /// One platform can be tested differentially against another.
@@ -13,7 +13,7 @@ use revive_dt_node::pool::NodePool;
 use revive_dt_report::reporter::{Report, Span};
 use temp_dir::TempDir;
 use tracing::Level;
-use tracing_subscriber::{EnvFilter, FmtSubscriber, fmt::format::FmtSpan};
+use tracing_subscriber::{EnvFilter, FmtSubscriber};
 static TEMP_DIR: LazyLock<TempDir> = LazyLock::new(|| TempDir::new().unwrap());
@@ -39,7 +39,7 @@ fn init_cli() -> anyhow::Result<Arguments> {
        .with_thread_ids(true)
        .with_thread_names(true)
        .with_env_filter(EnvFilter::from_default_env())
-        .with_span_events(FmtSpan::ENTER | FmtSpan::CLOSE)
+        .with_ansi(false)
        .pretty()
        .finish();
    tracing::subscriber::set_global_default(subscriber)?;
@@ -116,19 +116,24 @@ where
                follower_nodes.round_robbin(),
            );
-            match driver.execute(span) {
+            let execution_result = driver.execute(span);
                Ok(_) => {
            tracing::info!(
-                        "metadata {} success",
+                case_success_count = execution_result.successful_cases_count,
-                        metadata.directory().as_ref().unwrap().display()
+                case_failure_count = execution_result.failed_cases_count,
                "Execution completed"
            );
            let mut error_count = 0;
            for result in execution_result.results.iter() {
                if !result.is_success() {
                    tracing::error!(execution_error = ?result, "Encountered an error");
                    error_count += 1;
                }
                Err(error) => {
                    tracing::warn!(
                        "metadata {} failure: {error:?}",
                        metadata.file_path.as_ref().unwrap().display()
                    );
            }
            if error_count == 0 {
                tracing::info!("Execution succeeded");
            } else {
                tracing::info!("Execution failed");
            }
        },
    );
@@ -9,6 +9,8 @@ repository.workspace = true
 rust-version.workspace = true
 [dependencies]
 revive-dt-node-interaction = { workspace = true }
 alloy = { workspace = true }
 alloy-primitives = { workspace = true }
 alloy-sol-types = { workspace = true }
@@ -1,6 +1,6 @@
 use serde::Deserialize;
-use crate::{input::Input, mode::Mode};
+use crate::{define_wrapper_type, input::Input, mode::Mode};
 #[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
 pub struct Case {
@@ -10,3 +10,9 @@ pub struct Case {
    pub inputs: Vec<Input>,
    pub group: Option<String>,
 }
 define_wrapper_type!(
    /// A wrapper type for the index of test cases found in metadata file.
    #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    CaseIdx(usize);
 );
@@ -1,25 +1,27 @@
 use std::collections::HashMap;
 use alloy::{
-    hex,
+    eips::BlockNumberOrTag,
-    json_abi::{Function, JsonAbi},
+    json_abi::JsonAbi,
-    primitives::{Address, Bytes, TxKind},
+    network::TransactionBuilder,
-    rpc::types::{TransactionInput, TransactionRequest},
+    primitives::{Address, Bytes, U256},
    rpc::types::TransactionRequest,
 };
 use alloy_primitives::U256;
 use alloy_sol_types::SolValue;
 use semver::VersionReq;
-use serde::{Deserialize, de::Deserializer};
+use serde::Deserialize;
 use serde_json::Value;
 use revive_dt_node_interaction::EthereumNode;
 use crate::metadata::ContractInstance;
 #[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
 pub struct Input {
    #[serde(default = "default_caller")]
    pub caller: Address,
    pub comment: Option<String>,
    #[serde(default = "default_instance")]
-    pub instance: String,
+    pub instance: ContractInstance,
    #[serde(deserialize_with = "deserialize_method")]
    pub method: Method,
    pub calldata: Option<Calldata>,
    pub expected: Option<Expected>,
@@ -47,222 +49,347 @@ pub struct ExpectedOutput {
 #[serde(untagged)]
 pub enum Calldata {
    Single(String),
-    Compound(Vec<CalldataArg>),
+    Compound(Vec<String>),
 }
 #[derive(Clone, Debug, Deserialize, Eq, PartialEq)]
 #[serde(untagged)]
 pub enum CalldataArg {
    Literal(String),
    /// For example: `Contract.address`
    AddressRef(String),
 }
 /// Specify how the contract is called.
-#[derive(Debug, Default, Clone, Eq, PartialEq)]
+#[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
 pub enum Method {
    /// Initiate a deploy transaction, calling contracts constructor.
    ///
    /// Indicated by `#deployer`.
    #[serde(rename = "#deployer")]
    Deployer,
    /// Does not calculate and insert a function selector.
    ///
    /// Indicated by `#fallback`.
    #[default]
    #[serde(rename = "#fallback")]
    Fallback,
-    /// Call the public function with this selector.
+
-    ///
+    /// Call the public function with the given name.
-    /// Calculates the selector if neither deployer or fallback matches.
+    #[serde(untagged)]
-    Function([u8; 4]),
+    FunctionName(String),
 }
-fn deserialize_method<'de, D>(deserializer: D) -> Result<Method, D::Error>
+impl Calldata {
-where
+    pub fn find_all_contract_instances(&self, vec: &mut Vec<ContractInstance>) {
-    D: Deserializer<'de>,
+        if let Calldata::Compound(compound) = self {
-{
+            for item in compound {
-    Ok(match String::deserialize(deserializer)?.as_str() {
+                if let Some(instance) = item.strip_suffix(".address") {
-        "#deployer" => Method::Deployer,
+                    vec.push(ContractInstance::new_from(instance))
        "#fallback" => Method::Fallback,
        signature => {
            let signature = if signature.ends_with(')') {
                signature.to_string()
            } else {
                format!("{signature}()")
            };
            match Function::parse(&signature) {
                Ok(function) => Method::Function(function.selector().0),
                Err(error) => {
                    return Err(serde::de::Error::custom(format!(
                        "parsing function signature '{signature}' error: {error}"
                    )));
                }
            }
        }
-    })
+    }
 }
 impl ExpectedOutput {
    pub fn find_all_contract_instances(&self, vec: &mut Vec<ContractInstance>) {
        if let Some(ref cd) = self.return_data {
            cd.find_all_contract_instances(vec);
        }
    }
 }
 impl Input {
    fn instance_to_address(
        &self,
-        instance: &str,
+        instance: &ContractInstance,
-        deployed_contracts: &HashMap<String, Address>,
+        deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
    ) -> anyhow::Result<Address> {
        deployed_contracts
            .get(instance)
-            .copied()
+            .map(|(a, _)| *a)
-            .ok_or_else(|| anyhow::anyhow!("instance {instance} not deployed"))
+            .ok_or_else(|| anyhow::anyhow!("instance {instance:?} not deployed"))
    }
    pub fn encoded_input(
        &self,
-        deployed_abis: &HashMap<String, JsonAbi>,
+        deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
-        deployed_contracts: &HashMap<String, Address>,
+        chain_state_provider: &impl EthereumNode,
    ) -> anyhow::Result<Bytes> {
-        let Method::Function(selector) = self.method else {
+        match self.method {
-            return Ok(Bytes::default()); // fallback or deployer — no input
+            Method::Deployer | Method::Fallback => {
                let calldata_args = match &self.calldata {
                    Some(Calldata::Compound(args)) => args,
                    _ => anyhow::bail!("Expected compound calldata for function call"),
                };
-        let abi = deployed_abis
+                let mut calldata = Vec::<u8>::with_capacity(calldata_args.len() * 32);
-            .get(&self.instance)
+                for (arg_idx, arg) in calldata_args.iter().enumerate() {
-            .ok_or_else(|| anyhow::anyhow!("ABI for instance '{}' not found", &self.instance))?;
+                    match resolve_argument(arg, deployed_contracts, chain_state_provider) {
                        Ok(resolved) => {
                            calldata.extend(resolved.to_be_bytes::<32>());
                        }
                        Err(error) => {
                            tracing::error!(arg, arg_idx, ?error, "Failed to resolve argument");
                            return Err(error);
                        }
                    };
                }
-        tracing::trace!("ABI found for instance: {}", &self.instance);
+                Ok(calldata.into())
            }
            Method::FunctionName(ref function_name) => {
                let Some(abi) = deployed_contracts.get(&self.instance).map(|(_, a)| a) else {
                    tracing::error!(
                        contract_name = self.instance.as_ref(),
                        available_abis = ?deployed_contracts.keys().collect::<Vec<_>>(),
                        "Attempted to lookup ABI of contract but it wasn't found"
                    );
                    anyhow::bail!("ABI for instance '{}' not found", self.instance.as_ref());
                };
-        // Find function by selector
+                tracing::trace!("ABI found for instance: {}", &self.instance.as_ref());
                // We follow the same logic that's implemented in the matter-labs-tester where they resolve
                // the function name into a function selector and they assume that he function doesn't have
                // any existing overloads.
                // https://github.com/matter-labs/era-compiler-tester/blob/1dfa7d07cba0734ca97e24704f12dd57f6990c2c/compiler_tester/src/test/case/input/mod.rs#L158-L190
                let function = abi
                    .functions()
-            .find(|f| f.selector().0 == selector)
+                    .find(|function| function.signature().starts_with(function_name))
                    .ok_or_else(|| {
                        anyhow::anyhow!(
-                    "Function with selector {:?} not found in ABI for the instance {:?}",
+                            "Function with name {:?} not found in ABI for the instance {:?}",
-                    selector,
+                            function_name,
                            &self.instance
                        )
                    })?;
-        tracing::trace!("Functions found for instance: {}", &self.instance);
+                tracing::trace!("Functions found for instance: {}", self.instance.as_ref());
                let calldata_args = match &self.calldata {
                    Some(Calldata::Compound(args)) => args,
                    _ => anyhow::bail!("Expected compound calldata for function call"),
                };
        if calldata_args.len() != function.inputs.len() {
            anyhow::bail!(
                "Function expects {} args, but got {}",
                function.inputs.len(),
                calldata_args.len()
            );
        }
                tracing::trace!(
                    "Starting encoding ABI's parameters for instance: {}",
-            &self.instance
+                    self.instance.as_ref()
                );
-        let mut encoded = selector.to_vec();
+                // Allocating a vector that we will be using for the calldata. The vector size will be:
                // 4 bytes for the function selector.
                // function.inputs.len() * 32 bytes for the arguments (each argument is a U256).
                //
                // We're using indices in the following code in order to avoid the need for us to allocate
                // a new buffer for each one of the resolved arguments.
                let mut calldata = Vec::<u8>::with_capacity(4 + calldata_args.len() * 32);
                calldata.extend(function.selector().0);
-        for (i, param) in function.inputs.iter().enumerate() {
+                for (arg_idx, arg) in calldata_args.iter().enumerate() {
-            let arg = calldata_args.get(i).unwrap();
+                    match resolve_argument(arg, deployed_contracts, chain_state_provider) {
-            let encoded_arg = match arg {
+                        Ok(resolved) => {
-                CalldataArg::Literal(value) => match param.ty.as_str() {
+                            calldata.extend(resolved.to_be_bytes::<32>());
                    "uint256" | "uint" => {
                        let val: U256 = value.parse()?;
                        val.abi_encode()
                        }
-                    "uint24" => {
+                        Err(error) => {
-                        let val: u32 = value.parse()?;
+                            tracing::error!(arg, arg_idx, ?error, "Failed to resolve argument");
-                        (val & 0xFFFFFF).abi_encode()
+                            return Err(error);
                    }
                    "bool" => {
                        let val: bool = value.parse()?;
                        val.abi_encode()
                    }
                    "address" => {
                        let addr: Address = value.parse()?;
                        addr.abi_encode()
                    }
                    "string" => value.abi_encode(),
                    "bytes32" => {
                        let val = hex::decode(value.trim_start_matches("0x"))?;
                        let mut fixed = [0u8; 32];
                        fixed[..val.len()].copy_from_slice(&val);
                        fixed.abi_encode()
                    }
                    "uint256[]" | "uint[]" => {
                        let nums: Vec<u64> = serde_json::from_str(value)?;
                        nums.abi_encode()
                    }
                    "bytes" => {
                        let val = hex::decode(value.trim_start_matches("0x"))?;
                        val.abi_encode()
                    }
                    _ => anyhow::bail!("Unsupported type: {}", param.ty),
                },
                CalldataArg::AddressRef(name) => {
                    let contract_name = name.trim_end_matches(".address");
                    let addr = deployed_contracts
                        .get(contract_name)
                        .copied()
                        .ok_or_else(|| {
                            anyhow::anyhow!("Address for '{}' not found", contract_name)
                        })?;
                    addr.abi_encode()
                        }
                    };
            encoded.extend(encoded_arg);
                }
-        Ok(Bytes::from(encoded))
+                Ok(calldata.into())
            }
        }
    }
    /// Parse this input into a legacy transaction.
    pub fn legacy_transaction(
        &self,
-        chain_id: u64,
+        deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
-        nonce: u64,
+        chain_state_provider: &impl EthereumNode,
        deployed_contracts: &HashMap<String, Address>,
        deployed_abis: &HashMap<String, JsonAbi>,
    ) -> anyhow::Result<TransactionRequest> {
-        let to = match self.method {
+        let input_data = self.encoded_input(deployed_contracts, chain_state_provider)?;
-            Method::Deployer => Some(TxKind::Create),
+        let transaction_request = TransactionRequest::default();
-            _ => Some(TxKind::Call(
+        match self.method {
-                self.instance_to_address(&self.instance, deployed_contracts)?,
+            Method::Deployer => Ok(transaction_request.with_deploy_code(input_data)),
-            )),
+            _ => Ok(transaction_request
-        };
+                .to(self.instance_to_address(&self.instance, deployed_contracts)?)
                .input(input_data.into())),
        }
    }
-        let input_data = self.encoded_input(deployed_abis, deployed_contracts)?;
+    pub fn find_all_contract_instances(&self) -> Vec<ContractInstance> {
        let mut vec = Vec::new();
        vec.push(self.instance.clone());
-        Ok(TransactionRequest {
+        if let Some(ref cd) = self.calldata {
-            from: Some(self.caller),
+            cd.find_all_contract_instances(&mut vec);
-            to,
+        }
-            nonce: Some(nonce),
+        match &self.expected {
-            chain_id: Some(chain_id),
+            Some(Expected::Calldata(cd)) => {
-            gas_price: Some(5_000_000),
+                cd.find_all_contract_instances(&mut vec);
-            gas: Some(5_000_000),
+            }
-            input: TransactionInput::new(input_data),
+            Some(Expected::Expected(expected)) => {
-            ..Default::default()
+                expected.find_all_contract_instances(&mut vec);
-        })
+            }
            Some(Expected::ExpectedMany(expected)) => {
                for expected in expected {
                    expected.find_all_contract_instances(&mut vec);
                }
            }
            None => {}
        }
        vec
    }
 }
-fn default_instance() -> String {
+fn default_instance() -> ContractInstance {
-    "Test".to_string()
+    ContractInstance::new_from("Test")
 }
 fn default_caller() -> Address {
    "90F8bf6A479f320ead074411a4B0e7944Ea8c9C1".parse().unwrap()
 }
 /// This function takes in the string calldata argument provided in the JSON input and resolves it
 /// into a [`U256`] which is later used to construct the calldata.
 ///
 /// # Note
 ///
 /// This piece of code is taken from the matter-labs-tester repository which is licensed under MIT
 /// or Apache. The original source code can be found here:
 /// https://github.com/matter-labs/era-compiler-tester/blob/0ed598a27f6eceee7008deab3ff2311075a2ec69/compiler_tester/src/test/case/input/value.rs#L43-L146
 fn resolve_argument(
    value: &str,
    deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
    chain_state_provider: &impl EthereumNode,
 ) -> anyhow::Result<U256> {
    if let Some(instance) = value.strip_suffix(".address") {
        Ok(U256::from_be_slice(
            deployed_contracts
                .get(&ContractInstance::new_from(instance))
                .map(|(a, _)| *a)
                .ok_or_else(|| anyhow::anyhow!("Instance `{}` not found", instance))?
                .as_ref(),
        ))
    } else if let Some(value) = value.strip_prefix('-') {
        let value = U256::from_str_radix(value, 10)
            .map_err(|error| anyhow::anyhow!("Invalid decimal literal after `-`: {}", error))?;
        if value > U256::ONE << 255u8 {
            anyhow::bail!("Decimal literal after `-` is too big");
        }
        let value = value
            .checked_sub(U256::ONE)
            .ok_or_else(|| anyhow::anyhow!("`-0` is invalid literal"))?;
        Ok(U256::MAX.checked_sub(value).expect("Always valid"))
    } else if let Some(value) = value.strip_prefix("0x") {
        Ok(U256::from_str_radix(value, 16)
            .map_err(|error| anyhow::anyhow!("Invalid hexadecimal literal: {}", error))?)
    } else if value == "$CHAIN_ID" {
        let chain_id = chain_state_provider.chain_id()?;
        Ok(U256::from(chain_id))
    } else if value == "$GAS_LIMIT" {
        let gas_limit = chain_state_provider.block_gas_limit(BlockNumberOrTag::Latest)?;
        Ok(U256::from(gas_limit))
    } else if value == "$COINBASE" {
        let coinbase = chain_state_provider.block_coinbase(BlockNumberOrTag::Latest)?;
        Ok(U256::from_be_slice(coinbase.as_ref()))
    } else if value == "$DIFFICULTY" {
        let block_difficulty = chain_state_provider.block_difficulty(BlockNumberOrTag::Latest)?;
        Ok(block_difficulty)
    } else if value.starts_with("$BLOCK_HASH") {
        let offset: u64 = value
            .split(':')
            .next_back()
            .and_then(|value| value.parse().ok())
            .unwrap_or_default();
        let current_block_number = chain_state_provider.last_block_number()?;
        let desired_block_number = current_block_number - offset;
        let block_hash = chain_state_provider.block_hash(desired_block_number.into())?;
        Ok(U256::from_be_bytes(block_hash.0))
    } else if value == "$BLOCK_NUMBER" {
        let current_block_number = chain_state_provider.last_block_number()?;
        Ok(U256::from(current_block_number))
    } else if value == "$BLOCK_TIMESTAMP" {
        let timestamp = chain_state_provider.block_timestamp(BlockNumberOrTag::Latest)?;
        Ok(U256::from(timestamp))
    } else {
        Ok(U256::from_str_radix(value, 10)
            .map_err(|error| anyhow::anyhow!("Invalid decimal literal: {}", error))?)
    }
 }
 #[cfg(test)]
 mod tests {
    use super::*;
    use alloy::json_abi::JsonAbi;
-    use alloy_primitives::{address, keccak256};
+    use alloy_primitives::address;
    use alloy_sol_types::SolValue;
    use std::collections::HashMap;
    struct DummyEthereumNode;
    impl EthereumNode for DummyEthereumNode {
        fn execute_transaction(
            &self,
            _: TransactionRequest,
        ) -> anyhow::Result<alloy::rpc::types::TransactionReceipt> {
            unimplemented!()
        }
        fn trace_transaction(
            &self,
            _: alloy::rpc::types::TransactionReceipt,
        ) -> anyhow::Result<alloy::rpc::types::trace::geth::GethTrace> {
            unimplemented!()
        }
        fn state_diff(
            &self,
            _: alloy::rpc::types::TransactionReceipt,
        ) -> anyhow::Result<alloy::rpc::types::trace::geth::DiffMode> {
            unimplemented!()
        }
        fn fetch_add_nonce(&self, _: Address) -> anyhow::Result<u64> {
            unimplemented!()
        }
        fn chain_id(&self) -> anyhow::Result<alloy_primitives::ChainId> {
            Ok(0x123)
        }
        fn block_gas_limit(&self, _: alloy::eips::BlockNumberOrTag) -> anyhow::Result<u128> {
            Ok(0x1234)
        }
        fn block_coinbase(&self, _: alloy::eips::BlockNumberOrTag) -> anyhow::Result<Address> {
            Ok(Address::ZERO)
        }
        fn block_difficulty(&self, _: alloy::eips::BlockNumberOrTag) -> anyhow::Result<U256> {
            Ok(U256::from(0x12345u128))
        }
        fn block_hash(
            &self,
            _: alloy::eips::BlockNumberOrTag,
        ) -> anyhow::Result<alloy_primitives::BlockHash> {
            Ok([0xEE; 32].into())
        }
        fn block_timestamp(
            &self,
            _: alloy::eips::BlockNumberOrTag,
        ) -> anyhow::Result<alloy_primitives::BlockTimestamp> {
            Ok(0x123456)
        }
        fn last_block_number(&self) -> anyhow::Result<alloy_primitives::BlockNumber> {
            Ok(0x1234567)
        }
    }
    #[test]
    fn test_encoded_input_uint256() {
        let raw_metadata = r#"
@@ -278,26 +405,28 @@ mod tests {
        "#;
        let parsed_abi: JsonAbi = serde_json::from_str(raw_metadata).unwrap();
-        let selector = keccak256("store(uint256)".as_bytes())[0..4]
+        let selector = parsed_abi
-            .try_into()
+            .function("store")
-            .unwrap();
+            .unwrap()
            .first()
            .unwrap()
            .selector()
            .0;
        let input = Input {
-            instance: "Contract".to_string(),
+            instance: ContractInstance::new_from("Contract"),
-            method: Method::Function(selector),
+            method: Method::FunctionName("store".to_owned()),
-            calldata: Some(Calldata::Compound(vec![CalldataArg::Literal(
+            calldata: Some(Calldata::Compound(vec!["42".into()])),
                "42".to_string(),
            )])),
            ..Default::default()
        };
-        let mut deployed_abis = HashMap::new();
+        let mut contracts = HashMap::new();
-        deployed_abis.insert("Contract".to_string(), parsed_abi);
+        contracts.insert(
-        let deployed_contracts = HashMap::new();
+            ContractInstance::new_from("Contract"),
            (Address::ZERO, parsed_abi),
        );
-        let encoded = input
+        let encoded = input.encoded_input(&contracts, &DummyEthereumNode).unwrap();
            .encoded_input(&deployed_abis, &deployed_contracts)
            .unwrap();
        assert!(encoded.0.starts_with(&selector));
        type T = (u64,);
@@ -306,11 +435,11 @@ mod tests {
    }
    #[test]
-    fn test_encoded_input_bool() {
+    fn test_encoded_input_address_with_signature() {
        let raw_abi = r#"[
        {
-                "inputs": [{"name": "flag", "type": "bool"}],
+            "inputs": [{"name": "recipient", "type": "address"}],
-                "name": "toggle",
+            "name": "send",
            "outputs": [],
            "stateMutability": "nonpayable",
            "type": "function"
@@ -318,97 +447,38 @@ mod tests {
        ]"#;
        let parsed_abi: JsonAbi = serde_json::from_str(raw_abi).unwrap();
-        let selector = keccak256("toggle(bool)".as_bytes())[0..4]
+        let selector = parsed_abi
-            .try_into()
+            .function("send")
-            .unwrap();
+            .unwrap()
            .first()
            .unwrap()
            .selector()
            .0;
-        let input = Input {
+        let input: Input = Input {
-            instance: "Contract".to_string(),
+            instance: "Contract".to_owned().into(),
-            method: Method::Function(selector),
+            method: Method::FunctionName("send(address)".to_owned()),
-            calldata: Some(Calldata::Compound(vec![CalldataArg::Literal(
+            calldata: Some(Calldata::Compound(vec![
-                "true".to_string(),
+                "0x1000000000000000000000000000000000000001".to_string(),
-            )])),
+            ])),
            ..Default::default()
        };
-        let mut abis = HashMap::new();
+        let mut contracts = HashMap::new();
-        abis.insert("Contract".to_string(), parsed_abi);
+        contracts.insert(
-        let contracts = HashMap::new();
+            ContractInstance::new_from("Contract"),
            (Address::ZERO, parsed_abi),
        );
-        let encoded = input.encoded_input(&abis, &contracts).unwrap();
+        let encoded = input.encoded_input(&contracts, &DummyEthereumNode).unwrap();
        assert!(encoded.0.starts_with(&selector));
-        type T = (bool,);
+        type T = (alloy_primitives::Address,);
        let decoded: T = T::abi_decode(&encoded.0[4..]).unwrap();
-        assert_eq!(decoded.0, true);
+        assert_eq!(
-    }
+            decoded.0,
-
+            address!("0x1000000000000000000000000000000000000001")
-    #[test]
+        );
    fn test_encoded_input_string() {
        let raw_abi = r#"[
            {
                "inputs": [{"name": "msg", "type": "string"}],
                "name": "echo",
                "outputs": [],
                "stateMutability": "nonpayable",
                "type": "function"
            }
        ]"#;
        let parsed_abi: JsonAbi = serde_json::from_str(raw_abi).unwrap();
        let selector = keccak256("echo(string)".as_bytes())[0..4]
            .try_into()
            .unwrap();
        let input = Input {
            instance: "Contract".to_string(),
            method: Method::Function(selector),
            calldata: Some(Calldata::Compound(vec![CalldataArg::Literal(
                "hello".to_string(),
            )])),
            ..Default::default()
        };
        let mut abis = HashMap::new();
        abis.insert("Contract".to_string(), parsed_abi);
        let contracts = HashMap::new();
        let encoded = input.encoded_input(&abis, &contracts).unwrap();
        assert!(encoded.0.starts_with(&selector));
    }
    #[test]
    fn test_encoded_input_uint256_array() {
        let raw_abi = r#"[
        {
            "inputs": [{"name": "arr", "type": "uint256[]"}],
            "name": "sum",
            "outputs": [],
            "stateMutability": "nonpayable",
            "type": "function"
        }
        ]"#;
        let parsed_abi: JsonAbi = serde_json::from_str(raw_abi).unwrap();
        let selector = keccak256("sum(uint256[])".as_bytes())[0..4]
            .try_into()
            .unwrap();
        let input = Input {
            instance: "Contract".to_string(),
            method: Method::Function(selector),
            calldata: Some(Calldata::Compound(vec![CalldataArg::Literal(
                "[1,2,3]".to_string(),
            )])),
            ..Default::default()
        };
        let mut abis = HashMap::new();
        abis.insert("Contract".to_string(), parsed_abi);
        let contracts = HashMap::new();
        let encoded = input.encoded_input(&abis, &contracts).unwrap();
        assert!(encoded.0.starts_with(&selector));
    }
    #[test]
@@ -424,24 +494,30 @@ mod tests {
        ]"#;
        let parsed_abi: JsonAbi = serde_json::from_str(raw_abi).unwrap();
-        let selector = keccak256("send(address)".as_bytes())[0..4]
+        let selector = parsed_abi
-            .try_into()
+            .function("send")
-            .unwrap();
+            .unwrap()
            .first()
            .unwrap()
            .selector()
            .0;
-        let input = Input {
+        let input: Input = Input {
-            instance: "Contract".to_string(),
+            instance: ContractInstance::new_from("Contract"),
-            method: Method::Function(selector),
+            method: Method::FunctionName("send".to_owned()),
-            calldata: Some(Calldata::Compound(vec![CalldataArg::Literal(
+            calldata: Some(Calldata::Compound(vec![
                "0x1000000000000000000000000000000000000001".to_string(),
-            )])),
+            ])),
            ..Default::default()
        };
-        let mut abis = HashMap::new();
+        let mut contracts = HashMap::new();
-        abis.insert("Contract".to_string(), parsed_abi);
+        contracts.insert(
-        let contracts = HashMap::new();
+            ContractInstance::new_from("Contract"),
            (Address::ZERO, parsed_abi),
        );
-        let encoded = input.encoded_input(&abis, &contracts).unwrap();
+        let encoded = input.encoded_input(&contracts, &DummyEthereumNode).unwrap();
        assert!(encoded.0.starts_with(&selector));
        type T = (alloy_primitives::Address,);
@@ -451,4 +527,128 @@ mod tests {
            address!("0x1000000000000000000000000000000000000001")
        );
    }
    #[test]
    fn resolver_can_resolve_chain_id_variable() {
        // Arrange
        let input = "$CHAIN_ID";
        // Act
        let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
        // Assert
        let resolved = resolved.expect("Failed to resolve argument");
        assert_eq!(resolved, U256::from(DummyEthereumNode.chain_id().unwrap()))
    }
    #[test]
    fn resolver_can_resolve_gas_limit_variable() {
        // Arrange
        let input = "$GAS_LIMIT";
        // Act
        let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
        // Assert
        let resolved = resolved.expect("Failed to resolve argument");
        assert_eq!(
            resolved,
            U256::from(
                DummyEthereumNode
                    .block_gas_limit(Default::default())
                    .unwrap()
            )
        )
    }
    #[test]
    fn resolver_can_resolve_coinbase_variable() {
        // Arrange
        let input = "$COINBASE";
        // Act
        let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
        // Assert
        let resolved = resolved.expect("Failed to resolve argument");
        assert_eq!(
            resolved,
            U256::from_be_slice(
                DummyEthereumNode
                    .block_coinbase(Default::default())
                    .unwrap()
                    .as_ref()
            )
        )
    }
    #[test]
    fn resolver_can_resolve_block_difficulty_variable() {
        // Arrange
        let input = "$DIFFICULTY";
        // Act
        let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
        // Assert
        let resolved = resolved.expect("Failed to resolve argument");
        assert_eq!(
            resolved,
            DummyEthereumNode
                .block_difficulty(Default::default())
                .unwrap()
        )
    }
    #[test]
    fn resolver_can_resolve_block_hash_variable() {
        // Arrange
        let input = "$BLOCK_HASH";
        // Act
        let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
        // Assert
        let resolved = resolved.expect("Failed to resolve argument");
        assert_eq!(
            resolved,
            U256::from_be_bytes(DummyEthereumNode.block_hash(Default::default()).unwrap().0)
        )
    }
    #[test]
    fn resolver_can_resolve_block_number_variable() {
        // Arrange
        let input = "$BLOCK_NUMBER";
        // Act
        let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
        // Assert
        let resolved = resolved.expect("Failed to resolve argument");
        assert_eq!(
            resolved,
            U256::from(DummyEthereumNode.last_block_number().unwrap())
        )
    }
    #[test]
    fn resolver_can_resolve_block_timestamp_variable() {
        // Arrange
        let input = "$BLOCK_TIMESTAMP";
        // Act
        let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
        // Assert
        let resolved = resolved.expect("Failed to resolve argument");
        assert_eq!(
            resolved,
            U256::from(
                DummyEthereumNode
                    .block_timestamp(Default::default())
                    .unwrap()
            )
        )
    }
 }
@@ -3,5 +3,6 @@
 pub mod case;
 pub mod corpus;
 pub mod input;
 pub mod macros;
 pub mod metadata;
 pub mod mode;
@@ -0,0 +1,106 @@
 /// Defines wrappers around types.
 ///
 /// For example, the macro invocation seen below:
 ///
 /// ```rust,ignore
 /// define_wrapper_type!(CaseId => usize);
 /// ```
 ///
 /// Would define a wrapper type that looks like the following:
 ///
 /// ```rust,ignore
 /// pub struct CaseId(usize);
 /// ```
 ///
 /// And would also implement a number of methods on this type making it easier
 /// to use.
 ///
 /// These wrapper types become very useful as they make the code a lot easier
 /// to read.
 ///
 /// Take the following as an example:
 ///
 /// ```rust,ignore
 /// struct State {
 ///     contracts: HashMap<usize, HashMap<String, Vec<u8>>>
 /// }
 /// ```
 ///
 /// In the above code it's hard to understand what the various types refer to or
 /// what to expect them to contain.
 ///
 /// With these wrapper types we're able to create code that's self-documenting
 /// in that the types tell us what the code is referring to. The above code is
 /// transformed into
 ///
 /// ```rust,ignore
 /// struct State {
 ///     contracts: HashMap<CaseId, HashMap<ContractName, ContractByteCode>>
 /// }
 /// ```
 #[macro_export]
 macro_rules! define_wrapper_type {
    (
        $(#[$meta: meta])*
        $ident: ident($ty: ty) $(;)?
    ) => {
        $(#[$meta])*
        pub struct $ident($ty);
        impl $ident {
            pub fn new(value: $ty) -> Self {
                Self(value)
            }
            pub fn new_from<T: Into<$ty>>(value: T) -> Self {
                Self(value.into())
            }
            pub fn into_inner(self) -> $ty {
                self.0
            }
            pub fn as_inner(&self) -> &$ty {
                &self.0
            }
        }
        impl AsRef<$ty> for $ident {
            fn as_ref(&self) -> &$ty {
                &self.0
            }
        }
        impl AsMut<$ty> for $ident {
            fn as_mut(&mut self) -> &mut $ty {
                &mut self.0
            }
        }
        impl std::ops::Deref for $ident {
            type Target = $ty;
            fn deref(&self) -> &Self::Target {
                &self.0
            }
        }
        impl std::ops::DerefMut for $ident {
            fn deref_mut(&mut self) -> &mut Self::Target {
                &mut self.0
            }
        }
        impl From<$ty> for $ident {
            fn from(value: $ty) -> Self {
                Self(value)
            }
        }
        impl From<$ident> for $ty {
            fn from(value: $ident) -> Self {
                value.0
            }
        }
    };
 }
@@ -1,14 +1,17 @@
 use std::{
    collections::BTreeMap,
    fmt::Display,
    fs::{File, read_to_string},
    ops::Deref,
    path::{Path, PathBuf},
    str::FromStr,
 };
-use serde::Deserialize;
+use serde::{Deserialize, Serialize};
 use crate::{
    case::Case,
    define_wrapper_type,
    mode::{Mode, SolcMode},
 };
@@ -42,7 +45,8 @@ impl Deref for MetadataFile {
 #[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
 pub struct Metadata {
    pub cases: Vec<Case>,
-    pub contracts: Option<BTreeMap<String, String>>,
+    pub contracts: Option<BTreeMap<ContractInstance, ContractPathAndIdentifier>>,
    // TODO: Convert into wrapper types for clarity.
    pub libraries: Option<BTreeMap<String, BTreeMap<String, String>>>,
    pub ignore: Option<bool>,
    pub modes: Option<Vec<Mode>>,
@@ -77,28 +81,35 @@ impl Metadata {
            .to_path_buf())
    }
-    /// Extract the contract sources.
+    /// Returns the contract sources with canonicalized paths for the files
-    ///
+    pub fn contract_sources(
-    /// Returns a mapping of contract IDs to their source path and contract name.
+        &self,
-    pub fn contract_sources(&self) -> anyhow::Result<BTreeMap<String, (PathBuf, String)>> {
+    ) -> anyhow::Result<BTreeMap<ContractInstance, ContractPathAndIdentifier>> {
        let directory = self.directory()?;
        let mut sources = BTreeMap::new();
        let Some(contracts) = &self.contracts else {
            return Ok(sources);
        };
-        for (id, contract) in contracts {
+        for (
-            // TODO: broken if a colon is in the dir name..
+            alias,
-            let mut parts = contract.split(':');
+            ContractPathAndIdentifier {
-            let (Some(file_name), Some(contract_name)) = (parts.next(), parts.next()) else {
+                contract_source_path,
-                anyhow::bail!("metadata contains invalid contract: {contract}");
+                contract_ident,
-            };
+            },
-            let file = directory.to_path_buf().join(file_name);
+        ) in contracts
-            if !file.is_file() {
+        {
-                anyhow::bail!("contract {id} is not a file: {}", file.display());
+            let alias = alias.clone();
-            }
+            let absolute_path = directory.join(contract_source_path).canonicalize()?;
            let contract_ident = contract_ident.clone();
-            sources.insert(id.clone(), (file, contract_name.to_string()));
+            sources.insert(
                alias,
                ContractPathAndIdentifier {
                    contract_source_path: absolute_path,
                    contract_ident,
                },
            );
        }
        Ok(sources)
@@ -178,12 +189,16 @@ impl Metadata {
        match serde_json::from_str::<Self>(&spec) {
            Ok(mut metadata) => {
                metadata.file_path = Some(path.to_path_buf());
-                let name = path
+                metadata.contracts = Some(
-                    .file_name()
+                    [(
-                    .expect("this should be the path to a Solidity file")
+                        ContractInstance::new_from("test"),
-                    .to_str()
+                        ContractPathAndIdentifier {
-                    .expect("the file name should be valid UTF-8k");
+                            contract_source_path: path.to_path_buf(),
-                metadata.contracts = Some([(String::from("Test"), format!("{name}:Test"))].into());
+                            contract_ident: ContractIdent::new_from("Test"),
                        },
                    )]
                    .into(),
                );
                Some(metadata)
            }
            Err(error) => {
@@ -196,3 +211,139 @@ impl Metadata {
        }
    }
 }
 define_wrapper_type!(
    /// Represents a contract instance found a metadata file.
    ///
    /// Typically, this is used as the key to the "contracts" field of metadata files.
    #[derive(Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
    #[serde(transparent)]
    ContractInstance(String);
 );
 define_wrapper_type!(
    /// Represents a contract identifier found a metadata file.
    ///
    /// A contract identifier is the name of the contract in the source code.
    #[derive(Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
    #[serde(transparent)]
    ContractIdent(String);
 );
 /// Represents an identifier used for contracts.
 ///
 /// The type supports serialization from and into the following string format:
 ///
 /// ```text
 /// ${path}:${contract_ident}
 /// ```
 #[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
 #[serde(try_from = "String", into = "String")]
 pub struct ContractPathAndIdentifier {
    /// The path of the contract source code relative to the directory containing the metadata file.
    pub contract_source_path: PathBuf,
    /// The identifier of the contract.
    pub contract_ident: ContractIdent,
 }
 impl Display for ContractPathAndIdentifier {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}:{}",
            self.contract_source_path.display(),
            self.contract_ident.as_ref()
        )
    }
 }
 impl FromStr for ContractPathAndIdentifier {
    type Err = anyhow::Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let mut splitted_string = s.split(":").peekable();
        let mut path = None::<String>;
        let mut identifier = None::<String>;
        loop {
            let Some(next_item) = splitted_string.next() else {
                break;
            };
            if splitted_string.peek().is_some() {
                match path {
                    Some(ref mut path) => {
                        path.push(':');
                        path.push_str(next_item);
                    }
                    None => path = Some(next_item.to_owned()),
                }
            } else {
                identifier = Some(next_item.to_owned())
            }
        }
        let Some(path) = path else {
            anyhow::bail!("Path is not defined");
        };
        let Some(identifier) = identifier else {
            anyhow::bail!("Contract identifier is not defined")
        };
        Ok(Self {
            contract_source_path: PathBuf::from(path),
            contract_ident: ContractIdent::new(identifier),
        })
    }
 }
 impl TryFrom<String> for ContractPathAndIdentifier {
    type Error = anyhow::Error;
    fn try_from(value: String) -> Result<Self, Self::Error> {
        Self::from_str(&value)
    }
 }
 impl From<ContractPathAndIdentifier> for String {
    fn from(value: ContractPathAndIdentifier) -> Self {
        value.to_string()
    }
 }
 #[cfg(test)]
 mod test {
    use super::*;
    #[test]
    fn contract_identifier_respects_roundtrip_property() {
        // Arrange
        let string = "ERC20/ERC20.sol:ERC20";
        // Act
        let identifier = ContractPathAndIdentifier::from_str(string);
        // Assert
        let identifier = identifier.expect("Failed to parse");
        assert_eq!(
            identifier.contract_source_path.display().to_string(),
            "ERC20/ERC20.sol"
        );
        assert_eq!(identifier.contract_ident, "ERC20".to_owned().into());
        // Act
        let reserialized = identifier.to_string();
        // Assert
        assert_eq!(string, reserialized);
    }
    #[test]
    fn complex_metadata_file_can_be_deserialized() {
        // Arrange
        const JSON: &str = include_str!("../../../assets/test_metadata.json");
        // Act
        let metadata = serde_json::from_str::<Metadata>(JSON);
        // Assert
        metadata.expect("Failed to deserialize metadata");
    }
 }
@@ -11,6 +11,7 @@ rust-version.workspace = true
 [dependencies]
 alloy = { workspace = true }
 anyhow = { workspace = true }
 futures = { workspace = true }
 tracing = { workspace = true }
 once_cell = { workspace = true }
 tokio = { workspace = true }
@@ -0,0 +1,220 @@
 //! The alloy crate __requires__ a tokio runtime.
 //! We contain any async rust right here.
 use std::{any::Any, panic::AssertUnwindSafe, pin::Pin, thread};
 use futures::FutureExt;
 use once_cell::sync::Lazy;
 use tokio::{
    runtime::Builder,
    sync::{mpsc::UnboundedSender, oneshot},
 };
 /// A blocking async executor.
 ///
 /// This struct exposes the abstraction of a blocking async executor. It is a global and static
 /// executor which means that it doesn't require for new instances of it to be created, it's a
 /// singleton and can be accessed by any thread that wants to perform some async computation on the
 /// blocking executor thread.
 ///
 /// The API of the blocking executor is created in a way so that it's very natural, simple to use,
 /// and unbounded to specific tasks or return types. The following is an example of using this
 /// executor to drive an async computation:
 ///
 /// ```rust
 /// use revive_dt_node_interaction::*;
 ///
 /// fn blocking_function() {
 ///     let result = BlockingExecutor::execute(async move {
 ///         tokio::time::sleep(std::time::Duration::from_secs(1)).await;
 ///         0xFFu8
 ///     })
 ///     .expect("Computation failed");
 ///
 ///     assert_eq!(result, 0xFF);
 /// }
 /// ```
 ///
 /// Users get to pass in their async tasks without needing to worry about putting them in a [`Box`],
 /// [`Pin`], needing to perform down-casting, or the internal channel mechanism used by the runtime.
 /// To the user, it just looks like a function that converts some async code into sync code.
 ///
 /// This struct also handled panics that occur in the passed futures and converts them into errors
 /// that can be handled by the user. This is done to allow the executor to be robust.
 ///
 /// Internally, the executor communicates with the tokio runtime thread through channels which carry
 /// the [`TaskMessage`] and the results of the execution.
 pub struct BlockingExecutor;
 impl BlockingExecutor {
    pub fn execute<R>(future: impl Future<Output = R> + Send + 'static) -> Result<R, anyhow::Error>
    where
        R: Send + 'static,
    {
        // Note: The blocking executor is a singleton and therefore we store its state in a static
        // so that it's assigned only once. Additionally, when we set the state of the executor we
        // spawn the thread where the async runtime runs.
        static STATE: Lazy<ExecutorState> = Lazy::new(|| {
            tracing::trace!("Initializing the BlockingExecutor state");
            // All communication with the tokio runtime thread happens over mspc channels where the
            // producers here are the threads that want to run async tasks and the consumer here is
            // the tokio runtime thread.
            let (tx, mut rx) = tokio::sync::mpsc::unbounded_channel::<TaskMessage>();
            thread::spawn(move || {
                let runtime = Builder::new_current_thread()
                    .enable_all()
                    .build()
                    .expect("Failed to create the async runtime");
                runtime.block_on(async move {
                    while let Some(TaskMessage {
                        future: task,
                        response_tx: response_channel,
                    }) = rx.recv().await
                    {
                        tracing::trace!("Received a new future to execute");
                        tokio::spawn(async move {
                            // One of the things that the blocking executor does is that it allows
                            // us to catch panics if they occur. By wrapping the given future in an
                            // AssertUnwindSafe::catch_unwind we are able to catch all panic unwinds
                            // in the given future and convert them into errors.
                            let task = AssertUnwindSafe(task).catch_unwind();
                            let result = task.await;
                            let _ = response_channel.send(result);
                        });
                    }
                })
            });
            ExecutorState { tx }
        });
        // We need to perform blocking synchronous communication between the current thread and the
        // tokio runtime thread with the result of the async computation and the oneshot channels
        // from tokio allows us to do that. The sender side of the channel will be given to the
        // tokio runtime thread to send the result when the computation is completed and the receive
        // side of the channel will be kept with this thread to await for the response of the async
        // task to come back.
        let (response_tx, response_rx) =
            oneshot::channel::<Result<Box<dyn Any + Send>, Box<dyn Any + Send>>>();
        // The tokio runtime thread expects a Future<Output = Box<dyn Any + Send>> + Send to be
        // sent to it to execute. However, this function has a typed Future<Output = R> + Send and
        // therefore we need to change the type of the future to fit what the runtime thread expects
        // in the task message. In doing this conversion, we lose some of the type information since
        // we're converting R => dyn Any. However, we will perform down-casting on the result to
        // convert it back into R.
        let future = Box::pin(async move { Box::new(future.await) as Box<dyn Any + Send> });
        let task = TaskMessage::new(future, response_tx);
        if let Err(error) = STATE.tx.send(task) {
            tracing::error!(?error, "Failed to send the task to the blocking executor");
            anyhow::bail!("Failed to send the task to the blocking executor: {error:?}")
        }
        let result = match response_rx.blocking_recv() {
            Ok(result) => result,
            Err(error) => {
                tracing::error!(
                    ?error,
                    "Failed to get the response from the blocking executor"
                );
                anyhow::bail!("Failed to get the response from the blocking executor: {error:?}")
            }
        };
        match result.map(|result| {
            *result
                .downcast::<R>()
                .expect("Type mismatch in the downcast")
        }) {
            Ok(result) => Ok(result),
            Err(error) => {
                tracing::error!(
                    ?error,
                    "Failed to downcast the returned result into the expected type"
                );
                anyhow::bail!(
                    "Failed to downcast the returned result into the expected type: {error:?}"
                )
            }
        }
    }
 }
 /// Represents the state of the async runtime. This runtime is designed to be a singleton runtime
 /// which means that in the current running program there's just a single thread that has an async
 /// runtime.
 struct ExecutorState {
    /// The sending side of the task messages channel. This is used by all of the other threads to
    /// communicate with the async runtime thread.
    tx: UnboundedSender<TaskMessage>,
 }
 /// Represents a message that contains an asynchronous task that's to be executed by the runtime
 /// as well as a way for the runtime to report back on the result of the execution.
 struct TaskMessage {
    /// The task that's being requested to run. This is a future that returns an object that does
    /// implement [`Any`] and [`Send`] to allow it to be sent between the requesting thread and the
    /// async thread.
    future: Pin<Box<dyn Future<Output = Box<dyn Any + Send>> + Send>>,
    /// A one shot sender channel where the sender of the task is expecting to hear back on the
    /// result of the task.
    response_tx: oneshot::Sender<Result<Box<dyn Any + Send>, Box<dyn Any + Send>>>,
 }
 impl TaskMessage {
    pub fn new(
        future: Pin<Box<dyn Future<Output = Box<dyn Any + Send>> + Send>>,
        response_tx: oneshot::Sender<Result<Box<dyn Any + Send>, Box<dyn Any + Send>>>,
    ) -> Self {
        Self {
            future,
            response_tx,
        }
    }
 }
 #[cfg(test)]
 mod test {
    use super::*;
    #[test]
    fn simple_future_works() {
        // Act
        let result = BlockingExecutor::execute(async move {
            tokio::time::sleep(std::time::Duration::from_secs(1)).await;
            0xFFu8
        })
        .unwrap();
        // Assert
        assert_eq!(result, 0xFFu8);
    }
    #[test]
    #[allow(unreachable_code, clippy::unreachable)]
    fn panics_in_futures_are_caught() {
        // Act
        let result = BlockingExecutor::execute(async move {
            panic!("This is a panic!");
            0xFFu8
        });
        // Assert
        assert!(result.is_err());
        // Act
        let result = BlockingExecutor::execute(async move {
            tokio::time::sleep(std::time::Duration::from_secs(1)).await;
            0xFFu8
        })
        .unwrap();
        // Assert
        assert_eq!(result, 0xFFu8)
    }
 }
@@ -1,29 +1,48 @@
 //! This crate implements all node interactions.
-use alloy::primitives::Address;
+use alloy::eips::BlockNumberOrTag;
 use alloy::primitives::{Address, BlockHash, BlockNumber, BlockTimestamp, ChainId, U256};
 use alloy::rpc::types::trace::geth::{DiffMode, GethTrace};
 use alloy::rpc::types::{TransactionReceipt, TransactionRequest};
-use tokio_runtime::TO_TOKIO;
+use anyhow::Result;
-pub mod nonce;
+mod blocking_executor;
-mod tokio_runtime;
+pub use blocking_executor::*;
 pub mod trace;
 pub mod transaction;
 /// An interface for all interactions with Ethereum compatible nodes.
 pub trait EthereumNode {
    /// Execute the [TransactionRequest] and return a [TransactionReceipt].
-    fn execute_transaction(
+    fn execute_transaction(&self, transaction: TransactionRequest) -> Result<TransactionReceipt>;
        &self,
        transaction: TransactionRequest,
    ) -> anyhow::Result<TransactionReceipt>;
    /// Trace the transaction in the [TransactionReceipt] and return a [GethTrace].
-    fn trace_transaction(&self, transaction: TransactionReceipt) -> anyhow::Result<GethTrace>;
+    fn trace_transaction(&self, transaction: TransactionReceipt) -> Result<GethTrace>;
    /// Returns the state diff of the transaction hash in the [TransactionReceipt].
-    fn state_diff(&self, transaction: TransactionReceipt) -> anyhow::Result<DiffMode>;
+    fn state_diff(&self, transaction: TransactionReceipt) -> Result<DiffMode>;
    /// Returns the next available nonce for the given [Address].
-    fn fetch_add_nonce(&self, address: Address) -> anyhow::Result<u64>;
+    fn fetch_add_nonce(&self, address: Address) -> Result<u64>;
    /// Returns the ID of the chain that the node is on.
    fn chain_id(&self) -> Result<ChainId>;
    // TODO: This is currently a u128 due to Kitchensink needing more than 64 bits for its gas limit
    // when we implement the changes to the gas we need to adjust this to be a u64.
    /// Returns the gas limit of the specified block.
    fn block_gas_limit(&self, number: BlockNumberOrTag) -> Result<u128>;
    /// Returns the coinbase of the specified block.
    fn block_coinbase(&self, number: BlockNumberOrTag) -> Result<Address>;
    /// Returns the difficulty of the specified block.
    fn block_difficulty(&self, number: BlockNumberOrTag) -> Result<U256>;
    /// Returns the hash of the specified block.
    fn block_hash(&self, number: BlockNumberOrTag) -> Result<BlockHash>;
    /// Returns the timestamp of the specified block,
    fn block_timestamp(&self, number: BlockNumberOrTag) -> Result<BlockTimestamp>;
    /// Returns the number of the last block.
    fn last_block_number(&self) -> Result<BlockNumber>;
 }
@@ -1,55 +0,0 @@
 use std::pin::Pin;
 use alloy::{
    primitives::Address,
    providers::{Provider, ProviderBuilder},
 };
 use tokio::sync::oneshot;
 use crate::{TO_TOKIO, tokio_runtime::AsyncNodeInteraction};
 pub type Task = Pin<Box<dyn Future<Output = anyhow::Result<u64>> + Send>>;
 pub(crate) struct Nonce {
    sender: oneshot::Sender<anyhow::Result<u64>>,
    task: Task,
 }
 impl AsyncNodeInteraction for Nonce {
    type Output = anyhow::Result<u64>;
    fn split(
        self,
    ) -> (
        std::pin::Pin<Box<dyn Future<Output = Self::Output> + Send>>,
        oneshot::Sender<Self::Output>,
    ) {
        (self.task, self.sender)
    }
 }
 /// This is like `trace_transaction`, just for nonces.
 pub fn fetch_onchain_nonce(
    connection: String,
    wallet: alloy::network::EthereumWallet,
    address: Address,
 ) -> anyhow::Result<u64> {
    let sender = TO_TOKIO.lock().unwrap().nonce_sender.clone();
    let (tx, rx) = oneshot::channel();
    let task: Task = Box::pin(async move {
        let provider = ProviderBuilder::new()
            .wallet(wallet)
            .connect(&connection)
            .await?;
        let onchain = provider.get_transaction_count(address).await?;
        Ok(onchain)
    });
    sender
        .blocking_send(Nonce { task, sender: tx })
        .expect("not in async context");
    rx.blocking_recv()
        .unwrap_or_else(|err| anyhow::bail!("nonce fetch failed: {err}"))
 }
@@ -1,87 +0,0 @@
 //! The alloy crate __requires__ a tokio runtime.
 //! We contain any async rust right here.
 use once_cell::sync::Lazy;
 use std::pin::Pin;
 use std::sync::Mutex;
 use std::thread;
 use tokio::runtime::Runtime;
 use tokio::spawn;
 use tokio::sync::{mpsc, oneshot};
 use tokio::task::JoinError;
 use crate::nonce::Nonce;
 use crate::trace::Trace;
 use crate::transaction::Transaction;
 pub(crate) static TO_TOKIO: Lazy<Mutex<TokioRuntime>> =
    Lazy::new(|| Mutex::new(TokioRuntime::spawn()));
 /// Common interface for executing async node interactions from a non-async context.
 #[allow(clippy::type_complexity)]
 pub(crate) trait AsyncNodeInteraction: Send + 'static {
    type Output: Send;
    //// Returns the task and the output sender.
    fn split(
        self,
    ) -> (
        Pin<Box<dyn Future<Output = Self::Output> + Send>>,
        oneshot::Sender<Self::Output>,
    );
 }
 pub(crate) struct TokioRuntime {
    pub(crate) transaction_sender: mpsc::Sender<Transaction>,
    pub(crate) trace_sender: mpsc::Sender<Trace>,
    pub(crate) nonce_sender: mpsc::Sender<Nonce>,
 }
 impl TokioRuntime {
    fn spawn() -> Self {
        let rt = Runtime::new().expect("should be able to create the tokio runtime");
        let (transaction_sender, transaction_receiver) = mpsc::channel::<Transaction>(1024);
        let (trace_sender, trace_receiver) = mpsc::channel::<Trace>(1024);
        let (nonce_sender, nonce_receiver) = mpsc::channel::<Nonce>(1024);
        thread::spawn(move || {
            rt.block_on(async move {
                let transaction_task = spawn(interaction::<Transaction>(transaction_receiver));
                let trace_task = spawn(interaction::<Trace>(trace_receiver));
                let nonce_task = spawn(interaction::<Nonce>(nonce_receiver));
                if let Err(error) = transaction_task.await {
                    tracing::error!("tokio transaction task failed: {error}");
                }
                if let Err(error) = trace_task.await {
                    tracing::error!("tokio trace transaction task failed: {error}");
                }
                if let Err(error) = nonce_task.await {
                    tracing::error!("tokio nonce task failed: {error}");
                }
            });
        });
        Self {
            transaction_sender,
            trace_sender,
            nonce_sender,
        }
    }
 }
 async fn interaction<T>(mut receiver: mpsc::Receiver<T>) -> Result<(), JoinError>
 where
    T: AsyncNodeInteraction,
 {
    while let Some(task) = receiver.recv().await {
        spawn(async move {
            let (task, sender) = task.split();
            sender
                .send(task.await)
                .unwrap_or_else(|_| panic!("failed to send task output"));
        });
    }
    Ok(())
 }
@@ -1,43 +0,0 @@
 //! Trace transactions in a sync context.
 use std::pin::Pin;
 use alloy::rpc::types::trace::geth::GethTrace;
 use tokio::sync::oneshot;
 use crate::TO_TOKIO;
 use crate::tokio_runtime::AsyncNodeInteraction;
 pub type Task = Pin<Box<dyn Future<Output = anyhow::Result<GethTrace>> + Send>>;
 pub(crate) struct Trace {
    sender: oneshot::Sender<anyhow::Result<GethTrace>>,
    task: Task,
 }
 impl AsyncNodeInteraction for Trace {
    type Output = anyhow::Result<GethTrace>;
    fn split(
        self,
    ) -> (
        std::pin::Pin<Box<dyn Future<Output = Self::Output> + Send>>,
        oneshot::Sender<Self::Output>,
    ) {
        (self.task, self.sender)
    }
 }
 /// Execute some [Task] that return a [GethTrace] result.
 pub fn trace_transaction(task: Task) -> anyhow::Result<GethTrace> {
    let task_sender = TO_TOKIO.lock().unwrap().trace_sender.clone();
    let (sender, receiver) = oneshot::channel();
    task_sender
        .blocking_send(Trace { task, sender })
        .expect("we are not calling this from an async context");
    receiver
        .blocking_recv()
        .unwrap_or_else(|error| anyhow::bail!("no trace received: {error}"))
 }
@@ -1,46 +0,0 @@
 //! Execute transactions in a sync context.
 use std::pin::Pin;
 use alloy::rpc::types::TransactionReceipt;
 use tokio::sync::oneshot;
 use crate::TO_TOKIO;
 use crate::tokio_runtime::AsyncNodeInteraction;
 pub type Task = Pin<Box<dyn Future<Output = anyhow::Result<TransactionReceipt>> + Send>>;
 pub(crate) struct Transaction {
    receipt_sender: oneshot::Sender<anyhow::Result<TransactionReceipt>>,
    task: Task,
 }
 impl AsyncNodeInteraction for Transaction {
    type Output = anyhow::Result<TransactionReceipt>;
    fn split(
        self,
    ) -> (
        Pin<Box<dyn Future<Output = Self::Output> + Send>>,
        oneshot::Sender<Self::Output>,
    ) {
        (self.task, self.receipt_sender)
    }
 }
 /// Execute some [Task] that returns a [TransactionReceipt].
 pub fn execute_transaction(task: Task) -> anyhow::Result<TransactionReceipt> {
    let request_sender = TO_TOKIO.lock().unwrap().transaction_sender.clone();
    let (receipt_sender, receipt_receiver) = oneshot::channel();
    request_sender
        .blocking_send(Transaction {
            receipt_sender,
            task,
        })
        .expect("we are not calling this from an async context");
    receipt_receiver
        .blocking_recv()
        .unwrap_or_else(|error| anyhow::bail!("no receipt received: {error}"))
 }
@@ -12,10 +12,12 @@ rust-version.workspace = true
 anyhow = { workspace = true }
 alloy = { workspace = true }
 tracing = { workspace = true }
 tokio = { workspace = true }
 revive-dt-node-interaction = { workspace = true }
 revive-dt-config = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
 sp-core = { workspace = true }
@@ -23,3 +25,4 @@ sp-runtime = { workspace = true }
 [dev-dependencies]
 temp-dir = { workspace = true }
 tokio = { workspace = true }
@@ -2,7 +2,7 @@
 use std::{
    collections::HashMap,
-    fs::{File, create_dir_all, remove_dir_all},
+    fs::{File, OpenOptions, create_dir_all, remove_dir_all},
    io::{BufRead, BufReader, Read, Write},
    path::PathBuf,
    process::{Child, Command, Stdio},
@@ -10,24 +10,26 @@ use std::{
        Mutex,
        atomic::{AtomicU32, Ordering},
    },
    thread,
    time::{Duration, Instant},
 };
 use alloy::{
-    network::EthereumWallet,
+    eips::BlockNumberOrTag,
-    primitives::Address,
+    network::{Ethereum, EthereumWallet},
-    providers::{Provider, ProviderBuilder, ext::DebugApi},
+    primitives::{Address, BlockHash, BlockNumber, BlockTimestamp, U256},
    providers::{
        Provider, ProviderBuilder,
        ext::DebugApi,
        fillers::{FillProvider, TxFiller},
    },
    rpc::types::{
        TransactionReceipt, TransactionRequest,
        trace::geth::{DiffMode, GethDebugTracingOptions, PreStateConfig, PreStateFrame},
    },
 };
 use revive_dt_config::Arguments;
-use revive_dt_node_interaction::{
+use revive_dt_node_interaction::{BlockingExecutor, EthereumNode};
-    EthereumNode, nonce::fetch_onchain_nonce, trace::trace_transaction,
+use tracing::Level;
    transaction::execute_transaction,
 };
 use crate::Node;
@@ -45,6 +47,7 @@ pub struct Instance {
    connection_string: String,
    base_directory: PathBuf,
    data_directory: PathBuf,
    logs_directory: PathBuf,
    geth: PathBuf,
    id: u32,
    handle: Option<Child>,
@@ -52,11 +55,17 @@ pub struct Instance {
    start_timeout: u64,
    wallet: EthereumWallet,
    nonces: Mutex<HashMap<Address, u64>>,
    /// This vector stores [`File`] objects that we use for logging which we want to flush when the
    /// node object is dropped. We do not store them in a structured fashion at the moment (in
    /// separate fields) as the logic that we need to apply to them is all the same regardless of
    /// what it belongs to, we just want to flush them on [`Drop`] of the node.
    logs_file_to_flush: Vec<File>,
 }
 impl Instance {
    const BASE_DIRECTORY: &str = "geth";
    const DATA_DIRECTORY: &str = "data";
    const LOGS_DIRECTORY: &str = "logs";
    const IPC_FILE: &str = "geth.ipc";
    const GENESIS_JSON_FILE: &str = "genesis.json";
@@ -64,9 +73,14 @@ impl Instance {
    const READY_MARKER: &str = "IPC endpoint opened";
    const ERROR_MARKER: &str = "Fatal:";
    const GETH_STDOUT_LOG_FILE_NAME: &str = "node_stdout.log";
    const GETH_STDERR_LOG_FILE_NAME: &str = "node_stderr.log";
    /// Create the node directory and call `geth init` to configure the genesis.
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn init(&mut self, genesis: String) -> anyhow::Result<&mut Self> {
        create_dir_all(&self.base_directory)?;
        create_dir_all(&self.logs_directory)?;
        let genesis_path = self.base_directory.join(Self::GENESIS_JSON_FILE);
        File::create(&genesis_path)?.write_all(genesis.as_bytes())?;
@@ -96,8 +110,24 @@ impl Instance {
    /// Spawn the go-ethereum node child process.
    ///
-    /// [Instance::init] must be called priorly.
+    /// [Instance::init] must be called prior.
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn spawn_process(&mut self) -> anyhow::Result<&mut Self> {
        // This is the `OpenOptions` that we wish to use for all of the log files that we will be
        // opening in this method. We need to construct it in this way to:
        // 1. Be consistent
        // 2. Less verbose and more dry
        // 3. Because the builder pattern uses mutable references so we need to get around that.
        let open_options = {
            let mut options = OpenOptions::new();
            options.create(true).truncate(true).write(true);
            options
        };
        let stdout_logs_file = open_options
            .clone()
            .open(self.geth_stdout_log_file_path())?;
        let stderr_logs_file = open_options.open(self.geth_stderr_log_file_path())?;
        self.handle = Command::new(&self.geth)
            .arg("--dev")
            .arg("--datadir")
@@ -109,92 +139,190 @@ impl Instance {
            .arg("--nodiscover")
            .arg("--maxpeers")
            .arg("0")
-            .stderr(Stdio::piped())
+            .stderr(stderr_logs_file.try_clone()?)
-            .stdout(Stdio::null())
+            .stdout(stdout_logs_file.try_clone()?)
            .spawn()?
            .into();
        if let Err(error) = self.wait_ready() {
            tracing::error!(?error, "Failed to start geth, shutting down gracefully");
            self.shutdown()?;
            return Err(error);
        }
        self.logs_file_to_flush
            .extend([stderr_logs_file, stdout_logs_file]);
        Ok(self)
    }
    /// Wait for the g-ethereum node child process getting ready.
    ///
    /// [Instance::spawn_process] must be called priorly.
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn wait_ready(&mut self) -> anyhow::Result<&mut Self> {
        // Thanks clippy but geth is a server; we don't `wait` but eventually kill it.
        #[allow(clippy::zombie_processes)]
        let mut child = self.handle.take().expect("should be spawned");
        let start_time = Instant::now();
        let logs_file = OpenOptions::new()
            .read(true)
            .write(false)
            .append(false)
            .truncate(false)
            .open(self.geth_stderr_log_file_path())?;
        let maximum_wait_time = Duration::from_millis(self.start_timeout);
-        let mut stderr = BufReader::new(child.stderr.take().expect("should be piped")).lines();
+        let mut stderr = BufReader::new(logs_file).lines();
-        let error = loop {
+        loop {
-            let Some(Ok(line)) = stderr.next() else {
+            if let Some(Ok(line)) = stderr.next() {
                break "child process stderr reading error".to_string();
            };
                if line.contains(Self::ERROR_MARKER) {
-                break line;
+                    anyhow::bail!("Failed to start geth {line}");
                }
                if line.contains(Self::READY_MARKER) {
                // Keep stderr alive
                // https://github.com/alloy-rs/alloy/issues/2091#issuecomment-2676134147
                thread::spawn(move || for _ in stderr.by_ref() {});
                self.handle = child.into();
                    return Ok(self);
                }
            if Instant::now().duration_since(start_time) > maximum_wait_time {
                break "spawn timeout".to_string();
            }
-        };
+            if Instant::now().duration_since(start_time) > maximum_wait_time {
                anyhow::bail!("Timeout in starting geth");
            }
        }
    }
-        let _ = child.kill();
+    #[tracing::instrument(skip_all, fields(geth_node_id = self.id), level = Level::TRACE)]
-        anyhow::bail!("geth node #{} spawn error: {error}", self.id)
+    fn geth_stdout_log_file_path(&self) -> PathBuf {
        self.logs_directory.join(Self::GETH_STDOUT_LOG_FILE_NAME)
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id), level = Level::TRACE)]
    fn geth_stderr_log_file_path(&self) -> PathBuf {
        self.logs_directory.join(Self::GETH_STDERR_LOG_FILE_NAME)
    }
    fn provider(
        &self,
    ) -> impl Future<
        Output = anyhow::Result<
            FillProvider<impl TxFiller<Ethereum>, impl Provider<Ethereum>, Ethereum>,
        >,
    > + 'static {
        let connection_string = self.connection_string();
        let wallet = self.wallet.clone();
        Box::pin(async move {
            ProviderBuilder::new()
                .wallet(wallet)
                .connect(&connection_string)
                .await
                .map_err(Into::into)
        })
    }
 }
 impl EthereumNode for Instance {
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn execute_transaction(
        &self,
        transaction: TransactionRequest,
    ) -> anyhow::Result<alloy::rpc::types::TransactionReceipt> {
-        let connection_string = self.connection_string();
+        let provider = self.provider();
-        let wallet = self.wallet.clone();
+        BlockingExecutor::execute(async move {
            let outer_span = tracing::debug_span!("Submitting transaction", ?transaction,);
            let _outer_guard = outer_span.enter();
-        tracing::debug!("Submitting transaction: {transaction:#?}");
+            let provider = provider.await?;
-        execute_transaction(Box::pin(async move {
+            let pending_transaction = provider.send_transaction(transaction).await?;
-            Ok(ProviderBuilder::new()
+            let transaction_hash = pending_transaction.tx_hash();
-                .wallet(wallet)
+
-                .connect(&connection_string)
+            let span = tracing::info_span!("Awaiting transaction receipt", ?transaction_hash);
-                .await?
+            let _guard = span.enter();
-                .send_transaction(transaction)
+
-                .await?
+            // The following is a fix for the "transaction indexing is in progress" error that we
-                .get_receipt()
+            // used to get. You can find more information on this in the following GH issue in geth
-                .await?)
+            // https://github.com/ethereum/go-ethereum/issues/28877. To summarize what's going on,
-        }))
+            // before we can get the receipt of the transaction it needs to have been indexed by the
            // node's indexer. Just because the transaction has been confirmed it doesn't mean that
            // it has been indexed. When we call alloy's `get_receipt` it checks if the transaction
            // was confirmed. If it has been, then it will call `eth_getTransactionReceipt` method
            // which _might_ return the above error if the tx has not yet been indexed yet. So, we
            // need to implement a retry mechanism for the receipt to keep retrying to get it until
            // it eventually works, but we only do that if the error we get back is the "transaction
            // indexing is in progress" error or if the receipt is None.
            //
            // At the moment we do not allow for the 60 seconds to be modified and we take it as
            // being an implementation detail that's invisible to anything outside of this module.
            //
            // We allow a total of 60 retries for getting the receipt with one second between each
            // retry and the next which means that we allow for a total of 60 seconds of waiting
            // before we consider that we're unable to get the transaction receipt.
            let mut retries = 0;
            loop {
                match provider.get_transaction_receipt(*transaction_hash).await {
                    Ok(Some(receipt)) => {
                        tracing::info!("Obtained the transaction receipt");
                        break Ok(receipt);
                    }
                    Ok(None) => {
                        if retries == 60 {
                            tracing::error!(
                                "Polled for transaction receipt for 60 seconds but failed to get it"
                            );
                            break Err(anyhow::anyhow!("Failed to get the transaction receipt"));
                        } else {
                            tracing::trace!(
                                retries,
                                "Sleeping for 1 second and trying to get the receipt again"
                            );
                            retries += 1;
                            tokio::time::sleep(std::time::Duration::from_secs(1)).await;
                            continue;
                        }
                    }
                    Err(error) => {
                        let error_string = error.to_string();
                        if error_string.contains("transaction indexing is in progress") {
                            if retries == 60 {
                                tracing::error!(
                                    "Polled for transaction receipt for 60 seconds but failed to get it"
                                );
                                break Err(error.into());
                            } else {
                                tracing::trace!(
                                    retries,
                                    "Sleeping for 1 second and trying to get the receipt again"
                                );
                                retries += 1;
                                tokio::time::sleep(std::time::Duration::from_secs(1)).await;
                                continue;
                            }
                        } else {
                            break Err(error.into());
                        }
                    }
                }
            }
        })?
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn trace_transaction(
        &self,
        transaction: TransactionReceipt,
    ) -> anyhow::Result<alloy::rpc::types::trace::geth::GethTrace> {
        let connection_string = self.connection_string();
        let trace_options = GethDebugTracingOptions::prestate_tracer(PreStateConfig {
            diff_mode: Some(true),
            disable_code: None,
            disable_storage: None,
        });
-        let wallet = self.wallet.clone();
+        let provider = self.provider();
-        trace_transaction(Box::pin(async move {
+        BlockingExecutor::execute(async move {
-            Ok(ProviderBuilder::new()
+            Ok(provider
                .wallet(wallet)
                .connect(&connection_string)
                .await?
                .debug_trace_transaction(transaction.transaction_hash, trace_options)
                .await?)
-        }))
+        })?
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn state_diff(
        &self,
        transaction: alloy::rpc::types::TransactionReceipt,
@@ -208,11 +336,16 @@ impl EthereumNode for Instance {
        }
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn fetch_add_nonce(&self, address: Address) -> anyhow::Result<u64> {
-        let connection_string = self.connection_string.clone();
+        let provider = self.provider();
-        let wallet = self.wallet.clone();
+        let onchain_nonce = BlockingExecutor::execute::<anyhow::Result<_>>(async move {
-
+            provider
-        let onchain_nonce = fetch_onchain_nonce(connection_string, wallet, address)?;
+                .await?
                .get_transaction_count(address)
                .await
                .map_err(Into::into)
        })??;
        let mut nonces = self.nonces.lock().unwrap();
        let current = nonces.entry(address).or_insert(onchain_nonce);
@@ -220,6 +353,87 @@ impl EthereumNode for Instance {
        *current += 1;
        Ok(value)
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn chain_id(&self) -> anyhow::Result<alloy::primitives::ChainId> {
        let provider = self.provider();
        BlockingExecutor::execute(async move {
            provider.await?.get_chain_id().await.map_err(Into::into)
        })?
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn block_gas_limit(&self, number: BlockNumberOrTag) -> anyhow::Result<u128> {
        let provider = self.provider();
        BlockingExecutor::execute(async move {
            provider
                .await?
                .get_block_by_number(number)
                .await?
                .ok_or(anyhow::Error::msg("Blockchain has no blocks"))
                .map(|block| block.header.gas_limit as _)
        })?
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn block_coinbase(&self, number: BlockNumberOrTag) -> anyhow::Result<Address> {
        let provider = self.provider();
        BlockingExecutor::execute(async move {
            provider
                .await?
                .get_block_by_number(number)
                .await?
                .ok_or(anyhow::Error::msg("Blockchain has no blocks"))
                .map(|block| block.header.beneficiary)
        })?
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn block_difficulty(&self, number: BlockNumberOrTag) -> anyhow::Result<U256> {
        let provider = self.provider();
        BlockingExecutor::execute(async move {
            provider
                .await?
                .get_block_by_number(number)
                .await?
                .ok_or(anyhow::Error::msg("Blockchain has no blocks"))
                .map(|block| block.header.difficulty)
        })?
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn block_hash(&self, number: BlockNumberOrTag) -> anyhow::Result<BlockHash> {
        let provider = self.provider();
        BlockingExecutor::execute(async move {
            provider
                .await?
                .get_block_by_number(number)
                .await?
                .ok_or(anyhow::Error::msg("Blockchain has no blocks"))
                .map(|block| block.header.hash)
        })?
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn block_timestamp(&self, number: BlockNumberOrTag) -> anyhow::Result<BlockTimestamp> {
        let provider = self.provider();
        BlockingExecutor::execute(async move {
            provider
                .await?
                .get_block_by_number(number)
                .await?
                .ok_or(anyhow::Error::msg("Blockchain has no blocks"))
                .map(|block| block.header.timestamp)
        })?
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn last_block_number(&self) -> anyhow::Result<BlockNumber> {
        let provider = self.provider();
        BlockingExecutor::execute(async move {
            provider.await?.get_block_number().await.map_err(Into::into)
        })?
    }
 }
 impl Node for Instance {
@@ -231,6 +445,7 @@ impl Node for Instance {
        Self {
            connection_string: base_directory.join(Self::IPC_FILE).display().to_string(),
            data_directory: base_directory.join(Self::DATA_DIRECTORY),
            logs_directory: base_directory.join(Self::LOGS_DIRECTORY),
            base_directory,
            geth: config.geth.clone(),
            id,
@@ -239,22 +454,46 @@ impl Node for Instance {
            start_timeout: config.geth_start_timeout,
            wallet: config.wallet(),
            nonces: Mutex::new(HashMap::new()),
            // We know that we only need to be storing 2 files so we can specify that when creating
            // the vector. It's the stdout and stderr of the geth node.
            logs_file_to_flush: Vec::with_capacity(2),
        }
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn connection_string(&self) -> String {
        self.connection_string.clone()
    }
-    fn shutdown(self) -> anyhow::Result<()> {
+    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn shutdown(&mut self) -> anyhow::Result<()> {
        // Terminate the processes in a graceful manner to allow for the output to be flushed.
        if let Some(mut child) = self.handle.take() {
            child
                .kill()
                .map_err(|error| anyhow::anyhow!("Failed to kill the geth process: {error:?}"))?;
        }
        // Flushing the files that we're using for keeping the logs before shutdown.
        for file in self.logs_file_to_flush.iter_mut() {
            file.flush()?
        }
        // Remove the node's database so that subsequent runs do not run on the same database. We
        // ignore the error just in case the directory didn't exist in the first place and therefore
        // there's nothing to be deleted.
        let _ = remove_dir_all(self.base_directory.join(Self::DATA_DIRECTORY));
        Ok(())
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn spawn(&mut self, genesis: String) -> anyhow::Result<()> {
-        self.init(genesis)?.spawn_process()?.wait_ready()?;
+        self.init(genesis)?.spawn_process()?;
        Ok(())
    }
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn version(&self) -> anyhow::Result<String> {
        let output = Command::new(&self.geth)
            .arg("--version")
@@ -269,13 +508,9 @@ impl Node for Instance {
 }
 impl Drop for Instance {
    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
    fn drop(&mut self) {
-        if let Some(child) = self.handle.as_mut() {
+        self.shutdown().expect("Failed to shutdown")
            let _ = child.kill();
        }
        if self.base_directory.exists() {
            let _ = remove_dir_all(&self.base_directory);
        }
    }
 }
@@ -286,7 +521,7 @@ mod tests {
    use crate::{GENESIS_JSON, Node};
-    use super::Instance;
+    use super::*;
    fn test_config() -> (Arguments, TempDir) {
        let mut config = Arguments::default();
@@ -296,6 +531,16 @@ mod tests {
        (config, temp_dir)
    }
    fn new_node() -> (Instance, TempDir) {
        let (args, temp_dir) = test_config();
        let mut node = Instance::new(&args);
        node.init(GENESIS_JSON.to_owned())
            .expect("Failed to initialize the node")
            .spawn_process()
            .expect("Failed to spawn the node process");
        (node, temp_dir)
    }
    #[test]
    fn init_works() {
        Instance::new(&test_config().0)
@@ -318,4 +563,93 @@ mod tests {
            "expected version string, got: '{version}'"
        );
    }
    #[test]
    fn can_get_chain_id_from_node() {
        // Arrange
        let (node, _temp_dir) = new_node();
        // Act
        let chain_id = node.chain_id();
        // Assert
        let chain_id = chain_id.expect("Failed to get the chain id");
        assert_eq!(chain_id, 420_420_420);
    }
    #[test]
    fn can_get_gas_limit_from_node() {
        // Arrange
        let (node, _temp_dir) = new_node();
        // Act
        let gas_limit = node.block_gas_limit(BlockNumberOrTag::Latest);
        // Assert
        let gas_limit = gas_limit.expect("Failed to get the gas limit");
        assert_eq!(gas_limit, u32::MAX as u128)
    }
    #[test]
    fn can_get_coinbase_from_node() {
        // Arrange
        let (node, _temp_dir) = new_node();
        // Act
        let coinbase = node.block_coinbase(BlockNumberOrTag::Latest);
        // Assert
        let coinbase = coinbase.expect("Failed to get the coinbase");
        assert_eq!(coinbase, Address::new([0xFF; 20]))
    }
    #[test]
    fn can_get_block_difficulty_from_node() {
        // Arrange
        let (node, _temp_dir) = new_node();
        // Act
        let block_difficulty = node.block_difficulty(BlockNumberOrTag::Latest);
        // Assert
        let block_difficulty = block_difficulty.expect("Failed to get the block difficulty");
        assert_eq!(block_difficulty, U256::ZERO)
    }
    #[test]
    fn can_get_block_hash_from_node() {
        // Arrange
        let (node, _temp_dir) = new_node();
        // Act
        let block_hash = node.block_hash(BlockNumberOrTag::Latest);
        // Assert
        let _ = block_hash.expect("Failed to get the block hash");
    }
    #[test]
    fn can_get_block_timestamp_from_node() {
        // Arrange
        let (node, _temp_dir) = new_node();
        // Act
        let block_timestamp = node.block_timestamp(BlockNumberOrTag::Latest);
        // Assert
        let _ = block_timestamp.expect("Failed to get the block timestamp");
    }
    #[test]
    fn can_get_block_number_from_node() {
        // Arrange
        let (node, _temp_dir) = new_node();
        // Act
        let block_number = node.last_block_number();
        // Assert
        let block_number = block_number.expect("Failed to get the block number");
        assert_eq!(block_number, 0)
    }
 }
@@ -23,7 +23,7 @@ pub trait Node: EthereumNode {
    /// Prune the node instance and related data.
    ///
    /// Blocking until it's completely stopped.
-    fn shutdown(self) -> anyhow::Result<()>;
+    fn shutdown(&mut self) -> anyhow::Result<()>;
    /// Returns the nodes connection string.
    fn connection_string(&self) -> String;
Author	SHA1	Message	Date
Omar Abdulla	7836461763	Add test	2025-07-21 12:15:27 +03:00
Omar Abdulla	0e473e1633	Merge remote-tracking branch 'origin/main' into bugfix/function-signature	2025-07-21 12:13:24 +03:00
Omar	a9970eb2bb	Refactor the input handling logic (#48 ) * Add support for wrapper types * Move `FilesWithExtensionIterator` to `core::common` * Remove unneeded use of two `HashMap`s * Make metadata structs more typed * Impl new_from for wrapper types * Implement the new input handling logic * Fix edge-case in input handling * Ignore macro doc comment tests * Correct comment * Fix edge-case in deployment order	2025-07-21 09:01:52 +00:00
Omar Abdulla	c8cef4834f	Allow for the use of function signatures	2025-07-18 16:37:15 +03:00
Omar	2259942363	Cleanup execution logic (#45 ) * Introduce a custom kitchensink network * fix formatting * Added `--dev` to `substrate-node` arguments. This commit adds the `--dev` argument to the `substrate-node` to allow the chain to keep advancing as time goes own. We have found that if this option is not added then the chain won't advance forward. * fix clippy warning * fix clippy warning * Fix the ABI finding logic * Fix function selector and argument encoding * Avoid extra buffer allocation * Remove reliance on the web3 crate * Implement ABI fix in the compiler trait impl * Update the async runtime with syntactic sugar. * Fix tests * Fix doc test * Give nodes a standard way to get their alloy provider * Add ability to get the chain_id from node * Get kitchensink provider to use kitchensink network * Use provider method in tests * Add support for getting the gas limit from the node * Add a way to get the coinbase address * Add a way to get the block difficulty from the node * Add a way to get block info from the node * Expose APIs for getting the info of a specific block * Add resolution logic for other matterlabs variables * Fix tests * Add comment on alternative solutions * Change kitchensink gas limit assertion * Cleanup execution logic	2025-07-18 12:08:13 +00:00
Omar	0b97d7dc29	Support other matterlabs variables (#43 ) * Introduce a custom kitchensink network * fix formatting * Added `--dev` to `substrate-node` arguments. This commit adds the `--dev` argument to the `substrate-node` to allow the chain to keep advancing as time goes own. We have found that if this option is not added then the chain won't advance forward. * fix clippy warning * fix clippy warning * Fix function selector and argument encoding * Avoid extra buffer allocation * Remove reliance on the web3 crate * Update the async runtime with syntactic sugar. * Fix tests * Fix doc test * Give nodes a standard way to get their alloy provider * Add ability to get the chain_id from node * Get kitchensink provider to use kitchensink network * Use provider method in tests * Add support for getting the gas limit from the node * Add a way to get the coinbase address * Add a way to get the block difficulty from the node * Add a way to get block info from the node * Expose APIs for getting the info of a specific block * Add resolution logic for other matterlabs variables * Fix tests * Add comment on alternative solutions * Change kitchensink gas limit assertion * Remove un-needed profile config	2025-07-18 12:06:40 +00:00
Omar	2bee2d5c8b	Fix the ABI finding logic (#38 ) * Fix the ABI finding logic * Implement ABI fix in the compiler trait impl	2025-07-18 11:22:51 +00:00
Omar	854e8d9690	Fix `deserialization error: invalid value: string "0x2d79dd80ff729c000"` (#34 ) * Introduce a custom kitchensink network * fix formatting * Added `--dev` to `substrate-node` arguments. This commit adds the `--dev` argument to the `substrate-node` to allow the chain to keep advancing as time goes own. We have found that if this option is not added then the chain won't advance forward. * fix clippy warning * fix clippy warning	2025-07-18 11:22:13 +00:00
Omar	2d517784dd	Better logging for contract deployment (#46 ) * Log certain errors better * Remove unneeded code	2025-07-16 18:16:12 +00:00
Omar	baa11ad28f	Correctly identify which contracts to compile (#44 ) * Compile all contracts for a test file * Fix compilation errors related to paths * Set the base path if specified	2025-07-16 11:52:40 +00:00
Omar	c2e65f9e33	Fix function selector & argument encoding (#39 ) * Fix function selector and argument encoding * Avoid extra buffer allocation * Remove reliance on the web3 crate * Fix tests	2025-07-15 20:00:10 +00:00
Omar	14888f9767	Update the async runtime (#42 ) * Update the async runtime with syntactic sugar. * Fix doc test * Update crates/node-interaction/src/blocking_executor.rs Co-authored-by: xermicus <cyrill@parity.io> * Update crates/node-interaction/src/blocking_executor.rs Co-authored-by: xermicus <cyrill@parity.io> * Update crates/node-interaction/src/blocking_executor.rs Co-authored-by: xermicus <cyrill@parity.io> * Update crates/node-interaction/src/blocking_executor.rs Co-authored-by: xermicus <cyrill@parity.io> * Update crates/node-interaction/src/blocking_executor.rs Co-authored-by: xermicus <cyrill@parity.io> * Update crates/node-interaction/src/blocking_executor.rs Co-authored-by: xermicus <cyrill@parity.io> * Update crates/node-interaction/src/blocking_executor.rs Co-authored-by: xermicus <cyrill@parity.io> * Update crates/node-interaction/src/blocking_executor.rs Co-authored-by: xermicus <cyrill@parity.io> * Update crates/node-interaction/src/blocking_executor.rs Co-authored-by: xermicus <cyrill@parity.io> * Update crates/node-interaction/src/blocking_executor.rs Co-authored-by: xermicus <cyrill@parity.io> * Improve the comments * Update the release profile --------- Co-authored-by: xermicus <cyrill@parity.io>	2025-07-15 11:19:17 +00:00
Omar	3e99d1c2a5	Allow alloy to estimate tx gas (#37 )	2025-07-14 17:34:44 +00:00
Omar	4e234aa1bd	Remove code that was accidentally committed. (#41 ) * Remove code that was accidentally committed. * Remove unneeded dependency	2025-07-14 16:24:39 +00:00
Omar	b204de5484	Persist node logs (#36 ) * Persist node logs * Fix clippy lints * Delete the node's db on shutdown but persist logs * Fix tests * Separate stdout and stderr and use more consts. * More consistent handling of open options * Revert the use of subprocess * Remove outdated comment * Flush the log files on drop * Rename `log_files` -> `logs_file_to_flush`	2025-07-14 16:08:47 +00:00
Omar	5eb3a0e1b5	Fix for "transaction indexing is in progress" (#32 ) * Retry getting transaction receipt * Small fix to logging consistency * Introduce a custom kitchensink network * Fix formtting and clippy	2025-07-14 09:32:57 +00:00