feat: better cheatcodes tracing (foundry-rs#4950)

Author: DaniPopes

evm/src/coverage/analysis.rs

@@ -3,7 +3,6 @@ use ethers::solc::artifacts::ast::{self, Ast, Node, NodeType};
 use foundry_common::TestFunctionExt;
 use semver::Version;
 use std::collections::{HashMap, HashSet};
-use tracing::warn;
 
 /// A visitor that walks the AST of a single contract and finds coverage items.
 #[derive(Debug, Clone)]

evm/src/coverage/anchors.rs

@@ -31,15 +31,15 @@ pub fn find_anchors(
                             _ => panic!("Too many paths for branch"),
                         },
                         Err(e) => {
-                            tracing::warn!("Could not find anchor for item: {}, error: {e}", item);
+                            warn!("Could not find anchor for item: {}, error: {e}", item);
                             None
                         }
                     }
                 }
                 _ => match find_anchor_simple(source_map, ic_pc_map, *item_id, &item.loc) {
                     Ok(anchor) => Some(anchor),
                     Err(e) => {
-                        tracing::warn!("Could not find anchor for item: {}, error: {e}", item);
+                        warn!("Could not find anchor for item: {}, error: {e}", item);
                         None
                     }
                 },

evm/src/executor/backend/fuzz.rs

@@ -16,7 +16,6 @@ use revm::{
     Database, Inspector, JournaledState,
 };
 use std::borrow::Cow;
-use tracing::trace;
 
 /// A wrapper around `Backend` that ensures only `revm::DatabaseRef` functions are called.
 ///

evm/src/executor/backend/mod.rs

@@ -26,7 +26,6 @@ use revm::{
     Database, DatabaseCommit, Inspector, JournaledState, EVM,
 };
 use std::collections::{HashMap, HashSet};
-use tracing::{trace, warn};
 
 mod fuzz;
 pub mod snapshot;

evm/src/executor/fork/backend.rs

@@ -30,7 +30,6 @@ use std::{
         Arc,
     },
 };
-use tracing::{error, trace, warn};
 
 // Various future/request type aliases
 

evm/src/executor/fork/cache.rs

@@ -7,7 +7,7 @@ use revm::{
 };
 use serde::{ser::SerializeMap, Deserialize, Deserializer, Serialize, Serializer};
 use std::{collections::BTreeSet, fs, io::BufWriter, path::PathBuf, sync::Arc};
-use tracing::{trace, warn};
+
 use url::Url;
 
 pub type StorageInfo = Map<U256, U256>;

evm/src/executor/fork/database.rs

@@ -17,7 +17,6 @@ use revm::{
     Database, DatabaseCommit,
 };
 use std::sync::Arc;
-use tracing::{trace, warn};
 
 /// a [revm::Database] that's forked off another client
 ///

evm/src/executor/fork/multi.rs

@@ -31,7 +31,6 @@ use std::{
     },
     time::Duration,
 };
-use tracing::trace;
 
 /// The identifier for a specific fork, this could be the name of the network a custom descriptive
 /// name.

evm/src/executor/inspector/cheatcodes/config.rs

@@ -1,4 +1,4 @@
-use super::{ensure, err, Result};
+use super::{ensure, fmt_err, Result};
 use crate::executor::opts::EvmOpts;
 use ethers::solc::{utils::canonicalize, ProjectPathsConfig};
 use foundry_common::fs::normalize_path;
@@ -7,7 +7,6 @@ use foundry_config::{
     ResolvedRpcEndpoints,
 };
 use std::path::{Path, PathBuf};
-use tracing::trace;
 
 /// Additional, configurable context the `Cheatcodes` inspector has access to
 ///
@@ -135,7 +134,7 @@ impl CheatsConfig {
             }
             None => {
                 if !url_or_alias.starts_with("http") && !url_or_alias.starts_with("ws") {
-                    Err(err!("invalid rpc url {url_or_alias}"))
+                    Err(fmt_err!("invalid rpc url {url_or_alias}"))
                 } else {
                     Ok(url_or_alias)
                 }

evm/src/executor/inspector/cheatcodes/env.rs

@@ -1,4 +1,4 @@
-use super::{ensure, err, Cheatcodes, Result};
+use super::{ensure, fmt_err, Cheatcodes, Result};
 use crate::{
     abi::HEVMCalls,
     executor::{
@@ -21,7 +21,6 @@ use revm::{
     Database, EVMData,
 };
 use std::collections::BTreeMap;
-use tracing::trace;
 
 #[derive(Clone, Debug, Default)]
 pub struct Broadcast {
@@ -217,7 +216,8 @@ fn add_breakpoint(state: &mut Cheatcodes, caller: Address, inner: &str, add: boo
     let mut chars = inner.chars();
     let point = chars.next();
 
-    let point = point.ok_or_else(|| err!("Please provide at least one char for the breakpoint"))?;
+    let point =
+        point.ok_or_else(|| fmt_err!("Please provide at least one char for the breakpoint"))?;
 
     ensure!(chars.next().is_none(), "Provide only one character for the breakpoint");
     ensure!(point.is_alphabetic(), "Only alphabetic characters are accepted as breakpoints");
@@ -232,6 +232,7 @@ fn add_breakpoint(state: &mut Cheatcodes, caller: Address, inner: &str, add: boo
     Ok(Bytes::new())
 }
 
+#[instrument(level = "error", name = "env", target = "evm::cheatcodes", skip_all)]
 pub fn apply<DB: DatabaseExt>(
     state: &mut Cheatcodes,
     data: &mut EVMData<'_, DB>,