Merge pull request #6574 from ethereum-optimism/ctb/l1-xdm-immutables

contracts-bedrock: L1CrossDomainMessenger single impl

packages/contracts-bedrock/.gas-snapshot

@@ -25,7 +25,7 @@ Bytes_slice_Test:test_slice_fromZeroIdx_works() (gas: 20804)
 Bytes_toNibbles_Test:test_toNibbles_expectedResult128Bytes_works() (gas: 78882)
 Bytes_toNibbles_Test:test_toNibbles_expectedResult5Bytes_works() (gas: 3992)
 Bytes_toNibbles_Test:test_toNibbles_zeroLengthInput_works() (gas: 823)
-CrossDomainMessenger_BaseGas_Test:test_baseGas_succeeds() (gas: 20412)
+CrossDomainMessenger_BaseGas_Test:test_baseGas_succeeds() (gas: 20435)
 CrossDomainOwnable2_Test:test_onlyOwner_notMessenger_reverts() (gas: 8461)
 CrossDomainOwnable2_Test:test_onlyOwner_notOwner2_reverts() (gas: 57515)
 CrossDomainOwnable2_Test:test_onlyOwner_notOwner_reverts() (gas: 16610)
@@ -121,12 +121,12 @@ FaultDisputeGame_Test:test_resolve_rootUncontested_succeeds() (gas: 27256)
 FaultDisputeGame_Test:test_resolve_teamDeathmatch_succeeds() (gas: 395635)
 FaultDisputeGame_Test:test_rootClaim_succeeds() (gas: 8276)
 FeeVault_Test:test_constructor_succeeds() (gas: 18185)
-GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_0() (gas: 352139)
-GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_1() (gas: 2950346)
-GasBenchMark_L1StandardBridge_Deposit:test_depositERC20_benchmark_0() (gas: 537918)
-GasBenchMark_L1StandardBridge_Deposit:test_depositERC20_benchmark_1() (gas: 4050111)
-GasBenchMark_L1StandardBridge_Deposit:test_depositETH_benchmark_0() (gas: 439175)
-GasBenchMark_L1StandardBridge_Deposit:test_depositETH_benchmark_1() (gas: 3484902)
+GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_0() (gas: 354289)
+GasBenchMark_L1CrossDomainMessenger:test_sendMessage_benchmark_1() (gas: 2952496)
+GasBenchMark_L1StandardBridge_Deposit:test_depositERC20_benchmark_0() (gas: 540068)
+GasBenchMark_L1StandardBridge_Deposit:test_depositERC20_benchmark_1() (gas: 4052261)
+GasBenchMark_L1StandardBridge_Deposit:test_depositETH_benchmark_0() (gas: 441325)
+GasBenchMark_L1StandardBridge_Deposit:test_depositETH_benchmark_1() (gas: 3487052)
 GasBenchMark_L1StandardBridge_Finalize:test_finalizeETHWithdrawal_benchmark() (gas: 40409)
 GasBenchMark_L2OutputOracle:test_proposeL2Output_benchmark() (gas: 88513)
 GasBenchMark_OptimismPortal:test_depositTransaction_benchmark() (gas: 75079)
@@ -160,43 +160,43 @@ L1BlockTest:test_number_succeeds() (gas: 7629)
 L1BlockTest:test_sequenceNumber_succeeds() (gas: 7630)
 L1BlockTest:test_timestamp_succeeds() (gas: 7640)
 L1BlockTest:test_updateValues_succeeds() (gas: 60482)
-L1CrossDomainMessenger_Test:test_messageVersion_succeeds() (gas: 24803)
-L1CrossDomainMessenger_Test:test_relayMessage_legacyOldReplay_reverts() (gas: 49395)
-L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterFailureThenSuccess_reverts() (gas: 209744)
-L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterFailure_succeeds() (gas: 203642)
-L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterSuccess_reverts() (gas: 124024)
-L1CrossDomainMessenger_Test:test_relayMessage_legacy_succeeds() (gas: 77316)
-L1CrossDomainMessenger_Test:test_relayMessage_retryAfterFailure_succeeds() (gas: 197616)
-L1CrossDomainMessenger_Test:test_relayMessage_succeeds() (gas: 74274)
-L1CrossDomainMessenger_Test:test_relayMessage_toSystemContract_reverts() (gas: 56518)
+L1CrossDomainMessenger_Test:test_messageVersion_succeeds() (gas: 24781)
+L1CrossDomainMessenger_Test:test_relayMessage_legacyOldReplay_reverts() (gas: 49417)
+L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterFailureThenSuccess_reverts() (gas: 212527)
+L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterFailure_succeeds() (gas: 206219)
+L1CrossDomainMessenger_Test:test_relayMessage_legacyRetryAfterSuccess_reverts() (gas: 126476)
+L1CrossDomainMessenger_Test:test_relayMessage_legacy_succeeds() (gas: 79665)
+L1CrossDomainMessenger_Test:test_relayMessage_retryAfterFailure_succeeds() (gas: 200193)
+L1CrossDomainMessenger_Test:test_relayMessage_succeeds() (gas: 76623)
+L1CrossDomainMessenger_Test:test_relayMessage_toSystemContract_reverts() (gas: 60845)
 L1CrossDomainMessenger_Test:test_relayMessage_v2_reverts() (gas: 12343)
-L1CrossDomainMessenger_Test:test_replayMessage_withValue_reverts() (gas: 31063)
-L1CrossDomainMessenger_Test:test_sendMessage_succeeds() (gas: 390677)
-L1CrossDomainMessenger_Test:test_sendMessage_twice_succeeds() (gas: 1666608)
-L1CrossDomainMessenger_Test:test_xDomainMessageSender_reset_succeeds() (gas: 84716)
+L1CrossDomainMessenger_Test:test_replayMessage_withValue_reverts() (gas: 33166)
+L1CrossDomainMessenger_Test:test_sendMessage_succeeds() (gas: 392873)
+L1CrossDomainMessenger_Test:test_sendMessage_twice_succeeds() (gas: 1668908)
+L1CrossDomainMessenger_Test:test_xDomainMessageSender_reset_succeeds() (gas: 87043)
 L1CrossDomainMessenger_Test:test_xDomainSender_notSet_reverts() (gas: 24253)
 L1ERC721Bridge_Test:test_bridgeERC721To_localTokenZeroAddress_reverts() (gas: 52707)
 L1ERC721Bridge_Test:test_bridgeERC721To_remoteTokenZeroAddress_reverts() (gas: 27288)
-L1ERC721Bridge_Test:test_bridgeERC721To_succeeds() (gas: 445298)
+L1ERC721Bridge_Test:test_bridgeERC721To_succeeds() (gas: 447448)
 L1ERC721Bridge_Test:test_bridgeERC721To_wrongOwner_reverts() (gas: 61000)
 L1ERC721Bridge_Test:test_bridgeERC721_fromContract_reverts() (gas: 25666)
 L1ERC721Bridge_Test:test_bridgeERC721_localTokenZeroAddress_reverts() (gas: 50564)
 L1ERC721Bridge_Test:test_bridgeERC721_remoteTokenZeroAddress_reverts() (gas: 25189)
-L1ERC721Bridge_Test:test_bridgeERC721_succeeds() (gas: 442856)
+L1ERC721Bridge_Test:test_bridgeERC721_succeeds() (gas: 445006)
 L1ERC721Bridge_Test:test_bridgeERC721_wrongOwner_reverts() (gas: 60808)
 L1ERC721Bridge_Test:test_constructor_succeeds() (gas: 10178)
 L1ERC721Bridge_Test:test_finalizeBridgeERC721_notEscrowed_reverts() (gas: 22097)
 L1ERC721Bridge_Test:test_finalizeBridgeERC721_notFromRemoteMessenger_reverts() (gas: 19842)
 L1ERC721Bridge_Test:test_finalizeBridgeERC721_notViaLocalMessenger_reverts() (gas: 16049)
 L1ERC721Bridge_Test:test_finalizeBridgeERC721_selfToken_reverts() (gas: 17615)
-L1ERC721Bridge_Test:test_finalizeBridgeERC721_succeeds() (gas: 414390)
-L1StandardBridge_BridgeETHTo_Test:test_bridgeETHTo_succeeds() (gas: 510336)
-L1StandardBridge_BridgeETH_Test:test_bridgeETH_succeeds() (gas: 497491)
-L1StandardBridge_DepositERC20To_Test:test_depositERC20To_succeeds() (gas: 715776)
-L1StandardBridge_DepositERC20_Test:test_depositERC20_succeeds() (gas: 713441)
+L1ERC721Bridge_Test:test_finalizeBridgeERC721_succeeds() (gas: 416540)
+L1StandardBridge_BridgeETHTo_Test:test_bridgeETHTo_succeeds() (gas: 512509)
+L1StandardBridge_BridgeETH_Test:test_bridgeETH_succeeds() (gas: 499664)
+L1StandardBridge_DepositERC20To_Test:test_depositERC20To_succeeds() (gas: 717949)
+L1StandardBridge_DepositERC20_Test:test_depositERC20_succeeds() (gas: 715614)
 L1StandardBridge_DepositERC20_TestFail:test_depositERC20_notEoa_reverts() (gas: 22298)
-L1StandardBridge_DepositETHTo_Test:test_depositETHTo_succeeds() (gas: 510347)
-L1StandardBridge_DepositETH_Test:test_depositETH_succeeds() (gas: 497585)
+L1StandardBridge_DepositETHTo_Test:test_depositETHTo_succeeds() (gas: 512520)
+L1StandardBridge_DepositETH_Test:test_depositETH_succeeds() (gas: 499758)
 L1StandardBridge_DepositETH_TestFail:test_depositETH_notEoa_reverts() (gas: 40758)
 L1StandardBridge_FinalizeBridgeETH_Test:test_finalizeBridgeETH_succeeds() (gas: 51652)
 L1StandardBridge_FinalizeBridgeETH_TestFail:test_finalizeBridgeETH_incorrectValue_reverts() (gas: 34204)
@@ -208,11 +208,11 @@ L1StandardBridge_FinalizeERC20Withdrawal_TestFail:test_finalizeERC20Withdrawal_n
 L1StandardBridge_FinalizeETHWithdrawal_Test:test_finalizeETHWithdrawal_succeeds() (gas: 61722)
 L1StandardBridge_Getter_Test:test_getters_succeeds() (gas: 26157)
 L1StandardBridge_Initialize_Test:test_initialize_succeeds() (gas: 22050)
-L1StandardBridge_Receive_Test:test_receive_succeeds() (gas: 610745)
+L1StandardBridge_Receive_Test:test_receive_succeeds() (gas: 612895)
 L2CrossDomainMessenger_Test:test_messageVersion_succeeds() (gas: 8477)
 L2CrossDomainMessenger_Test:test_relayMessage_retry_succeeds() (gas: 163815)
 L2CrossDomainMessenger_Test:test_relayMessage_succeeds() (gas: 48946)
-L2CrossDomainMessenger_Test:test_relayMessage_toSystemContract_reverts() (gas: 29066)
+L2CrossDomainMessenger_Test:test_relayMessage_toSystemContract_reverts() (gas: 31169)
 L2CrossDomainMessenger_Test:test_relayMessage_v2_reverts() (gas: 11689)
 L2CrossDomainMessenger_Test:test_sendMessage_succeeds() (gas: 123768)
 L2CrossDomainMessenger_Test:test_sendMessage_twice_succeeds() (gas: 135434)

packages/contracts-bedrock/.storage-layout

@@ -25,6 +25,7 @@
 | msgNonce           | uint240                  | 205  | 0      | 30    | src/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
 | failedMessages     | mapping(bytes32 => bool) | 206  | 0      | 32    | src/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
 | __gap              | uint256[42]              | 207  | 0      | 1344  | src/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+| PORTAL             | contract OptimismPortal  | 249  | 0      | 20    | src/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
 
 =======================
 ➡ src/L1/L1StandardBridge.sol:L1StandardBridge

packages/contracts-bedrock/scripts/Deploy.s.sol

@@ -277,12 +277,13 @@ contract Deploy is Deployer {
 
     /// @notice Deploy the L1CrossDomainMessenger
     function deployL1CrossDomainMessenger() broadcast() public returns (address) {
-        address portal = mustGetAddress("OptimismPortalProxy");
-        L1CrossDomainMessenger messenger = new L1CrossDomainMessenger({
-            _portal: OptimismPortal(payable(portal))
-        });
+        L1CrossDomainMessenger messenger = new L1CrossDomainMessenger();
+
+        require(address(messenger.PORTAL()) == address(0));
+        require(address(messenger.portal()) == address(0));
 
-        require(address(messenger.PORTAL()) == portal);
+        bytes32 xdmSenderSlot = vm.load(address(messenger), bytes32(uint256(204)));
+        require(address(uint160(uint256(xdmSenderSlot))) == Constants.DEFAULT_L2_SENDER);
 
         save("L1CrossDomainMessenger", address(messenger));
         console.log("L1CrossDomainMessenger deployed at %s", address(messenger));
@@ -619,7 +620,12 @@ contract Deploy is Deployer {
         proxyAdmin.upgradeAndCall({
             _proxy: payable(l1CrossDomainMessengerProxy),
             _implementation: l1CrossDomainMessenger,
-            _data: abi.encodeCall(L1CrossDomainMessenger.initialize, ())
+            _data: abi.encodeCall(
+                L1CrossDomainMessenger.initialize,
+                (
+                    OptimismPortal(payable(optimismPortalProxy))
+                )
+            )
         });
 
         L1CrossDomainMessenger messenger = L1CrossDomainMessenger(l1CrossDomainMessengerProxy);
@@ -627,6 +633,9 @@ contract Deploy is Deployer {
         console.log("L1CrossDomainMessenger version: %s", version);
 
         require(address(messenger.PORTAL()) == optimismPortalProxy);
+        require(address(messenger.portal()) == optimismPortalProxy);
+        bytes32 xdmSenderSlot = vm.load(address(messenger), bytes32(uint256(204)));
+        require(address(uint160(uint256(xdmSenderSlot))) == Constants.DEFAULT_L2_SENDER);
     }
 
     /// @notice Initialize the L2OutputOracle

packages/contracts-bedrock/semver-lock.json

 {
-  "src/L1/L1CrossDomainMessenger.sol": "0x76697013a600b9fe46f5606d445725a164a37cff7058d109dc2c1601a46a4d2a",
+  "src/L1/L1CrossDomainMessenger.sol": "0x2b276f14475869cfd81868b03dc72b91dd726a787c9568caf4849fe34830b207",
   "src/L1/L1ERC721Bridge.sol": "0xac9d8e236a1b35c358f9800834f65375cf4270155e817cf3d0f2bac1968f9107",
   "src/L1/L1StandardBridge.sol": "0x26fd79e041c403f4bc68758c410fcc801975e7648c0b51a2c4a6e8c44fabcbfd",
   "src/L1/L2OutputOracle.sol": "0xd6c5eb38732077c4705f46a61be68a7beccc069a99ed1d07b8e1fc6e1de8ffa6",
@@ -9,7 +9,7 @@
   "src/L2/GasPriceOracle.sol": "0xc735a8bf01ad8bca194345748537bfd9924909c0342bc133c4a31e2fb8cb9882",
   "src/L2/L1Block.sol": "0x7fbfc8b4da630386636c665570321fdec287b0867dbe0f91c2e7cd5b7697c220",
   "src/L2/L1FeeVault.sol": "0x62bfe739ff939fc68f90916399ac4160936d31eb37749cb014dd9d0c5dd4183a",
-  "src/L2/L2CrossDomainMessenger.sol": "0x1ffe8f6bad8eaa4c7ecff77456d382bdc5b371ffd672af6b539cb1a97f23e265",
+  "src/L2/L2CrossDomainMessenger.sol": "0xc9641981f7aa79f44b5925100027098d8f76c6178c65aca99fafa859289182be",
   "src/L2/L2ERC721Bridge.sol": "0x2b30a48241787580918a6ce4263823c036a21bde9cd80cc38d9beb6626c4f93b",
   "src/L2/L2StandardBridge.sol": "0x73a4fea3dca8ac7d7ba32e38aadeb69bd344042666a40a75e8c28849f01999e5",
   "src/L2/L2ToL1MessagePasser.sol": "0xed800b600cb3f67e18a1ab10750e3934a8b3e42178f422bcacfde770a6e8e8bd",

packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol

@@ -12,25 +12,30 @@ import { Semver } from "../universal/Semver.sol";
 ///         for sending and receiving data on the L1 side. Users are encouraged to use this
 ///         interface instead of interacting with lower-level contracts directly.
 contract L1CrossDomainMessenger is CrossDomainMessenger, Semver {
-    /// @notice Address of the OptimismPortal.
-    OptimismPortal public immutable PORTAL;
+    /// @notice Address of the OptimismPortal. The public getter for this
+    ///         is legacy and will be removed in the future. Use `portal()` instead.
+    /// @custom:network-specific
+    /// @custom:legacy
+    OptimismPortal public PORTAL;
 
-    /// @custom:semver 1.4.1
+    /// @custom:semver 1.5.0
     /// @notice Constructs the L1CrossDomainMessenger contract.
-    /// @param _portal Address of the OptimismPortal contract on this network.
-    constructor(OptimismPortal _portal)
-        Semver(1, 4, 1)
-        CrossDomainMessenger(Predeploys.L2_CROSS_DOMAIN_MESSENGER)
-    {
-        PORTAL = _portal;
-        initialize();
+    constructor() Semver(1, 5, 0) CrossDomainMessenger(Predeploys.L2_CROSS_DOMAIN_MESSENGER) {
+        initialize({ _portal: OptimismPortal(payable(0)) });
     }
 
     /// @notice Initializes the contract.
-    function initialize() public initializer {
+    /// @param _portal Address of the OptimismPortal contract on this network.
+    function initialize(OptimismPortal _portal) public reinitializer(2) {
+        PORTAL = _portal;
         __CrossDomainMessenger_init();
     }
 
+    /// @notice Getter for the OptimismPortal address.
+    function portal() external view returns (address) {
+        return address(PORTAL);
+    }
+
     /// @inheritdoc CrossDomainMessenger
     function _sendMessage(
         address _to,

packages/contracts-bedrock/src/L2/L2CrossDomainMessenger.sol

@@ -14,18 +14,18 @@ import { L2ToL1MessagePasser } from "./L2ToL1MessagePasser.sol";
 ///         L2 on the L2 side. Users are generally encouraged to use this contract instead of lower
 ///         level message passing contracts.
 contract L2CrossDomainMessenger is CrossDomainMessenger, Semver {
-    /// @custom:semver 1.4.1
+    /// @custom:semver 1.5.0
     /// @notice Constructs the L2CrossDomainMessenger contract.
     /// @param _l1CrossDomainMessenger Address of the L1CrossDomainMessenger contract.
     constructor(address _l1CrossDomainMessenger)
-        Semver(1, 4, 1)
+        Semver(1, 5, 0)
         CrossDomainMessenger(_l1CrossDomainMessenger)
     {
         initialize();
     }
 
     /// @notice Initializer.
-    function initialize() public initializer {
+    function initialize() public reinitializer(2) {
         __CrossDomainMessenger_init();
     }
 

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

@@ -272,7 +272,7 @@ contract Messenger_Initializer is Portal_Initializer {
         addressManager = new AddressManager();
 
         // Setup implementation
-        L1CrossDomainMessenger L1MessengerImpl = new L1CrossDomainMessenger(op);
+        L1CrossDomainMessenger L1MessengerImpl = new L1CrossDomainMessenger();
 
         // Setup the address manager and proxy
         vm.prank(multisig);
@@ -282,7 +282,7 @@ contract Messenger_Initializer is Portal_Initializer {
             "OVM_L1CrossDomainMessenger"
         );
         L1Messenger = L1CrossDomainMessenger(address(proxy));
-        L1Messenger.initialize();
+        L1Messenger.initialize(op);
 
         vm.etch(
             Predeploys.L2_CROSS_DOMAIN_MESSENGER,