feat(script): additional contracts name in broadcast log (#11197)

feat(script): identify and record name of additional contracts

Author: grandizzy

crates/forge/tests/cli/script.rs

@@ -3009,3 +3009,95 @@ ONCHAIN EXECUTION COMPLETE & SUCCESSFUL.
     assert_eq!(receiver2.nonce, 0);
     assert_eq!(receiver2.balance.to_string(), "101000000000000000000");
 });
+
+// <https://github.com/foundry-rs/foundry/issues/11159>
+forgetest_async!(check_broadcast_log_with_additional_contracts, |prj, cmd| {
+    foundry_test_utils::util::initialize(prj.root());
+    prj.add_source(
+        "Counter.sol",
+        r#"
+contract Counter {
+    uint256 public number;
+
+    function setNumber(uint256 newNumber) public {
+        number = newNumber;
+    }
+
+    function increment() public {
+        number++;
+    }
+}
+   "#,
+    )
+    .unwrap();
+    prj.add_source(
+        "Factory.sol",
+        r#"
+import {Counter} from "./Counter.sol";
+
+contract Factory {
+    function deployCounter() public returns (Counter) {
+        return new Counter();
+    }
+}
+   "#,
+    )
+    .unwrap();
+    let deploy_script = prj
+        .add_script(
+            "Factory.s.sol",
+            r#"
+import "forge-std/Script.sol";
+import {Factory} from "../src/Factory.sol";
+import {Counter} from "../src/Counter.sol";
+
+contract FactoryScript is Script {
+    Factory public factory;
+    Counter public counter;
+
+    function setUp() public {}
+
+    function run() public {
+        vm.startBroadcast();
+
+        factory = new Factory();
+        counter = factory.deployCounter();
+
+        vm.stopBroadcast();
+    }
+}
+   "#,
+        )
+        .unwrap();
+
+    let deploy_contract = deploy_script.display().to_string() + ":FactoryScript";
+    let (_api, handle) = spawn(NodeConfig::test()).await;
+    cmd.args([
+        "script",
+        &deploy_contract,
+        "--root",
+        prj.root().to_str().unwrap(),
+        "--fork-url",
+        &handle.http_endpoint(),
+        "--slow",
+        "--broadcast",
+        "--private-key",
+        "ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80",
+    ])
+    .assert_success();
+
+    let broadcast_log = prj.root().join("broadcast/Factory.s.sol/31337/run-latest.json");
+    let script_sequence: ScriptSequence = serde_json::from_reader(
+        fs::File::open(prj.artifacts().join(broadcast_log)).expect("no broadcast log"),
+    )
+    .expect("no script sequence");
+
+    let counter_contract = script_sequence
+        .transactions
+        .get(1)
+        .expect("no tx")
+        .additional_contracts
+        .first()
+        .expect("no Counter contract");
+    assert_eq!(counter_contract.contract_name, Some("Counter".to_string()));
+});

crates/script-sequence/src/transaction.rs

@@ -8,6 +8,7 @@ use serde::{Deserialize, Serialize};
 pub struct AdditionalContract {
     #[serde(rename = "transactionType")]
     pub opcode: CallKind,
+    pub contract_name: Option<String>,
     pub address: Address,
     pub init_code: Bytes,
 }

crates/script/src/lib.rs

@@ -538,16 +538,24 @@ pub struct ScriptResult {
 }
 
 impl ScriptResult {
-    pub fn get_created_contracts(&self) -> Vec<AdditionalContract> {
+    pub fn get_created_contracts(
+        &self,
+        known_contracts: &ContractsByArtifact,
+    ) -> Vec<AdditionalContract> {
         self.traces
             .iter()
             .flat_map(|(_, traces)| {
                 traces.nodes().iter().filter_map(|node| {
                     if node.trace.kind.is_any_create() {
+                        let init_code = node.trace.data.clone();
+                        let contract_name = known_contracts
+                            .find_by_creation_code(init_code.as_ref())
+                            .map(|artifact| artifact.0.name.clone());
                         return Some(AdditionalContract {
                             opcode: node.trace.kind,
                             address: node.trace.address,
-                            init_code: node.trace.data.clone(),
+                            contract_name,
+                            init_code,
                         });
                     }
                     None

crates/script/src/simulate.rs

@@ -149,7 +149,11 @@ impl PreSimulationState {
                 };
 
                 let transaction = ScriptTransactionBuilder::from(transaction)
-                    .with_execution_result(&result, self.args.gas_estimate_multiplier)
+                    .with_execution_result(
+                        &result,
+                        self.args.gas_estimate_multiplier,
+                        &self.build_data,
+                    )
                     .build();
 
                 eyre::Ok((Some(transaction), is_noop_tx, result.traces))

crates/script/src/transaction.rs

@@ -1,4 +1,5 @@
 use super::ScriptResult;
+use crate::build::LinkedBuildData;
 use alloy_dyn_abi::JsonAbiExt;
 use alloy_primitives::{Address, B256, TxKind, hex};
 use eyre::Result;
@@ -146,8 +147,10 @@ impl ScriptTransactionBuilder {
         mut self,
         result: &ScriptResult,
         gas_estimate_multiplier: u64,
+        linked_build_data: &LinkedBuildData,
     ) -> Self {
-        let mut created_contracts = result.get_created_contracts();
+        let mut created_contracts =
+            result.get_created_contracts(&linked_build_data.known_contracts);
 
         // Add the additional contracts created in this transaction, so we can verify them later.
         created_contracts.retain(|contract| {