feat: Etherscan V2 support (#10440)

* Adding support to etherscanv2

* clippy+fmt

* Adding default for v2 and updating configuration to parse etherscan api version from config

* Updating api_version to use new variable and fix merge

* Use block explorer rev, fix fmt

* fix api version parsing

* fix fmt

* Simplify Etherscan provider option, default v2

* Use released version

* Updates, fix script --verify

* Clone api version, cast

* Cast fixes

* Tests nits

* configs for verify check

* Simplify, use EtherscanApiVersion enum

---------

Co-authored-by: Iain Nash <[email protected]>

Author: grandizzy

Cargo.lock

@@ -188,7 +188,7 @@ foundry-wallets = { path = "crates/wallets" }
 foundry-linking = { path = "crates/linking" }
 
 # solc & compilation utilities
-foundry-block-explorers = { version = "0.13.0", default-features = false }
+foundry-block-explorers = { version = "0.13.3", default-features = false }
 foundry-compilers = { version = "0.14.0", default-features = false }
 foundry-fork-db = "0.12"
 solang-parser = "=0.3.3"

Cargo.toml

@@ -1324,6 +1324,7 @@ async fn test_fork_execution_reverted() {
 
 // <https://github.com/foundry-rs/foundry/issues/8227>
 #[tokio::test(flavor = "multi_thread")]
+#[ignore]
 async fn test_immutable_fork_transaction_hash() {
     use std::str::FromStr;
 

crates/anvil/tests/it/fork.rs

@@ -1,12 +1,11 @@
 use super::{
-    creation_code::{fetch_creation_code, parse_code_output},
+    creation_code::{fetch_creation_code_from_etherscan, parse_code_output},
     interface::{fetch_abi_from_etherscan, load_abi_from_file},
 };
 use alloy_primitives::Address;
 use alloy_provider::Provider;
 use clap::{command, Parser};
 use eyre::Result;
-use foundry_block_explorers::Client;
 use foundry_cli::{
     opts::{EtherscanOpts, RpcOpts},
     utils::{self, LoadConfig},
@@ -46,15 +45,12 @@ pub struct ArtifactArgs {
 
 impl ArtifactArgs {
     pub async fn run(self) -> Result<()> {
-        let Self { contract, etherscan, rpc, output: output_location, abi_path } = self;
+        let Self { contract, mut etherscan, rpc, output: output_location, abi_path } = self;
 
-        let mut etherscan = etherscan;
         let config = rpc.load_config()?;
         let provider = utils::get_provider(&config)?;
-        let api_key = etherscan.key().unwrap_or_default();
         let chain = provider.get_chain_id().await?;
         etherscan.chain = Some(chain.into());
-        let client = Client::new(chain.into(), api_key)?;
 
         let abi = if let Some(ref abi_path) = abi_path {
             load_abi_from_file(abi_path, None)?
@@ -64,7 +60,7 @@ impl ArtifactArgs {
 
         let (abi, _) = abi.first().ok_or_else(|| eyre::eyre!("No ABI found"))?;
 
-        let bytecode = fetch_creation_code(contract, client, provider).await?;
+        let bytecode = fetch_creation_code_from_etherscan(contract, &etherscan, provider).await?;
         let bytecode =
             parse_code_output(bytecode, contract, &etherscan, abi_path.as_deref(), true, false)
                 .await?;

crates/cast/src/cmd/artifact.rs

@@ -1,13 +1,12 @@
 use super::{
-    creation_code::fetch_creation_code,
+    creation_code::fetch_creation_code_from_etherscan,
     interface::{fetch_abi_from_etherscan, load_abi_from_file},
 };
 use alloy_dyn_abi::DynSolType;
 use alloy_primitives::{Address, Bytes};
 use alloy_provider::Provider;
 use clap::{command, Parser};
 use eyre::{eyre, OptionExt, Result};
-use foundry_block_explorers::Client;
 use foundry_cli::{
     opts::{EtherscanOpts, RpcOpts},
     utils::{self, LoadConfig},
@@ -37,12 +36,10 @@ impl ConstructorArgsArgs {
 
         let config = rpc.load_config()?;
         let provider = utils::get_provider(&config)?;
-        let api_key = etherscan.key().unwrap_or_default();
         let chain = provider.get_chain_id().await?;
         etherscan.chain = Some(chain.into());
-        let client = Client::new(chain.into(), api_key)?;
 
-        let bytecode = fetch_creation_code(contract, client, provider).await?;
+        let bytecode = fetch_creation_code_from_etherscan(contract, &etherscan, provider).await?;
 
         let args_arr = parse_constructor_args(bytecode, contract, &etherscan, abi_path).await?;
         for arg in args_arr {

crates/cast/src/cmd/constructor_args.rs

@@ -50,12 +50,10 @@ impl CreationCodeArgs {
 
         let config = rpc.load_config()?;
         let provider = utils::get_provider(&config)?;
-        let api_key = etherscan.key().unwrap_or_default();
         let chain = provider.get_chain_id().await?;
         etherscan.chain = Some(chain.into());
-        let client = Client::new(chain.into(), api_key)?;
 
-        let bytecode = fetch_creation_code(contract, client, provider).await?;
+        let bytecode = fetch_creation_code_from_etherscan(contract, &etherscan, provider).await?;
 
         let bytecode = parse_code_output(
             bytecode,
@@ -131,11 +129,16 @@ pub async fn parse_code_output(
 }
 
 /// Fetches the creation code of a contract from Etherscan and RPC.
-pub async fn fetch_creation_code(
+pub async fn fetch_creation_code_from_etherscan(
     contract: Address,
-    client: Client,
+    etherscan: &EtherscanOpts,
     provider: RetryProvider,
 ) -> Result<Bytes> {
+    let config = etherscan.load_config()?;
+    let chain = config.chain.unwrap_or_default();
+    let api_version = config.get_etherscan_api_version(Some(chain));
+    let api_key = config.get_etherscan_api_key(Some(chain)).unwrap_or_default();
+    let client = Client::new_with_api_version(chain, api_key, api_version)?;
     let creation_data = client.contract_creation_data(contract).await?;
     let creation_tx_hash = creation_data.transaction_hash;
     let tx_data = provider.get_transaction_by_hash(creation_tx_hash).await?;

crates/cast/src/cmd/creation_code.rs

@@ -143,8 +143,9 @@ pub async fn fetch_abi_from_etherscan(
 ) -> Result<Vec<(JsonAbi, String)>> {
     let config = etherscan.load_config()?;
     let chain = config.chain.unwrap_or_default();
+    let api_version = config.get_etherscan_api_version(Some(chain));
     let api_key = config.get_etherscan_api_key(Some(chain)).unwrap_or_default();
-    let client = Client::new(chain, api_key)?;
+    let client = Client::new_with_api_version(chain, api_key, api_version)?;
     let source = client.contract_source_code(address).await?;
     source.items.into_iter().map(|item| Ok((item.abi()?, item.contract_name))).collect()
 }

crates/cast/src/cmd/interface.rs

@@ -299,6 +299,10 @@ impl figment::Provider for RunArgs {
             map.insert("etherscan_api_key".into(), api_key.as_str().into());
         }
 
+        if let Some(api_version) = &self.etherscan.api_version {
+            map.insert("etherscan_api_version".into(), api_version.to_string().into());
+        }
+
         if let Some(evm_version) = self.evm_version {
             map.insert("evm_version".into(), figment::value::Value::serialize(evm_version)?);
         }

crates/cast/src/cmd/run.rs

@@ -135,8 +135,9 @@ impl StorageArgs {
         }
 
         let chain = utils::get_chain(config.chain, &provider).await?;
+        let api_version = config.get_etherscan_api_version(Some(chain));
         let api_key = config.get_etherscan_api_key(Some(chain)).unwrap_or_default();
-        let client = Client::new(chain, api_key)?;
+        let client = Client::new_with_api_version(chain, api_key, api_version)?;
         let source = if let Some(proxy) = self.proxy {
             find_source(client, proxy.resolve(&provider).await?).await?
         } else {

crates/cast/src/cmd/storage.rs

@@ -13,6 +13,7 @@ use alloy_serde::WithOtherFields;
 use alloy_signer::Signer;
 use alloy_transport::TransportError;
 use eyre::Result;
+use foundry_block_explorers::EtherscanApiVersion;
 use foundry_cli::{
     opts::{CliAuthorizationList, TransactionOpts},
     utils::{self, parse_function_args},
@@ -141,6 +142,7 @@ pub struct CastTxBuilder<P, S> {
     auth: Option<CliAuthorizationList>,
     chain: Chain,
     etherscan_api_key: Option<String>,
+    etherscan_api_version: EtherscanApiVersion,
     access_list: Option<Option<AccessList>>,
     state: S,
 }
@@ -152,6 +154,7 @@ impl<P: Provider<AnyNetwork>> CastTxBuilder<P, InitState> {
         let mut tx = WithOtherFields::<TransactionRequest>::default();
 
         let chain = utils::get_chain(config.chain, &provider).await?;
+        let etherscan_api_version = config.get_etherscan_api_version(Some(chain));
         let etherscan_api_key = config.get_etherscan_api_key(Some(chain));
         let legacy = tx_opts.legacy || chain.is_legacy();
 
@@ -192,6 +195,7 @@ impl<P: Provider<AnyNetwork>> CastTxBuilder<P, InitState> {
             blob: tx_opts.blob,
             chain,
             etherscan_api_key,
+            etherscan_api_version,
             auth: tx_opts.auth,
             access_list: tx_opts.access_list,
             state: InitState,
@@ -208,6 +212,7 @@ impl<P: Provider<AnyNetwork>> CastTxBuilder<P, InitState> {
             blob: self.blob,
             chain: self.chain,
             etherscan_api_key: self.etherscan_api_key,
+            etherscan_api_version: self.etherscan_api_version,
             auth: self.auth,
             access_list: self.access_list,
             state: ToState { to },
@@ -233,6 +238,7 @@ impl<P: Provider<AnyNetwork>> CastTxBuilder<P, ToState> {
                 self.chain,
                 &self.provider,
                 self.etherscan_api_key.as_deref(),
+                self.etherscan_api_version,
             )
             .await?
         } else {
@@ -264,6 +270,7 @@ impl<P: Provider<AnyNetwork>> CastTxBuilder<P, ToState> {
             blob: self.blob,
             chain: self.chain,
             etherscan_api_key: self.etherscan_api_key,
+            etherscan_api_version: self.etherscan_api_version,
             auth: self.auth,
             access_list: self.access_list,
             state: InputState { kind: self.state.to.into(), input, func },

crates/cast/src/tx.rs

@@ -9,7 +9,7 @@ use anvil::{EthereumHardfork, NodeConfig};
 use foundry_test_utils::{
     rpc::{
         next_etherscan_api_key, next_http_archive_rpc_url, next_http_rpc_endpoint,
-        next_mainnet_etherscan_api_key, next_rpc_endpoint, next_ws_rpc_endpoint,
+        next_rpc_endpoint, next_ws_rpc_endpoint,
     },
     str,
     util::OutputExt,
@@ -1378,7 +1378,7 @@ casttest!(storage_layout_simple, |_prj, cmd| {
         "--block",
         "21034138",
         "--etherscan-api-key",
-        next_mainnet_etherscan_api_key().as_str(),
+        next_etherscan_api_key().as_str(),
         "0x13b0D85CcB8bf860b6b79AF3029fCA081AE9beF2",
     ])
     .assert_success()
@@ -1405,7 +1405,7 @@ casttest!(storage_layout_simple_json, |_prj, cmd| {
         "--block",
         "21034138",
         "--etherscan-api-key",
-        next_mainnet_etherscan_api_key().as_str(),
+        next_etherscan_api_key().as_str(),
         "0x13b0D85CcB8bf860b6b79AF3029fCA081AE9beF2",
         "--json",
     ])
@@ -1422,7 +1422,7 @@ casttest!(storage_layout_complex, |_prj, cmd| {
         "--block",
         "21034138",
         "--etherscan-api-key",
-        next_mainnet_etherscan_api_key().as_str(),
+        next_etherscan_api_key().as_str(),
         "0xBA12222222228d8Ba445958a75a0704d566BF2C8",
     ])
     .assert_success()
@@ -1470,7 +1470,7 @@ casttest!(storage_layout_complex_proxy, |_prj, cmd| {
         "--block",
         "7857852",
         "--etherscan-api-key",
-        next_mainnet_etherscan_api_key().as_str(),
+        next_etherscan_api_key().as_str(),
         "0xE2588A9CAb7Ea877206E35f615a39f84a64A7A3b",
         "--proxy",
         "0x29fcb43b46531bca003ddc8fcb67ffe91900c762"
@@ -1512,7 +1512,7 @@ casttest!(storage_layout_complex_json, |_prj, cmd| {
         "--block",
         "21034138",
         "--etherscan-api-key",
-        next_mainnet_etherscan_api_key().as_str(),
+        next_etherscan_api_key().as_str(),
         "0xBA12222222228d8Ba445958a75a0704d566BF2C8",
         "--json",
     ])
@@ -1601,7 +1601,7 @@ casttest!(fetch_weth_interface_from_etherscan, |_prj, cmd| {
     cmd.args([
         "interface",
         "--etherscan-api-key",
-        &next_mainnet_etherscan_api_key(),
+        &next_etherscan_api_key(),
         "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
     ])
     .assert_success()
@@ -1880,7 +1880,7 @@ casttest!(fetch_creation_code_from_etherscan, |_prj, cmd| {
     cmd.args([
         "creation-code",
         "--etherscan-api-key",
-        &next_mainnet_etherscan_api_key(),
+        &next_etherscan_api_key(),
         "0x0923cad07f06b2d0e5e49e63b8b35738d4156b95",
         "--rpc-url",
         eth_rpc_url.as_str(),
@@ -1899,7 +1899,7 @@ casttest!(fetch_creation_code_only_args_from_etherscan, |_prj, cmd| {
     cmd.args([
         "creation-code",
         "--etherscan-api-key",
-        &next_mainnet_etherscan_api_key(),
+        &next_etherscan_api_key(),
         "0x6982508145454ce325ddbe47a25d4ec3d2311933",
         "--rpc-url",
         eth_rpc_url.as_str(),
@@ -1919,7 +1919,7 @@ casttest!(fetch_constructor_args_from_etherscan, |_prj, cmd| {
     cmd.args([
         "constructor-args",
         "--etherscan-api-key",
-        &next_mainnet_etherscan_api_key(),
+        &next_etherscan_api_key(),
         "0x6982508145454ce325ddbe47a25d4ec3d2311933",
         "--rpc-url",
         eth_rpc_url.as_str(),
@@ -1940,7 +1940,7 @@ casttest!(test_non_mainnet_traces, |prj, cmd| {
         "--rpc-url",
         next_rpc_endpoint(NamedChain::Optimism).as_str(),
         "--etherscan-api-key",
-        next_etherscan_api_key(NamedChain::Optimism).as_str(),
+        next_etherscan_api_key().as_str(),
     ])
     .assert_success()
     .stdout_eq(str![[r#"
@@ -1963,7 +1963,7 @@ casttest!(fetch_artifact_from_etherscan, |_prj, cmd| {
     cmd.args([
         "artifact",
         "--etherscan-api-key",
-        &next_mainnet_etherscan_api_key(),
+        &next_etherscan_api_key(),
         "0x0923cad07f06b2d0e5e49e63b8b35738d4156b95",
         "--rpc-url",
         eth_rpc_url.as_str(),
@@ -2444,7 +2444,7 @@ contract WETH9 {
 
 casttest!(fetch_src_default, |_prj, cmd| {
     let weth = address!("0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2");
-    let etherscan_api_key = next_mainnet_etherscan_api_key();
+    let etherscan_api_key = next_etherscan_api_key();
 
     cmd.args(["source", &weth.to_string(), "--flatten", "--etherscan-api-key", &etherscan_api_key])
         .assert_success()

crates/cast/tests/cli/main.rs

@@ -21,6 +21,7 @@ foundry-evm.workspace = true
 foundry-wallets.workspace = true
 
 foundry-compilers = { workspace = true, features = ["full"] }
+foundry-block-explorers.workspace = true
 
 alloy-eips.workspace = true
 alloy-dyn-abi.workspace = true

crates/cli/Cargo.toml

@@ -2,6 +2,7 @@ use crate::opts::ChainValueParser;
 use alloy_chains::ChainKind;
 use clap::Parser;
 use eyre::Result;
+use foundry_block_explorers::EtherscanApiVersion;
 use foundry_config::{
     figment::{
         self,
@@ -114,6 +115,16 @@ pub struct EtherscanOpts {
     #[serde(rename = "etherscan_api_key", skip_serializing_if = "Option::is_none")]
     pub key: Option<String>,
 
+    /// The Etherscan API version.
+    #[arg(
+        short,
+        long = "etherscan-api-version",
+        alias = "api-version",
+        env = "ETHERSCAN_API_VERSION"
+    )]
+    #[serde(rename = "etherscan_api_version", skip_serializing_if = "Option::is_none")]
+    pub api_version: Option<EtherscanApiVersion>,
+
     /// The chain name or EIP-155 chain ID.
     #[arg(
         short,
@@ -154,6 +165,11 @@ impl EtherscanOpts {
         if let Some(key) = self.key() {
             dict.insert("etherscan_api_key".into(), key.into());
         }
+
+        if let Some(api_version) = &self.api_version {
+            dict.insert("etherscan_api_version".into(), api_version.to_string().into());
+        }
+
         if let Some(chain) = self.chain {
             if let ChainKind::Id(id) = chain.kind() {
                 dict.insert("chain_id".into(), (*id).into());