feat: add linking error (foundry-rs#9610)

* feat(linking): add a linking error code

Signed-off-by: 9547 <[email protected]>

* test linking failure

Signed-off-by: 9547 <[email protected]>

* track link error for all libs

Signed-off-by: 9547 <[email protected]>

* using the library F?

Signed-off-by: 9547 <[email protected]>

* fix

* apply existing lib link

* fix

Signed-off-by: 9547 <[email protected]>

* create2 check link fully

Signed-off-by: 9547 <[email protected]>

* clippy

Signed-off-by: 9547 <[email protected]>

* multi runner err check

Signed-off-by: 9547 <[email protected]>

* check linkable first

Signed-off-by: 9547 <[email protected]>

* fix

Signed-off-by: 9547 <[email protected]>

* rename

Signed-off-by: 9547 <[email protected]>

---------

Signed-off-by: 9547 <[email protected]>
Co-authored-by: DaniPopes <[email protected]>

Author: 2 people

crates/forge/src/multi_runner.rs

@@ -506,26 +506,28 @@ impl MultiContractRunnerBuilder {
             linker.contracts.keys(),
         )?;
 
-        let linked_contracts = linker.get_linked_artifacts(&libraries)?;
+        let linked_contracts = linker.get_linked_artifacts_cow(&libraries)?;
 
         // Create a mapping of name => (abi, deployment code, Vec<library deployment code>)
         let mut deployable_contracts = DeployableContracts::default();
 
         for (id, contract) in linked_contracts.iter() {
-            let Some(abi) = &contract.abi else { continue };
+            let Some(abi) = contract.abi.as_ref() else { continue };
 
             // if it's a test, link it and add to deployable contracts
             if abi.constructor.as_ref().map(|c| c.inputs.is_empty()).unwrap_or(true)
                 && abi.functions().any(|func| func.name.is_any_test())
             {
+                linker.ensure_linked(contract, id)?;
+
                 let Some(bytecode) =
                     contract.get_bytecode_bytes().map(|b| b.into_owned()).filter(|b| !b.is_empty())
                 else {
                     continue;
                 };
 
                 deployable_contracts
-                    .insert(id.clone(), TestContract { abi: abi.clone(), bytecode });
+                    .insert(id.clone(), TestContract { abi: abi.clone().into_owned(), bytecode });
             }
         }
 

crates/linking/src/lib.rs

@@ -29,6 +29,8 @@ pub enum LinkerError {
     InvalidAddress(<Address as std::str::FromStr>::Err),
     #[error("cyclic dependency found, can't link libraries via CREATE2")]
     CyclicDependency,
+    #[error("failed linking {artifact}")]
+    LinkingFailed { artifact: String },
 }
 
 pub struct Linker<'a> {
@@ -265,6 +267,30 @@ impl<'a> Linker<'a> {
         Ok(contract)
     }
 
+    /// Ensures that both initial and deployed bytecode are linked.
+    pub fn ensure_linked(
+        &self,
+        contract: &CompactContractBytecodeCow<'a>,
+        target: &ArtifactId,
+    ) -> Result<(), LinkerError> {
+        if let Some(bytecode) = &contract.bytecode
+            && bytecode.object.is_unlinked()
+        {
+            return Err(LinkerError::LinkingFailed {
+                artifact: target.source.to_string_lossy().into(),
+            });
+        }
+        if let Some(deployed_bytecode) = &contract.deployed_bytecode
+            && let Some(deployed_bytecode_obj) = &deployed_bytecode.bytecode
+            && deployed_bytecode_obj.object.is_unlinked()
+        {
+            return Err(LinkerError::LinkingFailed {
+                artifact: target.source.to_string_lossy().into(),
+            });
+        }
+        Ok(())
+    }
+
     pub fn get_linked_artifacts(
         &self,
         libraries: &Libraries,
@@ -685,4 +711,33 @@ mod tests {
                 );
         });
     }
+
+    #[test]
+    fn linking_failure() {
+        let linker = LinkerTest::new("../../testdata/default/linking/simple", true);
+        let linker_instance =
+            Linker::new(linker.project.root(), linker.output.artifact_ids().collect());
+
+        // Create a libraries object with an incorrect library name that won't match any references
+        let mut libraries = Libraries::default();
+        libraries.libs.entry("default/linking/simple/Simple.t.sol".into()).or_default().insert(
+            "NonExistentLib".to_string(),
+            "0x5a443704dd4b594b382c22a083e2bd3090a6fef3".to_string(),
+        );
+
+        // Try to link the LibraryConsumer contract with incorrect library
+        let artifact_id = linker_instance
+            .contracts
+            .keys()
+            .find(|id| id.name == "LibraryConsumer")
+            .expect("LibraryConsumer contract not found");
+
+        let contract = linker_instance.contracts.get(artifact_id).unwrap();
+
+        // Verify that the artifact has unlinked bytecode
+        assert!(
+            linker_instance.ensure_linked(contract, artifact_id).is_err(),
+            "Expected artifact to have unlinked bytecode"
+        );
+    }
 }