feat: cast storage --solc-version CLI argument (#11321)

* feat: storage solc version option

* feat(cast): add storage solc version unwrapping test

* feat(cast): add valid and invalid solc versions for cast storage tests

* feat(cast): collapse if statement

* chore: format

* feat(cast): warn if provided version is less than min solc

* feat(cast): test for min solc version warning on provided storage solc version

---------

Co-authored-by: grandizzy <[email protected]>
Co-authored-by: onbjerg <[email protected]>

Author: 3 people

crates/cast/src/cmd/storage.rs

@@ -73,6 +73,10 @@ pub struct StorageArgs {
 
     #[command(flatten)]
     build: BuildOpts,
+
+    /// Specify the solc version to compile with. Overrides detected version.
+    #[arg(long, value_parser = Version::parse)]
+    solc_version: Option<Version>,
 }
 
 impl_figment_convert_cast!(StorageArgs);
@@ -169,16 +173,24 @@ impl StorageArgs {
         let mut project = etherscan_project(metadata, root_path)?;
         add_storage_layout_output(&mut project);
 
-        let mut version = metadata.compiler_version()?;
+        // Decide on compiler to use (user override -> metadata -> autodetect)
+        let meta_version = metadata.compiler_version()?;
         let mut auto_detect = false;
-        if let Some(solcc) = project.compiler.solc.as_mut()
-            && let SolcCompiler::Specific(solc) = solcc
-            && solc.version < MIN_SOLC
-        {
-            version = solc.version.clone();
-            *solcc = SolcCompiler::AutoDetect;
+        let desired = if let Some(user_version) = self.solc_version {
+            if user_version < MIN_SOLC {
+                sh_warn!(
+                    "The provided --solc-version is {user_version} while the minimum version for \
+                     storage layouts is {MIN_SOLC} and as a result the output may be empty."
+                )?;
+            }
+            SolcCompiler::Specific(Solc::find_or_install(&user_version)?)
+        } else if meta_version < MIN_SOLC {
             auto_detect = true;
-        }
+            SolcCompiler::AutoDetect
+        } else {
+            SolcCompiler::Specific(Solc::find_or_install(&meta_version)?)
+        };
+        project.compiler.solc = Some(desired);
 
         // Compile
         let mut out = ProjectCompiler::new().quiet(true).compile(&project)?;
@@ -191,7 +203,7 @@ impl StorageArgs {
             if auto_detect && is_storage_layout_empty(&artifact.storage_layout) {
                 // try recompiling with the minimum version
                 sh_warn!(
-                    "The requested contract was compiled with {version} while the minimum version \
+                    "The requested contract was compiled with {meta_version} while the minimum version \
                      for storage layouts is {MIN_SOLC} and as a result the output may be empty.",
                 )?;
                 let solc = Solc::find_or_install(&MIN_SOLC)?;
@@ -392,4 +404,10 @@ mod tests {
         let key = config.get_etherscan_api_key(None).unwrap();
         assert_eq!(key, "dummykey".to_string());
     }
+
+    #[test]
+    fn parse_solc_version_arg() {
+        let args = StorageArgs::parse_from(["foundry-cli", "addr.eth", "--solc-version", "0.8.10"]);
+        assert_eq!(args.solc_version, Some(Version::parse("0.8.10").unwrap()));
+    }
 }

crates/cast/tests/cli/main.rs

@@ -1939,6 +1939,77 @@ casttest!(storage, |_prj, cmd| {
 "#]]);
 });
 
+casttest!(storage_with_valid_solc_version_1, |_prj, cmd| {
+    cmd.args([
+        "storage",
+        "0x13b0D85CcB8bf860b6b79AF3029fCA081AE9beF2",
+        "--solc-version",
+        "0.8.10",
+        "--rpc-url",
+        next_http_archive_rpc_url().as_str(),
+        "--etherscan-api-key",
+        next_etherscan_api_key().as_str(),
+    ])
+    .assert_success();
+});
+
+casttest!(storage_with_valid_solc_version_2, |_prj, cmd| {
+    cmd.args([
+        "storage",
+        "0x13b0D85CcB8bf860b6b79AF3029fCA081AE9beF2",
+        "--solc-version",
+        "0.8.23",
+        "--rpc-url",
+        next_http_archive_rpc_url().as_str(),
+        "--etherscan-api-key",
+        next_etherscan_api_key().as_str(),
+    ])
+    .assert_success();
+});
+
+casttest!(storage_with_invalid_solc_version_1, |_prj, cmd| {
+    let output = cmd
+        .args([
+            "storage",
+            "0x13b0D85CcB8bf860b6b79AF3029fCA081AE9beF2",
+            "--solc-version",
+            "0.4.0",
+            "--rpc-url",
+            next_http_archive_rpc_url().as_str(),
+            "--etherscan-api-key",
+            next_etherscan_api_key().as_str(),
+        ])
+        .assert_failure()
+        .get_output()
+        .stderr
+        .clone();
+    let stderr = String::from_utf8_lossy(&output);
+    assert!(
+        stderr.contains(
+            "Warning: The provided --solc-version is 0.4.0 while the minimum version for storage layouts is 0.6.5"
+        ),
+        "stderr did not contain expected warning. Full stderr:\n{stderr}"
+    );
+});
+
+casttest!(storage_with_invalid_solc_version_2, |_prj, cmd| {
+    cmd.args([
+        "storage",
+        "0x13b0D85CcB8bf860b6b79AF3029fCA081AE9beF2",
+        "--solc-version",
+        "0.8.2",
+        "--rpc-url",
+        next_http_archive_rpc_url().as_str(),
+        "--etherscan-api-key",
+        next_etherscan_api_key().as_str(),
+    ])
+    .assert_failure()
+    .stderr_eq(str![[r#"
+Error: Encountered invalid solc version in contracts/Create2Deployer.sol: No solc version exists that matches the version requirement: ^0.8.9
+
+"#]]);
+});
+
 // <https://github.com/foundry-rs/foundry/issues/6319>
 casttest!(storage_layout_simple, |_prj, cmd| {
     cmd.args([