feat(pg): Support fully qualified names in foundry

.changeset/wicked-coins-jog.md

@@ -0,0 +1,5 @@
+---
+'@chugsplash/plugins': patch
+---
+
+Support fully qualified names in foundry

packages/plugins/chugsplash/Storage.config.ts

@@ -22,7 +22,7 @@ const config: UserChugSplashConfig = {
   },
   contracts: {
     MyStorage: {
-      contract: 'Storage',
+      contract: 'contracts/test/ContainsStorage.sol:Storage',
       kind: 'proxy',
       constructorArgs,
       variables,

packages/plugins/contracts/test/SimpleStorage.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.9;
 
-import { Storage } from "./Storage.sol";
+import { Storage } from "./ContainsStorage.sol";
 import { Stateless } from "./Stateless.sol";
 
 contract SimpleStorage {

packages/plugins/contracts/test/Stateless.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.9;
 
-import { Storage } from "./Storage.sol";
+import { Storage } from "./ContainsStorage.sol";
 import { Version } from "@chugsplash/contracts/contracts/ChugSplashDataTypes.sol";
 
 contract Stateless {

packages/plugins/src/foundry/utils/index.ts

@@ -45,19 +45,36 @@ export const getContractArtifact = async (
   name: string,
   artifactFilder: string
 ): Promise<ContractArtifact> => {
+  // Try to find the artifact in the standard format
   const folderName = `${name}.sol`
   const fileName = `${name}.json`
-  const completeFilePath = join(artifactFilder, folderName, fileName)
-
-  if (!(await existsAsync(completeFilePath))) {
+  const standardFilePath = join(artifactFilder, folderName, fileName)
+
+  // Try to find the artifact in the qualified format
+  // Technically we don't need the full path to the file b/c foundry outputs a flat directory structure
+  // For clarity and consistency with other tools, we still handle the fully qualified format and recommend it
+  const qualifiedSections = name.split('/').pop()
+  const [file, contract] = qualifiedSections?.split(':') ?? ['', '']
+  const qualifiedFilePath = join(artifactFilder, file, `${contract}.json`)
+
+  if (await existsAsync(standardFilePath)) {
+    return parseFoundryArtifact(
+      JSON.parse(await readFileAsync(standardFilePath, 'utf8'))
+    )
+  } else if (await existsAsync(qualifiedFilePath)) {
+    return parseFoundryArtifact(
+      JSON.parse(await readFileAsync(qualifiedFilePath, 'utf8'))
+    )
+  } else {
+    // If we can't find the artifact, throw an error and recommend checking their options and using fully qualified format
     throw new Error(
-      `Could not find artifact for: ${name}. Please make sure that this contract exists in either the src, script, or test directory that you've configured in your foundry.toml.`
+      `Could not find artifact for: ${name}.
+- Please make sure that this contract exists in either the src, script, or test directory that you've configured in your foundry.toml.
+- If you have multiple contracts in the same file or have files with different names from the contracts they contain, please use the fully qualified name for the contract.
+  For example: 'path/to/file/SomeFile.sol:MyContract'
+`
     )
   }
-
-  const artifact = JSON.parse(await readFileAsync(completeFilePath, 'utf8'))
-
-  return parseFoundryArtifact(artifact)
 }
 
 /**

packages/plugins/test/foundry/ChugSplash.t.sol

@@ -5,7 +5,7 @@ import "forge-std/Test.sol";
 import "../../contracts/foundry/ChugSplash.sol";
 import { ChugSplashUtils } from "../../contracts/foundry/ChugSplashUtils.sol";
 import { SimpleStorage } from "../../contracts/test/SimpleStorage.sol";
-import { Storage } from "../../contracts/test/Storage.sol";
+import { Storage } from "../../contracts/test/ContainsStorage.sol";
 import { ComplexConstructorArgs } from "../../contracts/test/ComplexConstructorArgs.sol";
 import { Stateless } from "../../contracts/test/Stateless.sol";
 import { ChugSplashRegistry } from "@chugsplash/contracts/contracts/ChugSplashRegistry.sol";