Merge pull request #8219 from ethereum-optimism/ctb/cleanup-expectemits

contracts-bedrock: cleanup expect emits

packages/contracts-bedrock/.gas-snapshot

@@ -2,16 +2,16 @@ AdminFaucetAuthModuleTest:test_adminProof_verify_succeeds() (gas: 57607)
 AdminFaucetAuthModuleTest:test_nonAdminProof_verify_succeeds() (gas: 59050)
 AdminFaucetAuthModuleTest:test_proofWithWrongId_verify_succeeds() (gas: 60673)
 AssetReceiverTest:test_constructor_succeeds() (gas: 9693)
-AssetReceiverTest:test_receive_succeeds() (gas: 20844)
-AssetReceiverTest:test_withdrawERC20_succeeds() (gas: 183383)
+AssetReceiverTest:test_receive_succeeds() (gas: 20763)
+AssetReceiverTest:test_withdrawERC20_succeeds() (gas: 183320)
 AssetReceiverTest:test_withdrawERC20_unauthorized_reverts() (gas: 153517)
-AssetReceiverTest:test_withdrawERC20withAmount_succeeds() (gas: 182567)
+AssetReceiverTest:test_withdrawERC20withAmount_succeeds() (gas: 182507)
 AssetReceiverTest:test_withdrawERC20withAmount_unauthorized_reverts() (gas: 153564)
-AssetReceiverTest:test_withdrawERC721_succeeds() (gas: 50755)
+AssetReceiverTest:test_withdrawERC721_succeeds() (gas: 50695)
 AssetReceiverTest:test_withdrawERC721_unauthorized_reverts() (gas: 51063)
-AssetReceiverTest:test_withdrawETH_succeeds() (gas: 28344)
+AssetReceiverTest:test_withdrawETH_succeeds() (gas: 28266)
 AssetReceiverTest:test_withdrawETH_unauthorized_reverts() (gas: 10680)
-AssetReceiverTest:test_withdrawETHwithAmount_succeeds() (gas: 28241)
+AssetReceiverTest:test_withdrawETHwithAmount_succeeds() (gas: 28163)
 AssetReceiverTest:test_withdrawETHwithAmount_unauthorized_reverts() (gas: 10738)
 AttestationStationTest:test_attest_bulk_succeeds() (gas: 544321)
 AttestationStationTest:test_attest_individual_succeeds() (gas: 472850)
@@ -57,25 +57,25 @@ DisputeGameFactory_SetImplementation_Test:test_setImplementation_succeeds() (gas
 DisputeGameFactory_TransferOwnership_Test:test_transferOwnership_notOwner_reverts() (gas: 15974)
 DisputeGameFactory_TransferOwnership_Test:test_transferOwnership_succeeds() (gas: 18738)
 Drippie_Test:test_create_calledTwice_reverts() (gas: 168887)
-Drippie_Test:test_create_succeeds() (gas: 183401)
-Drippie_Test:test_drip_amount_succeeds() (gas: 285375)
+Drippie_Test:test_create_succeeds() (gas: 183459)
+Drippie_Test:test_drip_amount_succeeds() (gas: 285433)
 Drippie_Test:test_drip_notExist_reverts() (gas: 14920)
 Drippie_Test:test_drip_reentrant_reverts() (gas: 18875)
 Drippie_Test:test_name_notExist_reverts() (gas: 16056)
 Drippie_Test:test_notReentrant_zeroInterval_reverts() (gas: 18889)
 Drippie_Test:test_not_active_reverts() (gas: 171184)
-Drippie_Test:test_reentrant_succeeds() (gas: 180180)
+Drippie_Test:test_reentrant_succeeds() (gas: 180111)
 Drippie_Test:test_set_statusNone_reverts() (gas: 168743)
 Drippie_Test:test_set_statusSame_reverts() (gas: 169240)
-Drippie_Test:test_set_status_succeeds() (gas: 198536)
-Drippie_Test:test_shouldArchive_ifPaused_succeeds() (gas: 177348)
+Drippie_Test:test_set_status_succeeds() (gas: 198710)
+Drippie_Test:test_shouldArchive_ifPaused_succeeds() (gas: 177406)
 Drippie_Test:test_shouldNotAllowActive_ifArchived_reverts() (gas: 174691)
 Drippie_Test:test_shouldNotAllowPaused_ifArchived_reverts() (gas: 174714)
 Drippie_Test:test_shouldNotArchive_ifActive_reverts() (gas: 175754)
 Drippie_Test:test_status_unauthorized_reverts() (gas: 167410)
-Drippie_Test:test_trigger_oneFunction_succeeds() (gas: 338248)
-Drippie_Test:test_trigger_twoFunctions_succeeds() (gas: 491929)
-Drippie_Test:test_twice_inOneInterval_reverts() (gas: 303889)
+Drippie_Test:test_trigger_oneFunction_succeeds() (gas: 338179)
+Drippie_Test:test_trigger_twoFunctions_succeeds() (gas: 491860)
+Drippie_Test:test_twice_inOneInterval_reverts() (gas: 303820)
 FaucetTest:test_authAdmin_drip_succeeds() (gas: 366064)
 FaucetTest:test_drip_afterTimeout_succeeds() (gas: 447913)
 FaucetTest:test_drip_beforeTimeout_reverts() (gas: 378906)
@@ -172,16 +172,16 @@ L1BlockTest:test_timestamp_succeeds() (gas: 7663)
 L1BlockTest:test_updateValues_succeeds() (gas: 63327)
 L1CrossDomainMessenger_Test:test_messageVersion_succeeds() (gas: 24803)
 L1CrossDomainMessenger_Test:test_relayMessage_legacyOldReplay_reverts() (gas: 49385)
-L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterFailureThenSuccess_reverts() (gas: 236964)
-L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterFailure_succeeds() (gas: 230862)
-L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterSuccess_reverts() (gas: 123892)
-L1CrossDomainMessenger_Test:test_relayMessage_legacy_succeeds() (gas: 77251)
-L1CrossDomainMessenger_Test:test_relayMessage_retryAfterFailure_succeeds() (gas: 224880)
-L1CrossDomainMessenger_Test:test_relayMessage_succeeds() (gas: 74287)
+L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterFailureThenSuccess_reverts() (gas: 237022)
+L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterFailure_succeeds() (gas: 230978)
+L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterSuccess_reverts() (gas: 123950)
+L1CrossDomainMessenger_Test:test_relayMessage_legacy_succeeds() (gas: 77309)
+L1CrossDomainMessenger_Test:test_relayMessage_retryAfterFailure_succeeds() (gas: 224938)
+L1CrossDomainMessenger_Test:test_relayMessage_succeeds() (gas: 74345)
 L1CrossDomainMessenger_Test:test_relayMessage_toSystemContract_reverts() (gas: 56475)
 L1CrossDomainMessenger_Test:test_relayMessage_v2_reverts() (gas: 12410)
 L1CrossDomainMessenger_Test:test_replayMessage_withValue_reverts() (gas: 31031)
-L1CrossDomainMessenger_Test:test_sendMessage_succeeds() (gas: 390778)
+L1CrossDomainMessenger_Test:test_sendMessage_succeeds() (gas: 390952)
 L1CrossDomainMessenger_Test:test_sendMessage_twice_succeeds() (gas: 1666956)
 L1CrossDomainMessenger_Test:test_xDomainMessageSender_reset_succeeds() (gas: 85630)
 L1CrossDomainMessenger_Test:test_xDomainSender_notSet_reverts() (gas: 24282)
@@ -661,13 +661,13 @@ ResourceMetering_Test:test_meter_useMax_succeeds() (gas: 20020816)
 ResourceMetering_Test:test_meter_useMoreThanMax_reverts() (gas: 19549)
 SafeCall_Test:test_callWithMinGas_noLeakageHigh_succeeds() (gas: 1020805932)
 SafeCall_Test:test_callWithMinGas_noLeakageLow_succeeds() (gas: 1094905711)
-SequencerFeeVault_L2Withdrawal_Test:test_withdraw_toL2_succeeds() (gas: 80640)
+SequencerFeeVault_L2Withdrawal_Test:test_withdraw_toL2_succeeds() (gas: 80502)
 SequencerFeeVault_L2Withdrawal_Test:test_withdraw_toL2recipientReverts_fails() (gas: 48948)
 SequencerFeeVault_Test:test_constructor_succeeds() (gas: 7705)
 SequencerFeeVault_Test:test_minWithdrawalAmount_succeeds() (gas: 12794)
 SequencerFeeVault_Test:test_receive_succeeds() (gas: 17395)
 SequencerFeeVault_Test:test_withdraw_notEnough_reverts() (gas: 9399)
-SequencerFeeVault_Test:test_withdraw_toL1_succeeds() (gas: 616228)
+SequencerFeeVault_Test:test_withdraw_toL1_succeeds() (gas: 616090)
 SetPrevBaseFee_Test:test_setPrevBaseFee_succeeds() (gas: 11595)
 StandardBridge_Stateless_Test:test_isCorrectTokenPair_succeeds() (gas: 50149)
 StandardBridge_Stateless_Test:test_isOptimismMintableERC20_succeeds() (gas: 33142)

packages/contracts-bedrock/test/AssetReceiver.t.sol

@@ -53,7 +53,7 @@ contract AssetReceiverTest is AssetReceiver_Initializer {
         // Check that contract balance is 0 initially
         assertEq(address(assetReceiver).balance, 0);
 
-        vm.expectEmit(true, true, true, true, address(assetReceiver));
+        vm.expectEmit(address(assetReceiver));
         emit ReceivedETH(alice, 100);
         // Send funds
         vm.prank(alice);
@@ -75,7 +75,7 @@ contract AssetReceiverTest is AssetReceiver_Initializer {
 
         assertEq(address(alice).balance, 1 ether);
 
-        vm.expectEmit(true, true, true, true, address(assetReceiver));
+        vm.expectEmit(address(assetReceiver));
         emit WithdrewETH(alice, alice, 1 ether);
 
         // call withdrawETH
@@ -103,7 +103,7 @@ contract AssetReceiverTest is AssetReceiver_Initializer {
 
         assertEq(address(alice).balance, 1 ether);
 
-        vm.expectEmit(true, true, true, true, address(assetReceiver));
+        vm.expectEmit(address(assetReceiver));
         emit WithdrewETH(alice, alice, 0.5 ether);
 
         // call withdrawETH
@@ -131,7 +131,7 @@ contract AssetReceiverTest is AssetReceiver_Initializer {
         assertEq(testERC20.balanceOf(address(assetReceiver)), 100_000);
         assertEq(testERC20.balanceOf(alice), 0);
 
-        vm.expectEmit(true, true, true, true, address(assetReceiver));
+        vm.expectEmit(address(assetReceiver));
         emit WithdrewERC20(alice, alice, address(testERC20), 100_000);
 
         // call withdrawERC20
@@ -159,7 +159,7 @@ contract AssetReceiverTest is AssetReceiver_Initializer {
         assertEq(testERC20.balanceOf(address(assetReceiver)), 100_000);
         assertEq(testERC20.balanceOf(alice), 0);
 
-        vm.expectEmit(true, true, true, true, address(assetReceiver));
+        vm.expectEmit(address(assetReceiver));
         emit WithdrewERC20(alice, alice, address(testERC20), 50_000);
 
         // call withdrawERC20
@@ -188,7 +188,7 @@ contract AssetReceiverTest is AssetReceiver_Initializer {
         testERC721.transferFrom(alice, address(assetReceiver), DEFAULT_TOKEN_ID);
         assertEq(testERC721.ownerOf(DEFAULT_TOKEN_ID), address(assetReceiver));
 
-        vm.expectEmit(true, true, true, true, address(assetReceiver));
+        vm.expectEmit(address(assetReceiver));
         emit WithdrewERC721(alice, alice, address(testERC721), DEFAULT_TOKEN_ID);
 
         // Call withdrawERC721

packages/contracts-bedrock/test/Drippie.t.sol

@@ -116,7 +116,7 @@ contract Drippie_Test is Test {
     /// @notice Creates a drip and asserts that it was configured as expected.
     function test_create_succeeds() external {
         Drippie.DripConfig memory cfg = _defaultConfig();
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(drippie));
         emit DripCreated(dripName, dripName, cfg);
 
         if (cfg.reentrant) {
@@ -170,7 +170,7 @@ contract Drippie_Test is Test {
 
     /// @notice The owner should be able to set the status of the drip.
     function test_set_status_succeeds() external {
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(drippie));
         emit DripCreated(dripName, dripName, _defaultConfig());
         _createDefaultDrip(dripName);
 
@@ -183,7 +183,7 @@ contract Drippie_Test is Test {
 
         vm.prank(owner);
 
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(drippie));
         emit DripStatusUpdated({ nameref: dripName, name: dripName, status: Drippie.DripStatus.ACTIVE });
 
         drippie.status(dripName, Drippie.DripStatus.ACTIVE);
@@ -195,7 +195,7 @@ contract Drippie_Test is Test {
 
         vm.prank(owner);
 
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(drippie));
         emit DripStatusUpdated({ nameref: dripName, name: dripName, status: Drippie.DripStatus.PAUSED });
 
         drippie.status(dripName, Drippie.DripStatus.PAUSED);
@@ -238,7 +238,7 @@ contract Drippie_Test is Test {
 
         vm.prank(owner);
 
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(drippie));
         emit DripStatusUpdated({ nameref: dripName, name: dripName, status: Drippie.DripStatus.ARCHIVED });
 
         drippie.status(dripName, Drippie.DripStatus.ARCHIVED);
@@ -321,7 +321,7 @@ contract Drippie_Test is Test {
 
         _warpToExecutable(dripName);
 
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(drippie));
         emit DripExecuted({ nameref: dripName, name: dripName, executor: address(this), timestamp: block.timestamp });
 
         Drippie.DripAction[] memory actions = drippie.dripConfigActions(dripName);
@@ -358,7 +358,7 @@ contract Drippie_Test is Test {
 
         vm.expectCall(address(simpleStorage), 0, abi.encodeWithSelector(SimpleStorage.set.selector, key, value));
 
-        vm.expectEmit(true, true, true, true, address(drippie));
+        vm.expectEmit(address(drippie));
         emit DripExecuted(dripName, dripName, address(this), block.timestamp);
         drippie.drip(dripName);
 
@@ -402,7 +402,7 @@ contract Drippie_Test is Test {
 
         vm.expectCall(address(simpleStorage), 0, abi.encodeWithSelector(SimpleStorage.set.selector, keyTwo, valueTwo));
 
-        vm.expectEmit(true, true, true, true, address(drippie));
+        vm.expectEmit(address(drippie));
         emit DripExecuted(dripName, dripName, address(this), block.timestamp);
         drippie.drip(dripName);
 
@@ -434,7 +434,7 @@ contract Drippie_Test is Test {
 
         _warpToExecutable(dripName);
 
-        vm.expectEmit(true, true, true, true, address(drippie));
+        vm.expectEmit(address(drippie));
         emit DripExecuted({ nameref: dripName, name: dripName, executor: address(this), timestamp: block.timestamp });
 
         drippie.drip(dripName);
@@ -472,7 +472,7 @@ contract Drippie_Test is Test {
         cfg.interval = 0;
 
         vm.prank(owner);
-        vm.expectEmit(true, true, true, true, address(drippie));
+        vm.expectEmit(address(drippie));
         emit DripCreated(dripName, dripName, cfg);
         drippie.create(dripName, cfg);
 

packages/contracts-bedrock/test/L1CrossDomainMessenger.t.sol

@@ -47,7 +47,7 @@ contract L1CrossDomainMessenger_Test is Bridge_Initializer {
         );
 
         // TransactionDeposited event
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(optimismPortal));
         emitTransactionDeposited(
             AddressAliasHelper.applyL1ToL2Alias(address(l1CrossDomainMessenger)),
             Predeploys.L2_CROSS_DOMAIN_MESSENGER,
@@ -59,11 +59,11 @@ contract L1CrossDomainMessenger_Test is Bridge_Initializer {
         );
 
         // SentMessage event
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(l1CrossDomainMessenger));
         emit SentMessage(recipient, alice, hex"ff", l1CrossDomainMessenger.messageNonce(), 100);
 
         // SentMessageExtension1 event
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(l1CrossDomainMessenger));
         emit SentMessageExtension1(alice, 0);
 
         vm.prank(alice);
@@ -122,7 +122,7 @@ contract L1CrossDomainMessenger_Test is Bridge_Initializer {
         vm.store(address(optimismPortal), bytes32(senderSlotIndex), bytes32(abi.encode(sender)));
         vm.prank(address(optimismPortal));
 
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(l1CrossDomainMessenger));
 
         bytes32 hash = Hashing.hashCrossDomainMessage(
             Encoding.encodeVersionedNonce({ _nonce: 0, _version: 1 }), sender, target, 0, 0, hex"1111"
@@ -229,7 +229,7 @@ contract L1CrossDomainMessenger_Test is Bridge_Initializer {
         assertEq(l1CrossDomainMessenger.successfulMessages(hash), false);
         assertEq(l1CrossDomainMessenger.failedMessages(hash), true);
 
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(l1CrossDomainMessenger));
 
         emit RelayedMessage(hash);
 
@@ -275,7 +275,7 @@ contract L1CrossDomainMessenger_Test is Bridge_Initializer {
         vm.expectCall(target, hex"1111");
 
         // Expect RelayedMessage event to be emitted.
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(l1CrossDomainMessenger));
         emit RelayedMessage(hash);
 
         // Relay the message.
@@ -364,7 +364,7 @@ contract L1CrossDomainMessenger_Test is Bridge_Initializer {
         vm.expectCall(target, hex"1111");
 
         // Expect FailedRelayedMessage event to be emitted.
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(l1CrossDomainMessenger));
         emit FailedRelayedMessage(hash);
 
         // Relay the message.
@@ -392,7 +392,7 @@ contract L1CrossDomainMessenger_Test is Bridge_Initializer {
         vm.expectCall(target, hex"1111");
 
         // Expect RelayedMessage event to be emitted.
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(l1CrossDomainMessenger));
         emit RelayedMessage(hash);
 
         // Retry the message.
@@ -437,7 +437,7 @@ contract L1CrossDomainMessenger_Test is Bridge_Initializer {
         vm.expectCall(target, hex"1111");
 
         // Expect RelayedMessage event to be emitted.
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(l1CrossDomainMessenger));
         emit RelayedMessage(hash);
 
         // Relay the message.
@@ -524,7 +524,7 @@ contract L1CrossDomainMessenger_Test is Bridge_Initializer {
         vm.expectCall(target, hex"1111");
 
         // Expect RelayedMessage event to be emitted.
-        vm.expectEmit(true, true, true, true);
+        vm.expectEmit(address(l1CrossDomainMessenger));
         emit RelayedMessage(hash);
 
         // Retry the message

packages/contracts-bedrock/test/SequencerFeeVault.t.sol

@@ -70,9 +70,9 @@ contract SequencerFeeVault_Test is CommonTest {
         // No ether has been withdrawn yet
         assertEq(sequencerFeeVault.totalProcessed(), 0);
 
-        vm.expectEmit(true, true, true, true, address(Predeploys.SEQUENCER_FEE_WALLET));
+        vm.expectEmit(address(Predeploys.SEQUENCER_FEE_WALLET));
         emit Withdrawal(address(sequencerFeeVault).balance, sequencerFeeVault.RECIPIENT(), address(this));
-        vm.expectEmit(true, true, true, true, address(Predeploys.SEQUENCER_FEE_WALLET));
+        vm.expectEmit(address(Predeploys.SEQUENCER_FEE_WALLET));
         emit Withdrawal(
             address(sequencerFeeVault).balance,
             sequencerFeeVault.RECIPIENT(),
@@ -115,9 +115,9 @@ contract SequencerFeeVault_L2Withdrawal_Test is CommonTest {
         // No ether has been withdrawn yet
         assertEq(sequencerFeeVault.totalProcessed(), 0);
 
-        vm.expectEmit(true, true, true, true, address(Predeploys.SEQUENCER_FEE_WALLET));
+        vm.expectEmit(address(Predeploys.SEQUENCER_FEE_WALLET));
         emit Withdrawal(address(sequencerFeeVault).balance, sequencerFeeVault.RECIPIENT(), address(this));
-        vm.expectEmit(true, true, true, true, address(Predeploys.SEQUENCER_FEE_WALLET));
+        vm.expectEmit(address(Predeploys.SEQUENCER_FEE_WALLET));
         emit Withdrawal(
             address(sequencerFeeVault).balance,
             sequencerFeeVault.RECIPIENT(),