feat(cheatcodes): access broadcast artifacts

[yash-atreya]

Motivation

Builds upon #9098

Closes #4732 + partially addresses #9083
Closes #6807

#9083 requires access to the broadcast artifacts while the script is running. This isn't possible with the current script design as txs are broadcasted and their respective artifacts are written after the execution of the script is complete.

Solution

// Returns the most recent broadcast for the given contract on `chainId` matching `txType`.
function getBroadcast(string memory contractName, uint64 chainId, BroadcastTxType txType) external returns (BroadcastTxSummary memory);

//  Returns all broadcasts for the given contract on `chainId` with the specified `txType`.
//  Sorted such that the most recent broadcast is the first element, and the oldest is the last. i.e descending order of BroadcastTxSummary.blockNumber.
function getBroadcasts(string memory contractName, uint64 chainId, BroadcastTxType txType) external returns (BroadcastTxSummary[] memory);

// Returns all broadcasts for the given contract on `chainId`.
// Sorted such that the most recent broadcast is the first element, and the oldest is the last. i.e descending order of BroadcastTxSummary.blockNumber.
function getBroadcasts(string memory contractName, uint64 chainId) external returns (BroadcastTxSummary[] memory);

// Returns the most recent deployment for the current `chainId`.
function getDeployment(string memory contractName) external returns (address deployedAddress);

// Returns the most recent deployment for the given contract on `chainId`
function getDeployment(string memory contractName, uint64 chainId) external returns (address deployedAddress);

// Returns all deployments for the given contract on `chainId`
// Sorted in descending order of deployment time i.e descending order of BroadcastTxSummary.blockNumber.
// The most recent deployment is the first element, and the oldest is the last.
function getDeployments(string memory contractName, uint64 chainId) external returns (address[] memory deployedAddresses);

These cheatcodes enable the following behaviour:

• Deploy a contract forge script CounterDeployScript --broadcast
• Access the broadcast artifacts forge script BroadcastCollector

contract BroadcastCollector is Script {
    function run() public {
        // Get the most recent counter deployment
        Vm.BroadcastTxSummary memory broadcast = Vm(address(vm)).getBroadcast(
            "Counter",
            31337,
            Vm.BroadcastTxType.Create
        );

        console.logBytes32(broadcast.txHash);
        console.logAddress(broadcast.contractAddress); // New contract address
    }
}

• Tests

[yash-atreya]

I don't think this will close #9083 because it mentions the need for access of transaction hashes during script execution, which is not really feasible with current script design. This PR only adds access to artifacts after script was broadcasted

And #4732 mentions access of deployed contract addresses vs broadcasted transactions data, so I think we should either follow its design where you are getting address by string memory contractName ot at least add helpers matching the proposed getDeployment cheats to make API simpler

@klkvr added the getDeployment helpers.

[klkvr]

nice, looking good

just have nits