Merge remote-tracking branch 'origin/dev' into dev-autolink

elopez · elopez · commit 4183fee8a067 · 2025-08-23T13:04:01.000-03:00
diff --git a/.github/workflows/black.yml b/.github/workflows/black.yml
@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Python 3.8
         uses: actions/setup-python@v5
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -43,7 +43,7 @@ jobs:
           - python: 3.12
             type: brownie
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Set up shell
       if: runner.os == 'Windows'
       run: |
diff --git a/.github/workflows/darglint.yml b/.github/workflows/darglint.yml
@@ -17,7 +17,7 @@ jobs:
   tests:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Set up Python 3.8
       uses: actions/setup-python@v5
       with:
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -28,7 +28,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Setup Pages
         uses: actions/configure-pages@v5
       - uses: actions/setup-python@v5
diff --git a/.github/workflows/etherscan.yml b/.github/workflows/etherscan.yml
@@ -24,7 +24,7 @@ jobs:
         os: ["ubuntu-latest", "windows-2022"]
         type: ["etherscan"]
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Set up shell
       if: runner.os == 'Windows'
       run: |
diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml
@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Python 3.8
         uses: actions/setup-python@v5
diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml
@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Python 3.8
         uses: actions/setup-python@v5
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -39,7 +39,7 @@ jobs:
       - build-release
     steps:
       - name: fetch dists
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           name: crytic-compile-dists
           path: dist/
@@ -48,7 +48,7 @@ jobs:
         uses: pypa/gh-action-pypi-publish@v1.12.4
 
       - name: sign
-        uses: sigstore/gh-action-sigstore-python@v3.0.0
+        uses: sigstore/gh-action-sigstore-python@v3.0.1
         with:
           inputs: ./dist/*.tar.gz ./dist/*.whl
           release-signing-artifacts: true
diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml
@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Python 3.8
         uses: actions/setup-python@v5
diff --git a/.github/workflows/pytest.yml b/.github/workflows/pytest.yml
@@ -26,7 +26,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python 3.8
         uses: actions/setup-python@v5
         with:
diff --git a/crytic_compile/cryticparser/defaults.py b/crytic_compile/cryticparser/defaults.py
@@ -44,7 +44,7 @@
     "hardhat_cache_directory": None,
     "hardhat_artifacts_directory": None,
     "foundry_ignore_compile": False,
-    "foundry_out_directory": "out",
+    "foundry_out_directory": None,
     "foundry_compile_all": False,
     "export_dir": "crytic-export",
     "compile_libraries": None,
diff --git a/crytic_compile/platform/abstract_platform.py b/crytic_compile/platform/abstract_platform.py
@@ -42,6 +42,7 @@ class PlatformConfig:
     tests_path: str = "test"
     libs_path: List[str] = field(default_factory=lambda: ["lib"])
     scripts_path: str = "script"
+    out_path: str = "out"
 
 
 class AbstractPlatform(metaclass=abc.ABCMeta):
diff --git a/crytic_compile/platform/etherscan.py b/crytic_compile/platform/etherscan.py
@@ -71,7 +71,7 @@
     "avax": ("43114", "snowscan.xyz"),
     "testnet.avax": ("43113", "testnet.snowscan.xyz"),
     "bttc": ("199", "bttcscan.com"),
-    "testnet.bttc": ("1028", "testnet.bttcscan.com"),
+    "testnet.bttc": ("1029", "testnet.bttcscan.com"),
     "celo": ("42220", "celoscan.io"),
     "alfajores.celo": ("44787", "alfajores.celoscan.io"),
     "cronos": ("25", "cronoscan.com"),
@@ -112,6 +112,16 @@
     "abstract": ("2741", "abscan.org"),
     "sepolia.abstract": ("11124", "sepolia.abscan.org"),
     "berachain": ("80094", "berascan.com"),
+    "testnet.monad": ("10143", "testnet.monadscan.com"),
+    "hoodi": ("560048", "hoodi.etherscan.io"),
+    "memecore": ("43521", "testnet.memecorescan.io"),
+    "testnet.berachain": ("80069", "testnet.berascan.com"),
+    "swellchain": ("1923", "swellchainscan.io"),
+    "testnet.swellchain": ("1924", "sepolia.swellchainscan.io"),
+    "hyperevm": ("999", "hyperevmscan.io"),
+    "katana": ("747474", "katanascan.com"),
+    "sei": ("1329", "seiscan.io"),
+    "testnet.sei": ("1328", "testnet.seiscan.io"),
 }
 
 SUPPORTED_NETWORK = {**SUPPORTED_NETWORK_V1, **SUPPORTED_NETWORK_V2}
diff --git a/crytic_compile/platform/foundry.py b/crytic_compile/platform/foundry.py
@@ -2,10 +2,9 @@
 Foundry platform
 """
 import logging
-import os
 import subprocess
 from pathlib import Path
-from typing import TYPE_CHECKING, List, Optional, TypeVar
+from typing import TYPE_CHECKING, List, Optional, TypeVar, Union
 
 import json
 
@@ -32,6 +31,14 @@ class Foundry(AbstractPlatform):
     PROJECT_URL = "https://github.com/foundry-rs/foundry"
     TYPE = Type.FOUNDRY
 
+    def __init__(self, target: str, **_kwargs: str):
+        super().__init__(target, **_kwargs)
+
+        project_root = Foundry.locate_project_root(target)
+        # if we are initializing this, it is indeed a foundry project and thus has a root path
+        assert project_root is not None
+        self._project_root: Path = project_root
+
     # pylint: disable=too-many-locals,too-many-statements,too-many-branches
     def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
         """Compile
@@ -46,44 +53,55 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
             "ignore_compile", False
         )
 
-        out_directory = kwargs.get("foundry_out_directory", "out")
+        foundry_config = None
 
         if ignore_compile:
             LOGGER.info(
                 "--ignore-compile used, if something goes wrong, consider removing the ignore compile flag"
             )
-
-        if not ignore_compile:
+        else:
             compilation_command = [
                 "forge",
                 "build",
                 "--build-info",
             ]
 
+            targeted_build = not self._project_root.samefile(self._target)
+            if targeted_build:
+                compilation_command += [
+                    str(Path(self._target).resolve().relative_to(self._project_root))
+                ]
+
             compile_all = kwargs.get("foundry_compile_all", False)
 
-            if not compile_all:
-                foundry_config = self.config(self._target)
-                if foundry_config:
-                    compilation_command += [
-                        "--skip",
-                        f"*/{foundry_config.tests_path}/**",
-                        f"*/{foundry_config.scripts_path}/**",
-                        "--force",
-                    ]
+            foundry_config = self.config(self._project_root)
+
+            if not targeted_build and not compile_all and foundry_config:
+                compilation_command += [
+                    "--skip",
+                    f"./{foundry_config.tests_path}/**",
+                    f"./{foundry_config.scripts_path}/**",
+                    "--force",
+                ]
 
             run(
                 compilation_command,
-                cwd=self._target,
+                cwd=self._project_root,
             )
 
+        out_directory_detected = foundry_config.out_path if foundry_config else "out"
+        out_directory_config = kwargs.get("foundry_out_directory", None)
+        out_directory = out_directory_config if out_directory_config else out_directory_detected
+
         build_directory = Path(
-            self._target,
+            self._project_root,
             out_directory,
             "build-info",
         )
 
-        hardhat_like_parsing(crytic_compile, self._target, build_directory, self._target)
+        hardhat_like_parsing(
+            crytic_compile, str(self._target), build_directory, str(self._project_root)
+        )
 
     def clean(self, **kwargs: str) -> None:
         """Clean compilation artifacts
@@ -99,7 +117,38 @@ def clean(self, **kwargs: str) -> None:
         if ignore_compile:
             return
 
-        run(["forge", "clean"], cwd=self._target)
+        run(["forge", "clean"], cwd=self._project_root)
+
+    @staticmethod
+    def locate_project_root(file_or_dir: str) -> Optional[Path]:
+        """Determine the project root (if the target is a Foundry project)
+
+        Foundry projects are detected through the presence of their
+        configuration file. See the following for reference:
+
+        https://github.com/foundry-rs/foundry/blob/6983a938580a1eb25d9dbd61eb8cad8cd137a86d/crates/config/README.md#foundrytoml
+
+        Args:
+            file_or_dir (str): path to the target
+
+        Returns:
+            Optional[Path]: path to the project root, if found
+        """
+
+        target = Path(file_or_dir).resolve()
+
+        # if the target is a directory, see if it has a foundry config
+        if target.is_dir() and (target / "foundry.toml").is_file():
+            return target
+
+        # if the target is a file, it might be a specific contract
+        # within a foundry project. Look in parent directories for a
+        # config file
+        for p in target.parents:
+            if (p / "foundry.toml").is_file():
+                return p
+
+        return None
 
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
@@ -115,10 +164,10 @@ def is_supported(target: str, **kwargs: str) -> bool:
         if kwargs.get("foundry_ignore", False):
             return False
 
-        return os.path.isfile(os.path.join(target, "foundry.toml"))
+        return Foundry.locate_project_root(target) is not None
 
     @staticmethod
-    def config(working_dir: str) -> Optional[PlatformConfig]:
+    def config(working_dir: Union[str, Path]) -> Optional[PlatformConfig]:
         """Return configuration data that should be passed to solc, such as remappings.
 
         Args:
@@ -150,6 +199,7 @@ def config(working_dir: str) -> Optional[PlatformConfig]:
         result.tests_path = json_config.get("test")
         result.libs_path = json_config.get("libs")
         result.scripts_path = json_config.get("script")
+        result.out_path = json_config.get("out")
 
         return result
 
diff --git a/scripts/ci_test_foundry.sh b/scripts/ci_test_foundry.sh
@@ -1,13 +1,14 @@
 #!/usr/bin/env bash
-
 ### Test foundry integration
+set -Eeuxo pipefail
 
 
-cd /tmp || exit 255
+## test 1 - same folder
 
+cd /tmp || exit 255
 mkdir forge_test
 cd forge_test || exit 255
-forge init --no-commit
+forge init
 
 crytic-compile .
 if [ $? -ne 0 ]
@@ -16,11 +17,35 @@ then
     exit 255
 fi
 
-mkdir /tmp/forge_test/test_2
-rsync -a --exclude='test_2' ./ /tmp/forge_test/test_2/
-crytic-compile ./test_2
+
+## test 2 - same folder, different out dir
+
+cd /tmp || exit 255
+mkdir forge_test2
+cd forge_test2 || exit 255
+forge init
+
+sed -i 's/^out\s*=.*$/out = "foobar"/' foundry.toml
+
+crytic-compile .
 if [ $? -ne 0 ]
 then
     echo "foundry test 2 failed"
     exit 255
-fi
+fi
+
+## test 3 - different folder
+
+cd /tmp || exit 255
+mkdir forge_test3
+cd forge_test3 || exit 255
+forge init
+
+cd /tmp || exit 255
+
+crytic-compile ./forge_test3
+if [ $? -ne 0 ]
+then
+    echo "foundry test 3 failed"
+    exit 255
+fi
