feat: --compile-autolink

This implements automatic dependency resolution and linking of
libraries through crytic-compile, using the existing internal
mechanism provided by `--compile-libraries`. The chosen library
deployment addresses are provided on a `<key>.link` JSON file when
using the solc export format. This can be then used by fuzzers or
other tools that would like to deploy contracts that require
external libraries.

Author: elopez

crytic_compile/crytic_compile.py

@@ -27,6 +27,7 @@
 from crytic_compile.platform.all_export import PLATFORMS_EXPORT
 from crytic_compile.platform.solc import Solc
 from crytic_compile.platform.standard import export_to_standard
+from crytic_compile.utils.libraries import generate_library_addresses, get_deployment_order
 from crytic_compile.utils.naming import Filename
 from crytic_compile.utils.npm import get_package_name
 from crytic_compile.utils.zip import load_from_zip
@@ -206,6 +207,10 @@ def __init__(self, target: Union[str, AbstractPlatform], **kwargs: str) -> None:
 
         self._bytecode_only = False
 
+        self._autolink: bool = kwargs.get("compile_autolink", False)
+
+        self._autolink_deployment_order: Optional[List[str]] = None
+
         self.libraries: Optional[Dict[str, int]] = _extract_libraries(kwargs.get("compile_libraries", None))  # type: ignore
 
         self._compile(**kwargs)
@@ -632,12 +637,54 @@ def _compile(self, **kwargs: str) -> None:
                 self._platform.clean(**kwargs)
             self._platform.compile(self, **kwargs)
 
+        # Handle autolink after compilation
+        if self._autolink:
+            self._apply_autolink()
+
         remove_metadata = kwargs.get("compile_remove_metadata", False)
         if remove_metadata:
             for compilation_unit in self._compilation_units.values():
                 for source_unit in compilation_unit.source_units.values():
                     source_unit.remove_metadata()
 
+    def _apply_autolink(self) -> None:
+        """Apply automatic library linking with sequential addresses"""
+
+        # Collect all libraries that need linking and compute deployment info
+        all_libraries_needed: Set[str] = set()
+        all_dependencies: Dict[str, List[str]] = {}
+        all_target_contracts: List[str] = []
+
+        for compilation_unit in self._compilation_units.values():
+            # Build dependency graph for this compilation unit
+            for source_unit in compilation_unit.source_units.values():
+                all_target_contracts.extend(source_unit.contracts_names_without_libraries)
+
+                for contract_name in source_unit.contracts_names:
+                    deps = source_unit.libraries_names(contract_name)
+
+                    if deps or contract_name in all_target_contracts:
+                        all_dependencies[contract_name] = deps
+                        all_libraries_needed.update(deps)
+
+        # Calculate deployment order globally
+        deployment_order, _ = get_deployment_order(all_dependencies, all_target_contracts)
+        self._autolink_deployment_order = deployment_order
+
+        if all_libraries_needed:
+            # Apply the library linking (similar to compile_libraries but auto-generated)
+            library_addresses = generate_library_addresses(all_libraries_needed)
+
+            if self.libraries is None:
+                self.libraries = {}
+
+            # Respect any user-provided addresses through compile_libraries
+            self.libraries = library_addresses | self.libraries
+
+    @property
+    def deployment_order(self) -> Optional[List[str]]:
+        return self._autolink_deployment_order
+
     @staticmethod
     def _run_custom_build(custom_build: str) -> None:
         """Run a custom build

crytic_compile/cryticparser/cryticparser.py

@@ -35,6 +35,13 @@ def init(parser: ArgumentParser) -> None:
         default=DEFAULTS_FLAG_IN_CONFIG["compile_libraries"],
     )
 
+    group_compile.add_argument(
+        "--compile-autolink",
+        help="Automatically link all found libraries with sequential addresses starting from 0xa070",
+        action="store_true",
+        default=DEFAULTS_FLAG_IN_CONFIG["compile_autolink"],
+    )
+
     group_compile.add_argument(
         "--compile-remove-metadata",
         help="Remove the metadata from the bytecodes",

crytic_compile/cryticparser/defaults.py

@@ -48,4 +48,5 @@
     "foundry_compile_all": False,
     "export_dir": "crytic-export",
     "compile_libraries": None,
+    "compile_autolink": False,
 }

crytic_compile/platform/solc.py

@@ -57,9 +57,34 @@ def _build_contract_data(compilation_unit: "CompilationUnit") -> Dict:
     return contracts
 
 
+def _export_link_info(compilation_unit: "CompilationUnit", key: str, autolink_path: str) -> None:
+    """Export linking information to a separate file"""
+
+    # Get library addresses if they exist
+    library_addresses = {}
+    if compilation_unit.crytic_compile.libraries:
+        library_addresses = {
+            name: f"0x{addr:040x}"
+            for name, addr in compilation_unit.crytic_compile.libraries.items()
+        }
+
+    # Filter deployment order to only include libraries that have addresses
+    full_deployment_order = compilation_unit.crytic_compile.deployment_order or []
+    filtered_deployment_order = [lib for lib in full_deployment_order if lib in library_addresses]
+
+    # Create autolink output with deployment order and library addresses
+    autolink_output = {
+        "deployment_order": filtered_deployment_order,
+        "library_addresses": library_addresses,
+    }
+
+    with open(autolink_path, "w", encoding="utf8") as file_desc:
+        json.dump(autolink_output, file_desc, indent=2)
+
+
 def export_to_solc_from_compilation_unit(
     compilation_unit: "CompilationUnit", key: str, export_dir: str
-) -> Optional[str]:
+) -> Optional[List[str]]:
     """Export the compilation unit to the standard solc output format.
     The exported file will be $key.json
 
@@ -69,7 +94,7 @@ def export_to_solc_from_compilation_unit(
         export_dir (str): Export directory
 
     Returns:
-        Optional[str]: path to the file generated
+        Optional[List[str]]: path to the files generated
     """
     contracts = _build_contract_data(compilation_unit)
 
@@ -88,7 +113,16 @@ def export_to_solc_from_compilation_unit(
 
         with open(path, "w", encoding="utf8") as file_desc:
             json.dump(output, file_desc)
-        return path
+
+        paths = [path]
+
+        # Export link info if compile_autolink or compile_libraries was used
+        if compilation_unit.crytic_compile.libraries:
+            link_path = os.path.join(export_dir, f"{key}.link")
+            _export_link_info(compilation_unit, key, link_path)
+            paths.append(link_path)
+
+        return paths
     return None
 
 
@@ -110,17 +144,18 @@ def export_to_solc(crytic_compile: "CryticCompile", **kwargs: str) -> List[str]:
 
     if len(crytic_compile.compilation_units) == 1:
         compilation_unit = list(crytic_compile.compilation_units.values())[0]
-        path = export_to_solc_from_compilation_unit(compilation_unit, "combined_solc", export_dir)
-        if path:
-            return [path]
+        paths = export_to_solc_from_compilation_unit(compilation_unit, "combined_solc", export_dir)
+        if paths:
+            return paths
         return []
 
-    paths = []
+    all_paths = []
     for key, compilation_unit in crytic_compile.compilation_units.items():
-        path = export_to_solc_from_compilation_unit(compilation_unit, key, export_dir)
-        if path:
-            paths.append(path)
-    return paths
+        paths = export_to_solc_from_compilation_unit(compilation_unit, key, export_dir)
+        if paths:
+            all_paths.extend(paths)
+
+    return all_paths
 
 
 class Solc(AbstractPlatform):

crytic_compile/utils/libraries.py

@@ -0,0 +1,92 @@
+"""
+Library utilities for dependency resolution and auto-linking
+"""
+from typing import Dict, List, Set, Optional, Tuple
+from crytic_compile.compilation_unit import CompilationUnit
+
+
+def get_deployment_order(
+    dependencies: Dict[str, List[str]], target_contracts: List[str]
+) -> Tuple[List[str], Set[str]]:
+    """Get deployment order using topological sorting (Kahn's algorithm)
+
+    Args:
+        dependencies: Dict mapping contract_name -> [required_libraries]
+        target_contracts: List of target contracts to prioritize
+
+    Returns:
+        Tuple of (deployment_order, libraries_needed)
+    """
+    # Build complete dependency graph
+    all_contracts = set(dependencies.keys())
+    for deps in dependencies.values():
+        all_contracts.update(deps)
+
+    # Calculate in-degrees
+    in_degree = {contract: 0 for contract in all_contracts}
+    for contract, deps in dependencies.items():
+        for dep in deps:
+            if dep in in_degree:
+                in_degree[contract] += 1
+
+    # Initialize queue with nodes that have no dependencies
+    queue = [contract for contract in all_contracts if in_degree[contract] == 0]
+
+    result = []
+    libraries_needed = set()
+
+    deployment_order = []
+
+    while queue:
+        # Sort queue to prioritize libraries first, then target contracts in order
+        queue.sort(
+            key=lambda x: (
+                x in target_contracts,  # Libraries (False) come before targets (True)
+                target_contracts.index(x) if x in target_contracts else 0,  # Target order
+            )
+        )
+
+        current = queue.pop(0)
+        result.append(current)
+
+        # Check if this is a library (not in target contracts but required by others)
+        if current not in target_contracts:
+            libraries_needed.add(current)
+            deployment_order.append(current)  # Only add libraries to deployment order
+
+        # Update in-degrees for dependents
+        for contract, deps in dependencies.items():
+            if current in deps:
+                in_degree[contract] -= 1
+                if in_degree[contract] == 0 and contract not in result:
+                    queue.append(contract)
+
+    # Check for circular dependencies
+    if len(result) != len(all_contracts):
+        remaining = all_contracts - set(result)
+        raise ValueError(f"Circular dependency detected involving: {remaining}")
+
+    return deployment_order, libraries_needed
+
+
+def generate_library_addresses(
+    libraries_needed: Set[str], start_address: int = 0xA070
+) -> Dict[str, int]:
+    """Generate sequential addresses for libraries
+
+    Args:
+        libraries_needed: Set of library names that need addresses
+        start_address: Starting address (default 0xa070, resembling "auto")
+
+    Returns:
+        Dict mapping library_name -> address
+    """
+    library_addresses = {}
+    current_address = start_address
+
+    # Sort libraries for consistent ordering
+    for library in sorted(libraries_needed):
+        library_addresses[library] = current_address
+        current_address += 1
+
+    return library_addresses

tests/library_dependency_test.sol

@@ -0,0 +1,88 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+// Simple library with no dependencies
+library MathLib {
+    function add(uint256 a, uint256 b) external pure returns (uint256) {
+        return a + b;
+    }
+
+    function multiply(uint256 a, uint256 b) external pure returns (uint256) {
+        return a * b;
+    }
+}
+
+// Library that depends on MathLib
+library AdvancedMath {
+    function square(uint256 a) external pure returns (uint256) {
+        return MathLib.multiply(a, a);
+    }
+
+    function addAndSquare(uint256 a, uint256 b) external pure returns (uint256) {
+        uint256 sum = MathLib.add(a, b);
+        return MathLib.multiply(sum, sum);
+    }
+}
+
+// Library that depends on both MathLib and AdvancedMath
+library ComplexMath {
+    function complexOperation(uint256 a, uint256 b) external pure returns (uint256) {
+        uint256 squared = AdvancedMath.square(a);
+        return MathLib.add(squared, b);
+    }
+
+    function megaOperation(uint256 a, uint256 b, uint256 c) external pure returns (uint256) {
+        uint256 result1 = AdvancedMath.addAndSquare(a, b);
+        uint256 result2 = MathLib.multiply(result1, c);
+        return result2;
+    }
+}
+
+// Contract that uses ComplexMath (which transitively depends on others)
+contract TestComplexDependencies {
+    uint256 public result;
+
+    constructor() {
+        result = 0;
+    }
+
+    function performComplexCalculation(uint256 a, uint256 b, uint256 c) public {
+        result = ComplexMath.megaOperation(a, b, c);
+    }
+
+    function performSimpleCalculation(uint256 a, uint256 b) public {
+        result = ComplexMath.complexOperation(a, b);
+    }
+
+    function getResult() public view returns (uint256) {
+        return result;
+    }
+}
+
+// Another contract that only uses MathLib directly
+contract SimpleMathContract {
+    uint256 public value;
+
+    constructor(uint256 _initial) {
+        value = _initial;
+    }
+
+    function addValue(uint256 _amount) public {
+        value = MathLib.add(value, _amount);
+    }
+
+    function multiplyValue(uint256 _factor) public {
+        value = MathLib.multiply(value, _factor);
+    }
+}
+
+// Contract that uses multiple libraries at the same level
+contract MultiLibraryContract {
+    uint256 public simpleResult;
+    uint256 public advancedResult;
+
+    function calculate(uint256 a, uint256 b) public {
+        simpleResult = MathLib.add(a, b);
+        advancedResult = AdvancedMath.square(a);
+    }
+}