Merge pull request #5101 from ethereum-optimism/fix/gas-benchmarks

contracts-bedrock: fix gas benchmarks

packages/contracts-bedrock/.gas-snapshot

@@ -29,17 +29,17 @@ DeployerWhitelist_Test:test_owner_succeeds() (gas: 7582)
 DeployerWhitelist_Test:test_storageSlots_succeeds() (gas: 33395)
 FeeVault_Test:test_constructor_succeeds() (gas: 10736)
 FeeVault_Test:test_minWithdrawalAmount_succeeds() (gas: 10713)
-GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_0() (gas: 261350)
-GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_1() (gas: 76077)
-GasBenchMark_L1StandardBridge_Deposit:test_depositERC20_benchmark_0() (gas: 348302)
-GasBenchMark_L1StandardBridge_Deposit:test_depositERC20_benchmark_1() (gas: 112955)
-GasBenchMark_L1StandardBridge_Deposit:test_depositETH_benchmark_0() (gas: 348324)
-GasBenchMark_L1StandardBridge_Deposit:test_depositETH_benchmark_1() (gas: 112975)
+GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_0() (gas: 266726)
+GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_1() (gas: 2100049)
+GasBenchMark_L1StandardBridge_Deposit:test_depositERC20_benchmark_0() (gas: 452677)
+GasBenchMark_L1StandardBridge_Deposit:test_depositERC20_benchmark_1() (gas: 3199814)
+GasBenchMark_L1StandardBridge_Deposit:test_depositETH_benchmark_0() (gas: 353934)
+GasBenchMark_L1StandardBridge_Deposit:test_depositETH_benchmark_1() (gas: 2634777)
 GasBenchMark_L1StandardBridge_Finalize:test_finalizeETHWithdrawal_benchmark() (gas: 40409)
 GasBenchMark_L2OutputOracle:test_proposeL2Output_benchmark() (gas: 88513)
 GasBenchMark_OptimismPortal:test_depositTransaction_benchmark() (gas: 75085)
-GasBenchMark_OptimismPortal:test_depositTransaction_benchmark_1() (gas: 36396)
-GasBenchMark_OptimismPortal:test_proveWithdrawalTransaction_benchmark() (gas: 169229)
+GasBenchMark_OptimismPortal:test_depositTransaction_benchmark_1() (gas: 77809)
+GasBenchMark_OptimismPortal:test_proveWithdrawalTransaction_benchmark() (gas: 169237)
 GasPriceOracle_Test:test_baseFee_succeeds() (gas: 8325)
 GasPriceOracle_Test:test_decimals_succeeds() (gas: 6167)
 GasPriceOracle_Test:test_gasPrice_succeeds() (gas: 8294)
@@ -70,43 +70,43 @@ L1BlockTest:test_timestamp_succeeds() (gas: 7640)
 L1BlockTest:test_updateValues_succeeds() (gas: 60482)
 L1CrossDomainMessenger_Test:test_messageVersion_succeeds() (gas: 24715)
 L1CrossDomainMessenger_Test:test_relayMessage_legacyOldReplay_reverts() (gas: 49394)
-L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterFailureThenSuccess_reverts() (gas: 228315)
-L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterFailure_succeeds() (gas: 201809)
-L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterSuccess_reverts() (gas: 142009)
-L1CrossDomainMessenger_Test:test_relayMessage_legacy_succeeds() (gas: 74919)
-L1CrossDomainMessenger_Test:test_relayMessage_reentrancyDiffMessage_succeeds() (gas: 720561)
-L1CrossDomainMessenger_Test:test_relayMessage_reentrancySameMessage_reverts() (gas: 657661)
-L1CrossDomainMessenger_Test:test_relayMessage_retryAfterFailure_succeeds() (gas: 195716)
-L1CrossDomainMessenger_Test:test_relayMessage_succeeds() (gas: 71855)
-L1CrossDomainMessenger_Test:test_relayMessage_toSystemContract_reverts() (gas: 96299)
+L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterFailureThenSuccess_reverts() (gas: 233298)
+L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterFailure_succeeds() (gas: 206792)
+L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterSuccess_reverts() (gas: 146992)
+L1CrossDomainMessenger_Test:test_relayMessage_legacy_succeeds() (gas: 79902)
+L1CrossDomainMessenger_Test:test_relayMessage_reentrancyDiffMessage_succeeds() (gas: 726027)
+L1CrossDomainMessenger_Test:test_relayMessage_reentrancySameMessage_reverts() (gas: 662644)
+L1CrossDomainMessenger_Test:test_relayMessage_retryAfterFailure_succeeds() (gas: 200699)
+L1CrossDomainMessenger_Test:test_relayMessage_succeeds() (gas: 76838)
+L1CrossDomainMessenger_Test:test_relayMessage_toSystemContract_reverts() (gas: 101282)
 L1CrossDomainMessenger_Test:test_relayMessage_v2_reverts() (gas: 12365)
 L1CrossDomainMessenger_Test:test_replayMessage_withValue_reverts() (gas: 53445)
-L1CrossDomainMessenger_Test:test_sendMessage_succeeds() (gas: 299704)
-L1CrossDomainMessenger_Test:test_sendMessage_twice_succeeds() (gas: 1490580)
-L1CrossDomainMessenger_Test:test_xDomainMessageSender_reset_succeeds() (gas: 82384)
+L1CrossDomainMessenger_Test:test_sendMessage_succeeds() (gas: 304768)
+L1CrossDomainMessenger_Test:test_sendMessage_twice_succeeds() (gas: 1496208)
+L1CrossDomainMessenger_Test:test_xDomainMessageSender_reset_succeeds() (gas: 87367)
 L1CrossDomainMessenger_Test:test_xDomainSender_notSet_reverts() (gas: 24296)
 L1ERC721Bridge_Test:test_bridgeERC721To_localTokenZeroAddress_reverts() (gas: 52707)
 L1ERC721Bridge_Test:test_bridgeERC721To_remoteTokenZeroAddress_reverts() (gas: 27310)
-L1ERC721Bridge_Test:test_bridgeERC721To_succeeds() (gas: 354750)
+L1ERC721Bridge_Test:test_bridgeERC721To_succeeds() (gas: 359863)
 L1ERC721Bridge_Test:test_bridgeERC721To_wrongOwner_reverts() (gas: 60934)
 L1ERC721Bridge_Test:test_bridgeERC721_fromContract_reverts() (gas: 25666)
 L1ERC721Bridge_Test:test_bridgeERC721_localTokenZeroAddress_reverts() (gas: 50564)
 L1ERC721Bridge_Test:test_bridgeERC721_remoteTokenZeroAddress_reverts() (gas: 25124)
-L1ERC721Bridge_Test:test_bridgeERC721_succeeds() (gas: 352330)
+L1ERC721Bridge_Test:test_bridgeERC721_succeeds() (gas: 357443)
 L1ERC721Bridge_Test:test_bridgeERC721_wrongOwner_reverts() (gas: 60830)
 L1ERC721Bridge_Test:test_constructor_succeeds() (gas: 10200)
 L1ERC721Bridge_Test:test_finalizeBridgeERC721_notEscrowed_reverts() (gas: 22119)
 L1ERC721Bridge_Test:test_finalizeBridgeERC721_notFromRemoteMessenger_reverts() (gas: 19797)
 L1ERC721Bridge_Test:test_finalizeBridgeERC721_notViaLocalMessenger_reverts() (gas: 16049)
 L1ERC721Bridge_Test:test_finalizeBridgeERC721_selfToken_reverts() (gas: 17615)
-L1ERC721Bridge_Test:test_finalizeBridgeERC721_succeeds() (gas: 323842)
-L1StandardBridge_BridgeETHTo_Test:test_bridgeETHTo_succeeds() (gas: 419592)
-L1StandardBridge_BridgeETH_Test:test_bridgeETH_succeeds() (gas: 406813)
-L1StandardBridge_DepositERC20To_Test:test_depositERC20To_succeeds() (gas: 624889)
-L1StandardBridge_DepositERC20_Test:test_depositERC20_succeeds() (gas: 622590)
+L1ERC721Bridge_Test:test_finalizeBridgeERC721_succeeds() (gas: 328955)
+L1StandardBridge_BridgeETHTo_Test:test_bridgeETHTo_succeeds() (gas: 424692)
+L1StandardBridge_BridgeETH_Test:test_bridgeETH_succeeds() (gas: 411913)
+L1StandardBridge_DepositERC20To_Test:test_depositERC20To_succeeds() (gas: 629996)
+L1StandardBridge_DepositERC20_Test:test_depositERC20_succeeds() (gas: 627697)
 L1StandardBridge_DepositERC20_TestFail:test_depositERC20_notEoa_reverts() (gas: 22320)
-L1StandardBridge_DepositETHTo_Test:test_depositETHTo_succeeds() (gas: 419669)
-L1StandardBridge_DepositETH_Test:test_depositETH_succeeds() (gas: 406907)
+L1StandardBridge_DepositETHTo_Test:test_depositETHTo_succeeds() (gas: 424769)
+L1StandardBridge_DepositETH_Test:test_depositETH_succeeds() (gas: 412007)
 L1StandardBridge_DepositETH_TestFail:test_depositETH_notEoa_reverts() (gas: 40780)
 L1StandardBridge_FinalizeBridgeETH_Test:test_finalizeBridgeETH_succeeds() (gas: 51674)
 L1StandardBridge_FinalizeBridgeETH_TestFail:test_finalizeBridgeETH_incorrectValue_reverts() (gas: 34207)
@@ -118,7 +118,7 @@ L1StandardBridge_FinalizeERC20Withdrawal_TestFail:test_finalizeERC20Withdrawal_n
 L1StandardBridge_FinalizeETHWithdrawal_Test:test_finalizeETHWithdrawal_succeeds() (gas: 61722)
 L1StandardBridge_Getter_Test:test_getters_succeeds() (gas: 32173)
 L1StandardBridge_Initialize_Test:test_initialize_succeeds() (gas: 22050)
-L1StandardBridge_Receive_Test:test_receive_succeeds() (gas: 520216)
+L1StandardBridge_Receive_Test:test_receive_succeeds() (gas: 525310)
 L2CrossDomainMessenger_Test:test_messageVersion_succeeds() (gas: 8411)
 L2CrossDomainMessenger_Test:test_relayMessage_reentrancyDiffMessage_succeeds() (gas: 681087)
 L2CrossDomainMessenger_Test:test_relayMessage_reentrancySameMessage_reverts() (gas: 626802)
@@ -181,7 +181,7 @@ L2StandardBridge_BridgeERC20_Test:test_bridgeLegacyERC20_succeeds() (gas: 393552
 L2StandardBridge_BridgeERC20_Test:test_withdrawLegacyERC20_succeeds() (gas: 393878)
 L2StandardBridge_BridgeERC20_Test:test_withdraw_notEOA_reverts() (gas: 251758)
 L2StandardBridge_BridgeERC20_Test:test_withdraw_withdrawingERC20_succeeds() (gas: 385508)
-L2StandardBridge_Bridge_Test:test_finalizeBridgeETH_incorrectValue_reverts() (gas: 23843)
+L2StandardBridge_Bridge_Test:test_finalizeBridgeETH_incorrectValue_reverts() (gas: 23840)
 L2StandardBridge_Bridge_Test:test_finalizeBridgeETH_sendToMessenger_reverts() (gas: 23982)
 L2StandardBridge_Bridge_Test:test_finalizeBridgeETH_sendToSelf_reverts() (gas: 23870)
 L2StandardBridge_Bridge_Test:test_finalizeDeposit_depositingERC20_succeeds() (gas: 93824)
@@ -414,6 +414,7 @@ SequencerFeeVault_Test:test_minWithdrawalAmount_succeeds() (gas: 5442)
 SequencerFeeVault_Test:test_receive_succeeds() (gas: 17373)
 SequencerFeeVault_Test:test_withdraw_notEnough_reverts() (gas: 9331)
 SequencerFeeVault_Test:test_withdraw_succeeds() (gas: 163228)
+SetPrevBaseFee_Test:test_setPrevBaseFee_succeeds() (gas: 11559)
 StandardBridge_Stateless_Test:test_isCorrectTokenPair_succeeds() (gas: 49936)
 StandardBridge_Stateless_Test:test_isOptimismMintableERC20_succeeds() (gas: 33072)
 SystemConfig_Initialize_TestFail:test_initialize_lowGasLimit_reverts() (gas: 62012)

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

@@ -8,27 +8,22 @@ import "./CommonTest.t.sol";
 import { CrossDomainMessenger } from "../universal/CrossDomainMessenger.sol";
 import { ResourceMetering } from "../L1/ResourceMetering.sol";
 
-uint128 constant INITIAL_BASE_FEE = 1_000_000_000;
-
 // Free function for setting the prevBaseFee param in the OptimismPortal.
 function setPrevBaseFee(
     Vm _vm,
     address _op,
     uint128 _prevBaseFee
 ) {
-    _vm.store(
-        address(_op),
-        bytes32(uint256(1)),
-        bytes32(
-            abi.encode(
-                ResourceMetering.ResourceParams({
-                    prevBaseFee: _prevBaseFee,
-                    prevBoughtGas: 0,
-                    prevBlockNum: uint64(block.number)
-                })
-            )
-        )
-    );
+    _vm.store(address(_op), bytes32(uint256(1)), bytes32((block.number << 192) | _prevBaseFee));
+}
+
+contract SetPrevBaseFee_Test is Portal_Initializer {
+    function test_setPrevBaseFee_succeeds() external {
+        setPrevBaseFee(vm, address(op), 100 gwei);
+        (uint128 prevBaseFee, , uint64 prevBlockNum) = op.params();
+        assertEq(uint256(prevBaseFee), 100 gwei);
+        assertEq(uint256(prevBlockNum), block.number);
+    }
 }
 
 // Tests for obtaining pure gas cost estimates for commonly used functions.
@@ -37,6 +32,8 @@ function setPrevBaseFee(
 // In order to achieve this we make no assertions, and handle everything else in the setUp()
 // function.
 contract GasBenchMark_OptimismPortal is Portal_Initializer {
+    uint128 INITIAL_BASE_FEE;
+
     // Reusable default values for a test withdrawal
     Types.WithdrawalTransaction _defaultTx;
 
@@ -76,7 +73,7 @@ contract GasBenchMark_OptimismPortal is Portal_Initializer {
     }
 
     // Get the system into a nice ready-to-use state.
-    function setUp() public override {
+    function setUp() public virtual override {
         // Configure the oracle to return the output root we've prepared.
         vm.warp(oracle.computeL2Timestamp(_proposedBlockNumber) + 1);
         vm.prank(oracle.PROPOSER());
@@ -88,6 +85,9 @@ contract GasBenchMark_OptimismPortal is Portal_Initializer {
                 oracle.FINALIZATION_PERIOD_SECONDS() +
                 1
         );
+
+        INITIAL_BASE_FEE = op.INITIAL_BASE_FEE();
+
         // Fund the portal so that we can withdraw ETH.
         vm.deal(address(op), 0xFFFFFFFF);
     }
@@ -124,45 +124,83 @@ contract GasBenchMark_OptimismPortal is Portal_Initializer {
 }
 
 contract GasBenchMark_L1CrossDomainMessenger is Messenger_Initializer {
+    uint128 INITIAL_BASE_FEE;
+
+    function setUp() public virtual override {
+        super.setUp();
+        INITIAL_BASE_FEE = op.INITIAL_BASE_FEE();
+    }
+
     function test_sendMessage_benchmark_0() external {
+        vm.pauseGasMetering();
+        setPrevBaseFee(vm, address(op), INITIAL_BASE_FEE);
         // The amount of data typically sent during a bridge deposit.
         bytes
             memory data = hex"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff";
+        vm.resumeGasMetering();
         L1Messenger.sendMessage(bob, data, uint32(100));
     }
 
     function test_sendMessage_benchmark_1() external {
-        setPrevBaseFee(vm, address(op), INITIAL_BASE_FEE);
+        vm.pauseGasMetering();
+        setPrevBaseFee(vm, address(op), 10 gwei);
         // The amount of data typically sent during a bridge deposit.
         bytes
             memory data = hex"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff";
+        vm.resumeGasMetering();
         L1Messenger.sendMessage(bob, data, uint32(100));
     }
 }
 
 contract GasBenchMark_L1StandardBridge_Deposit is Bridge_Initializer {
+    uint128 INITIAL_BASE_FEE;
+
     function setUp() public virtual override {
         super.setUp();
+        INITIAL_BASE_FEE = op.INITIAL_BASE_FEE();
         deal(address(L1Token), alice, 100000, true);
         vm.startPrank(alice, alice);
+        L1Token.approve(address(L1Bridge), type(uint256).max);
     }
 
     function test_depositETH_benchmark_0() external {
+        vm.pauseGasMetering();
+        setPrevBaseFee(vm, address(op), INITIAL_BASE_FEE);
+        vm.resumeGasMetering();
         L1Bridge.depositETH{ value: 500 }(50000, hex"");
     }
 
     function test_depositETH_benchmark_1() external {
-        setPrevBaseFee(vm, address(op), INITIAL_BASE_FEE);
+        vm.pauseGasMetering();
+        setPrevBaseFee(vm, address(op), 10 gwei);
+        vm.resumeGasMetering();
         L1Bridge.depositETH{ value: 500 }(50000, hex"");
     }
 
     function test_depositERC20_benchmark_0() external {
-        L1Bridge.depositETH{ value: 500 }(50000, hex"");
+        vm.pauseGasMetering();
+        setPrevBaseFee(vm, address(op), INITIAL_BASE_FEE);
+        vm.resumeGasMetering();
+        L1Bridge.bridgeERC20({
+            _localToken: address(L1Token),
+            _remoteToken: address(L2Token),
+            _amount: 100,
+            _minGasLimit: 100_000,
+            _extraData: hex""
+        });
     }
 
     function test_depositERC20_benchmark_1() external {
-        setPrevBaseFee(vm, address(op), INITIAL_BASE_FEE);
-        L1Bridge.depositETH{ value: 500 }(50000, hex"");
+        vm.pauseGasMetering();
+        setPrevBaseFee(vm, address(op), 10 gwei);
+        vm.resumeGasMetering();
+        L1Bridge.bridgeERC20({
+            _localToken: address(L1Token),
+            _remoteToken: address(L2Token),
+            _amount: 100,
+            _minGasLimit: 100_000,
+            _extraData: hex""
+        });
     }
 }
 

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

@@ -156,8 +156,8 @@ contract L2OutputOracle_Initializer is CommonTest {
 
 contract Portal_Initializer is L2OutputOracle_Initializer {
     // Test target
-    OptimismPortal opImpl;
-    OptimismPortal op;
+    OptimismPortal internal opImpl;
+    OptimismPortal internal op;
 
     event WithdrawalFinalized(bytes32 indexed withdrawalHash, bool success);
     event WithdrawalProven(
@@ -177,14 +177,14 @@ contract Portal_Initializer is L2OutputOracle_Initializer {
             abi.encodeWithSelector(OptimismPortal.initialize.selector, false)
         );
         op = OptimismPortal(payable(address(proxy)));
+        vm.label(address(op), "OptimismPortal");
     }
 }
 
-contract Messenger_Initializer is L2OutputOracle_Initializer {
-    OptimismPortal op;
-    AddressManager addressManager;
-    L1CrossDomainMessenger L1Messenger;
-    L2CrossDomainMessenger L2Messenger =
+contract Messenger_Initializer is Portal_Initializer {
+    AddressManager internal addressManager;
+    L1CrossDomainMessenger internal L1Messenger;
+    L2CrossDomainMessenger internal L2Messenger =
         L2CrossDomainMessenger(Predeploys.L2_CROSS_DOMAIN_MESSENGER);
 
     event SentMessage(
@@ -220,17 +220,11 @@ contract Messenger_Initializer is L2OutputOracle_Initializer {
         bytes data
     );
 
-    event WithdrawalFinalized(bytes32 indexed, bool success);
-
     event WhatHappened(bool success, bytes returndata);
 
     function setUp() public virtual override {
         super.setUp();
 
-        // Deploy the OptimismPortal
-        op = new OptimismPortal({ _l2Oracle: oracle, _guardian: guardian, _paused: false });
-        vm.label(address(op), "OptimismPortal");
-
         // Deploy the address manager
         vm.prank(multisig);
         addressManager = new AddressManager();

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

@@ -41,7 +41,7 @@ contract StandardBridgeTester is StandardBridge {
 contract LegacyMintable is ERC20, ILegacyMintableERC20 {
     constructor(string memory _name, string memory _ticker) ERC20(_name, _ticker) {}
 
-    function l1Token() external view returns (address) {
+    function l1Token() external pure returns (address) {
         return address(0);
     }
 
@@ -55,7 +55,7 @@ contract LegacyMintable is ERC20, ILegacyMintableERC20 {
      *         check. Allows for testing against code that is has been deployed,
      *         assuming different compiler version is no problem.
      */
-    function supportsInterface(bytes4 _interfaceId) external view returns (bool) {
+    function supportsInterface(bytes4 _interfaceId) external pure returns (bool) {
         bytes4 firstSupportedInterface = bytes4(keccak256("supportsInterface(bytes4)")); // ERC165
         bytes4 secondSupportedInterface = ILegacyMintableERC20.l1Token.selector ^
             ILegacyMintableERC20.mint.selector ^