feat(cheatcodes): getArtifactPathByCode and `getArtifactPathByDep…

…loyedCode` (#8938)

* feat(`cheatcodes`): vm.getArtifactPath

* cargo cheats

* nit

* nit

* fix

* test: vm.getArtifactPath

* feat: vm.getArtifactPath(creationCode)

* cheats

* nit

* change seed

* rm vm.getArtifactPath(contractName)

* fmt

* nit

* fix

* nit

* rename

* nit

* fix

---------

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

crates/cheatcodes/spec/src/vm.rs

@@ -1531,6 +1531,14 @@ interface Vm {
     #[cheatcode(group = Filesystem)]
     function writeLine(string calldata path, string calldata data) external;
 
+    /// Gets the artifact path from code (aka. creation code).
+    #[cheatcode(group = Filesystem)]
+    function getArtifactPathByCode(bytes calldata code) external view returns (string memory path);
+
+    /// Gets the artifact path from deployed code (aka. runtime code).
+    #[cheatcode(group = Filesystem)]
+    function getArtifactPathByDeployedCode(bytes calldata deployedCode) external view returns (string memory path);
+
     /// Gets the creation bytecode from an artifact file. Takes in the relative path to the json file or the path to the
     /// artifact in the form of <path>:<contract>:<version> where <contract> and <version> parts are optional.
     #[cheatcode(group = Filesystem)]

crates/cheatcodes/src/fs.rs

@@ -250,6 +250,34 @@ impl Cheatcode for writeLineCall {
     }
 }
 
+impl Cheatcode for getArtifactPathByCodeCall {
+    fn apply(&self, state: &mut Cheatcodes) -> 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(&self, state: &mut Cheatcodes) -> 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(&self, state: &mut Cheatcodes) -> Result {
         let Self { artifactPath: path } = self;

testdata/default/cheats/GetArtifactPath.t.sol

@@ -0,0 +1,37 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity 0.8.18;
+
+import "ds-test/test.sol";
+import "cheats/Vm.sol";
+
+contract DummyForGetArtifactPath {}
+
+contract GetArtifactPathTest is DSTest {
+    Vm constant vm = Vm(HEVM_ADDRESS);
+
+    function testGetArtifactPathByCode() public {
+        DummyForGetArtifactPath dummy = new DummyForGetArtifactPath();
+        bytes memory dummyCreationCode = type(DummyForGetArtifactPath).creationCode;
+
+        string memory root = vm.projectRoot();
+        string memory path = vm.getArtifactPathByCode(dummyCreationCode);
+
+        string memory expectedPath =
+            string.concat(root, "/out/default/GetArtifactPath.t.sol/DummyForGetArtifactPath.json");
+
+        assertEq(path, expectedPath);
+    }
+
+    function testGetArtifactPathByDeployedCode() public {
+        DummyForGetArtifactPath dummy = new DummyForGetArtifactPath();
+        bytes memory dummyRuntimeCode = address(dummy).code;
+
+        string memory root = vm.projectRoot();
+        string memory path = vm.getArtifactPathByDeployedCode(dummyRuntimeCode);
+
+        string memory expectedPath =
+            string.concat(root, "/out/default/GetArtifactPath.t.sol/DummyForGetArtifactPath.json");
+
+        assertEq(path, expectedPath);
+    }
+}