fix(pg): use artifact inference in Foundry plugin

.changeset/many-wolves-end.md

@@ -0,0 +1,7 @@
+---
+'@sphinx-labs/contracts': patch
+'@sphinx-labs/plugins': patch
+'@sphinx-labs/core': patch
+---
+
+Use artifact inference in Foundry plugin

docs/troubleshooting-guide.md

@@ -4,38 +4,11 @@ This guide covers some common issues you might encounter using Sphinx. If your q
 
 ## Table of Contents
 
-- [Labeling contracts](#labeling-contracts)
 - [Slow compilation speed](#slow-compilation-speed)
 - [Errors](#errors)
   - [`Ineffective mark-compacts near heap limit allocation failed`](#ineffective-mark-compacts-near-heap-limit-allocation-failed)
   - [`EvmError: MemoryLimitOOG`](#evmerror-memorylimitoog)
 
-## Labeling contracts
-
-When Sphinx can't infer the contract corresponding to an address, an error will be thrown asking you to label it yourself. This makes it possible for Sphinx to verify the contract on Etherscan and create a deployment artifact for it.
-
-You can label a contract in your deployment script with the `sphinxLabel` function, which is inherited from `Sphinx.sol`. For example:
-
-```sol
-MyToken token = new MyToken{ salt: bytes32(0) }();
-sphinxLabel(address(token), "src/tokens/MyToken.sol:MyToken");
-```
-
-You must use the **fully qualified name** of the contract, which is in the format `full/path/to/SourceFile.sol:ContractName`, as shown in the example above.
-
-If you're having trouble finding the contract corresponding to an address, we recommend using `console.log`. You can import it into your script using:
-
-```
-import "forge-std/console.sol";
-```
-
-Then, you can log the addresses of your contracts:
-
-```
-MyToken token = new MyToken{ salt: bytes32(0) }();
-console.log('MyToken', address(token));
-```
-
 ## Slow compilation speed
 
 Sphinx may slow down the compilation speed of your script because the `Sphinx.sol` contract is large. You can speed up compilation during development by disabling the Solidity compiler optimizer. One approach is to create a new profile in your `foundry.toml` file. For example:

packages/contracts/contracts/foundry/SphinxPluginTypes.sol

@@ -86,7 +86,6 @@ struct DeploymentInfo {
     SphinxConfig newConfig;
     ExecutionMode executionMode;
     InitialChainState initialState;
-    Label[] labels;
     bool arbitraryChain;
 }
 
@@ -124,11 +123,6 @@ struct SphinxConfig {
     uint256 saltNonce;
 }
 
-struct Label {
-    address addr;
-    string fullyQualifiedName;
-}
-
 struct DeployOptions {
     bytes32 salt;
     string referenceName;

packages/contracts/contracts/foundry/SphinxUtils.sol

@@ -23,7 +23,6 @@ import {
     InitialChainState,
     OptionalAddress,
     Wallet,
-    Label,
     ExecutionMode,
     SystemContractInfo
 } from "./SphinxPluginTypes.sol";

packages/core/src/config/types.ts

@@ -99,7 +99,6 @@ export type DeploymentInfo = {
   newConfig: SphinxConfig
   executionMode: ExecutionMode
   initialState: InitialChainState
-  labels: Array<Label>
   arbitraryChain: boolean
 }
 
@@ -124,11 +123,6 @@ export type UserAddressOverrides = {
   address: string
 }
 
-export type Label = {
-  addr: string
-  fullyQualifiedName: string
-}
-
 export type SphinxConfigWithAddresses = SphinxConfig & {
   safeAddress: string
   moduleAddress: string

packages/core/src/preview.ts

@@ -1,4 +1,4 @@
-import { yellow, green, blue, bold } from 'chalk'
+import { yellow, green, bold } from 'chalk'
 
 import { DecodedAction, ParsedConfig } from './config/types'
 import {
@@ -127,20 +127,17 @@ export const getPreviewString = (
 
   // Warn about unlabeled addresses
   if (preview.unlabeledAddresses.size > 0) {
-    const troubleshootingGuideLink = blue.underline(
-      `https://github.com/sphinx-labs/sphinx/blob/main/docs/troubleshooting-guide.md#labeling-contracts\n\n`
-    )
     previewString += `${yellow.bold(
-      `Warning: Sphinx can't infer the contracts that correspond to the following addresses:\n`
+      `Warning: Sphinx couldn't find a contract artifact for the following addresses:\n`
     )}`
     previewString += `${Array.from(preview.unlabeledAddresses)
       .map((e) => yellow(`- ${e}`))
       .join('\n')}\n`
-    previewString +=
-      yellow(
-        `If you'd like Sphinx to verify any of these contracts on Etherscan or create their deployment artifacts,\n` +
-          `please label them in your script. See the troubleshooting guide for more information:\n`
-      ) + troubleshootingGuideLink
+    previewString += yellow(
+      `This typically happens when deploying contracts using hardcoded bytecode and no \n` +
+        `associated source file. Sphinx will not create a deployment artifact or attempt \n` +
+        `Etherscan verification for any address in the list above.\n\n`
+    )
   }
 
   if (includeConfirmQuestion) {

packages/core/src/utils.ts

@@ -40,7 +40,6 @@ import {
   ActionInput,
   RawCreate2ActionInput,
   RawActionInput,
-  Label,
   ParsedConfig,
   Create2ActionInput,
   FunctionCallActionInput,
@@ -928,17 +927,6 @@ export const isString = (str: string | null | undefined): str is string => {
   return typeof str === 'string'
 }
 
-export const isLabel = (l: Label | undefined): l is Label => {
-  if (l === undefined) {
-    return false
-  }
-
-  return (
-    typeof (l as Label).addr === 'string' &&
-    typeof (l as Label).fullyQualifiedName === 'string'
-  )
-}
-
 export const toSphinxTransaction = (
   actionInput: RawActionInput
 ): SphinxTransaction => {

packages/plugins/contracts/foundry/Sphinx.sol

@@ -16,7 +16,6 @@ import {
     DeploymentInfo,
     NetworkInfo,
     Wallet,
-    Label,
     SphinxTransaction,
     ExecutionMode,
     SystemContractInfo
@@ -65,8 +64,6 @@ abstract contract Sphinx {
      */
     SphinxConfig public sphinxConfig;
 
-    Label[] private labels;
-
     SphinxConstants private constants;
 
     SphinxUtils private sphinxUtils;
@@ -173,18 +170,6 @@ abstract contract Sphinx {
         // the delegatecall in our error message.
         require(success, "Sphinx: Deployment script failed.");
 
-        // Set the labels. We do this after running the user's script because the user may assign
-        // labels in their deployment. We use a for-loop instead of directly assigning the labels to
-        // prevent an error when compiling with `viaIR` and the solc optimizer enabled (runs =
-        // 200) using solc v0.8.5.
-        deploymentInfo.labels = new Label[](labels.length);
-        for (uint i = 0; i < labels.length; i++) {
-            deploymentInfo.labels[i] = Label({
-                addr: labels[i].addr,
-                fullyQualifiedName: labels[i].fullyQualifiedName
-            });
-        }
-
         return deploymentInfo;
     }
 
@@ -293,32 +278,6 @@ abstract contract Sphinx {
         );
     }
 
-    function sphinxLabel(address _addr, string memory _fullyQualifiedName) internal {
-        for (uint256 i = 0; i < labels.length; i++) {
-            Label memory label = labels[i];
-            if (label.addr == _addr) {
-                require(
-                    keccak256(abi.encodePacked(_fullyQualifiedName)) ==
-                        keccak256(abi.encodePacked(label.fullyQualifiedName)),
-                    string(
-                        abi.encodePacked(
-                            "Sphinx: The address ",
-                            vm.toString(_addr),
-                            " was labeled with two names:\n",
-                            label.fullyQualifiedName,
-                            "\n",
-                            _fullyQualifiedName,
-                            "\nPlease choose one label."
-                        )
-                    )
-                );
-                return;
-            }
-        }
-
-        labels.push(Label(_addr, _fullyQualifiedName));
-    }
-
     /**
      * @notice Return the user's config ABI encoded. This is useful for retrieving the config
      *         off-chain. We ABI encode the config because it's difficult to decode complex

packages/plugins/contracts/test/script/Cases.s.sol

@@ -7,9 +7,6 @@ import { Sphinx } from "../../foundry/Sphinx.sol";
 import { CREATE3 } from "solady/utils/CREATE3.sol";
 import { ConstructorDeploysContract } from "../../../contracts/test/ConstructorDeploysContract.sol";
 import { Fallback } from "../../../contracts/test/Fallback.sol";
-import {
-    ConflictingNameContract
-} from "../../../contracts/test/conflictingNameContracts/First.sol";
 
 contract Simple is Script, Sphinx {
     constructor() {
@@ -39,63 +36,16 @@ contract Simple is Script, Sphinx {
         Fallback fallbackContract = Fallback(CREATE3.deploy(bytes32(0), fallbackInitCode, 0));
         fallbackContract.set(1);
 
-        // Deploys contract that deploys another contract in its constructor using create2
-        // The contract deployed is labeled
-        ConstructorDeploysContract constructorDeploysContract = new ConstructorDeploysContract{
-            salt: bytes32(uint(1))
-        }(1);
-        sphinxLabel(
-            address(constructorDeploysContract.myContract()),
-            "contracts/test/ConstructorDeploysContract.sol:DeployedInConstructor"
-        );
+        // Deploys contract that deploys another contract in its constructor using create2.
+        // The deployed contract is automatically labeled because it has a source file.
+        new ConstructorDeploysContract{ salt: bytes32(uint(1)) }(1);
 
-        // Deploys contract that deploys another contract in its constructor using create3
-        // Both the parent and child are labeled
+        // Deploys contract that deploys another contract in its constructor using create3.
+        // Both the parent and child are labeled because they both have source files.
         bytes memory constructorDeploysContractInitCode = abi.encodePacked(
             type(ConstructorDeploysContract).creationCode,
             abi.encode(2)
         );
-        ConstructorDeploysContract constructorDeploysContractCreate3 = ConstructorDeploysContract(
-            CREATE3.deploy(bytes32(uint(1)), constructorDeploysContractInitCode, 0)
-        );
-        sphinxLabel(
-            address(constructorDeploysContractCreate3),
-            "contracts/test/ConstructorDeploysContract.sol:ConstructorDeploysContract"
-        );
-        sphinxLabel(
-            address(constructorDeploysContractCreate3.myContract()),
-            "contracts/test/ConstructorDeploysContract.sol:DeployedInConstructor"
-        );
-
-        // Deploys contract that deploys another contract in its constructor using create2
-        // The contract is not labeled
-        new ConstructorDeploysContract{ salt: bytes32(uint(2)) }(3);
-
-        // Deploys contract that deploys another contract in its constructor using create3
-        // Neither contract is labeled
-        bytes memory constructorDeploysContractUnlabeledInitCode = abi.encodePacked(
-            type(ConstructorDeploysContract).creationCode,
-            abi.encode(4)
-        );
-        CREATE3.deploy(bytes32(uint(2)), constructorDeploysContractUnlabeledInitCode, 0);
-
-        // Deploy a contract whose name is not unique in the source directory
-        // The contract is labeled
-        ConflictingNameContract conflictingNameContract = new ConflictingNameContract{ salt: 0 }(1);
-        sphinxLabel(
-            address(conflictingNameContract),
-            "contracts/test/conflictingNameContracts/First.sol:ConflictingNameContract"
-        );
-
-        // Deploy a contract whose name is not unique in the source directory
-        // The contract is not labeled
-        new ConflictingNameContract{ salt: bytes32(uint(1)) }(2);
-
-        // Deploy a contract whose name is not unique in the source directory
-        // We interact with the contract, so it does not require a label
-        ConflictingNameContract conflictingNameContractInteract = new ConflictingNameContract{
-            salt: bytes32(uint(2))
-        }(3);
-        conflictingNameContractInteract.set(5);
+        CREATE3.deploy(bytes32(uint(1)), constructorDeploysContractInitCode, 0);
     }
 }

packages/plugins/script/Sample.s.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.0;
 
 import {Script, console} from "sphinx-forge-std/Script.sol";
 import {Sphinx} from "../contracts/foundry/Sphinx.sol";
-import {Network, Label} from "@sphinx-labs/contracts/contracts/foundry/SphinxPluginTypes.sol";
+import {Network} from "@sphinx-labs/contracts/contracts/foundry/SphinxPluginTypes.sol";
 import {MyContract1} from "../contracts/test/MyContracts.sol";
 import {CREATE3} from "solady/utils/CREATE3.sol";
 
@@ -42,7 +42,6 @@ contract Sample is Sphinx {
 
         bytes memory initCode =
             abi.encodePacked(type(MyContract1).creationCode, abi.encode(1, 2, address(1), address(2)));
-        address deployed = CREATE3.deploy(bytes32(0), initCode, 0);
-        sphinxLabel(deployed, "contracts/test/MyContracts.sol:MyContract1");
+        CREATE3.deploy(bytes32(0), initCode, 0);
     }
 }