foundry_cheatcodes/

fs.rs

//! Implementations of [`Filesystem`](spec::Group::Filesystem) cheatcodes.

use super::string::parse;
use crate::{
    Cheatcode, CheatcodesCore, CheatcodesExecutor, CheatsCtxt, Result, Vm::*,
    inspector::exec_create,
};
use alloy_dyn_abi::DynSolType;
use alloy_json_abi::ContractObject;
use alloy_network::{AnyNetwork, Network, ReceiptResponse};
use alloy_primitives::{Bytes, FixedBytes, U256, hex, map::Entry};
use alloy_sol_types::SolValue;
use dialoguer::{Input, Password};
use forge_script_sequence::{BroadcastReader, TransactionWithMetadata};
use foundry_common::{contracts::ContractData, fs};
use foundry_config::fs_permissions::FsAccessKind;
use foundry_evm_core::{FoundryTransaction, env::FoundryContextExt, evm::FoundryEvmNetwork};
use foundry_evm_traces::CallKind;
use revm::{
    context::{Cfg, ContextTr, CreateScheme, JournalTr},
    handler::handle_reservoir_remaining_gas,
    interpreter::CreateInputs,
    primitives::hardfork::SpecId,
};
use semver::Version;
use std::{
    io::{BufRead, BufReader},
    path::{Path, PathBuf},
    process::Command,
    sync::mpsc,
    thread,
    time::{SystemTime, UNIX_EPOCH},
};
use walkdir::WalkDir;

/// Parsed artifact path components.
#[derive(Debug, Default, PartialEq, Eq)]
struct ParsedArtifactPath<'a> {
    file: Option<PathBuf>,
    contract_name: Option<&'a str>,
    version: Option<Version>,
    profile: Option<&'a str>,
}

/// Parses an artifact path string into its components.
///
/// Supports the following formats:
/// - `path/to/contract.sol`
/// - `path/to/contract.sol:ContractName`
/// - `path/to/contract.sol:ContractName:0.8.23`
/// - `path/to/contract.sol:ContractName:profile`
/// - `path/to/contract.sol:0.8.23`
/// - `path/to/contract.sol:profile`
/// - `ContractName`
/// - `ContractName:0.8.23`
/// - `ContractName:profile`
fn parse_artifact_path(path: &str) -> std::result::Result<ParsedArtifactPath<'_>, String> {
    // A Windows drive separator belongs to the file, not the artifact's suffix fields.
    // Recognize it on every host so parsing does not depend on the current platform.
    let unprefixed = path.strip_prefix(r"\\?\").unwrap_or(path);
    let drive_prefix_len = match unprefixed.as_bytes() {
        [drive, b':', b'/' | b'\\', ..] if drive.is_ascii_alphabetic() => {
            path.len() - unprefixed.len() + 2
        }
        _ => 0,
    };
    let mut parts = path[drive_prefix_len..].split(':');

    let mut file = None;
    let mut contract_name = None;
    let mut version = None;
    let mut profile = None;

    let path_or_name = parts.next().unwrap();
    let path_or_name = &path[..drive_prefix_len + path_or_name.len()];
    if path_or_name.contains('.') {
        file = Some(PathBuf::from(path_or_name));
        if let Some(name_or_version_or_profile) = parts.next() {
            if name_or_version_or_profile.contains('.')
                || Version::parse(name_or_version_or_profile).is_ok()
            {
                version = Some(name_or_version_or_profile);
            } else {
                contract_name = Some(name_or_version_or_profile);
                if let Some(version_or_profile) = parts.next() {
                    if version_or_profile.contains('.')
                        || Version::parse(version_or_profile).is_ok()
                    {
                        version = Some(version_or_profile);
                    } else {
                        profile = Some(version_or_profile);
                    }
                }
            }
        }
    } else {
        contract_name = Some(path_or_name);
        if let Some(version_or_profile) = parts.next() {
            if version_or_profile.contains('.') || Version::parse(version_or_profile).is_ok() {
                version = Some(version_or_profile);
            } else {
                profile = Some(version_or_profile);
            }
        }
    }

    let version = if let Some(version) = version {
        Some(Version::parse(version).map_err(|e| format!("failed parsing version: {e}"))?)
    } else {
        None
    };

    Ok(ParsedArtifactPath { file, contract_name, version, profile })
}

impl Cheatcode for existsCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path } = self;
        let path = state.config.ensure_path_allowed(path, FsAccessKind::Read)?;
        Ok(path.exists().abi_encode())
    }
}

impl Cheatcode for fsMetadataCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path } = self;
        let path = state.config.ensure_path_allowed(path, FsAccessKind::Read)?;

        let metadata = path.metadata()?;

        // These fields not available on all platforms; default to 0
        let [modified, accessed, created] =
            [metadata.modified(), metadata.accessed(), metadata.created()].map(|time| {
                time.unwrap_or(UNIX_EPOCH).duration_since(UNIX_EPOCH).unwrap_or_default().as_secs()
            });

        Ok(FsMetadata {
            isDir: metadata.is_dir(),
            isSymlink: metadata.is_symlink(),
            length: U256::from(metadata.len()),
            readOnly: metadata.permissions().readonly(),
            modified: U256::from(modified),
            accessed: U256::from(accessed),
            created: U256::from(created),
        }
        .abi_encode())
    }
}

impl Cheatcode for isDirCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path } = self;
        let path = state.config.ensure_path_allowed(path, FsAccessKind::Read)?;
        Ok(path.is_dir().abi_encode())
    }
}

impl Cheatcode for isFileCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path } = self;
        let path = state.config.ensure_path_allowed(path, FsAccessKind::Read)?;
        Ok(path.is_file().abi_encode())
    }
}

impl Cheatcode for projectRootCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self {} = self;
        Ok(state.config.root.display().to_string().abi_encode())
    }
}

impl Cheatcode for currentFilePathCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self {} = self;
        let artifact = state
            .config
            .running_artifact
            .as_ref()
            .ok_or_else(|| fmt_err!("no running contract found"))?;
        let relative = artifact.source.strip_prefix(&state.config.root).unwrap_or(&artifact.source);
        Ok(relative.display().to_string().abi_encode())
    }
}

impl Cheatcode for unixTimeCall {
    fn apply_context_free(&self) -> Result {
        let Self {} = self;
        let difference = SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .map_err(|e| fmt_err!("failed getting Unix timestamp: {e}"))?;
        Ok(difference.as_millis().abi_encode())
    }
}

impl Cheatcode for closeFileCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path } = self;
        let path = state.config.ensure_path_allowed(path, FsAccessKind::Read)?;

        state.test_context.opened_read_files.remove(&path);

        Ok(Default::default())
    }
}

impl Cheatcode for copyFileCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { from, to } = self;
        let from = state.config.ensure_path_allowed(from, FsAccessKind::Read)?;
        let to = state.config.ensure_path_allowed(to, FsAccessKind::Write)?;
        state.config.ensure_not_foundry_toml(&to)?;

        let n = fs::copy(from, to)?;
        Ok(n.abi_encode())
    }
}

impl Cheatcode for createDirCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path, recursive } = self;
        let path = state.config.ensure_path_allowed(path, FsAccessKind::Write)?;
        if *recursive { fs::create_dir_all(path) } else { fs::create_dir(path) }?;
        Ok(Default::default())
    }
}

impl Cheatcode for readDir_0Call {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path } = self;
        read_dir(state, path.as_ref(), 1, false)
    }
}

impl Cheatcode for readDir_1Call {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path, maxDepth } = self;
        read_dir(state, path.as_ref(), *maxDepth, false)
    }
}

impl Cheatcode for readDir_2Call {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path, maxDepth, followLinks } = self;
        read_dir(state, path.as_ref(), *maxDepth, *followLinks)
    }
}

impl Cheatcode for readFileCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path } = self;
        let path = state.config.ensure_path_allowed(path, FsAccessKind::Read)?;
        Ok(fs::locked_read_to_string(path)?.abi_encode())
    }
}

impl Cheatcode for readFileBinaryCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path } = self;
        let path = state.config.ensure_path_allowed(path, FsAccessKind::Read)?;
        Ok(fs::locked_read(path)?.abi_encode())
    }
}

impl Cheatcode for readLineCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path } = self;
        let path = state.config.ensure_path_allowed(path, FsAccessKind::Read)?;

        // Get reader for previously opened file to continue reading OR initialize new reader
        let reader = match state.test_context.opened_read_files.entry(path.clone()) {
            Entry::Occupied(entry) => entry.into_mut(),
            Entry::Vacant(entry) => entry.insert(BufReader::new(fs::open(path)?)),
        };

        let mut line: String = String::new();
        reader.read_line(&mut line)?;

        // Remove trailing newline character, preserving others for cases where it may be important
        if line.ends_with('\n') {
            line.pop();
            if line.ends_with('\r') {
                line.pop();
            }
        }

        Ok(line.abi_encode())
    }
}

impl Cheatcode for readLinkCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { linkPath: path } = self;
        // Validate the resolved target, but keep the link itself for read_link.
        state.config.ensure_path_allowed(path, FsAccessKind::Read)?;
        let target = fs::read_link(state.config.root.join(path))?;
        Ok(target.display().to_string().abi_encode())
    }
}

impl Cheatcode for removeDirCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path, recursive } = self;
        let path = state.config.ensure_path_allowed(path, FsAccessKind::Write)?;
        state.config.ensure_not_foundry_toml(&path)?;
        if *recursive { fs::remove_dir_all(path) } else { fs::remove_dir(path) }?;
        Ok(Default::default())
    }
}

impl Cheatcode for removeFileCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path } = self;
        let path = state.config.ensure_path_allowed(path, FsAccessKind::Write)?;
        state.config.ensure_not_foundry_toml(&path)?;

        // also remove from the set if opened previously
        state.test_context.opened_read_files.remove(&path);

        if state.fs_commit {
            fs::remove_file(&path)?;
        }

        Ok(Default::default())
    }
}

impl Cheatcode for writeFileCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path, data } = self;
        write_file(state, path.as_ref(), data.as_bytes())
    }
}

impl Cheatcode for writeFileBinaryCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path, data } = self;
        write_file(state, path.as_ref(), data)
    }
}

impl Cheatcode for writeLineCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { path, data: line } = self;
        let path = state.config.ensure_path_allowed(path, FsAccessKind::Write)?;
        state.config.ensure_not_foundry_toml(&path)?;

        if state.fs_commit {
            fs::locked_write_line(path, line)?;
        }

        Ok(Default::default())
    }
}

impl Cheatcode for getArtifactPathByCodeCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { code } = self;
        let (artifact_id, _) = state
            .config
            .available_artifacts
            .as_ref()
            .and_then(|artifacts| artifacts.find_by_creation_code(code))
            .ok_or_else(|| fmt_err!("no matching artifact found"))?;

        Ok(artifact_id.path.to_string_lossy().abi_encode())
    }
}

impl Cheatcode for getArtifactPathByDeployedCodeCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { deployedCode } = self;
        let (artifact_id, _) = state
            .config
            .available_artifacts
            .as_ref()
            .and_then(|artifacts| artifacts.find_by_deployed_code(deployedCode))
            .ok_or_else(|| fmt_err!("no matching artifact found"))?;

        Ok(artifact_id.path.to_string_lossy().abi_encode())
    }
}

impl Cheatcode for getCodeCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { artifactPath: path } = self;
        Ok(get_artifact_code(state, path, false)?.abi_encode())
    }
}

impl Cheatcode for getDeployedCodeCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { artifactPath: path } = self;
        Ok(get_artifact_code(state, path, true)?.abi_encode())
    }
}

impl Cheatcode for getSelectorsCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { artifactPath: path } = self;
        let selectors: Vec<FixedBytes<4>> = match get_artifact_source(state, path)? {
            ArtifactSource::InMemory(data) => data.abi.functions().map(|f| f.selector()).collect(),
            ArtifactSource::Disk(path) => {
                let data = read_artifact_file(state, &path)?;
                // Parse as raw JSON rather than `ContractObject` so we can still read selectors
                // from artifacts with unlinked bytecode (which `ContractObject` rejects).
                let json: serde_json::Value = serde_json::from_str(&data)?;
                let abi =
                    json.get("abi").ok_or_else(|| fmt_err!("no `abi` field in artifact JSON"))?;
                let abi: alloy_json_abi::JsonAbi =
                    serde_json::from_value(abi.clone()).map_err(|e| fmt_err!("{e}"))?;
                abi.functions().map(|f| f.selector()).collect()
            }
        };
        Ok(selectors.abi_encode())
    }
}

impl Cheatcode for deployCode_0Call {
    fn apply_full<FEN: FoundryEvmNetwork>(
        &self,
        ccx: &mut CheatsCtxt<'_, '_, FEN>,
        executor: &mut dyn CheatcodesExecutor<FEN>,
    ) -> Result {
        let Self { artifactPath: path } = self;
        deploy_code(ccx, executor, path, None, None, None)
    }
}

impl Cheatcode for deployCode_1Call {
    fn apply_full<FEN: FoundryEvmNetwork>(
        &self,
        ccx: &mut CheatsCtxt<'_, '_, FEN>,
        executor: &mut dyn CheatcodesExecutor<FEN>,
    ) -> Result {
        let Self { artifactPath: path, constructorArgs: args } = self;
        deploy_code(ccx, executor, path, Some(args), None, None)
    }
}

impl Cheatcode for deployCode_2Call {
    fn apply_full<FEN: FoundryEvmNetwork>(
        &self,
        ccx: &mut CheatsCtxt<'_, '_, FEN>,
        executor: &mut dyn CheatcodesExecutor<FEN>,
    ) -> Result {
        let Self { artifactPath: path, value } = self;
        deploy_code(ccx, executor, path, None, Some(*value), None)
    }
}

impl Cheatcode for deployCode_3Call {
    fn apply_full<FEN: FoundryEvmNetwork>(
        &self,
        ccx: &mut CheatsCtxt<'_, '_, FEN>,
        executor: &mut dyn CheatcodesExecutor<FEN>,
    ) -> Result {
        let Self { artifactPath: path, constructorArgs: args, value } = self;
        deploy_code(ccx, executor, path, Some(args), Some(*value), None)
    }
}

impl Cheatcode for deployCode_4Call {
    fn apply_full<FEN: FoundryEvmNetwork>(
        &self,
        ccx: &mut CheatsCtxt<'_, '_, FEN>,
        executor: &mut dyn CheatcodesExecutor<FEN>,
    ) -> Result {
        let Self { artifactPath: path, salt } = self;
        deploy_code(ccx, executor, path, None, None, Some((*salt).into()))
    }
}

impl Cheatcode for deployCode_5Call {
    fn apply_full<FEN: FoundryEvmNetwork>(
        &self,
        ccx: &mut CheatsCtxt<'_, '_, FEN>,
        executor: &mut dyn CheatcodesExecutor<FEN>,
    ) -> Result {
        let Self { artifactPath: path, constructorArgs: args, salt } = self;
        deploy_code(ccx, executor, path, Some(args), None, Some((*salt).into()))
    }
}

impl Cheatcode for deployCode_6Call {
    fn apply_full<FEN: FoundryEvmNetwork>(
        &self,
        ccx: &mut CheatsCtxt<'_, '_, FEN>,
        executor: &mut dyn CheatcodesExecutor<FEN>,
    ) -> Result {
        let Self { artifactPath: path, value, salt } = self;
        deploy_code(ccx, executor, path, None, Some(*value), Some((*salt).into()))
    }
}

impl Cheatcode for deployCode_7Call {
    fn apply_full<FEN: FoundryEvmNetwork>(
        &self,
        ccx: &mut CheatsCtxt<'_, '_, FEN>,
        executor: &mut dyn CheatcodesExecutor<FEN>,
    ) -> Result {
        let Self { artifactPath: path, constructorArgs: args, value, salt } = self;
        deploy_code(ccx, executor, path, Some(args), Some(*value), Some((*salt).into()))
    }
}

/// Helper function to deploy contract from artifact code.
/// Uses CREATE2 scheme if salt specified.
fn deploy_code<FEN: FoundryEvmNetwork>(
    ccx: &mut CheatsCtxt<'_, '_, FEN>,
    executor: &mut dyn CheatcodesExecutor<FEN>,
    path: &str,
    constructor_args: Option<&Bytes>,
    value: Option<U256>,
    salt: Option<U256>,
) -> Result {
    // Synthetic creation bypasses the CREATE opcode's static-context check.
    if ccx.is_static {
        return Err(crate::Error::from(Bytes::new()));
    }

    let mut bytecode = get_artifact_code(&ccx.state.core, path, false)?.to_vec();
    if let Some(args) = constructor_args {
        bytecode.extend_from_slice(args);
    }

    let depth = ccx.depth();

    // The nested EVM executes the synthetic create one level deeper, so resolve the prank at the
    // original depth just as the native create inspector would.
    let prank_changes =
        ccx.state.get_prank(depth).and_then(|prank| prank.changes_for(depth, ccx.caller));
    let caller = prank_changes.as_ref().and_then(|changes| changes.caller).unwrap_or(ccx.caller);

    let value = value.unwrap_or(U256::ZERO);
    let scheme =
        if let Some(salt) = salt { CreateScheme::Create2 { salt } } else { CreateScheme::Create };
    let mut inputs = CreateInputs::new(caller, scheme, value, bytecode.into(), 0, 0);
    let init_code_len = inputs.init_code().len();

    // Charge the caller as the CREATE and CREATE2 opcodes would, before changing any state.
    let spec = ccx.spec().into();
    let gas_params = ccx.ecx.cfg().gas_params();
    let mut cost = if salt.is_some() {
        gas_params.create2_cost(init_code_len)
    } else {
        gas_params.create_cost()
    };
    if spec.is_enabled_in(SpecId::SHANGHAI) {
        if init_code_len > ccx.max_initcode_size() {
            ccx.gas.spend_all();
            return Err(fmt_err!("initcode size limit exceeded"));
        }
        cost = cost.saturating_add(gas_params.initcode_cost(init_code_len));
    }
    let create_state_gas = gas_params.create_state_gas();
    if !ccx.gas.record_regular_cost(cost) {
        ccx.gas.spend_all();
        return Err(fmt_err!("out of gas"));
    }

    // EIP-8037: charge the account creation state gas if the creation can proceed and the
    // destination is empty.
    if ccx.ecx.cfg().is_amsterdam_eip8037_enabled() {
        let caller_info = &ccx.ecx.journal_mut().load_account(caller)?.data.info;
        if caller_info.balance >= value && caller_info.nonce != u64::MAX {
            let created_address = inputs.created_address(caller_info.nonce);
            if ccx.ecx.journal_mut().load_account(created_address)?.data.info.is_empty() {
                if !ccx.gas.record_state_cost(create_state_gas) {
                    ccx.gas.spend_all();
                    return Err(fmt_err!("out of gas"));
                }
                inputs.set_charged_create_state_gas(true);
            }
        }
    }

    // The call to the cheatcode already kept back 1/64 of the caller's gas, as the CREATE opcode
    // would, so forward all of the remaining gas to the create frame.
    let gas_limit = ccx.gas.remaining();
    // This cannot fail as it does not exceed `remaining`.
    let _ = ccx.gas.record_regular_cost(gas_limit);
    inputs.set_gas_limit(gas_limit);
    inputs.set_reservoir(ccx.gas.reservoir());

    // Broadcast the synthetic create only if it was requested by the broadcaster at the broadcast
    // depth, as for native creates.
    if let Some(broadcast) = &mut ccx.state.broadcast
        && depth == broadcast.depth
        && ccx.caller == broadcast.original_caller
    {
        broadcast.deploy_from_code = true;
    }

    if let Some(changes) = prank_changes {
        if let Some(new_origin) = changes.origin {
            ccx.ecx.tx_mut().set_caller(new_origin);
        }
        if let Some(used) = changes.used {
            ccx.state.pranks.insert(depth, used);
        }
    }

    // Restore the outer marker afterwards, as constructors can call `deployCode` too.
    let outer_deploy_code_depth = ccx.state.deploy_code_depth.replace(depth);
    let outcome = exec_create(executor, inputs, ccx);
    ccx.state.deploy_code_depth = outer_deploy_code_depth;

    // Clear the flag in case the synthetic create was not broadcast, and end a single-call
    // broadcast at the original depth as native create cleanup would.
    if let Some(broadcast) = &mut ccx.state.broadcast {
        broadcast.deploy_from_code = false;
        if broadcast.single_call && depth == broadcast.depth {
            ccx.ecx.tx_mut().set_caller(broadcast.original_origin);
            ccx.state.broadcast = None;
        }
    }

    // Restore the prank state at the original depth as native create cleanup would.
    if let Some(prank) = ccx.state.get_prank(depth).copied()
        && depth == prank.depth
    {
        ccx.ecx.tx_mut().set_caller(prank.prank_origin);
        if prank.single_call {
            ccx.state.pranks.remove(&depth);
        }
    }

    let mut outcome = outcome?;
    handle_reservoir_remaining_gas(
        outcome.result.result,
        ccx.gas.tracker_mut(),
        outcome.result.gas.tracker_mut(),
    );
    // Refund the upfront state charge if the account was not created, as revm does.
    let created = outcome.result.result.is_ok() && outcome.address.is_some();
    if outcome.charged_create_state_gas && !created {
        ccx.gas.refill_reservoir(create_state_gas);
    }

    if !outcome.result.result.is_ok() {
        return Err(crate::Error::from(outcome.result.output));
    }

    let address = outcome.address.ok_or_else(|| fmt_err!("contract creation failed"))?;

    Ok(address.abi_encode())
}

/// Resolved location of an artifact referenced by a cheatcode path argument.
enum ArtifactSource<'a> {
    /// The artifact was matched in the in-memory `available_artifacts` list.
    InMemory(&'a ContractData),
    /// The artifact must be read from the given path on disk.
    Disk(PathBuf),
}

/// Resolves a cheatcode artifact reference to its source.
///
/// Can parse the following input formats:
/// - `path/to/artifact.json`
/// - `path/to/contract.sol`
/// - `path/to/contract.sol:ContractName`
/// - `path/to/contract.sol:ContractName:0.8.23`
/// - `path/to/contract.sol:ContractName:profile`
/// - `path/to/contract.sol:0.8.23`
/// - `path/to/contract.sol:profile`
/// - `ContractName`
/// - `ContractName:0.8.23`
/// - `ContractName:profile`
fn get_artifact_source<'a>(state: &'a CheatcodesCore, path: &str) -> Result<ArtifactSource<'a>> {
    if path.ends_with(".json") {
        let path = state.config.ensure_path_allowed(path, FsAccessKind::Read)?;
        return Ok(ArtifactSource::Disk(path));
    }

    let artifacts =
        state.config.available_artifacts.as_ref().or(state.config.artifact_lookup.as_ref());
    let resolve_source = |file: PathBuf| {
        let cwd = state
            .config
            .running_artifact
            .as_ref()
            .and_then(|artifact| artifact.source.parent())
            .unwrap_or(&state.config.paths.root);
        let relative_cwd = cwd.strip_prefix(&state.config.paths.root).unwrap_or(cwd);
        let has_matching_remapping = state.config.paths.remappings.iter().any(|remapping| {
            remapping.context.as_ref().is_none_or(|context| relative_cwd.starts_with(context))
                && file.strip_prefix(&remapping.name).is_ok()
        });

        if has_matching_remapping {
            state.config.paths.resolve_library_import(cwd, &file).map_or(file, |resolved| {
                resolved.strip_prefix(&state.config.paths.root).unwrap_or(&resolved).to_path_buf()
            })
        } else {
            file
        }
    };
    let exact_identifier = path
        .rsplit_once(':')
        .map(|(source, contract)| (resolve_source(PathBuf::from(source)), contract))
        .filter(|(source, contract)| {
            artifacts.into_iter().flat_map(|artifacts| artifacts.iter()).any(|(id, _)| {
                id.source == *source
                    && id.name.split('.').next().is_some_and(|name| name == *contract)
            })
        });

    let parsed = match parse_artifact_path(path) {
        Ok(parsed) => parsed,
        Err(_) if exact_identifier.is_some() => {
            ParsedArtifactPath { file: None, contract_name: None, version: None, profile: None }
        }
        Err(error) => return Err(fmt_err!("failed to parse artifact path: {error}")),
    };
    let ParsedArtifactPath { file, contract_name, version, profile } = parsed;
    let file = file.map(resolve_source);

    // Use the artifact lookup if present.
    if let Some(artifacts) = artifacts {
        let ambiguous_file_profile =
            file.is_some() && version.is_none() && profile.is_none() && contract_name.is_some();
        let filter_artifacts = |treat_ambiguous_as_profile: bool| -> Vec<_> {
            artifacts
                .iter()
                .filter(|(id, _)| {
                    if let Some((source, contract)) = &exact_identifier {
                        return id.source == *source
                            && id.name.split('.').next().is_some_and(|name| name == *contract);
                    }

                    // name might be in the form of "Counter.0.8.23"
                    let id_name = id.name.split('.').next().unwrap();

                    if let Some(path) = &file
                        && !id.source.ends_with(path)
                    {
                        return false;
                    }
                    if let Some(ref version) = version
                        && (id.version.minor != version.minor
                            || id.version.major != version.major
                            || id.version.patch != version.patch)
                    {
                        return false;
                    }
                    if let Some(profile) = profile
                        && id.profile != profile
                    {
                        return false;
                    }
                    if let Some(name) = contract_name {
                        if treat_ambiguous_as_profile && ambiguous_file_profile {
                            return id.profile == name;
                        }

                        return id_name == name;
                    }

                    true
                })
                .collect()
        };

        let mut filtered = filter_artifacts(false);
        if filtered.is_empty() && ambiguous_file_profile {
            filtered = filter_artifacts(true);
        }

        let artifact = match &filtered[..] {
            [] => None,
            [artifact] => Some(Ok(*artifact)),
            filtered => {
                let mut filtered = filtered.to_vec();
                // If we know the current script/test contract solc version, try to filter by it
                Some(
                    state
                        .config
                        .running_artifact
                        .as_ref()
                        .and_then(|running| {
                            // Only filter by running version if user did NOT specify a version
                            if exact_identifier.is_some() || version.is_none() {
                                filtered.retain(|(id, _)| id.version == running.version);

                                // Return artifact if only one matched
                                if filtered.len() == 1 {
                                    return Some(filtered[0]);
                                }
                            }

                            // Only filter by running profile if user did NOT specify a profile
                            if exact_identifier.is_some() || profile.is_none() {
                                filtered.retain(|(id, _)| id.profile == running.profile);

                                return (filtered.len() == 1).then(|| filtered[0]);
                            }

                            None
                        })
                        .ok_or_else(|| fmt_err!("multiple matching artifacts found")),
                )
            }
        };

        if let Some(artifact) = artifact {
            return Ok(ArtifactSource::InMemory(artifact?.1));
        }
    }

    // Fallback: construct path manually when no artifacts list or no match found
    let path_in_artifacts = match (file.map(|f| f.to_string_lossy().to_string()), contract_name) {
        (Some(file), Some(contract_name)) => PathBuf::from(format!("{file}/{contract_name}.json")),
        (None, Some(contract_name)) => {
            PathBuf::from(format!("{contract_name}.sol/{contract_name}.json"))
        }
        (Some(file), None) => {
            let name = file.replace(".sol", "");
            PathBuf::from(format!("{file}/{name}.json"))
        }
        _ => bail!("invalid artifact path"),
    };

    let path = state.config.paths.artifacts.join(path_in_artifacts);
    let path = state.config.ensure_path_allowed(path, FsAccessKind::Read)?;
    Ok(ArtifactSource::Disk(path))
}

/// Reads an artifact JSON file, mapping I/O errors to a helpful message when the
/// lookup fell through the in-memory artifacts list.
fn read_artifact_file(state: &CheatcodesCore, path: &Path) -> Result<String> {
    fs::read_to_string(path).map_err(|e| {
        if state.config.available_artifacts.is_some() {
            fmt_err!("no matching artifact found")
        } else {
            e.into()
        }
    })
}

/// Returns the bytecode from a JSON artifact file.
///
/// See [`get_artifact_source`] for the supported path formats.
///
/// This function is safe to use with contracts that have library dependencies.
/// `alloy_json_abi::ContractObject` validates bytecode during JSON parsing and will
/// reject artifacts with unlinked library placeholders.
fn get_artifact_code(state: &CheatcodesCore, path: &str, deployed: bool) -> Result<Bytes> {
    let maybe_bytecode = match get_artifact_source(state, path)? {
        ArtifactSource::InMemory(data) => {
            if deployed { data.deployed_bytecode() } else { data.bytecode() }.cloned()
        }
        ArtifactSource::Disk(path) => {
            let data = read_artifact_file(state, &path)?;
            let artifact = serde_json::from_str::<ContractObject>(&data)?;
            if deployed { artifact.deployed_bytecode } else { artifact.bytecode }
        }
    };
    maybe_bytecode.ok_or_else(|| fmt_err!("no bytecode for contract; is it abstract or unlinked?"))
}

impl Cheatcode for ffiCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { commandInput: input } = self;
        let stdout = ffi_stdout(state, input)?;
        Ok(decode_ffi_stdout(&stdout).abi_encode())
    }
}

impl Cheatcode for ffiUintCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { commandInput: input } = self;
        parse(&ffi_stdout(state, input)?, &DynSolType::Uint(256))
    }
}

impl Cheatcode for ffiStringCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { commandInput: input } = self;
        Ok(ffi_stdout(state, input)?.abi_encode())
    }
}

impl Cheatcode for ffiBytesCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { commandInput: input } = self;
        let stdout = ffi_stdout(state, input)?;
        Ok(hex::decode(&stdout)
            .map_err(|err| fmt_err!("failed parsing ffi stdout as bytes: {err}"))?
            .abi_encode())
    }
}

impl Cheatcode for tryFfiCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { commandInput: input } = self;
        ffi(state, input).map(|res| res.abi_encode())
    }
}

impl Cheatcode for promptCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { promptText: text } = self;
        prompt(state, text, prompt_input).map(|res| res.abi_encode())
    }
}

impl Cheatcode for promptSecretCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { promptText: text } = self;
        prompt(state, text, prompt_password).map(|res| res.abi_encode())
    }
}

impl Cheatcode for promptSecretUintCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { promptText: text } = self;
        parse(&prompt(state, text, prompt_password)?, &DynSolType::Uint(256))
    }
}

impl Cheatcode for promptAddressCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { promptText: text } = self;
        parse(&prompt(state, text, prompt_input)?, &DynSolType::Address)
    }
}

impl Cheatcode for promptUintCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { promptText: text } = self;
        parse(&prompt(state, text, prompt_input)?, &DynSolType::Uint(256))
    }
}

pub(super) fn write_file(state: &CheatcodesCore, path: &Path, contents: &[u8]) -> Result {
    let path = state.config.ensure_path_allowed(path, FsAccessKind::Write)?;
    // write access to foundry.toml is not allowed
    state.config.ensure_not_foundry_toml(&path)?;

    if state.fs_commit {
        fs::locked_write(path, contents)?;
    }

    Ok(Default::default())
}

fn read_dir(state: &CheatcodesCore, path: &Path, max_depth: u64, follow_links: bool) -> Result {
    let root = state.config.ensure_path_allowed(path, FsAccessKind::Read)?;
    let paths: Vec<DirEntry> = WalkDir::new(root)
        .min_depth(1)
        .max_depth(max_depth.try_into().unwrap_or(usize::MAX))
        .follow_links(follow_links)
        .contents_first(false)
        .same_file_system(true)
        .sort_by_file_name()
        .into_iter()
        .map(|entry| match entry {
            Ok(entry) => DirEntry {
                errorMessage: String::new(),
                path: entry.path().display().to_string(),
                depth: entry.depth() as u64,
                isDir: entry.file_type().is_dir(),
                isSymlink: entry.path_is_symlink(),
            },
            Err(e) => DirEntry {
                errorMessage: e.to_string(),
                path: e.path().map(|p| p.display().to_string()).unwrap_or_default(),
                depth: e.depth() as u64,
                isDir: false,
                isSymlink: false,
            },
        })
        .collect();
    Ok(paths.abi_encode())
}

fn ffi(state: &CheatcodesCore, input: &[String]) -> Result<FfiResult> {
    let output = ffi_command(state, input)?;

    let stdout = String::from_utf8(output.stdout)?;
    let stdout = stdout.trim();
    Ok(FfiResult {
        exitCode: output.status.code().unwrap_or(69),
        stdout: decode_ffi_stdout(stdout),
        stderr: output.stderr.into(),
    })
}

fn ffi_stdout(state: &CheatcodesCore, input: &[String]) -> Result<String> {
    let output = ffi_command(state, input)?;
    let stdout = String::from_utf8(output.stdout)?;
    if !output.status.success() {
        return Err(fmt_err!(
            "ffi command {:?} exited with code {}. stderr: {}",
            input,
            output.status.code().unwrap_or(69),
            String::from_utf8_lossy(&output.stderr)
        ));
    }
    if !output.stderr.is_empty() {
        let stderr = String::from_utf8_lossy(&output.stderr);
        warn!(target: "cheatcodes", ?input, ?stderr, "ffi command wrote to stderr");
    }
    Ok(stdout.trim().to_string())
}

fn decode_ffi_stdout(stdout: &str) -> Bytes {
    hex::decode(stdout).unwrap_or_else(|_| stdout.as_bytes().to_vec()).into()
}

fn ffi_command(state: &CheatcodesCore, input: &[String]) -> Result<std::process::Output> {
    ensure!(
        state.config.ffi,
        "FFI is disabled; add the `--ffi` flag to allow tests to call external commands"
    );
    ensure!(!input.is_empty() && !input[0].is_empty(), "can't execute empty command");
    let mut cmd = Command::new(&input[0]);
    cmd.args(&input[1..]);

    debug!(target: "cheatcodes", ?cmd, "invoking ffi");

    cmd.current_dir(&state.config.root)
        .output()
        .map_err(|err| fmt_err!("failed to execute command {cmd:?}: {err}"))
}

fn prompt_input(prompt_text: &str) -> Result<String, dialoguer::Error> {
    Input::new().allow_empty(true).with_prompt(prompt_text).interact_text()
}

fn prompt_password(prompt_text: &str) -> Result<String, dialoguer::Error> {
    Password::new().with_prompt(prompt_text).interact()
}

fn prompt(
    state: &CheatcodesCore,
    prompt_text: &str,
    input: fn(&str) -> Result<String, dialoguer::Error>,
) -> Result<String> {
    let text_clone = prompt_text.to_string();
    let timeout = state.config.prompt_timeout;
    let (tx, rx) = mpsc::channel();

    thread::spawn(move || {
        let _ = tx.send(input(&text_clone));
    });

    match rx.recv_timeout(timeout) {
        Ok(res) => res.map_err(|err| {
            let _ = sh_println!();
            err.to_string().into()
        }),
        Err(_) => {
            let _ = sh_eprintln!();
            Err("Prompt timed out".into())
        }
    }
}

impl Cheatcode for getBroadcastCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { contractName, chainId, txType } = self;

        let latest_broadcast = latest_broadcast::<AnyNetwork>(
            contractName,
            *chainId,
            &state.config.broadcast,
            vec![map_broadcast_tx_type(*txType)],
        )?;

        Ok(latest_broadcast.abi_encode())
    }
}

impl Cheatcode for getBroadcasts_0Call {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { contractName, chainId, txType } = self;

        let reader = BroadcastReader::new(contractName.clone(), *chainId, &state.config.broadcast)?
            .with_tx_type(map_broadcast_tx_type(*txType));

        let broadcasts = reader.read::<AnyNetwork>()?;

        let summaries = broadcasts
            .into_iter()
            .flat_map(|broadcast| {
                let results = reader.into_tx_receipts(broadcast);
                parse_broadcast_results(results)
            })
            .collect::<Vec<_>>();

        Ok(summaries.abi_encode())
    }
}

impl Cheatcode for getBroadcasts_1Call {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { contractName, chainId } = self;

        let reader = BroadcastReader::new(contractName.clone(), *chainId, &state.config.broadcast)?;

        let broadcasts = reader.read::<AnyNetwork>()?;

        let summaries = broadcasts
            .into_iter()
            .flat_map(|broadcast| {
                let results = reader.into_tx_receipts(broadcast);
                parse_broadcast_results(results)
            })
            .collect::<Vec<_>>();

        Ok(summaries.abi_encode())
    }
}

impl Cheatcode for getDeployment_0Call {
    fn apply_stateful<FEN: FoundryEvmNetwork>(&self, ccx: &mut CheatsCtxt<'_, '_, FEN>) -> Result {
        let Self { contractName } = self;
        let chain_id = ccx.chain_id();

        let latest_broadcast = latest_broadcast::<AnyNetwork>(
            contractName,
            chain_id,
            &ccx.state.core.config.broadcast,
            vec![CallKind::Create, CallKind::Create2],
        )?;

        Ok(latest_broadcast.contractAddress.abi_encode())
    }
}

impl Cheatcode for getDeployment_1Call {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { contractName, chainId } = self;

        let latest_broadcast = latest_broadcast::<AnyNetwork>(
            contractName,
            *chainId,
            &state.config.broadcast,
            vec![CallKind::Create, CallKind::Create2],
        )?;

        Ok(latest_broadcast.contractAddress.abi_encode())
    }
}

impl Cheatcode for getDeploymentsCall {
    fn apply_context(&self, state: &mut CheatcodesCore) -> Result {
        let Self { contractName, chainId } = self;

        let reader = BroadcastReader::new(contractName.clone(), *chainId, &state.config.broadcast)?
            .with_tx_type(CallKind::Create)
            .with_tx_type(CallKind::Create2);

        let broadcasts = reader.read::<AnyNetwork>()?;

        let summaries = broadcasts
            .into_iter()
            .flat_map(|broadcast| {
                let results = reader.into_tx_receipts(broadcast);
                parse_broadcast_results(results)
            })
            .collect::<Vec<_>>();

        let deployed_addresses =
            summaries.into_iter().map(|summary| summary.contractAddress).collect::<Vec<_>>();

        Ok(deployed_addresses.abi_encode())
    }
}

fn map_broadcast_tx_type(tx_type: BroadcastTxType) -> CallKind {
    match tx_type {
        BroadcastTxType::Call => CallKind::Call,
        BroadcastTxType::Create => CallKind::Create,
        BroadcastTxType::Create2 => CallKind::Create2,
        _ => unreachable!("invalid tx type"),
    }
}

fn parse_broadcast_results<N: Network>(
    results: Vec<(TransactionWithMetadata<N>, N::ReceiptResponse)>,
) -> Vec<BroadcastTxSummary> {
    results
        .into_iter()
        .map(|(tx, receipt)| BroadcastTxSummary {
            txHash: receipt.transaction_hash(),
            blockNumber: receipt.block_number().unwrap_or_default(),
            txType: match tx.call_kind {
                CallKind::Call => BroadcastTxType::Call,
                CallKind::Create => BroadcastTxType::Create,
                CallKind::Create2 => BroadcastTxType::Create2,
                _ => unreachable!("invalid tx type"),
            },
            contractAddress: tx.contract_address.unwrap_or_default(),
            success: receipt.status(),
        })
        .collect()
}

fn latest_broadcast<N: Network>(
    contract_name: &String,
    chain_id: u64,
    broadcast_path: &Path,
    filters: Vec<CallKind>,
) -> Result<BroadcastTxSummary>
where
    N::TxEnvelope: for<'d> serde::Deserialize<'d>,
{
    let mut reader = BroadcastReader::new(contract_name.clone(), chain_id, broadcast_path)?;

    for filter in filters {
        reader = reader.with_tx_type(filter);
    }

    let broadcast = reader.read_latest::<N>()?;

    let results = reader.into_tx_receipts(broadcast);

    let summaries = parse_broadcast_results(results);

    summaries
        .first()
        .ok_or_else(|| fmt_err!("no deployment found for {contract_name} on chain {chain_id}"))
        .cloned()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::CheatsConfig;
    use alloy_primitives::{Bloom, address, b256};
    use foundry_common::ContractsByArtifact;
    use foundry_compilers::{
        ArtifactId,
        artifacts::{
            BytecodeObject, CompactBytecode, CompactContractBytecode, remappings::Remapping,
        },
    };
    use std::{env, fs as stdfs, str::FromStr, sync::Arc};
    use tempfile::TempDir;

    fn cheats() -> CheatcodesCore {
        let config = CheatsConfig {
            ffi: true,
            root: PathBuf::from(&env!("CARGO_MANIFEST_DIR")),
            ..Default::default()
        };
        CheatcodesCore::new(Arc::new(config))
    }

    #[test]
    fn test_ffi_hex() {
        let msg = b"gm";
        let cheats = cheats();
        let args = ["echo".to_string(), hex::encode(msg)];
        let output = ffi(&cheats, &args).unwrap();
        assert_eq!(output.stdout, Bytes::from(msg));
    }

    #[test]
    fn test_ffi_string() {
        let msg = "gm";
        let cheats = cheats();
        let args = ["echo".to_string(), msg.to_string()];
        let output = ffi(&cheats, &args).unwrap();
        assert_eq!(output.stdout, Bytes::from(msg.as_bytes()));
    }

    #[test]
    fn test_ffi_fails_on_error_code() {
        let mut cheats = cheats();

        // Use a command that is guaranteed to fail with a non-zero exit code on any platform.
        #[cfg(unix)]
        let args = vec!["false".to_string()];
        #[cfg(windows)]
        let args = vec!["cmd".to_string(), "/c".to_string(), "exit 1".to_string()];

        let result = Cheatcode::apply_context(&ffiCall { commandInput: args }, &mut cheats);

        // Assert that the cheatcode returned an error.
        assert!(result.is_err(), "Expected ffi cheatcode to fail, but it succeeded");

        // Assert that the error message contains the expected information.
        let err_msg = result.unwrap_err().to_string();
        assert!(
            err_msg.contains("exited with code 1"),
            "Error message did not contain exit code: {err_msg}"
        );
    }

    #[test]
    fn test_artifact_parsing() {
        let s = include_str!("../../evm/test-data/solc-obj.json");
        let artifact: ContractObject = serde_json::from_str(s).unwrap();
        assert!(artifact.bytecode.is_some());

        let artifact: ContractObject = serde_json::from_str(s).unwrap();
        assert!(artifact.deployed_bytecode.is_some());
    }

    #[test]
    fn test_alloy_json_abi_rejects_unlinked_bytecode() {
        let artifact_json = r#"{
            "abi": [],
            "bytecode": "0x73__$987e73aeca5e61ce83e4cb0814d87beda9$__63baf2f868"
        }"#;

        let result: Result<ContractObject, _> = serde_json::from_str(artifact_json);
        assert!(result.is_err(), "should reject unlinked bytecode with placeholders");
        let err = result.unwrap_err().to_string();
        assert!(err.contains("expected bytecode, found unlinked bytecode with placeholder"));
    }

    #[test]
    fn test_parse_artifact_path_file_only() {
        let parsed = super::parse_artifact_path("path/to/Contract.sol").unwrap();
        assert_eq!(parsed.file, Some(PathBuf::from("path/to/Contract.sol")));
        assert_eq!(parsed.contract_name, None);
        assert_eq!(parsed.version, None);
        assert_eq!(parsed.profile, None);
    }

    #[test]
    fn test_parse_artifact_path_windows_drive() {
        for file in [
            "C:/project/src/Contract.sol",
            r"C:\project\src\Contract.sol",
            r"\\?\C:\project\src\Contract.sol",
            r"\\server\share\Contract.sol",
        ] {
            for (suffix, contract_name, version, profile) in [
                ("", None, None, None),
                (":MyContract", Some("MyContract"), None, None),
                (":0.8.23", None, Some(Version::new(0, 8, 23)), None),
                (":MyContract:0.8.23", Some("MyContract"), Some(Version::new(0, 8, 23)), None),
                (":MyContract:optimized", Some("MyContract"), None, Some("optimized")),
            ] {
                let input = format!("{file}{suffix}");
                assert_eq!(
                    parse_artifact_path(&input).unwrap(),
                    ParsedArtifactPath {
                        file: Some(PathBuf::from(file)),
                        contract_name,
                        version,
                        profile,
                    },
                    "{input}"
                );
            }
        }

        // A one-letter contract name must still allow version and profile suffixes.
        assert_eq!(parse_artifact_path("C:0.8.23").unwrap().version, Some(Version::new(0, 8, 23)));
        assert_eq!(parse_artifact_path("C:optimized").unwrap().profile, Some("optimized"));
    }

    #[test]
    fn test_parse_artifact_path_file_and_contract() {
        let parsed = super::parse_artifact_path("path/to/Contract.sol:MyContract").unwrap();
        assert_eq!(parsed.file, Some(PathBuf::from("path/to/Contract.sol")));
        assert_eq!(parsed.contract_name, Some("MyContract"));
        assert_eq!(parsed.version, None);
        assert_eq!(parsed.profile, None);
    }

    #[test]
    fn test_parse_artifact_path_file_contract_version() {
        let parsed = super::parse_artifact_path("path/to/Contract.sol:MyContract:0.8.23").unwrap();
        assert_eq!(parsed.file, Some(PathBuf::from("path/to/Contract.sol")));
        assert_eq!(parsed.contract_name, Some("MyContract"));
        assert_eq!(parsed.version, Some(semver::Version::new(0, 8, 23)));
        assert_eq!(parsed.profile, None);
    }

    #[test]
    fn test_parse_artifact_path_file_contract_profile() {
        let parsed =
            super::parse_artifact_path("path/to/Contract.sol:MyContract:optimized").unwrap();
        assert_eq!(parsed.file, Some(PathBuf::from("path/to/Contract.sol")));
        assert_eq!(parsed.contract_name, Some("MyContract"));
        assert_eq!(parsed.version, None);
        assert_eq!(parsed.profile, Some("optimized"));
    }

    #[test]
    fn test_parse_artifact_path_file_and_version() {
        let parsed = super::parse_artifact_path("path/to/Contract.sol:0.8.18").unwrap();
        assert_eq!(parsed.file, Some(PathBuf::from("path/to/Contract.sol")));
        assert_eq!(parsed.contract_name, None);
        assert_eq!(parsed.version, Some(semver::Version::new(0, 8, 18)));
        assert_eq!(parsed.profile, None);
    }

    #[test]
    fn test_parse_artifact_path_file_and_profile() {
        // The parser keeps the two-part file form ambiguous. Artifact lookup can resolve this
        // segment as a profile when no contract name matches.
        let parsed = super::parse_artifact_path("Contract.sol:paris").unwrap();
        assert_eq!(parsed.file, Some(PathBuf::from("Contract.sol")));
        assert_eq!(parsed.contract_name, Some("paris"));
        assert_eq!(parsed.version, None);
        assert_eq!(parsed.profile, None);
    }

    fn test_artifact(
        source: &str,
        name: &str,
        profile: &str,
        bytecode: Bytes,
    ) -> (ArtifactId, CompactContractBytecode) {
        (
            ArtifactId {
                path: PathBuf::from(format!("{source}/{name}.json")),
                name: name.to_owned(),
                source: PathBuf::from(source),
                version: Version::new(0, 8, 30),
                build_id: String::new(),
                profile: profile.to_owned(),
            },
            CompactContractBytecode {
                abi: Some(Default::default()),
                bytecode: Some(CompactBytecode {
                    object: BytecodeObject::Bytecode(bytecode),
                    source_map: None,
                    link_references: Default::default(),
                }),
                deployed_bytecode: None,
            },
        )
    }

    #[test]
    fn test_get_artifact_code_resolves_file_profile_ambiguity() {
        let default_bytecode = Bytes::from_static(&[0x60, 0x01]);
        let paris_bytecode = Bytes::from_static(&[0x60, 0x02]);
        let source = "src/GetCodeProfile.t.sol";
        let artifacts = ContractsByArtifact::new([
            test_artifact(source, "GetCodeProfile", "default", default_bytecode),
            test_artifact(source, "GetCodeProfile", "paris", paris_bytecode.clone()),
        ]);
        let config = CheatsConfig {
            available_artifacts: Some(artifacts),
            root: PathBuf::from(&env!("CARGO_MANIFEST_DIR")),
            ..Default::default()
        };
        let cheats = CheatcodesCore::new(Arc::new(config));

        let bytecode =
            super::get_artifact_code(&cheats, "src/GetCodeProfile.t.sol:paris", false).unwrap();

        assert_eq!(bytecode, paris_bytecode);
    }

    #[test]
    fn test_get_artifact_code_exact_colon_path_uses_running_profile() {
        let default_bytecode = Bytes::from_static(&[0x60, 0x01]);
        let optimized_bytecode = Bytes::from_static(&[0x60, 0x02]);
        let versioned_bytecode = Bytes::from_static(&[0x60, 0x03]);
        let source = "src/Colon:Path.sol";
        let default = test_artifact(source, "Target", "default", default_bytecode);
        let optimized =
            test_artifact(source, "Target.optimized", "optimized", optimized_bytecode.clone());
        let mut versioned = test_artifact(
            source,
            "Target.0.8.29.optimized",
            "optimized",
            versioned_bytecode.clone(),
        );
        versioned.0.version = Version::new(0, 8, 29);
        let artifacts = ContractsByArtifact::new([default, optimized, versioned]);
        for (patch, expected) in [(30, optimized_bytecode), (29, versioned_bytecode)] {
            let running_artifact = ArtifactId {
                source: PathBuf::from("test/Runner.t.sol"),
                name: "Runner".to_owned(),
                path: PathBuf::from("test/Runner.t.sol/Runner.json"),
                version: Version::new(0, 8, patch),
                build_id: String::new(),
                profile: "optimized".to_owned(),
            };
            let config = CheatsConfig {
                available_artifacts: Some(artifacts.clone()),
                running_artifact: Some(running_artifact),
                root: PathBuf::from(&env!("CARGO_MANIFEST_DIR")),
                ..Default::default()
            };
            let cheats = CheatcodesCore::new(Arc::new(config));
            let bytecode =
                super::get_artifact_code(&cheats, "src/Colon:Path.sol:Target", false).unwrap();
            assert_eq!(bytecode, expected);
        }
    }

    #[test]
    fn test_get_artifact_code_prefers_contract_name_over_file_profile_ambiguity() {
        let profile_bytecode = Bytes::from_static(&[0x60, 0x02]);
        let contract_bytecode = Bytes::from_static(&[0x60, 0x03]);
        let source = "src/GetCodeProfile.t.sol";
        let artifacts = ContractsByArtifact::new([
            test_artifact(source, "GetCodeProfile", "paris", profile_bytecode),
            test_artifact(source, "paris", "default", contract_bytecode.clone()),
        ]);
        let config = CheatsConfig {
            available_artifacts: Some(artifacts),
            root: PathBuf::from(&env!("CARGO_MANIFEST_DIR")),
            ..Default::default()
        };
        let cheats = CheatcodesCore::new(Arc::new(config));

        let bytecode =
            super::get_artifact_code(&cheats, "src/GetCodeProfile.t.sol:paris", false).unwrap();

        assert_eq!(bytecode, contract_bytecode);
    }

    #[test]
    fn test_get_artifact_code_resolves_remapping() {
        let bytecode = Bytes::from_static(&[0x60, 0x01]);
        let artifacts = ContractsByArtifact::new([test_artifact(
            "src/Something.sol",
            "Something",
            "default",
            bytecode.clone(),
        )]);
        let root = PathBuf::from(&env!("CARGO_MANIFEST_DIR"));
        let paths = foundry_compilers::ProjectPathsConfig::builder()
            .remapping(Remapping::from_str("@example/=src/").unwrap())
            .build_with_root(&root);
        let config = CheatsConfig {
            available_artifacts: Some(artifacts),
            root,
            paths,
            ..Default::default()
        };
        let cheats = CheatcodesCore::new(Arc::new(config));

        let resolved =
            super::get_artifact_code(&cheats, "@example/Something.sol:Something", false).unwrap();

        assert_eq!(resolved, bytecode);
    }

    #[test]
    fn test_get_artifact_code_remaps_exact_paths_before_profile_selection() {
        for file in ["Target.sol", "Colon:Path.sol"] {
            let source = format!("src/{file}");
            let remapped = format!("lib/alternate/{file}");
            let default_bytecode = Bytes::from_static(&[0x60, 0x02]);
            let optimized_bytecode = Bytes::from_static(&[0x60, 0x03]);
            let artifacts = ContractsByArtifact::new([
                test_artifact(&source, "Target", "default", Bytes::from_static(&[0x60, 0x01])),
                test_artifact(&remapped, "Target", "default", default_bytecode.clone()),
                test_artifact(
                    &remapped,
                    "Target.optimized",
                    "optimized",
                    optimized_bytecode.clone(),
                ),
            ]);
            for (profile, expected) in
                [("default", default_bytecode), ("optimized", optimized_bytecode)]
            {
                let root = PathBuf::from(&env!("CARGO_MANIFEST_DIR"));
                let paths = foundry_compilers::ProjectPathsConfig::builder()
                    .remapping(Remapping::from_str("src/=lib/alternate/").unwrap())
                    .build_with_root(&root);
                let config = CheatsConfig {
                    available_artifacts: Some(artifacts.clone()),
                    running_artifact: Some(
                        test_artifact("test/Runner.t.sol", "Runner", profile, Bytes::new()).0,
                    ),
                    root,
                    paths,
                    ..Default::default()
                };
                let cheats = CheatcodesCore::new(Arc::new(config));
                let resolved =
                    super::get_artifact_code(&cheats, &format!("{source}:Target"), false).unwrap();
                assert_eq!(resolved, expected, "{source} in {profile} profile");
            }
        }
    }

    #[test]
    fn test_get_artifact_code_preserves_project_path_on_library_collision() {
        let root_bytecode = Bytes::from_static(&[0x60, 0x01]);
        let library_bytecode = Bytes::from_static(&[0x60, 0x02]);
        let artifacts = ContractsByArtifact::new([
            test_artifact("src/Thing.sol", "RootThing", "default", root_bytecode.clone()),
            test_artifact("lib/src/Thing.sol", "LibThing", "default", library_bytecode),
        ]);
        let temp = TempDir::new().unwrap();
        let library = temp.path().join("lib");
        stdfs::create_dir_all(library.join("src")).unwrap();
        stdfs::write(library.join("src/Thing.sol"), "").unwrap();
        let paths = foundry_compilers::ProjectPathsConfig::builder()
            .remappings([])
            .lib(library)
            .build_with_root(temp.path());
        let config = CheatsConfig {
            available_artifacts: Some(artifacts),
            root: temp.path().to_path_buf(),
            paths,
            ..Default::default()
        };
        let cheats = CheatcodesCore::new(Arc::new(config));

        let resolved = super::get_artifact_code(&cheats, "src/Thing.sol:RootThing", false).unwrap();

        assert_eq!(resolved, root_bytecode);
    }

    #[test]
    fn test_parse_artifact_path_contract_only() {
        let parsed = super::parse_artifact_path("MyContract").unwrap();
        assert_eq!(parsed.file, None);
        assert_eq!(parsed.contract_name, Some("MyContract"));
        assert_eq!(parsed.version, None);
        assert_eq!(parsed.profile, None);
    }

    #[test]
    fn test_parse_artifact_path_contract_and_version() {
        let parsed = super::parse_artifact_path("MyContract:0.8.23").unwrap();
        assert_eq!(parsed.file, None);
        assert_eq!(parsed.contract_name, Some("MyContract"));
        assert_eq!(parsed.version, Some(semver::Version::new(0, 8, 23)));
        assert_eq!(parsed.profile, None);
    }

    #[test]
    fn test_parse_artifact_path_contract_and_profile() {
        let parsed = super::parse_artifact_path("MyContract:optimized").unwrap();
        assert_eq!(parsed.file, None);
        assert_eq!(parsed.contract_name, Some("MyContract"));
        assert_eq!(parsed.version, None);
        assert_eq!(parsed.profile, Some("optimized"));
    }

    #[test]
    fn test_parse_artifact_path_profile_names() {
        // Test various profile name patterns
        for profile in ["v1", "v2", "paris", "optimized", "default", "prod", "dev"] {
            let path = format!("MyContract:{profile}");
            let parsed = super::parse_artifact_path(&path).unwrap();
            assert_eq!(parsed.contract_name, Some("MyContract"));
            assert_eq!(parsed.profile, Some(profile));
            assert_eq!(parsed.version, None);
        }
    }

    #[test]
    fn test_parse_artifact_path_invalid_version() {
        // Invalid semver should be treated as profile
        let parsed = super::parse_artifact_path("MyContract:invalid").unwrap();
        assert_eq!(parsed.contract_name, Some("MyContract"));
        assert_eq!(parsed.profile, Some("invalid"));
        assert_eq!(parsed.version, None);
    }

    fn unique_temp_dir(prefix: &str) -> PathBuf {
        env::temp_dir().join(format!(
            "foundry-cheatcodes-{prefix}-{}",
            SystemTime::now().duration_since(UNIX_EPOCH).unwrap().as_nanos()
        ))
    }

    #[test]
    fn test_latest_broadcast_reads_tempo_sequences() {
        let root = unique_temp_dir("tempo-broadcast");
        let broadcast_path = root.join("broadcast");
        let sequence_dir = broadcast_path.join("Counter.s.sol").join("31337");
        stdfs::create_dir_all(&sequence_dir).unwrap();

        let tx_hash = "0x04548a0ea27e2cccc1479af3c2ff02da4d4d3ea46af8e8d7edaa49f6ea27073f";
        let block_hash = "0x860f788b251ece768e63b0d3906d156f652d843848b71c7fe81faacd49139d66";
        let from = "0xa70ab0448e66cd77995bfbba5c5b64b41a85f3fd";
        let contract_address = "0x20c0000000000000000000000000000000000000";
        let zero_bloom = format!("{:#x}", Bloom::ZERO);

        let sequence = serde_json::json!({
            "transactions": [{
                "hash": tx_hash,
                "transactionType": "CREATE",
                "contractName": "Counter",
                "contractAddress": contract_address,
                "function": serde_json::Value::Null,
                "arguments": serde_json::Value::Null,
                "transaction": {
                    "type": "0x76",
                    "from": from,
                    "to": serde_json::Value::Null,
                    "data": "0x",
                    "value": "0x0",
                    "gas": "0x5208",
                    "nonce": "0x0",
                    "accessList": [],
                    "calls": [],
                    "nonceKey": "0x0",
                    "feePayerSignature": serde_json::Value::Null,
                    "validBefore": serde_json::Value::Null,
                    "validAfter": serde_json::Value::Null,
                    "keyAuthorization": serde_json::Value::Null,
                    "aaAuthorizationList": []
                },
                "additionalContracts": [],
                "isFixedGasLimit": false
            }],
            "receipts": [{
                "type": "0x76",
                "status": "0x1",
                "cumulativeGasUsed": "0x5208",
                "logs": [],
                "logsBloom": zero_bloom,
                "transactionHash": tx_hash,
                "transactionIndex": "0x0",
                "blockHash": block_hash,
                "blockNumber": "0x7",
                "gasUsed": "0x5208",
                "effectiveGasPrice": "0x1",
                "from": from,
                "to": serde_json::Value::Null,
                "contractAddress": contract_address,
                "feePayer": from
            }],
            "libraries": [],
            "pending": [],
            "returns": {},
            "timestamp": 1,
            "chain": 31337,
            "commit": serde_json::Value::Null
        });

        fs::write_json_file(&sequence_dir.join("run-1.json"), &sequence).unwrap();

        let latest = latest_broadcast::<AnyNetwork>(
            &"Counter".to_owned(),
            31337,
            &broadcast_path,
            vec![CallKind::Create],
        )
        .unwrap();

        assert_eq!(
            latest.txHash,
            b256!("04548a0ea27e2cccc1479af3c2ff02da4d4d3ea46af8e8d7edaa49f6ea27073f")
        );
        assert_eq!(latest.blockNumber, 7);
        assert!(matches!(latest.txType, BroadcastTxType::Create));
        assert_eq!(latest.contractAddress, address!("20c0000000000000000000000000000000000000"));
        assert!(latest.success);

        stdfs::remove_dir_all(root).unwrap();
    }
}