Merge remote-tracking branch 'origin/main' into cleanup-execution-logic

* Fix the ABI finding logic

* Implement ABI fix in the compiler trait impl

Cargo.lock

@@ -3984,6 +3984,7 @@ dependencies = [
  "alloy-primitives",
  "alloy-sol-types",
  "anyhow",
+ "revive-dt-node-interaction",
  "semver 1.0.26",
  "serde",
  "serde_json",
@@ -4013,6 +4014,7 @@ version = "0.1.0"
 dependencies = [
  "alloy",
  "anyhow",
+ "futures",
  "once_cell",
  "tokio",
  "tracing",

Cargo.toml

@@ -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"

crates/compiler/src/lib.rs

@@ -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>,
-    base_path: Option<String>,
+    allow_paths: Vec<PathBuf>,
+    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,
         })
     }
 

crates/compiler/src/revive_resolc.rs

@@ -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)
-            .arg("--standard-json")
-            .args(&input.extra_options)
+        let mut command = Command::new(&self.resolc_path);
+        command
             .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,12 +71,64 @@ impl SolidityCompiler for Resolc {
             });
         }
 
-        let parsed: SolcStandardJsonOutput = serde_json::from_slice(&stdout).map_err(|e| {
-            anyhow::anyhow!(
-                "failed to parse resolc JSON output: {e}\nstderr: {}",
-                String::from_utf8_lossy(&stderr)
-            )
-        })?;
+        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,

crates/compiler/src/solc.rs

@@ -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")
-            .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 = 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,
         })
     }

crates/core/src/driver/mod.rs

@@ -1,11 +1,11 @@
 //! The test driver handles the compilation and execution of the test cases.
 
 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, map::HashMap},
     rpc::types::{
         TransactionRequest,
         trace::geth::{AccountState, DiffMode},
@@ -19,7 +19,7 @@ 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 tracing::Level;
+use std::fmt::Debug;
 
 use crate::Platform;
 
@@ -69,14 +69,13 @@ where
             anyhow::bail!("unsupported solc version: {:?}", &mode.solc_version);
         };
 
-        let mut compiler = Compiler::<T::Compiler>::new()
-            .base_path(metadata.directory()?.display().to_string())
+        let compiler = Compiler::<T::Compiler>::new()
+            .allow_path(metadata.directory()?)
             .solc_optimizer(mode.solc_optimize());
 
-        for (file, _contract) in metadata.contract_sources()?.values() {
-            tracing::debug!("contract source {}", file.display());
-            compiler = compiler.with_source(file)?;
-        }
+        let compiler = FilesWithExtensionIterator::new(metadata.directory()?)
+            .with_allowed_extension("sol")
+            .try_fold(compiler, |compiler, path| compiler.with_source(&path))?;
 
         let mut task = CompilationTask {
             json_input: compiler.input(),
@@ -136,10 +135,10 @@ where
         );
 
         let tx = match input.legacy_transaction(
-            self.config.network_id,
             nonce,
             &self.deployed_contracts,
             &self.deployed_abis,
+            node,
         ) {
             Ok(tx) => {
                 tracing::debug!("Legacy transaction data: {tx:#?}");
@@ -184,12 +183,15 @@ where
     }
 
     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>()
+        let tracing_span = tracing::debug_span!(
+            "Deploying contracts",
+            ?input,
+            node = std::any::type_name::<T>()
         );
+        let _guard = tracing_span.enter();
+
+        tracing::debug!(number_of_contracts_to_deploy = self.contracts.len());
+
         for output in self.contracts.values() {
             let Some(contract_map) = &output.contracts else {
                 tracing::debug!(
@@ -201,6 +203,9 @@ where
 
             for contracts in contract_map.values() {
                 for (contract_name, contract) in contracts {
+                    let tracing_span = tracing::info_span!("Deploying contract", contract_name);
+                    let _guard = tracing_span.enter();
+
                     tracing::debug!(
                         "Contract name is: {:?} and the input name is: {:?}",
                         &contract_name,
@@ -218,7 +223,17 @@ where
                         continue;
                     };
 
-                    let nonce = node.fetch_add_nonce(input.caller)?;
+                    let nonce = match node.fetch_add_nonce(input.caller) {
+                        Ok(nonce) => nonce,
+                        Err(error) => {
+                            tracing::error!(
+                                caller = ?input.caller,
+                                ?error,
+                                "Failed to get the nonce for the caller"
+                            );
+                            return Err(error);
+                        }
+                    };
 
                     tracing::debug!(
                         "Calculated nonce {}, for contract {}, having address {} on node: {}",
@@ -228,15 +243,25 @@ where
                         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()
+                    // We are using alloy for building and submitting the transactions and it will
+                    // automatically fill in all of the missing fields from the provider that we
+                    // are using.
+                    let code = match alloy::hex::decode(&code) {
+                        Ok(code) => code,
+                        Err(error) => {
+                            tracing::error!(
+                                code,
+                                ?error,
+                                "Failed to hex-decode the code of the contract. (This could possibly mean that it contains '_' and therefore it requires linking to be performed)"
+                            );
+                            return Err(error.into());
+                        }
+                    };
+                    let tx = {
+                        let tx = TransactionRequest::default()
+                            .nonce(nonce)
+                            .from(input.caller);
+                        TransactionBuilder::<Ethereum>::with_deploy_code(tx, code)
                     };
 
                     let receipt = match node.execute_transaction(tx) {
@@ -283,51 +308,40 @@ where
                         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}"
-                        );
+                    let Some(Value::String(metadata)) = &contract.metadata else {
+                        tracing::error!(?contract, "Contract does not have a metadata field");
+                        anyhow::bail!("Contract does not have a metadata field: {contract:?}");
+                    };
 
-                        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);
-                    }
+                    // Deserialize the solc metadata into a JSON object so we can get the ABI of the
+                    // contracts. If we fail to perform the deserialization then we return an error
+                    // as there's no other way to handle this.
+                    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}"
+                        );
+                    };
+
+                    // Accessing the ABI on the solc metadata and erroring if the accessing failed
+                    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}"
+                        );
+                    };
+
+                    // Deserialize the ABI object that we got from the unstructured JSON into a
+                    // structured ABI object and error out if we fail.
+                    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_abis.insert(contract_name.clone(), abi);
                 }
             }
         }
@@ -390,66 +404,177 @@ 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() {
-                // Creating a tracing span to know which case within the metadata is being executed
-                // and which one we're getting logs for.
-                let tracing_span = tracing::span!(
-                    Level::INFO,
-                    "Executing case",
-                    case = case.name,
+            // We build the contracts. If building the contracts for the metadata file fails then we
+            // have no other option but to keep note of this error and move on to the next solc mode
+            // and NOT just bail out of the execution as a whole.
+            let build_result = tracing::info_span!("Building contracts").in_scope(|| {
+                match leader_state.build_contracts(&mode, self.metadata) {
+                    Ok(_) => {
+                        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 {
-                    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);
+                // For inputs if one of the inputs fail we move on to the next case (we do not move
+                // on to the next input as it doesn't make sense. It depends on the previous one).
+                for (input_idx, input) in case.inputs.iter().enumerate() {
+                    let tracing_span = tracing::info_span!("Handling input", input_idx);
+                    let _guard = tracing_span.enter();
+
+                    // TODO: verify if this is correct, I doubt that we need to do contract redeploy
+                    // for each input. It doesn't quite look to be correct but we need to cross
+                    // check with the matterlabs implementation. This matches our implementation but
+                    // I have doubts around its correctness.
+                    let deployment_result = tracing::info_span!(
+                        "Deploying contracts",
+                        contract_name = input.instance
+                    )
+                    .in_scope(|| {
+                        if let Err(error) = leader_state.deploy_contracts(input, self.leader_node) {
+                            tracing::error!(target = ?Target::Leader, ?error, "Contract deployment failed");
+                            execution_result.add_failed_case(
+                                Target::Leader,
+                                mode.clone(),
+                                case.name.clone().unwrap_or("no case name".to_owned()),
+                                case_idx,
+                                input_idx,
+                                anyhow::Error::msg(
+                                    format!("Failed to deploy contracts, {error}")
+                                )
+                            );
+                            return Err(error)
+                        };
+                        if let Err(error) =
+                            follower_state.deploy_contracts(input, self.follower_node)
+                        {
+                            tracing::error!(target = ?Target::Follower, ?error, "Contract deployment failed");
+                            execution_result.add_failed_case(
+                                Target::Follower,
+                                mode.clone(),
+                                case.name.clone().unwrap_or("no case name".to_owned()),
+                                case_idx,
+                                input_idx,
+                                anyhow::Error::msg(
+                                    format!("Failed to deploy contracts, {error}")
+                                )
+                            );
+                            return Err(error)
+                        };
+                        Ok(())
+                    });
+                    if deployment_result.is_err() {
+                        // 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 let Err(err) = follower_state.deploy_contracts(input, self.follower_node) {
-                        tracing::error!("Follower deployment failed for {}: {err}", input.instance);
-                        continue;
-                    } else {
-                        tracing::debug!("Follower deployment succeeded for {}", &input.instance);
-                    }
+                    let execution_result =
+                        tracing::info_span!("Executing input", contract_name = input.instance)
+                            .in_scope(|| {
+                                let (leader_receipt, _, leader_diff) =
+                                    match leader_state.execute_input(input, self.leader_node) {
+                                        Ok(result) => result,
+                                        Err(error) => {
+                                            tracing::error!(
+                                                target = ?Target::Leader,
+                                                ?error,
+                                                "Contract execution failed"
+                                            );
+                                            return Err(error);
+                                        }
+                                    };
 
-                    tracing::debug!("Starting executing contract {}", &input.instance);
+                                let (follower_receipt, _, follower_diff) =
+                                    match follower_state.execute_input(input, self.follower_node) {
+                                        Ok(result) => result,
+                                        Err(error) => {
+                                            tracing::error!(
+                                                target = ?Target::Follower,
+                                                ?error,
+                                                "Contract execution failed"
+                                            );
+                                            return Err(error);
+                                        }
+                                    };
 
-                    let (leader_receipt, _, leader_diff) =
-                        match leader_state.execute_input(input, self.leader_node) {
-                            Ok(result) => result,
-                            Err(err) => {
-                                tracing::error!(
-                                    "Leader execution failed for {}: {err}",
-                                    input.instance
-                                );
-                                continue;
-                            }
-                        };
-
-                    let (follower_receipt, _, follower_diff) =
-                        match follower_state.execute_input(input, self.follower_node) {
-                            Ok(result) => result,
-                            Err(err) => {
-                                tracing::error!(
-                                    "Follower execution failed for {}: {err}",
-                                    input.instance
-                                );
-                                continue;
-                            }
-                        };
+                                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.");
@@ -473,9 +598,311 @@ 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: usize,
+    ) {
+        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: usize,
+        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, usize)>;
+
+    /// 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, usize)> {
+        None
+    }
+
+    fn input_index(&self) -> Option<usize> {
+        None
+    }
+}
+
+#[derive(Debug)]
+pub enum CaseResult {
+    Success {
+        target: Target,
+        solc_mode: SolcMode,
+        case_name: String,
+        case_idx: usize,
+    },
+    Failure {
+        target: Target,
+        solc_mode: SolcMode,
+        case_name: String,
+        case_idx: usize,
+        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, usize)> {
+        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),
+        }
+    }
+}
+
+/// 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`
+struct FilesWithExtensionIterator {
+    /// The set of allowed extensions that that match the requirement and that should be returned
+    /// when found.
+    allowed_extensions: std::collections::HashSet<std::borrow::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<std::path::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.
+    ///
+    /// [`Iterator`]: std::iter::Iterator
+    files_matching_allowed_extensions: Vec<std::path::PathBuf>,
+}
+
+impl FilesWithExtensionIterator {
+    fn new(root_directory: std::path::PathBuf) -> Self {
+        Self {
+            allowed_extensions: Default::default(),
+            directories_to_search: vec![root_directory],
+            files_matching_allowed_extensions: Default::default(),
+        }
+    }
+
+    fn with_allowed_extension(
+        mut self,
+        allowed_extension: impl Into<std::borrow::Cow<'static, str>>,
+    ) -> Self {
+        self.allowed_extensions.insert(allowed_extension.into());
+        self
+    }
+}
+
+impl Iterator for FilesWithExtensionIterator {
+    type Item = std::path::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()
     }
 }

crates/core/src/main.rs

@@ -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,20 +116,25 @@ where
                 follower_nodes.round_robbin(),
             );
 
-            match driver.execute(span) {
-                Ok(_) => {
-                    tracing::info!(
-                        "metadata {} success",
-                        metadata.directory().as_ref().unwrap().display()
-                    );
-                }
-                Err(error) => {
-                    tracing::warn!(
-                        "metadata {} failure: {error:?}",
-                        metadata.file_path.as_ref().unwrap().display()
-                    );
+            let execution_result = driver.execute(span);
+            tracing::info!(
+                case_success_count = execution_result.successful_cases_count,
+                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;
                 }
             }
+            if error_count == 0 {
+                tracing::info!("Execution succeeded");
+            } else {
+                tracing::info!("Execution failed");
+            }
         },
     );
 

crates/format/Cargo.toml

@@ -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 }

crates/format/src/input.rs

@@ -1,17 +1,18 @@
 use std::collections::HashMap;
 
 use alloy::{
-    hex,
-    json_abi::{Function, JsonAbi},
-    primitives::{Address, Bytes, TxKind},
-    rpc::types::{TransactionInput, TransactionRequest},
+    eips::BlockNumberOrTag,
+    json_abi::JsonAbi,
+    network::TransactionBuilder,
+    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;
+
 #[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
 pub struct Input {
     #[serde(default = "default_caller")]
@@ -19,7 +20,6 @@ pub struct Input {
     pub comment: Option<String>,
     #[serde(default = "default_instance")]
     pub instance: String,
-    #[serde(deserialize_with = "deserialize_method")]
     pub method: Method,
     pub calldata: Option<Calldata>,
     pub expected: Option<Expected>,
@@ -47,58 +47,28 @@ pub struct ExpectedOutput {
 #[serde(untagged)]
 pub enum Calldata {
     Single(String),
-    Compound(Vec<CalldataArg>),
-}
-
-#[derive(Clone, Debug, Deserialize, Eq, PartialEq)]
-#[serde(untagged)]
-pub enum CalldataArg {
-    Literal(String),
-    /// For example: `Contract.address`
-    AddressRef(String),
+    Compound(Vec<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.
-    ///
-    /// Calculates the selector if neither deployer or fallback matches.
-    Function([u8; 4]),
-}
 
-fn deserialize_method<'de, D>(deserializer: D) -> Result<Method, D::Error>
-where
-    D: Deserializer<'de>,
-{
-    Ok(match String::deserialize(deserializer)?.as_str() {
-        "#deployer" => Method::Deployer,
-        "#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}"
-                    )));
-                }
-            }
-        }
-    })
+    /// Call the public function with the given name.
+    #[serde(untagged)]
+    FunctionName(String),
 }
 
 impl Input {
@@ -117,25 +87,34 @@ impl Input {
         &self,
         deployed_abis: &HashMap<String, JsonAbi>,
         deployed_contracts: &HashMap<String, Address>,
+        chain_state_provider: &impl EthereumNode,
     ) -> anyhow::Result<Bytes> {
-        let Method::Function(selector) = self.method else {
+        let Method::FunctionName(ref function_name) = self.method else {
             return Ok(Bytes::default()); // fallback or deployer — no input
         };
 
-        let abi = deployed_abis
-            .get(&self.instance)
-            .ok_or_else(|| anyhow::anyhow!("ABI for instance '{}' not found", &self.instance))?;
+        let Some(abi) = deployed_abis.get(&self.instance) else {
+            tracing::error!(
+                contract_name = self.instance,
+                available_abis = ?deployed_abis.keys().collect::<Vec<_>>(),
+                "Attempted to lookup ABI of contract but it wasn't found"
+            );
+            anyhow::bail!("ABI for instance '{}' not found", &self.instance);
+        };
 
         tracing::trace!("ABI found for instance: {}", &self.instance);
 
-        // Find function by selector
+        // 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.name.starts_with(function_name))
             .ok_or_else(|| {
                 anyhow::anyhow!(
-                    "Function with selector {:?} not found in ABI for the instance {:?}",
-                    selector,
+                    "Function with name {:?} not found in ABI for the instance {:?}",
+                    function_name,
                     &self.instance
                 )
             })?;
@@ -160,90 +139,47 @@ impl Input {
             &self.instance
         );
 
-        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() {
-            let arg = calldata_args.get(i).unwrap();
-            let encoded_arg = match arg {
-                CalldataArg::Literal(value) => match param.ty.as_str() {
-                    "uint256" | "uint" => {
-                        let val: U256 = value.parse()?;
-                        val.abi_encode()
-                    }
-                    "uint24" => {
-                        let val: u32 = value.parse()?;
-                        (val & 0xFFFFFF).abi_encode()
-                    }
-                    "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()
+        for (arg_idx, arg) in calldata_args.iter().enumerate() {
+            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);
                 }
             };
-
-            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,
         nonce: u64,
         deployed_contracts: &HashMap<String, Address>,
         deployed_abis: &HashMap<String, JsonAbi>,
+        chain_state_provider: &impl EthereumNode,
     ) -> anyhow::Result<TransactionRequest> {
-        let to = match self.method {
-            Method::Deployer => Some(TxKind::Create),
-            _ => Some(TxKind::Call(
-                self.instance_to_address(&self.instance, deployed_contracts)?,
-            )),
-        };
-
-        let input_data = self.encoded_input(deployed_abis, deployed_contracts)?;
-
-        Ok(TransactionRequest {
-            from: Some(self.caller),
-            to,
-            nonce: Some(nonce),
-            chain_id: Some(chain_id),
-            gas_price: Some(5_000_000),
-            gas: Some(5_000_000),
-            input: TransactionInput::new(input_data),
-            ..Default::default()
-        })
+        let input_data =
+            self.encoded_input(deployed_abis, deployed_contracts, chain_state_provider)?;
+        let transaction_request = TransactionRequest::default().nonce(nonce);
+        match self.method {
+            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())),
+        }
     }
 }
 
@@ -255,14 +191,148 @@ 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<String, Address>,
+    chain_state_provider: &impl EthereumNode,
+) -> anyhow::Result<U256> {
+    if let Some(instance) = value.strip_suffix(".address") {
+        Ok(U256::from_be_slice(
+            deployed_contracts
+                .get(instance)
+                .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,16 +348,18 @@ mod tests {
         "#;
 
         let parsed_abi: JsonAbi = serde_json::from_str(raw_metadata).unwrap();
-        let selector = keccak256("store(uint256)".as_bytes())[0..4]
-            .try_into()
-            .unwrap();
+        let selector = parsed_abi
+            .function("store")
+            .unwrap()
+            .first()
+            .unwrap()
+            .selector()
+            .0;
 
         let input = Input {
             instance: "Contract".to_string(),
-            method: Method::Function(selector),
-            calldata: Some(Calldata::Compound(vec![CalldataArg::Literal(
-                "42".to_string(),
-            )])),
+            method: Method::FunctionName("store".to_owned()),
+            calldata: Some(Calldata::Compound(vec!["42".into()])),
             ..Default::default()
         };
 
@@ -296,7 +368,7 @@ mod tests {
         let deployed_contracts = HashMap::new();
 
         let encoded = input
-            .encoded_input(&deployed_abis, &deployed_contracts)
+            .encoded_input(&deployed_abis, &deployed_contracts, &DummyEthereumNode)
             .unwrap();
         assert!(encoded.0.starts_with(&selector));
 
@@ -305,112 +377,6 @@ mod tests {
         assert_eq!(decoded.0, 42);
     }
 
-    #[test]
-    fn test_encoded_input_bool() {
-        let raw_abi = r#"[
-            {
-                "inputs": [{"name": "flag", "type": "bool"}],
-                "name": "toggle",
-                "outputs": [],
-                "stateMutability": "nonpayable",
-                "type": "function"
-            }
-        ]"#;
-
-        let parsed_abi: JsonAbi = serde_json::from_str(raw_abi).unwrap();
-        let selector = keccak256("toggle(bool)".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(
-                "true".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));
-
-        type T = (bool,);
-        let decoded: T = T::abi_decode(&encoded.0[4..]).unwrap();
-        assert_eq!(decoded.0, true);
-    }
-
-    #[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]
     fn test_encoded_input_address() {
         let raw_abi = r#"[
@@ -424,16 +390,20 @@ mod tests {
         ]"#;
 
         let parsed_abi: JsonAbi = serde_json::from_str(raw_abi).unwrap();
-        let selector = keccak256("send(address)".as_bytes())[0..4]
-            .try_into()
-            .unwrap();
+        let selector = parsed_abi
+            .function("send")
+            .unwrap()
+            .first()
+            .unwrap()
+            .selector()
+            .0;
 
-        let input = Input {
+        let input: Input = Input {
             instance: "Contract".to_string(),
-            method: Method::Function(selector),
-            calldata: Some(Calldata::Compound(vec![CalldataArg::Literal(
+            method: Method::FunctionName("send".to_owned()),
+            calldata: Some(Calldata::Compound(vec![
                 "0x1000000000000000000000000000000000000001".to_string(),
-            )])),
+            ])),
             ..Default::default()
         };
 
@@ -441,7 +411,9 @@ mod tests {
         abis.insert("Contract".to_string(), parsed_abi);
         let contracts = HashMap::new();
 
-        let encoded = input.encoded_input(&abis, &contracts).unwrap();
+        let encoded = input
+            .encoded_input(&abis, &contracts, &DummyEthereumNode)
+            .unwrap();
         assert!(encoded.0.starts_with(&selector));
 
         type T = (alloy_primitives::Address,);
@@ -451,4 +423,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()
+            )
+        )
+    }
 }

crates/node-interaction/Cargo.toml

@@ -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 }

crates/node-interaction/src/blocking_executor.rs

@@ -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)
+    }
+}

crates/node-interaction/src/lib.rs

@@ -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 tokio_runtime;
-pub mod trace;
-pub mod transaction;
+mod blocking_executor;
+pub use blocking_executor::*;
 
 /// An interface for all interactions with Ethereum compatible nodes.
 pub trait EthereumNode {
     /// Execute the [TransactionRequest] and return a [TransactionReceipt].
-    fn execute_transaction(
-        &self,
-        transaction: TransactionRequest,
-    ) -> anyhow::Result<TransactionReceipt>;
+    fn execute_transaction(&self, transaction: TransactionRequest) -> 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>;
 }

crates/node-interaction/src/nonce.rs

@@ -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}"))
-}

crates/node-interaction/src/tokio_runtime.rs

@@ -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(())
-}

crates/node-interaction/src/trace.rs

@@ -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}"))
-}

crates/node-interaction/src/transaction.rs

@@ -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}"))
-}

crates/node/Cargo.toml

@@ -25,3 +25,4 @@ sp-runtime = { workspace = true }
 
 [dev-dependencies]
 temp-dir = { workspace = true }
+tokio = { workspace = true }

crates/node/src/geth.rs

@@ -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,
-    primitives::Address,
-    providers::{Provider, ProviderBuilder, ext::DebugApi},
+    eips::BlockNumberOrTag,
+    network::{Ethereum, EthereumWallet},
+    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::{
-    EthereumNode, nonce::fetch_onchain_nonce, trace::trace_transaction,
-    transaction::execute_transaction,
-};
+use revive_dt_node_interaction::{BlockingExecutor, EthereumNode};
+use tracing::Level;
 
 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,64 +139,95 @@ impl Instance {
             .arg("--nodiscover")
             .arg("--maxpeers")
             .arg("0")
-            .stderr(Stdio::piped())
-            .stdout(Stdio::null())
+            .stderr(stderr_logs_file.try_clone()?)
+            .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 maximum_wait_time = Duration::from_millis(self.start_timeout);
-        let mut stderr = BufReader::new(child.stderr.take().expect("should be piped")).lines();
-        let error = loop {
-            let Some(Ok(line)) = stderr.next() else {
-                break "child process stderr reading error".to_string();
-            };
-            if line.contains(Self::ERROR_MARKER) {
-                break 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);
+        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(logs_file).lines();
+        loop {
+            if let Some(Ok(line)) = stderr.next() {
+                if line.contains(Self::ERROR_MARKER) {
+                    anyhow::bail!("Failed to start geth {line}");
+                }
+                if line.contains(Self::READY_MARKER) {
+                    return Ok(self);
+                }
             }
             if Instant::now().duration_since(start_time) > maximum_wait_time {
-                break "spawn timeout".to_string();
+                anyhow::bail!("Timeout in starting geth");
             }
-        };
+        }
+    }
 
-        let _ = child.kill();
-        anyhow::bail!("geth node #{} spawn error: {error}", self.id)
+    #[tracing::instrument(skip_all, fields(geth_node_id = self.id), level = Level::TRACE)]
+    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 wallet = self.wallet.clone();
-
-        execute_transaction(Box::pin(async move {
+        let provider = self.provider();
+        BlockingExecutor::execute(async move {
             let outer_span = tracing::debug_span!("Submitting transaction", ?transaction,);
             let _outer_guard = outer_span.enter();
 
-            let provider = ProviderBuilder::new()
-                .wallet(wallet)
-                .connect(&connection_string)
-                .await?;
+            let provider = provider.await?;
 
             let pending_transaction = provider.send_transaction(transaction).await?;
             let transaction_hash = pending_transaction.tx_hash();
@@ -238,31 +299,30 @@ impl EthereumNode for Instance {
                     }
                 }
             }
-        }))
+        })?
     }
 
+    #[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 {
-            Ok(ProviderBuilder::new()
-                .wallet(wallet)
-                .connect(&connection_string)
+        BlockingExecutor::execute(async move {
+            Ok(provider
                 .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,
@@ -276,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 wallet = self.wallet.clone();
-
-        let onchain_nonce = fetch_onchain_nonce(connection_string, wallet, address)?;
+        let provider = self.provider();
+        let onchain_nonce = BlockingExecutor::execute::<anyhow::Result<_>>(async move {
+            provider
+                .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);
@@ -288,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 {
@@ -299,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,
@@ -307,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")
@@ -337,14 +508,9 @@ impl Node for Instance {
 }
 
 impl Drop for Instance {
+    #[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
     fn drop(&mut self) {
-        tracing::info!(id = self.id, "Dropping node");
-        if let Some(child) = self.handle.as_mut() {
-            let _ = child.kill();
-        }
-        if self.base_directory.exists() {
-            let _ = remove_dir_all(&self.base_directory);
-        }
+        self.shutdown().expect("Failed to shutdown")
     }
 }
 
@@ -355,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();
@@ -365,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)
@@ -387,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)
+    }
 }

crates/node/src/kitchensink.rs

@@ -1,8 +1,8 @@
 use std::{
     collections::HashMap,
-    fs::create_dir_all,
-    io::BufRead,
-    path::PathBuf,
+    fs::{File, OpenOptions, create_dir_all, remove_dir_all},
+    io::{BufRead, Write},
+    path::{Path, PathBuf},
     process::{Child, Command, Stdio},
     sync::{
         Mutex,
@@ -13,13 +13,18 @@ use std::{
 
 use alloy::{
     consensus::{BlockHeader, TxEnvelope},
+    eips::BlockNumberOrTag,
     hex,
     network::{
         Ethereum, EthereumWallet, Network, TransactionBuilder, TransactionBuilderError,
         UnbuiltTransactionError,
     },
-    primitives::{Address, B64, B256, BlockNumber, Bloom, Bytes, U256},
-    providers::{Provider, ProviderBuilder, ext::DebugApi},
+    primitives::{Address, B64, B256, BlockHash, BlockNumber, BlockTimestamp, Bloom, Bytes, U256},
+    providers::{
+        Provider, ProviderBuilder,
+        ext::DebugApi,
+        fillers::{FillProvider, TxFiller},
+    },
     rpc::types::{
         TransactionReceipt,
         eth::{Block, Header, Transaction},
@@ -30,12 +35,10 @@ use serde::{Deserialize, Serialize};
 use serde_json::{Value as JsonValue, json};
 use sp_core::crypto::Ss58Codec;
 use sp_runtime::AccountId32;
+use tracing::Level;
 
 use revive_dt_config::Arguments;
-use revive_dt_node_interaction::{
-    EthereumNode, nonce::fetch_onchain_nonce, trace::trace_transaction,
-    transaction::execute_transaction,
-};
+use revive_dt_node_interaction::{BlockingExecutor, EthereumNode};
 
 use crate::Node;
 
@@ -49,13 +52,22 @@ pub struct KitchensinkNode {
     rpc_url: String,
     wallet: EthereumWallet,
     base_directory: PathBuf,
+    logs_directory: PathBuf,
     process_substrate: Option<Child>,
     process_proxy: Option<Child>,
     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 KitchensinkNode {
     const BASE_DIRECTORY: &str = "kitchensink";
+    const LOGS_DIRECTORY: &str = "logs";
+    const DATA_DIRECTORY: &str = "chains";
+
     const SUBSTRATE_READY_MARKER: &str = "Running JSON-RPC server";
     const ETH_PROXY_READY_MARKER: &str = "Running JSON-RPC server";
     const CHAIN_SPEC_JSON_FILE: &str = "template_chainspec.json";
@@ -65,11 +77,21 @@ impl KitchensinkNode {
     const SUBSTRATE_LOG_ENV: &str = "error,evm=debug,sc_rpc_server=info,runtime::revive=debug";
     const PROXY_LOG_ENV: &str = "info,eth-rpc=debug";
 
+    const KITCHENSINK_STDOUT_LOG_FILE_NAME: &str = "node_stdout.log";
+    const KITCHENSINK_STDERR_LOG_FILE_NAME: &str = "node_stderr.log";
+
+    const PROXY_STDOUT_LOG_FILE_NAME: &str = "proxy_stdout.log";
+    const PROXY_STDERR_LOG_FILE_NAME: &str = "proxy_stderr.log";
+
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
     fn init(&mut self, genesis: &str) -> anyhow::Result<&mut Self> {
         create_dir_all(&self.base_directory)?;
+        create_dir_all(&self.logs_directory)?;
 
         let template_chainspec_path = self.base_directory.join(Self::CHAIN_SPEC_JSON_FILE);
 
+        // Note: we do not pipe the logs of this process to a separate file since this is just a
+        // once-off export of the default chain spec and not part of the long-running node process.
         let output = Command::new(&self.substrate_binary)
             .arg("export-chain-spec")
             .arg("--chain")
@@ -118,6 +140,7 @@ impl KitchensinkNode {
         Ok(self)
     }
 
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
     fn spawn_process(&mut self) -> anyhow::Result<()> {
         let substrate_rpc_port = Self::BASE_SUBSTRATE_RPC_PORT + self.id as u16;
         let proxy_rpc_port = Self::BASE_PROXY_RPC_PORT + self.id as u16;
@@ -126,8 +149,26 @@ impl KitchensinkNode {
 
         let chainspec_path = self.base_directory.join(Self::CHAIN_SPEC_JSON_FILE);
 
+        // 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
+        };
+
         // Start Substrate node
-        let mut substrate_process = Command::new(&self.substrate_binary)
+        let kitchensink_stdout_logs_file = open_options
+            .clone()
+            .open(self.kitchensink_stdout_log_file_path())?;
+        let kitchensink_stderr_logs_file = open_options
+            .clone()
+            .open(self.kitchensink_stderr_log_file_path())?;
+        self.process_substrate = Command::new(&self.substrate_binary)
+            .arg("--dev")
             .arg("--chain")
             .arg(chainspec_path)
             .arg("--base-path")
@@ -142,40 +183,62 @@ impl KitchensinkNode {
             .arg("--rpc-cors")
             .arg("all")
             .env("RUST_LOG", Self::SUBSTRATE_LOG_ENV)
-            .stdout(Stdio::null())
-            .stderr(Stdio::piped())
-            .spawn()?;
+            .stdout(kitchensink_stdout_logs_file.try_clone()?)
+            .stderr(kitchensink_stderr_logs_file.try_clone()?)
+            .spawn()?
+            .into();
 
         // Give the node a moment to boot
-        Self::wait_ready(
-            &mut substrate_process,
+        if let Err(error) = Self::wait_ready(
+            self.kitchensink_stderr_log_file_path().as_path(),
             Self::SUBSTRATE_READY_MARKER,
             Duration::from_secs(30),
-        )?;
+        ) {
+            tracing::error!(
+                ?error,
+                "Failed to start substrate, shutting down gracefully"
+            );
+            self.shutdown()?;
+            return Err(error);
+        };
 
-        let mut proxy_process = Command::new(&self.eth_proxy_binary)
+        let eth_proxy_stdout_logs_file = open_options
+            .clone()
+            .open(self.proxy_stdout_log_file_path())?;
+        let eth_proxy_stderr_logs_file = open_options.open(self.proxy_stderr_log_file_path())?;
+        self.process_proxy = Command::new(&self.eth_proxy_binary)
             .arg("--dev")
             .arg("--rpc-port")
             .arg(proxy_rpc_port.to_string())
             .arg("--node-rpc-url")
             .arg(format!("ws://127.0.0.1:{substrate_rpc_port}"))
             .env("RUST_LOG", Self::PROXY_LOG_ENV)
-            .stdout(Stdio::null())
-            .stderr(Stdio::piped())
-            .spawn()?;
+            .stdout(eth_proxy_stdout_logs_file.try_clone()?)
+            .stderr(eth_proxy_stderr_logs_file.try_clone()?)
+            .spawn()?
+            .into();
 
-        Self::wait_ready(
-            &mut proxy_process,
+        if let Err(error) = Self::wait_ready(
+            self.proxy_stderr_log_file_path().as_path(),
             Self::ETH_PROXY_READY_MARKER,
             Duration::from_secs(30),
-        )?;
+        ) {
+            tracing::error!(?error, "Failed to start proxy, shutting down gracefully");
+            self.shutdown()?;
+            return Err(error);
+        };
 
-        self.process_substrate = Some(substrate_process);
-        self.process_proxy = Some(proxy_process);
+        self.logs_file_to_flush.extend([
+            kitchensink_stdout_logs_file,
+            kitchensink_stderr_logs_file,
+            eth_proxy_stdout_logs_file,
+            eth_proxy_stderr_logs_file,
+        ]);
 
         Ok(())
     }
 
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
     fn extract_balance_from_genesis_file(
         &self,
         genesis_str: &str,
@@ -216,27 +279,30 @@ impl KitchensinkNode {
         Ok(account_id.to_ss58check())
     }
 
-    fn wait_ready(child: &mut Child, marker: &str, timeout: Duration) -> anyhow::Result<()> {
+    fn wait_ready(logs_file_path: &Path, marker: &str, timeout: Duration) -> anyhow::Result<()> {
         let start_time = std::time::Instant::now();
-        let stderr = child.stderr.take().expect("stderr must be piped");
+        let logs_file = OpenOptions::new()
+            .read(true)
+            .write(false)
+            .append(false)
+            .truncate(false)
+            .open(logs_file_path)?;
 
-        let mut lines = std::io::BufReader::new(stderr).lines();
+        let mut lines = std::io::BufReader::new(logs_file).lines();
         loop {
             if let Some(Ok(line)) = lines.next() {
-                println!("Kitchensink log: {line:?}");
                 if line.contains(marker) {
-                    std::thread::spawn(move || for _ in lines.by_ref() {});
                     return Ok(());
                 }
             }
 
             if start_time.elapsed() > timeout {
-                let _ = child.kill();
                 anyhow::bail!("Timeout waiting for process readiness: {marker}");
             }
         }
     }
 
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
     pub fn eth_rpc_version(&self) -> anyhow::Result<String> {
         let output = Command::new(&self.eth_proxy_binary)
             .arg("--version")
@@ -248,58 +314,94 @@ impl KitchensinkNode {
             .stdout;
         Ok(String::from_utf8_lossy(&output).trim().to_string())
     }
+
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id), level = Level::TRACE)]
+    fn kitchensink_stdout_log_file_path(&self) -> PathBuf {
+        self.logs_directory
+            .join(Self::KITCHENSINK_STDOUT_LOG_FILE_NAME)
+    }
+
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id), level = Level::TRACE)]
+    fn kitchensink_stderr_log_file_path(&self) -> PathBuf {
+        self.logs_directory
+            .join(Self::KITCHENSINK_STDERR_LOG_FILE_NAME)
+    }
+
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id), level = Level::TRACE)]
+    fn proxy_stdout_log_file_path(&self) -> PathBuf {
+        self.logs_directory.join(Self::PROXY_STDOUT_LOG_FILE_NAME)
+    }
+
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id), level = Level::TRACE)]
+    fn proxy_stderr_log_file_path(&self) -> PathBuf {
+        self.logs_directory.join(Self::PROXY_STDERR_LOG_FILE_NAME)
+    }
+
+    fn provider(
+        &self,
+    ) -> impl Future<
+        Output = anyhow::Result<
+            FillProvider<
+                impl TxFiller<KitchenSinkNetwork>,
+                impl Provider<KitchenSinkNetwork>,
+                KitchenSinkNetwork,
+            >,
+        >,
+    > + 'static {
+        let connection_string = self.connection_string();
+        let wallet = self.wallet.clone();
+        Box::pin(async move {
+            ProviderBuilder::new()
+                .network::<KitchenSinkNetwork>()
+                .wallet(wallet)
+                .connect(&connection_string)
+                .await
+                .map_err(Into::into)
+        })
+    }
 }
 
 impl EthereumNode for KitchensinkNode {
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
     fn execute_transaction(
         &self,
         transaction: alloy::rpc::types::TransactionRequest,
     ) -> anyhow::Result<TransactionReceipt> {
-        let url = self.rpc_url.clone();
-        let wallet = self.wallet.clone();
-
-        tracing::debug!("Submitting transaction: {transaction:#?}");
-
-        tracing::info!("Submitting tx to kitchensink");
-        let receipt = execute_transaction(Box::pin(async move {
-            Ok(ProviderBuilder::new()
-                .network::<KitchenSinkNetwork>()
-                .wallet(wallet)
-                .connect(&url)
+        tracing::debug!(?transaction, "Submitting transaction");
+        let provider = self.provider();
+        let receipt = BlockingExecutor::execute(async move {
+            Ok(provider
                 .await?
                 .send_transaction(transaction)
                 .await?
                 .get_receipt()
                 .await?)
-        }));
+        })?;
         tracing::info!(?receipt, "Submitted tx to kitchensink");
         receipt
     }
 
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
     fn trace_transaction(
         &self,
         transaction: TransactionReceipt,
     ) -> anyhow::Result<alloy::rpc::types::trace::geth::GethTrace> {
-        let url = self.rpc_url.clone();
         let trace_options = GethDebugTracingOptions::prestate_tracer(PreStateConfig {
             diff_mode: Some(true),
             disable_code: None,
             disable_storage: None,
         });
+        let provider = self.provider();
 
-        let wallet = self.wallet.clone();
-
-        trace_transaction(Box::pin(async move {
-            Ok(ProviderBuilder::new()
-                .network::<KitchenSinkNetwork>()
-                .wallet(wallet)
-                .connect(&url)
+        BlockingExecutor::execute(async move {
+            Ok(provider
                 .await?
                 .debug_trace_transaction(transaction.transaction_hash, trace_options)
                 .await?)
-        }))
+        })?
     }
 
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
     fn state_diff(&self, transaction: TransactionReceipt) -> anyhow::Result<DiffMode> {
         match self
             .trace_transaction(transaction)?
@@ -310,11 +412,16 @@ impl EthereumNode for KitchensinkNode {
         }
     }
 
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
     fn fetch_add_nonce(&self, address: Address) -> anyhow::Result<u64> {
-        let url = self.rpc_url.clone();
-        let wallet = self.wallet.clone();
-
-        let onchain_nonce = fetch_onchain_nonce(url, wallet, address)?;
+        let provider = self.provider();
+        let onchain_nonce = BlockingExecutor::execute::<anyhow::Result<_>>(async move {
+            provider
+                .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);
@@ -322,6 +429,87 @@ impl EthereumNode for KitchensinkNode {
         *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)
+        })?
+    }
+
+    #[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 KitchensinkNode {
@@ -329,6 +517,7 @@ impl Node for KitchensinkNode {
         let kitchensink_directory = config.directory().join(Self::BASE_DIRECTORY);
         let id = NODE_COUNT.fetch_add(1, Ordering::SeqCst);
         let base_directory = kitchensink_directory.join(id.to_string());
+        let logs_directory = base_directory.join(Self::LOGS_DIRECTORY);
 
         Self {
             id,
@@ -337,30 +526,54 @@ impl Node for KitchensinkNode {
             rpc_url: String::new(),
             wallet: config.wallet(),
             base_directory,
+            logs_directory,
             process_substrate: None,
             process_proxy: None,
             nonces: Mutex::new(HashMap::new()),
+            // We know that we only need to be storing 4 files so we can specify that when creating
+            // the vector. It's the stdout and stderr of the substrate-node and the eth-rpc.
+            logs_file_to_flush: Vec::with_capacity(4),
         }
     }
 
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
     fn connection_string(&self) -> String {
         self.rpc_url.clone()
     }
 
-    fn shutdown(mut self) -> anyhow::Result<()> {
+    #[tracing::instrument(skip_all, fields(kitchensink_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.process_proxy.take() {
-            let _ = child.kill();
+            child
+                .kill()
+                .map_err(|error| anyhow::anyhow!("Failed to kill the proxy process: {error:?}"))?;
         }
         if let Some(mut child) = self.process_substrate.take() {
-            let _ = child.kill();
+            child.kill().map_err(|error| {
+                anyhow::anyhow!("Failed to kill the substrate 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(kitchensink_node_id = self.id))]
     fn spawn(&mut self, genesis: String) -> anyhow::Result<()> {
         self.init(&genesis)?.spawn_process()
     }
 
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
     fn version(&self) -> anyhow::Result<String> {
         let output = Command::new(&self.substrate_binary)
             .arg("--version")
@@ -375,13 +588,9 @@ impl Node for KitchensinkNode {
 }
 
 impl Drop for KitchensinkNode {
+    #[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
     fn drop(&mut self) {
-        if let Some(mut child) = self.process_proxy.take() {
-            let _ = child.kill();
-        }
-        if let Some(mut child) = self.process_substrate.take() {
-            let _ = child.kill();
-        }
+        self.shutdown().expect("Failed to shutdown")
     }
 }
 
@@ -808,13 +1017,15 @@ impl BlockHeader for KitchenSinkHeader {
 
 #[cfg(test)]
 mod tests {
+    use alloy::rpc::types::TransactionRequest;
     use revive_dt_config::Arguments;
     use std::path::PathBuf;
+    use std::sync::LazyLock;
     use temp_dir::TempDir;
 
     use std::fs;
 
-    use super::KitchensinkNode;
+    use super::*;
     use crate::{GENESIS_JSON, Node};
 
     fn test_config() -> (Arguments, TempDir) {
@@ -829,6 +1040,66 @@ mod tests {
         (config, temp_dir)
     }
 
+    fn new_node() -> (KitchensinkNode, Arguments, TempDir) {
+        // Note: When we run the tests in the CI we found that if they're all
+        // run in parallel then the CI is unable to start all of the nodes in
+        // time and their start up times-out. Therefore, we want all of the
+        // nodes to be started in series and not in parallel. To do this, we use
+        // a dummy mutex here such that there can only be a single node being
+        // started up at any point of time. This will make our tests run slower
+        // but it will allow the node startup to not timeout.
+        //
+        // Note: an alternative to starting all of the nodes in series and not
+        // in parallel would be for us to reuse the same node between tests
+        // which is not the best thing to do in my opinion as it removes all
+        // of the isolation between tests and makes them depend on what other
+        // tests do. For example, if one test checks what the block number is
+        // and another test submits a transaction then the tx test would have
+        // side effects that affect the block number test.
+        static NODE_START_MUTEX: Mutex<()> = Mutex::new(());
+        let _guard = NODE_START_MUTEX.lock().unwrap();
+
+        let (args, temp_dir) = test_config();
+        let mut node = KitchensinkNode::new(&args);
+        node.init(GENESIS_JSON)
+            .expect("Failed to initialize the node")
+            .spawn_process()
+            .expect("Failed to spawn the node process");
+        (node, args, temp_dir)
+    }
+
+    /// A shared node that multiple tests can use. It starts up once.
+    fn shared_node() -> &'static KitchensinkNode {
+        static NODE: LazyLock<(KitchensinkNode, TempDir)> = LazyLock::new(|| {
+            let (node, _, temp_dir) = new_node();
+            (node, temp_dir)
+        });
+        &NODE.0
+    }
+
+    #[tokio::test]
+    async fn node_mines_simple_transfer_transaction_and_returns_receipt() {
+        // Arrange
+        let (node, args, _temp_dir) = new_node();
+
+        let provider = node.provider().await.expect("Failed to create provider");
+
+        let account_address = args.wallet().default_signer().address();
+        let transaction = TransactionRequest::default()
+            .to(account_address)
+            .value(U256::from(100_000_000_000_000u128));
+
+        // Act
+        let receipt = provider.send_transaction(transaction).await;
+
+        // Assert
+        let _ = receipt
+            .expect("Failed to send the transfer transaction")
+            .get_receipt()
+            .await
+            .expect("Failed to get the receipt for the transfer");
+    }
+
     #[test]
     fn test_init_generates_chainspec_with_balances() {
         let genesis_content = r#"
@@ -990,4 +1261,92 @@ mod tests {
             "Expected eth-rpc version string, got: {version}"
         );
     }
+
+    #[test]
+    fn can_get_chain_id_from_node() {
+        // Arrange
+        let node = shared_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 = shared_node();
+
+        // Act
+        let gas_limit = node.block_gas_limit(BlockNumberOrTag::Latest);
+
+        // Assert
+        let _ = gas_limit.expect("Failed to get the gas limit");
+    }
+
+    #[test]
+    fn can_get_coinbase_from_node() {
+        // Arrange
+        let node = shared_node();
+
+        // Act
+        let coinbase = node.block_coinbase(BlockNumberOrTag::Latest);
+
+        // Assert
+        let coinbase = coinbase.expect("Failed to get the coinbase");
+        assert_eq!(coinbase, Address::ZERO)
+    }
+
+    #[test]
+    fn can_get_block_difficulty_from_node() {
+        // Arrange
+        let node = shared_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 = shared_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 = shared_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 = shared_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)
+    }
 }

crates/node/src/lib.rs

@@ -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;