Merge remote-tracking branch 'origin/main' into bugfix/finding-contract-abi

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::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},
@@ -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(),
@@ -135,21 +134,17 @@ where
             std::any::type_name::<T>()
         );
 
-        let tx = match input.legacy_transaction(
-            self.config.network_id,
-            nonce,
-            &self.deployed_contracts,
-            &self.deployed_abis,
-        ) {
-            Ok(tx) => {
-                tracing::debug!("Legacy transaction data: {tx:#?}");
-                tx
-            }
-            Err(err) => {
-                tracing::error!("Failed to construct legacy transaction: {err:?}");
-                return Err(err);
-            }
-        };
+        let tx =
+            match input.legacy_transaction(nonce, &self.deployed_contracts, &self.deployed_abis) {
+                Ok(tx) => {
+                    tracing::debug!("Legacy transaction data: {tx:#?}");
+                    tx
+                }
+                Err(err) => {
+                    tracing::error!("Failed to construct legacy transaction: {err:?}");
+                    return Err(err);
+                }
+            };
 
         tracing::trace!("Executing transaction for input: {input:?}");
 
@@ -184,12 +179,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 +199,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,
@@ -228,16 +229,14 @@ 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 = alloy::hex::decode(&code)?;
+                    let tx = TransactionRequest::default()
+                        .nonce(nonce)
+                        .from(input.caller)
+                        .with_deploy_code(code);
 
                     let receipt = match node.execute_transaction(tx) {
                         Ok(receipt) => receipt,
@@ -468,3 +467,77 @@ where
         Ok(())
     }
 }
+
+/// 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()
+    }
+}