cast/cmd/

mod.rs

//! `cast` subcommands.
//!
//! All subcommands should respect the `foundry_config::Config`.
//! If a subcommand accepts values that are supported by the `Config`, then the subcommand should
//! implement `figment::Provider` which allows the subcommand to override the config's defaults, see
//! [`foundry_config::Config`].

use alloy_network::{AnyNetwork, Network};
use alloy_primitives::{Address, Bytes, map::AddressHashMap};
use alloy_provider::Provider;
use alloy_rpc_types::BlockId;
use eyre::Result;
use foundry_cli::{
    json::print_scalar,
    opts::RpcOpts,
    utils::{LoadConfig, get_provider, load_config_from_provider},
};
use foundry_common::{
    provider::{ProviderBuilder, RetryProvider},
    shell,
};
use foundry_config::{Config, figment::Figment};
use foundry_evm::{core::bytecode::InstIter, opts::EvmOpts};
use foundry_evm_networks::NetworkVariant;
use futures::StreamExt;
use serde::Serialize;
use serde_json::Value;
use std::fmt::{Display, Write};

const MAX_CONCURRENT_RPC_REQUESTS: usize = 5;

/// Loads Cast's config and applies its normalized network to the EVM options.
pub(crate) fn load_cast_config_and_evm_opts(figment: Figment) -> Result<(Box<Config>, EvmOpts)> {
    let config = Box::new(load_config_from_provider(figment.clone())?);
    let mut evm_opts = figment.extract::<EvmOpts>()?;
    evm_opts.networks = config.networks;
    Ok((config, evm_opts))
}

/// Loads the config for `rpc` and builds the default provider from it.
pub(crate) fn rpc_provider(rpc: &RpcOpts) -> Result<RetryProvider> {
    get_provider(&rpc.load_config()?)
}

/// Asks whether to continue after a warning, printing `Aborted.` when the user declines.
pub(crate) fn confirm_continue() -> Result<bool> {
    let response: String = foundry_common::prompt!("\nContinue anyway? [y/N] ")?;
    if matches!(response.trim(), "y" | "Y") {
        return Ok(true);
    }
    sh_status!("Aborted.")?;
    Ok(false)
}

/// Prints `json` pretty-printed (un-enveloped) in JSON mode, `plain` otherwise.
pub(crate) fn print_json_or(json: Value, plain: impl Display) -> Result<()> {
    if shell::is_json() {
        sh_println!("{}", serde_json::to_string_pretty(&json)?)?;
    } else {
        sh_println!("{plain}")?;
    }
    Ok(())
}

/// Prints the primary result of a command: a JSON envelope in `--json` mode, otherwise a raw line
/// that bypasses the shell verbosity layer so `--quiet` does not suppress it.
pub(crate) fn print_result_line(value: impl Serialize + Display) -> Result<()> {
    if shell::is_json() {
        return print_scalar(value);
    }
    print_raw_line(value)
}

/// Prints a raw line to stdout, bypassing the shell verbosity layer so `--quiet` does not
/// suppress it.
pub(crate) fn print_raw_line(value: impl Display) -> Result<()> {
    let mut shell = shell::Shell::get();
    let out = shell.out();
    writeln!(out, "{value}")?;
    out.flush()?;
    Ok(())
}

/// Fetches the non-empty code of `addresses` at `block` with bounded concurrency, warning about
/// addresses whose code cannot be fetched.
pub(crate) async fn fetch_code_via_rpc<N: Network, P: Provider<N>>(
    provider: &P,
    addresses: impl IntoIterator<Item = Address>,
    block: BlockId,
) -> AddressHashMap<Bytes> {
    let mut code_by_address = AddressHashMap::default();
    let mut requests = futures::stream::iter(addresses)
        .map(
            |address| async move { (address, provider.get_code_at(address).block_id(block).await) },
        )
        .buffer_unordered(MAX_CONCURRENT_RPC_REQUESTS);
    while let Some((address, code)) = requests.next().await {
        match code {
            Ok(code) if !code.is_empty() => {
                code_by_address.insert(address, code);
            }
            Ok(_) => {}
            Err(err) => {
                let _ = sh_warn!("Failed to fetch code for {address}: {err}");
            }
        }
    }
    code_by_address
}

pub mod access_list;
pub mod artifact;
mod auth;
pub mod b2e_payload;
pub mod bal;
pub mod batch_mktx;
pub mod batch_send;
pub mod bind;
pub mod call;
pub mod call_overrides;
pub mod constructor_args;
pub mod create2;
pub mod creation_code;
#[cfg(any(feature = "base", feature = "optimism"))]
pub mod da_estimate;
pub mod erc20;
pub mod erc4626;
pub mod estimate;
pub mod events;
pub mod find_block;
pub mod interface;
pub mod keychain;
pub mod logs;
pub(crate) mod miner;
pub mod mktx;
pub mod receive_policy;
pub mod rpc;
pub mod run;
pub mod safe;
pub mod send;
pub mod storage;
pub mod storage_credits;
pub mod tempo;
pub(crate) mod tempo_policy_args;
pub mod tip20;
pub mod tip403;
pub mod trace;
pub mod txpool;
pub mod vaddr;
pub mod wallet;

/// Validates a Tempo transaction requirement against an explicit execution family.
pub(crate) fn validate_tempo_network(config: &Config, requires_tempo: bool) -> Result<()> {
    if requires_tempo && config.networks.has_network_selection() {
        let network = config.networks.execution_network();
        eyre::ensure!(
            network.is_tempo(),
            "Tempo transaction options conflict with configured network `{}`",
            config.networks.execution_profile_name()
        );
    }
    Ok(())
}

/// Resolves the RPC request family before typed transaction construction.
pub(crate) async fn resolve_transaction_network(
    config: &Config,
    requires_tempo: bool,
) -> Result<NetworkVariant> {
    validate_tempo_network(config, requires_tempo)?;
    if requires_tempo {
        return Ok(NetworkVariant::Tempo);
    }
    if config.networks.has_network_selection() {
        return Ok(config.networks.execution_network());
    }
    if let Some(chain) = config.chain {
        return Ok(chain.id().into());
    }
    if config.eth_rpc_curl {
        return Ok(NetworkVariant::Ethereum);
    }

    let provider = ProviderBuilder::<AnyNetwork>::from_config(config)?.build()?;
    Ok(provider.get_chain_id().await?.into())
}

pub(crate) fn disassemble(code: &[u8]) -> Result<String> {
    let mut output = String::new();
    for (pc, inst) in InstIter::new(code).with_pc() {
        writeln!(output, "{pc:08x}: {inst}")?;
    }
    Ok(output)
}

/// Rejects blob options before Base's transaction builder can discard them.
#[cfg(feature = "base")]
pub(crate) fn validate_base_transaction_options(
    tx: &foundry_cli::opts::TransactionOpts,
) -> eyre::Result<()> {
    eyre::ensure!(
        !tx.blob && !tx.eip4844 && tx.blob_gas_price.is_none(),
        "Base does not support blob transactions; remove --blob, --eip4844, and --blob-gas-price"
    );
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;

    #[cfg(feature = "base")]
    use alloy_chains::NamedChain;
    #[cfg(feature = "base")]
    use foundry_config::Chain;

    #[tokio::test]
    async fn transaction_network_respects_explicit_selection() {
        for network in [NetworkVariant::Ethereum, NetworkVariant::Tempo] {
            let config =
                Config { networks: network.into(), eth_rpc_curl: true, ..Default::default() };
            assert_eq!(resolve_transaction_network(&config, false).await.unwrap(), network);
            assert_eq!(
                resolve_transaction_network(&config, true).await.is_ok(),
                network.is_tempo()
            );
        }
        let config = Config { eth_rpc_curl: true, ..Default::default() };
        assert_eq!(
            resolve_transaction_network(&config, true).await.unwrap(),
            NetworkVariant::Tempo
        );
        assert_eq!(
            resolve_transaction_network(&config, false).await.unwrap(),
            NetworkVariant::Ethereum
        );

        let config = Config {
            networks: foundry_evm_networks::NetworkConfigs::with_celo(),
            eth_rpc_curl: true,
            ..Default::default()
        };
        assert_eq!(
            resolve_transaction_network(&config, false).await.unwrap(),
            NetworkVariant::Ethereum
        );
        assert_eq!(
            resolve_transaction_network(&config, true).await.unwrap_err().to_string(),
            "Tempo transaction options conflict with configured network `celo`"
        );
    }

    #[cfg(feature = "monad")]
    #[test]
    fn normalized_hardfork_network_is_applied_to_evm_opts() {
        let figment = Config::figment().merge(("hardfork", "monad:MonadNine"));
        let (config, evm_opts) = load_cast_config_and_evm_opts(figment).unwrap();

        assert!(config.networks.is_monad());
        assert!(evm_opts.networks.is_monad());
    }

    #[cfg(feature = "base")]
    #[tokio::test]
    async fn resolve_network_preserves_explicit_base() {
        let config = Config { networks: NetworkVariant::Base.into(), ..Default::default() };
        assert_eq!(
            resolve_transaction_network(&config, false).await.unwrap(),
            NetworkVariant::Base
        );
        assert_eq!(
            resolve_transaction_network(&config, true).await.unwrap_err().to_string(),
            "Tempo transaction options conflict with configured network `base`"
        );
    }

    #[cfg(feature = "base")]
    #[tokio::test]
    async fn resolve_network_infers_base_from_chain_id() {
        let config =
            Config { chain: Some(Chain::from_named(NamedChain::Base)), ..Default::default() };
        assert_eq!(
            resolve_transaction_network(&config, false).await.unwrap(),
            NetworkVariant::Base
        );
    }

    #[cfg(all(any(feature = "base", feature = "optimism"), not(feature = "monad")))]
    #[tokio::test]
    async fn resolve_network_allows_rpc_without_local_evm() {
        let config = Config {
            chain: Some(foundry_config::Chain::from_named(alloy_chains::NamedChain::Monad)),
            ..Default::default()
        };
        assert_eq!(
            resolve_transaction_network(&config, false).await.unwrap(),
            NetworkVariant::Ethereum
        );
    }

    #[cfg(feature = "base")]
    #[tokio::test]
    async fn resolve_network_preserves_config_over_chain_in_curl_mode() {
        let config = Config {
            networks: NetworkVariant::Base.into(),
            chain: Some(foundry_config::Chain::from_id(31337)),
            eth_rpc_curl: true,
            ..Default::default()
        };
        assert_eq!(
            resolve_transaction_network(&config, false).await.unwrap(),
            NetworkVariant::Base
        );
        let config = Config {
            networks: NetworkVariant::Ethereum.into(),
            chain: Some(foundry_config::Chain::from_id(8453)),
            ..config
        };
        assert_eq!(
            resolve_transaction_network(&config, false).await.unwrap(),
            NetworkVariant::Ethereum
        );
    }

    #[cfg(all(feature = "base", not(feature = "optimism")))]
    #[tokio::test]
    async fn resolve_network_allows_rpc_without_optimism() {
        let config =
            Config { chain: Some(foundry_config::Chain::from_id(10)), ..Default::default() };
        assert_eq!(
            resolve_transaction_network(&config, false).await.unwrap(),
            NetworkVariant::Ethereum
        );
    }

    #[cfg(any(feature = "base", feature = "optimism"))]
    #[tokio::test]
    async fn resolve_network_still_defaults_unknown_chain_ids_to_ethereum() {
        let config =
            Config { chain: Some(foundry_config::Chain::from_id(u64::MAX)), ..Default::default() };
        assert_eq!(
            resolve_transaction_network(&config, false).await.unwrap(),
            NetworkVariant::Ethereum
        );
    }
}