anvil_zksync/

cli.rs

use crate::utils::{
    TELEMETRY_SENSITIVE_VALUE, get_cli_command_telemetry_props, parse_genesis_file,
};
use alloy::signers::local::coins_bip39::{English, Mnemonic};
use anvil_zksync_common::{
    cache::{CacheConfig, CacheType, DEFAULT_DISK_CACHE_DIR},
    sh_err, sh_warn,
    utils::io::write_json_file,
};
use anvil_zksync_config::types::{AccountGenerator, Genesis, SystemContractsOptions};
use anvil_zksync_config::{BaseTokenConfig, L1Config, TestNodeConfig};
use anvil_zksync_config::{
    DebugTraceConfig,
    constants::{DEFAULT_MNEMONIC, TEST_NODE_NETWORK_ID},
    types::ZKsyncOsConfig,
};
use anvil_zksync_core::node::fork::ForkConfig;
use anvil_zksync_core::node::{InMemoryNode, VersionedState};
use anvil_zksync_types::{
    LogLevel, ShowGasDetails, ShowStorageLogs, ShowVMDetails, TransactionOrder,
};
use clap::{ArgAction, Parser, Subcommand, ValueEnum};
use flate2::read::GzDecoder;
use futures::FutureExt;
use num::rational::Ratio;
use rand::{SeedableRng, rngs::StdRng};
use std::collections::HashMap;
use std::env;
use std::io::Read;
use std::net::IpAddr;
use std::num::NonZeroU64;
use std::path::PathBuf;
use std::str::FromStr;
use std::time::Duration;
use std::{
    future::Future,
    pin::Pin,
    task::{Context, Poll},
};
use tokio::time::{Instant, Interval};
use url::Url;
use zksync_telemetry::TelemetryProps;
use zksync_types::fee_model::{BaseTokenConversionRatio, ConversionRatio};
use zksync_types::{H256, ProtocolVersionId, U256};

const DEFAULT_PORT: &str = "8011";
const DEFAULT_HOST: &str = "0.0.0.0";
const DEFAULT_ACCOUNTS: &str = "10";
const DEFAULT_BALANCE: &str = "10000";
const DEFAULT_ALLOW_ORIGIN: &str = "*";
const DEFAULT_TX_ORDER: &str = "fifo";

#[derive(Debug, Parser, Clone)]
#[command(
    author = "Matter Labs",
    version,
    about = "A fast and extensible local ZKsync test node.",
    long_about = "anvil-zksync\n\nA developer-friendly ZKsync local node for testing."
)]
pub struct Cli {
    #[command(subcommand)]
    pub command: Option<Command>,

    // General Options
    #[arg(long, help_heading = "General Options")]
    /// Run in offline mode (disables all network requests).
    pub offline: bool,

    #[arg(long, help_heading = "General Options")]
    /// Enable health check endpoint.
    /// It will be available for GET requests at /health.
    /// The endpoint will return 200 OK if the node is healthy.
    pub health_check_endpoint: bool,

    /// Writes output of `anvil-zksync` as json to user-specified file.
    #[arg(long, value_name = "OUT_FILE", help_heading = "General Options")]
    pub config_out: Option<String>,

    #[arg(long, default_value = DEFAULT_PORT, help_heading = "Network Options")]
    /// Port to listen on (default: 8011).
    pub port: Option<u16>,

    /// The hosts the server will listen on.
    #[arg(
        long,
        value_name = "IP_ADDR",
        env = "ANVIL_ZKSYNC_IP_ADDR",
        default_value = DEFAULT_HOST,
        value_delimiter = ',',
        help_heading = "Network Options"
    )]
    pub host: Vec<IpAddr>,

    #[arg(long, help_heading = "Network Options")]
    /// Specify chain ID (default: 260).
    pub chain_id: Option<u32>,

    #[arg(long, default_value = "true", default_missing_value = "true", num_args(0..=1), help_heading = "Debugging Options")]
    /// If true, prints node config on startup.
    pub show_node_config: Option<bool>,

    // Debugging Options
    #[arg(long, help_heading = "Debugging Options")]
    /// Show storage log information.
    pub show_storage_logs: Option<ShowStorageLogs>,

    #[arg(long, help_heading = "Debugging Options")]
    /// Show VM details information.
    pub show_vm_details: Option<ShowVMDetails>,

    #[arg(long, help_heading = "Debugging Options")]
    /// Show gas details information.
    pub show_gas_details: Option<ShowGasDetails>,

    /// Increments verbosity each time it is used. (-vv, -vvv)
    ///
    /// Example usage:
    ///   - `-vv` => verbosity level 2 (includes user calls, user L1-L2 logs, and event calls)
    ///   - `-vvv` => level 3 (includes system calls, system L1-L2 logs, and system event calls)
    ///   - `-vvvv` => level 4 (includes system calls, system event calls, and precompiles)
    ///   - `-vvvvv` => level 5 (includes everything)
    #[arg(short = 'v', long = "verbosity", action = ArgAction::Count, help_heading = "Debugging Options")]
    pub verbosity: u8,

    // Gas Configuration
    #[arg(long, help_heading = "Gas Configuration")]
    /// Custom L1 gas price (in wei).
    pub l1_gas_price: Option<u64>,

    #[arg(long, alias = "gas-price", help_heading = "Gas Configuration")]
    /// Custom L2 gas price (in wei).
    pub l2_gas_price: Option<u64>,

    #[arg(long, help_heading = "Gas Configuration")]
    /// Custom L1 pubdata price (in wei).
    pub l1_pubdata_price: Option<u64>,

    #[arg(long, help_heading = "Gas Configuration")]
    /// Gas price estimation scale factor.
    pub price_scale_factor: Option<f64>,

    #[arg(long, help_heading = "Gas Configuration")]
    /// Gas limit estimation scale factor.
    pub limit_scale_factor: Option<f32>,

    #[arg(long, help_heading = "System Configuration")]
    /// Directory to override bytecodes.
    pub override_bytecodes_dir: Option<String>,

    #[arg(long, help_heading = "System Configuration")]
    /// Enforces bytecode compression (default: false).
    pub enforce_bytecode_compression: Option<bool>,

    // System Configuration
    #[arg(long, help_heading = "System Configuration")]
    /// Option for system contracts (default: built-in).
    pub dev_system_contracts: Option<SystemContractsOptions>,

    /// Override the location of the compiled system contracts.
    #[arg(
        long,
        help_heading = "System Configuration",
        value_parser = clap::value_parser!(PathBuf),
    )]
    pub system_contracts_path: Option<PathBuf>,

    /// Override the EVM emulator bytecode with a compiled artifact, independently of
    /// --dev-system-contracts. Useful for testing a locally built emulator.
    #[arg(
        long,
        help_heading = "System Configuration",
        value_parser = clap::value_parser!(PathBuf),
    )]
    pub evm_emulator_path: Option<PathBuf>,

    #[arg(long, value_parser = protocol_version_from_str, help_heading = "System Configuration")]
    /// Protocol version to use for new blocks (default: 26). Also affects revision of built-in
    /// contracts that will get deployed (if applicable).
    pub protocol_version: Option<ProtocolVersionId>,

    #[arg(long, help_heading = "System Configuration")]
    /// Enables EVM interpreter.
    pub evm_interpreter: bool,

    #[clap(flatten)]
    /// ZKsync OS detailed config.
    pub zksync_os_group: ZKsyncOsGroup,

    // Logging Configuration
    #[arg(long, help_heading = "Logging Configuration")]
    /// Log level (default: info).
    pub log: Option<LogLevel>,

    #[arg(long, help_heading = "Logging Configuration")]
    /// Log file path (default: anvil-zksync.log).
    pub log_file_path: Option<String>,

    #[arg(long, alias = "quiet", default_missing_value = "true", num_args(0..=1), help_heading = "Logging Configuration")]
    /// If true, the tool will not print anything on startup.
    pub silent: Option<bool>,

    // Cache Options
    #[arg(long, help_heading = "Cache Options")]
    /// Cache type (none, memory, or disk). Default: "disk".
    pub cache: Option<CacheType>,

    #[arg(long, help_heading = "Cache Options")]
    /// Reset the local disk cache.
    pub reset_cache: Option<bool>,

    #[arg(long, help_heading = "Cache Options")]
    /// Cache directory location for disk cache (default: .cache).
    pub cache_dir: Option<String>,

    /// Number of dev accounts to generate and configure.
    #[arg(
        long,
        short,
        default_value = DEFAULT_ACCOUNTS,
        value_name = "NUM",
        help_heading = "Account Configuration"
    )]
    pub accounts: u64,

    /// The balance of every dev account in Ether.
    #[arg(
        long,
        default_value = DEFAULT_BALANCE,
        value_name = "NUM",
        help_heading = "Account Configuration"
    )]
    pub balance: u64,

    /// The timestamp of the genesis block.
    #[arg(long, value_name = "NUM")]
    pub timestamp: Option<u64>,

    /// Initialize the genesis block with the given `genesis.json` file.
    #[arg(long, value_name = "PATH", value_parser= parse_genesis_file)]
    pub init: Option<Genesis>,

    /// This is an alias for both --load-state and --dump-state.
    ///
    /// It initializes the chain with the state and block environment stored at the file, if it
    /// exists, and dumps the chain's state on exit.
    #[arg(
        long,
        value_name = "PATH",
        conflicts_with_all = &[
            "init",
            "dump_state",
            "load_state"
        ]
    )]
    pub state: Option<PathBuf>,

    /// Interval in seconds at which the state and block environment is to be dumped to disk.
    ///
    /// See --state and --dump-state
    #[arg(short, long, value_name = "SECONDS")]
    pub state_interval: Option<u64>,

    /// Dump the state and block environment of chain on exit to the given file.
    ///
    /// If the value is a directory, the state will be written to `<VALUE>/state.json`.
    #[arg(long, value_name = "PATH", conflicts_with = "init")]
    pub dump_state: Option<PathBuf>,

    /// Preserve historical state snapshots when dumping the state.
    ///
    /// This will save the in-memory states of the chain at particular block hashes.
    ///
    /// These historical states will be loaded into the memory when `--load-state` / `--state`, and
    /// aids in RPC calls beyond the block at which state was dumped.
    #[arg(long, conflicts_with = "init", default_value = "false")]
    pub preserve_historical_states: bool,

    /// Initialize the chain from a previously saved state snapshot.
    #[arg(long, value_name = "PATH", conflicts_with = "init")]
    pub load_state: Option<PathBuf>,

    /// BIP39 mnemonic phrase used for generating accounts.
    /// Cannot be used if `mnemonic_random` or `mnemonic_seed` are used.
    #[arg(long, short, conflicts_with_all = &["mnemonic_seed", "mnemonic_random"], help_heading = "Account Configuration")]
    pub mnemonic: Option<String>,

    /// Automatically generates a BIP39 mnemonic phrase and derives accounts from it.
    /// Cannot be used with other `mnemonic` options.
    /// You can specify the number of words you want in the mnemonic.
    /// [default: 12]
    #[arg(long, conflicts_with_all = &["mnemonic", "mnemonic_seed"], default_missing_value = "12", num_args(0..=1), help_heading = "Account Configuration")]
    pub mnemonic_random: Option<usize>,

    /// Generates a BIP39 mnemonic phrase from a given seed.
    /// Cannot be used with other `mnemonic` options.
    /// CAREFUL: This is NOT SAFE and should only be used for testing.
    /// Never use the private keys generated in production.
    #[arg(long = "mnemonic-seed-unsafe", conflicts_with_all = &["mnemonic", "mnemonic_random"],  help_heading = "Account Configuration")]
    pub mnemonic_seed: Option<u64>,

    /// Sets the derivation path of the child key to be derived.
    /// [default: m/44'/60'/0'/0/]
    #[arg(long, help_heading = "Account Configuration")]
    pub derivation_path: Option<String>,

    /// Enables automatic impersonation on startup. This allows any transaction sender to be
    /// simulated as different accounts, which is useful for testing contract behavior.
    #[arg(
        long,
        visible_alias = "auto-unlock",
        help_heading = "Account Configuration"
    )]
    pub auto_impersonate: bool,

    /// Block time in seconds for interval sealing.
    /// If unset, node seals a new block as soon as there is at least one transaction.
    #[arg(short, long, value_name = "SECONDS", value_parser = duration_from_secs_f64, help_heading = "Block Sealing")]
    pub block_time: Option<Duration>,

    /// Disable auto and interval mining, and mine on demand instead.
    #[arg(long, visible_alias = "no-mine", conflicts_with = "block_time")]
    pub no_mining: bool,

    /// The cors `allow_origin` header
    #[arg(long, default_value = DEFAULT_ALLOW_ORIGIN, help_heading = "Server options")]
    pub allow_origin: String,

    /// Disable CORS.
    #[arg(long, conflicts_with = "allow_origin", help_heading = "Server options")]
    pub no_cors: bool,

    /// Transaction ordering in the mempool.
    #[arg(long, default_value = DEFAULT_TX_ORDER)]
    pub order: TransactionOrder,

    #[clap(flatten)]
    pub l1_group: Option<L1Group>,

    /// Enable automatic execution of L1 batches
    #[arg(long, requires = "l1_group", default_missing_value = "true", num_args(0..=1), help_heading = "UNSTABLE - L1")]
    pub auto_execute_l1: Option<bool>,

    /// Base token symbol to use instead of 'ETH'.
    #[arg(long, help_heading = "Custom Base Token")]
    pub base_token_symbol: Option<String>,

    /// Base token conversion ratio (e.g., '40000', '628/17').
    #[arg(long, help_heading = "Custom Base Token")]
    pub base_token_ratio: Option<Ratio<u64>>,
}

#[derive(Clone, Debug, clap::Args)]
pub struct ZKsyncOsGroup {
    /// Enables ZKsync OS.
    #[arg(long, help_heading = "UNSTABLE - ZKsync OS")]
    pub zksync_os: bool,

    /// Path to ZKsync OS binary (if you need to compute witnesses).
    #[arg(long, requires = "zksync_os", help_heading = "UNSTABLE - ZKsync OS")]
    pub zksync_os_bin_path: Option<String>,
}

impl From<ZKsyncOsGroup> for ZKsyncOsConfig {
    fn from(group: ZKsyncOsGroup) -> Self {
        ZKsyncOsConfig {
            zksync_os: group.zksync_os,
            zksync_os_bin_path: group.zksync_os_bin_path,
        }
    }
}

#[derive(Debug, Clone, clap::Args)]
#[group(id = "l1_group", multiple = false)]
pub struct L1Group {
    /// Enable L1 support and spawn L1 anvil node on the provided port (defaults to 8012).
    #[arg(long, conflicts_with = "external_l1", default_missing_value = "8012", num_args(0..=1), help_heading = "UNSTABLE - L1")]
    pub spawn_l1: Option<u16>,

    /// Enable L1 support and use provided address as L1 JSON-RPC endpoint.
    #[arg(long, conflicts_with = "spawn_l1", help_heading = "UNSTABLE - L1")]
    pub external_l1: Option<String>,
}

#[derive(Debug, Subcommand, Clone)]
pub enum Command {
    /// Starts a new empty local network.
    #[command(name = "run")]
    Run,
    /// Starts a local network that is a fork of another network.
    #[command(name = "fork")]
    Fork(ForkArgs),
    /// Starts a local network that is a fork of another network, and replays a given TX on it.
    #[command(name = "replay_tx")]
    ReplayTx(ReplayArgs),
    /// Fetches debug_traceTransaction for a TX and prints formatted traces (respects -v).
    #[command(name = "debug-trace")]
    DebugTrace(DebugTxArgs),
}

#[derive(Debug, Parser, Clone)]
pub struct ForkArgs {
    /// Whether to fork from existing network.
    /// If not set - will start a new network from genesis.
    /// If set - will try to fork a remote network. Possible values:
    /// Possible values:
    ///   • `era` / `mainnet`
    ///   • `era-testnet` / `sepolia-testnet`
    ///   • `abstract` / `abstract-testnet`
    ///   • `sophon` / `sophon-testnet`
    ///   • `cronos` / `cronos-testnet`
    ///   • `lens` / `lens-testnet`
    ///   • `openzk` / `openzk-testnet`
    ///   • `zkcandy`
    ///  - http://XXX:YY
    #[arg(
        long,
        alias = "network",
        value_enum,
        help = "Which network to fork (builtins) or an HTTP(S) URL"
    )]
    pub fork_url: ForkUrl,
    // Fork at a given L2 miniblock height.
    // If not set - will use the current finalized block from the network.
    #[arg(
        long,
        value_name = "BLOCK",
        long_help = "Fetch state from a specific block number over a remote endpoint.",
        alias = "fork-at"
    )]
    pub fork_block_number: Option<u64>,

    /// Fetch state from a specific transaction hash over a remote endpoint.
    ///
    /// See --fork-url.
    #[arg(
        long,
        requires = "fork_url",
        value_name = "TRANSACTION",
        conflicts_with = "fork_block_number"
    )]
    pub fork_transaction_hash: Option<H256>,
}

#[derive(Debug, Parser, Clone)]
pub struct ReplayArgs {
    /// Whether to fork from existing network.
    /// If not set - will start a new network from genesis.
    /// If set - will try to fork a remote network. Possible values:
    /// Possible values:
    ///   • `era` / `mainnet`
    ///   • `era-testnet` / `sepolia-testnet`
    ///   • `abstract` / `abstract-testnet`
    ///   • `sophon` / `sophon-testnet`
    ///   • `cronos` / `cronos-testnet`
    ///   • `lens` / `lens-testnet`
    ///   • `openzk` / `openzk-testnet`
    ///   • `zkcandy`
    ///   • custom HTTP(S) URL
    ///  - http://XXX:YY
    #[arg(
        long,
        alias = "network",
        value_enum,
        help = "Which network to fork (builtins) or an HTTP(S) URL"
    )]
    pub fork_url: ForkUrl,
    /// Transaction hash to replay.
    #[arg(help = "Transaction hash to replay.")]
    pub tx: H256,
}

#[derive(Debug, Parser, Clone)]
pub struct DebugTxArgs {
    #[arg(
        long,
        alias = "network",
        value_enum,
        help = "Which network to fork (builtins) or an HTTP(S) URL"
    )]
    pub fork_url: ForkUrl,

    /// Transaction hash to debug.
    pub tx: H256,

    /// Only top-level call from debug API (passes through to `only_top_call`).
    #[arg(long)]
    pub only_top: bool,
}

// Elastic Network ZK Chains
#[derive(Debug, Clone, ValueEnum)]
#[value(rename_all = "kebab-case")]
pub enum BuiltinNetwork {
    #[value(alias = "mainnet")]
    Era,
    #[value(alias = "sepolia-testnet")]
    EraTestnet,
    Abstract,
    AbstractTestnet,
    #[value(alias = "sophon-mainnet")]
    Sophon,
    SophonTestnet,
    Cronos,
    CronosTestnet,
    Lens,
    LensTestnet,
    Openzk,
    OpenzkTestnet,
    Zkcandy,
}

/// ForkUrl is used to specify the URL of the forked network.
#[derive(Debug, Clone)]
pub enum ForkUrl {
    Builtin(BuiltinNetwork),
    Custom(Url),
}

impl BuiltinNetwork {
    /// Converts the BuiltinNetwork to a ForkConfig.
    pub fn to_fork_config(&self) -> ForkConfig {
        match self {
            BuiltinNetwork::Era => ForkConfig {
                url: "https://mainnet.era.zksync.io".parse().unwrap(),
                estimate_gas_price_scale_factor: 1.5,
                estimate_gas_scale_factor: 1.3,
            },
            BuiltinNetwork::EraTestnet => ForkConfig {
                url: "https://sepolia.era.zksync.dev".parse().unwrap(),
                estimate_gas_price_scale_factor: 2.0,
                estimate_gas_scale_factor: 1.3,
            },
            BuiltinNetwork::Abstract => ForkConfig {
                url: "https://api.mainnet.abs.xyz".parse().unwrap(),
                estimate_gas_price_scale_factor: 1.5,
                estimate_gas_scale_factor: 1.3,
            },
            BuiltinNetwork::AbstractTestnet => ForkConfig {
                url: "https://api.testnet.abs.xyz".parse().unwrap(),
                estimate_gas_price_scale_factor: 1.5,
                estimate_gas_scale_factor: 1.3,
            },
            BuiltinNetwork::Sophon => ForkConfig {
                url: "https://rpc.sophon.xyz".parse().unwrap(),
                estimate_gas_price_scale_factor: 1.5,
                estimate_gas_scale_factor: 1.3,
            },
            BuiltinNetwork::SophonTestnet => ForkConfig {
                url: "https://rpc.testnet.sophon.xyz".parse().unwrap(),
                estimate_gas_price_scale_factor: 1.5,
                estimate_gas_scale_factor: 1.3,
            },
            BuiltinNetwork::Cronos => ForkConfig {
                url: "https://mainnet.zkevm.cronos.org".parse().unwrap(),
                estimate_gas_price_scale_factor: 1.5,
                estimate_gas_scale_factor: 1.3,
            },
            BuiltinNetwork::CronosTestnet => ForkConfig {
                url: "https://testnet.zkevm.cronos.org".parse().unwrap(),
                estimate_gas_price_scale_factor: 1.5,
                estimate_gas_scale_factor: 1.3,
            },
            BuiltinNetwork::Lens => ForkConfig {
                url: "https://rpc.lens.xyz".parse().unwrap(),
                estimate_gas_price_scale_factor: 1.5,
                estimate_gas_scale_factor: 1.3,
            },
            BuiltinNetwork::LensTestnet => ForkConfig {
                url: "https://rpc.testnet.lens.xyz".parse().unwrap(),
                estimate_gas_price_scale_factor: 1.5,
                estimate_gas_scale_factor: 1.3,
            },
            BuiltinNetwork::Openzk => ForkConfig {
                url: "https://rpc.openzk.net".parse().unwrap(),
                estimate_gas_price_scale_factor: 1.5,
                estimate_gas_scale_factor: 1.3,
            },
            BuiltinNetwork::OpenzkTestnet => ForkConfig {
                url: "https://openzk-testnet.rpc.caldera.xyz/http"
                    .parse()
                    .unwrap(),
                estimate_gas_price_scale_factor: 1.5,
                estimate_gas_scale_factor: 1.3,
            },
            BuiltinNetwork::Zkcandy => ForkConfig {
                url: "https://rpc.zkcandy.io".parse().unwrap(),
                estimate_gas_price_scale_factor: 1.5,
                estimate_gas_scale_factor: 1.3,
            },
        }
    }
}

impl ForkUrl {
    /// Converts the ForkUrl to a ForkConfig.
    pub fn to_config(&self) -> ForkConfig {
        match self {
            ForkUrl::Builtin(net) => net.to_fork_config(),
            ForkUrl::Custom(url) => ForkConfig::unknown(url.clone()),
        }
    }
}

impl FromStr for ForkUrl {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        if let Ok(net) = BuiltinNetwork::from_str(s, true) {
            return Ok(ForkUrl::Builtin(net));
        }
        Url::parse(s)
            .map(ForkUrl::Custom)
            .map_err(|e| format!("`{s}` is neither a known network nor a valid URL: {e}"))
    }
}

impl Cli {
    /// Checks for deprecated options and warns users.
    pub fn deprecated_config_option() {
        let args: Vec<String> = env::args().collect();

        let deprecated_flags: HashMap<&str, &str> = [
        ("--config",
            "⚠ The '--config' option has been removed. Please migrate to using other configuration options or defaults."),

        ("--show-calls",
            "⚠ The '--show-calls' option is deprecated. Use verbosity levels instead:\n\
             -vv  → Show user calls\n\
             -vvv → Show system calls"),

        ("--show-event-logs",
            "⚠ The '--show-event-logs' option is deprecated. Event logs are now included in traces by default.\n\
             Use verbosity levels instead:\n\
             -vv  → Show user calls\n\
             -vvv → Show system calls"),

        ("--resolve-hashes",
            "⚠ The '--resolve-hashes' option is deprecated. Automatic decoding of function and event selectors\n\
             using OpenChain is now enabled by default, unless running in offline mode.\n\
             If needed, disable it explicitly with `--offline`."),

        ("--show-outputs",
            "⚠ The '--show-outputs' option has been deprecated. Output logs are now included in traces by default."),

        ("--debug",
            "⚠ The '--debug' (or '-d') option is deprecated. Use verbosity levels instead:\n\
             -vv  → Show user calls\n\
             -vvv → Show system calls"),

        ("-d",
            "⚠ The '-d' option is deprecated. Use verbosity levels instead:\n\
             -vv  → Show user calls\n\
             -vvv → Show system calls"),
    ]
    .iter()
    .copied()
    .collect();

        // Prefix flags that may have values assigned (e.g., --show-calls=system)
        let prefix_flags = [
            "--config=",
            "--show-calls=",
            "--resolve-hashes=",
            "--show-outputs=",
            "--show-event-logs=",
        ];

        let mut detected = false;

        for arg in &args {
            if let Some(warning) = deprecated_flags.get(arg.as_str()) {
                if !detected {
                    sh_warn!("⚠ Deprecated CLI Options Detected (as of v0.4.0):\n");
                    sh_warn!("[Options below will be removed in v0.4.1]\n");
                    detected = true;
                }
                sh_warn!("{}", warning);
            } else if let Some(base_flag) =
                prefix_flags.iter().find(|&&prefix| arg.starts_with(prefix))
            {
                let warning = deprecated_flags
                    .get(base_flag.trim_end_matches("="))
                    .unwrap_or(&"⚠ Unknown deprecated option.");
                if !detected {
                    sh_warn!("⚠ Deprecated CLI Options Detected (as of v0.4.0):\n");
                    sh_warn!("[Options below will be removed in v0.4.1]\n");
                    detected = true;
                }
                sh_warn!("{}", warning);
            }
        }
    }

    /// Converts the CLI arguments to a `TestNodeConfig`.
    pub fn into_test_node_config(
        self,
    ) -> Result<TestNodeConfig, zksync_error::anvil_zksync::env::AnvilEnvironmentError> {
        // We keep a serialized version of the provided arguments to communicate them later if the arguments were incorrect.
        let debug_self_repr = format!("{self:#?}");

        let genesis_balance = U256::from(self.balance as u128 * 10u128.pow(18));
        let mut config = TestNodeConfig::default()
            .with_port(self.port)
            .with_offline(if self.offline { Some(true) } else { None })
            .with_l1_gas_price(self.l1_gas_price)
            .with_l2_gas_price(self.l2_gas_price)
            .with_l1_pubdata_price(self.l1_pubdata_price)
            .with_vm_log_detail(self.show_vm_details)
            .with_show_storage_logs(self.show_storage_logs)
            .with_show_gas_details(self.show_gas_details)
            .with_gas_limit_scale(self.limit_scale_factor)
            .with_price_scale(self.price_scale_factor)
            .with_verbosity_level(self.verbosity)
            .with_show_node_config(self.show_node_config)
            .with_silent(self.silent)
            .with_system_contracts(self.dev_system_contracts)
            .with_system_contracts_path(self.system_contracts_path.clone())
            .with_evm_emulator_path(self.evm_emulator_path.clone())
            .with_protocol_version(self.protocol_version)
            .with_override_bytecodes_dir(self.override_bytecodes_dir.clone())
            .with_enforce_bytecode_compression(self.enforce_bytecode_compression)
            .with_log_level(self.log)
            .with_log_file_path(self.log_file_path.clone())
            .with_account_generator(self.account_generator())
            .with_auto_impersonate(self.auto_impersonate)
            .with_genesis_balance(genesis_balance)
            .with_cache_dir(self.cache_dir.clone())
            .with_cache_config(self.cache.map(|cache_type| {
                match cache_type {
                    CacheType::None => CacheConfig::None,
                    CacheType::Memory => CacheConfig::Memory,
                    CacheType::Disk => CacheConfig::Disk {
                        dir: self
                            .cache_dir
                            .unwrap_or_else(|| DEFAULT_DISK_CACHE_DIR.to_string()),
                        reset: self.reset_cache.unwrap_or(false),
                    },
                }
            }))
            .with_genesis_timestamp(self.timestamp)
            .with_genesis(self.init)
            .with_chain_id(self.chain_id)
            .set_config_out(self.config_out)
            .with_host(self.host)
            .with_evm_interpreter(if self.evm_interpreter {
                Some(true)
            } else {
                None
            })
            .with_zksync_os(self.zksync_os_group.into())
            .with_health_check_endpoint(if self.health_check_endpoint {
                Some(true)
            } else {
                None
            })
            .with_block_time(self.block_time)
            .with_no_mining(self.no_mining)
            .with_allow_origin(self.allow_origin)
            .with_no_cors(self.no_cors)
            .with_transaction_order(self.order)
            .with_state(self.state)
            .with_state_interval(self.state_interval)
            .with_dump_state(self.dump_state)
            .with_preserve_historical_states(self.preserve_historical_states)
            .with_load_state(self.load_state)
            .with_l1_config(self.l1_group.and_then(|group| {
                group.spawn_l1.map(|port| L1Config::Spawn { port }).or(group
                    .external_l1
                    .map(|address| L1Config::External { address }))
            }))
            .with_auto_execute_l1(self.auto_execute_l1)
            .with_base_token_config({
                let ratio = self.base_token_ratio.unwrap_or(Ratio::ONE);
                BaseTokenConfig {
                    symbol: self.base_token_symbol.unwrap_or("ETH".to_string()),
                    ratio: BaseTokenConversionRatio::new_simple(ConversionRatio {
                        numerator: NonZeroU64::new(*ratio.numer())
                            .expect("base token conversion ratio cannot have 0 as numerator"),
                        denominator: NonZeroU64::new(*ratio.denom())
                            .expect("base token conversion ratio cannot have 0 as denominator"),
                    }),
                }
            });

        if self.evm_interpreter && config.protocol_version() < ProtocolVersionId::Version27 {
            return Err(zksync_error::anvil_zksync::env::InvalidArguments {
                details: "EVM interpreter requires protocol version 27 or higher".into(),
                arguments: debug_self_repr,
            });
        }

        if let Some(Command::DebugTrace(args)) = &self.command {
            let dt = DebugTraceConfig {
                fork_url: args.fork_url.to_config().url.to_string(),
                tx: args.tx,
                only_top: args.only_top,
            };
            config = config.with_debug_trace(Some(dt));
        }

        Ok(config)
    }

    /// Converts the CLI arguments to a `TelemetryProps` to be used as event props.
    pub fn into_telemetry_props(self) -> TelemetryProps {
        TelemetryProps::new()
            .insert("command", get_cli_command_telemetry_props(self.command))
            .insert_with("offline", self.offline, |v| v.then_some(v))
            .insert_with("health_check_endpoint", self.health_check_endpoint, |v| {
                v.then_some(v)
            })
            .insert_with("config_out", self.config_out, |v| {
                v.map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert_with("port", self.port, |v| {
                v.filter(|&p| p.to_string() != DEFAULT_PORT)
                    .map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert_with("host", &self.host, |v| {
                v.first()
                    .filter(|&h| h.to_string() != DEFAULT_HOST || self.host.len() != 1)
                    .map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert_with("chain_id", self.chain_id, |v| {
                v.map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert_with("show_node_config", self.show_node_config, |v| {
                (!v.unwrap_or(false)).then_some(false)
            })
            .insert(
                "show_storage_logs",
                self.show_storage_logs.map(|v| v.to_string()),
            )
            .insert(
                "show_vm_details",
                self.show_vm_details.map(|v| v.to_string()),
            )
            .insert(
                "show_gas_details",
                self.show_gas_details.map(|v| v.to_string()),
            )
            .insert(
                "l1_gas_price",
                self.l1_gas_price.map(serde_json::Number::from),
            )
            .insert(
                "l2_gas_price",
                self.l2_gas_price.map(serde_json::Number::from),
            )
            .insert(
                "l1_pubdata_price",
                self.l1_pubdata_price.map(serde_json::Number::from),
            )
            .insert(
                "price_scale_factor",
                self.price_scale_factor.map(|v| {
                    serde_json::Number::from_f64(v).unwrap_or(serde_json::Number::from(0))
                }),
            )
            .insert(
                "limit_scale_factor",
                self.limit_scale_factor.map(|v| {
                    serde_json::Number::from_f64(v as f64).unwrap_or(serde_json::Number::from(0))
                }),
            )
            .insert_with("override_bytecodes_dir", self.override_bytecodes_dir, |v| {
                v.map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert(
                "dev_system_contracts",
                self.dev_system_contracts.map(|v| format!("{v:?}")),
            )
            .insert(
                "protocol_version",
                self.protocol_version.map(|v| v.to_string()),
            )
            .insert_with("evm_interpreter", self.evm_interpreter, |v| v.then_some(v))
            .insert("log", self.log.map(|v| v.to_string()))
            .insert_with("log_file_path", self.log_file_path, |v| {
                v.map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert("silent", self.silent)
            .insert("cache", self.cache.map(|v| format!("{v:?}")))
            .insert("reset_cache", self.reset_cache)
            .insert_with("cache_dir", self.cache_dir, |v| {
                v.map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert_with("accounts", self.accounts, |v| {
                (v.to_string() != DEFAULT_ACCOUNTS).then_some(serde_json::Number::from(v))
            })
            .insert_with("balance", self.balance, |v| {
                (v.to_string() != DEFAULT_BALANCE).then_some(serde_json::Number::from(v))
            })
            .insert("timestamp", self.timestamp.map(serde_json::Number::from))
            .insert_with("init", self.init, |v| v.map(|_| TELEMETRY_SENSITIVE_VALUE))
            .insert_with("state", self.state, |v| {
                v.map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert(
                "state_interval",
                self.state_interval.map(serde_json::Number::from),
            )
            .insert_with("dump_state", self.dump_state, |v| {
                v.map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert_with(
                "preserve_historical_states",
                self.preserve_historical_states,
                |v| v.then_some(v),
            )
            .insert_with("load_state", self.load_state, |v| {
                v.map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert_with("mnemonic", self.mnemonic, |v| {
                v.map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert_with("mnemonic_random", self.mnemonic_random, |v| {
                v.map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert_with("mnemonic_seed", self.mnemonic_seed, |v| {
                v.map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert_with("derivation_path", self.derivation_path, |v| {
                v.map(|_| TELEMETRY_SENSITIVE_VALUE)
            })
            .insert_with("auto_impersonate", self.auto_impersonate, |v| {
                v.then_some(v)
            })
            .insert("block_time", self.block_time.map(|v| format!("{v:?}")))
            .insert_with("no_mining", self.no_mining, |v| v.then_some(v))
            .insert_with("allow_origin", self.allow_origin, |v| {
                (v != DEFAULT_ALLOW_ORIGIN).then_some(TELEMETRY_SENSITIVE_VALUE)
            })
            .insert_with("no_cors", self.no_cors, |v| v.then_some(v))
            .insert_with("order", self.order, |v| {
                (v.to_string() != DEFAULT_TX_ORDER).then_some(v.to_string())
            })
            .take()
    }

    fn account_generator(&self) -> AccountGenerator {
        let mut generator = AccountGenerator::new(self.accounts as usize)
            .phrase(DEFAULT_MNEMONIC)
            .chain_id(self.chain_id.unwrap_or(TEST_NODE_NETWORK_ID));
        if let Some(ref mnemonic) = self.mnemonic {
            generator = generator.phrase(mnemonic);
        } else if let Some(count) = self.mnemonic_random {
            let mut rng = rand::thread_rng();
            let mnemonic = match Mnemonic::<English>::new_with_count(&mut rng, count) {
                Ok(mnemonic) => mnemonic.to_phrase(),
                Err(_) => DEFAULT_MNEMONIC.to_string(),
            };
            generator = generator.phrase(mnemonic);
        } else if let Some(seed) = self.mnemonic_seed {
            let mut seed = StdRng::seed_from_u64(seed);
            let mnemonic = Mnemonic::<English>::new(&mut seed).to_phrase();
            generator = generator.phrase(mnemonic);
        }
        if let Some(ref derivation) = self.derivation_path {
            generator = generator.derivation_path(derivation);
        }
        generator
    }
}

fn duration_from_secs_f64(s: &str) -> Result<Duration, String> {
    let s = s.parse::<f64>().map_err(|e| e.to_string())?;
    if s == 0.0 {
        return Err("Duration must be greater than 0".to_string());
    }
    Duration::try_from_secs_f64(s).map_err(|e| e.to_string())
}

fn protocol_version_from_str(s: &str) -> anyhow::Result<ProtocolVersionId> {
    let version = s.parse::<u16>()?;
    Ok(ProtocolVersionId::try_from(version)?)
}

// Implementation adapted from: https://github.com/foundry-rs/foundry/blob/206dab285437bd6889463ab006b6a5fb984079d8/crates/anvil/src/cmd.rs#L606
/// Helper type to periodically dump the state of the chain to disk
pub struct PeriodicStateDumper {
    in_progress_dump: Option<Pin<Box<dyn Future<Output = ()> + Send + Sync + 'static>>>,
    node: InMemoryNode,
    dump_state: Option<PathBuf>,
    preserve_historical_states: bool,
    interval: Interval,
}

impl PeriodicStateDumper {
    pub fn new(
        node: InMemoryNode,
        dump_state: Option<PathBuf>,
        interval: Duration,
        preserve_historical_states: bool,
    ) -> Self {
        let dump_state = dump_state.map(|mut dump_state| {
            if dump_state.is_dir() {
                dump_state = dump_state.join("state.json");
            }
            dump_state
        });

        let interval = tokio::time::interval_at(Instant::now() + interval, interval);
        Self {
            in_progress_dump: None,
            node,
            dump_state,
            preserve_historical_states,
            interval,
        }
    }

    #[allow(dead_code)] // TODO: Remove this once the method is used
    pub async fn dump(&self) {
        if let Some(state) = self.dump_state.clone() {
            Self::dump_state(self.node.clone(), state, self.preserve_historical_states).await
        }
    }

    /// Infallible state dump
    async fn dump_state(node: InMemoryNode, dump_path: PathBuf, preserve_historical_states: bool) {
        tracing::trace!(path=?dump_path, "Dumping state");

        // Spawn a blocking task for state dumping
        let state_bytes = match node.dump_state(preserve_historical_states).await {
            Ok(bytes) => bytes,
            Err(err) => {
                sh_err!("Failed to dump state: {:?}", err);
                return;
            }
        };

        let mut decoder = GzDecoder::new(&state_bytes.0[..]);
        let mut json_str = String::new();
        if let Err(err) = decoder.read_to_string(&mut json_str) {
            sh_err!("Failed to decompress state bytes: {}", err);
            return;
        }

        let state = match serde_json::from_str::<VersionedState>(&json_str) {
            Ok(state) => state,
            Err(err) => {
                sh_err!("Failed to parse state JSON: {}", err);
                return;
            }
        };

        if let Err(err) = write_json_file(&dump_path, &state) {
            sh_err!("Failed to write state to file: {}", err);
        } else {
            tracing::trace!(path = ?dump_path, "Dumped state successfully");
        }
    }
}

// An endless future that periodically dumps the state to disk if configured.
// Implementation adapted from: https://github.com/foundry-rs/foundry/blob/206dab285437bd6889463ab006b6a5fb984079d8/crates/anvil/src/cmd.rs#L658
impl Future for PeriodicStateDumper {
    type Output = anyhow::Result<()>;

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        let this = self.get_mut();
        if this.dump_state.is_none() {
            return Poll::Pending;
        }

        loop {
            if let Some(mut flush) = this.in_progress_dump.take() {
                match flush.poll_unpin(cx) {
                    Poll::Ready(_) => {
                        this.interval.reset();
                    }
                    Poll::Pending => {
                        this.in_progress_dump = Some(flush);
                        return Poll::Pending;
                    }
                }
            }

            if this.interval.poll_tick(cx).is_ready() {
                let api = this.node.clone();
                let path = this.dump_state.clone().expect("exists; see above");
                this.in_progress_dump = Some(Box::pin(Self::dump_state(
                    api,
                    path,
                    this.preserve_historical_states,
                )));
            } else {
                break;
            }
        }

        Poll::Pending
    }
}

#[cfg(test)]
mod tests {
    use crate::cli::PeriodicStateDumper;

    use super::Cli;
    use anvil_zksync_core::node::InMemoryNode;
    use clap::Parser;
    use serde_json::{Value, json};
    use std::{
        env,
        net::{IpAddr, Ipv4Addr},
    };
    use zksync_types::{H160, U256};

    #[test]
    fn can_parse_host() {
        // Test adapted from https://github.com/foundry-rs/foundry/blob/398ef4a3d55d8dd769ce86cada5ec845e805188b/crates/anvil/src/cmd.rs#L895
        let args = Cli::parse_from(["anvil-zksync"]);
        assert_eq!(args.host, vec![IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0))]);

        let args = Cli::parse_from([
            "anvil-zksync",
            "--host",
            "::1",
            "--host",
            "1.1.1.1",
            "--host",
            "2.2.2.2",
        ]);
        assert_eq!(
            args.host,
            ["::1", "1.1.1.1", "2.2.2.2"]
                .map(|ip| ip.parse::<IpAddr>().unwrap())
                .to_vec()
        );

        let args = Cli::parse_from(["anvil-zksync", "--host", "::1,1.1.1.1,2.2.2.2"]);
        assert_eq!(
            args.host,
            ["::1", "1.1.1.1", "2.2.2.2"]
                .map(|ip| ip.parse::<IpAddr>().unwrap())
                .to_vec()
        );

        unsafe {
            env::set_var("ANVIL_ZKSYNC_IP_ADDR", "1.1.1.1");
        }
        let args = Cli::parse_from(["anvil-zksync"]);
        assert_eq!(args.host, vec!["1.1.1.1".parse::<IpAddr>().unwrap()]);

        unsafe {
            env::set_var("ANVIL_ZKSYNC_IP_ADDR", "::1,1.1.1.1,2.2.2.2");
        }
        let args = Cli::parse_from(["anvil-zksync"]);
        assert_eq!(
            args.host,
            ["::1", "1.1.1.1", "2.2.2.2"]
                .map(|ip| ip.parse::<IpAddr>().unwrap())
                .to_vec()
        );
    }

    #[tokio::test]
    async fn test_dump_state() -> anyhow::Result<()> {
        let temp_dir = tempfile::Builder::new()
            .prefix("state-test")
            .tempdir()
            .expect("failed creating temporary dir");
        let dump_path = temp_dir.path().join("state.json");

        let config = anvil_zksync_config::TestNodeConfig {
            dump_state: Some(dump_path.clone()),
            state_interval: Some(1),
            preserve_historical_states: true,
            ..Default::default()
        };

        let node = InMemoryNode::test_config(None, config.clone());

        let mut state_dumper = PeriodicStateDumper::new(
            node.clone(),
            config.dump_state.clone(),
            std::time::Duration::from_secs(1),
            config.preserve_historical_states,
        );

        // Spawn the state dumper as a task:
        let dumper_handle = tokio::spawn(async move {
            tokio::select! {
                _ = &mut state_dumper => {}
            }
            state_dumper.dump().await;
        });
        tokio::time::sleep(std::time::Duration::from_secs(2)).await;

        dumper_handle.abort();
        let _ = dumper_handle.await;

        let dumped_data =
            std::fs::read_to_string(&dump_path).expect("Expected state file to be created");
        let _: Value =
            serde_json::from_str(&dumped_data).expect("Failed to parse dumped state as JSON");

        Ok(())
    }

    #[tokio::test]
    async fn test_load_state() -> anyhow::Result<()> {
        let temp_dir = tempfile::Builder::new()
            .prefix("state-load-test")
            .tempdir()
            .expect("failed creating temporary dir");
        let state_path = temp_dir.path().join("state.json");

        let config = anvil_zksync_config::TestNodeConfig {
            dump_state: Some(state_path.clone()),
            state_interval: Some(1),
            preserve_historical_states: true,
            ..Default::default()
        };

        let node = InMemoryNode::test_config(None, config.clone());
        let test_address = H160::from_low_u64_be(12345);
        node.set_rich_account(test_address, U256::from(1000000u64))
            .await;

        let mut state_dumper = PeriodicStateDumper::new(
            node.clone(),
            config.dump_state.clone(),
            std::time::Duration::from_secs(1),
            config.preserve_historical_states,
        );

        let dumper_handle = tokio::spawn(async move {
            tokio::select! {
                _ = &mut state_dumper => {}
            }
            state_dumper.dump().await;
        });

        tokio::time::sleep(std::time::Duration::from_secs(2)).await;

        dumper_handle.abort();
        let _ = dumper_handle.await;

        // assert the state json file was created
        std::fs::read_to_string(&state_path).expect("Expected state file to be created");

        let new_config = anvil_zksync_config::TestNodeConfig::default();
        let new_node = InMemoryNode::test_config(None, new_config.clone());

        new_node
            .load_state(zksync_types::web3::Bytes(std::fs::read(&state_path)?))
            .await?;

        // assert the balance from the loaded state is correctly applied
        let balance = new_node.get_balance_impl(test_address, None).await?;
        assert_eq!(balance, U256::from(1000000u64));

        Ok(())
    }

    #[tokio::test]
    async fn test_cli_telemetry_data_skips_missing_args() -> anyhow::Result<()> {
        let args = Cli::parse_from(["anvil-zksync"]).into_telemetry_props();
        let json = args.to_inner();
        let expected_json: serde_json::Value = json!({});
        assert_eq!(json, expected_json);
        Ok(())
    }

    #[tokio::test]
    async fn test_cli_telemetry_data_hides_sensitive_data() -> anyhow::Result<()> {
        let args = Cli::parse_from([
            "anvil-zksync",
            "--offline",
            "--host",
            "100.100.100.100",
            "--port",
            "3333",
            "--chain-id",
            "123",
            "--config-out",
            "/some/path",
            "fork",
            "--fork-url",
            "era",
        ])
        .into_telemetry_props();
        let json = args.to_inner();
        let expected_json: serde_json::Value = json!({
            "command": {
                "args": {
                    "fork_url": "Builtin(Era)"
                },
                "name": "fork"
            },
            "offline": true,
            "config_out": "***",
            "port": "***",
            "host": "***",
            "chain_id": "***"
        });
        assert_eq!(json, expected_json);
        Ok(())
    }
}