contracts-bedrock: remove storage spacers (#2907)

Remove storage spacers in the xdomainmessengers. These are no longer necessary because the storage layout has changed significantly and we will need to handle that during state surgery anyways. Inheriting from upgradable contracts with spacers caused the storage layout to diverge from the existing contracts. Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

contracts-bedrock: remove storage spacers (#2907)
Remove storage spacers in the xdomainmessengers. These are no longer necessary because the storage layout has changed significantly and we will need to handle that during state surgery anyways. Inheriting from upgradable contracts with spacers caused the storage layout to diverge from the existing contracts. Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
611d93a1 · Mark Tyneway · GitHub · 1ba3c14f · 611d93a1 · 611d93a1
Commit 611d93a1 authored Jul 05, 2022 by Mark Tyneway Committed by GitHub Jul 05, 2022
Showing with 73 additions and 82 deletions

old-seas-jump.md .changeset/old-seas-jump.md +5 -0

.storage-layout packages/contracts-bedrock/.storage-layout +68 -76

CrossDomainMessenger.sol ...acts-bedrock/contracts/universal/CrossDomainMessenger.sol +0 -6

No files found.
--- a/.changeset/old-seas-jump.md
+++ b/.changeset/old-seas-jump.md
+---
+'@eth-optimism/contracts-bedrock': patch
+---
+
+Remove storage slot buffer in xdomain messengers
--- a/packages/contracts-bedrock/.storage-layout
+++ b/packages/contracts-bedrock/.storage-layout
@@ -6,45 +6,41 @@
 ➡ L1CrossDomainMessenger
 =======================

-+---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------+
-| Name                      | Type                     | Slot | Offset | Bytes | Contract                                                       |
-+===============================================================================================================================================+
-| _initialized              | uint8                    | 0    | 0      | 1     | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| _initializing             | bool                     | 0    | 1      | 1     | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| __gap                     | uint256[50]              | 1    | 0      | 1600  | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| _owner                    | address                  | 51   | 0      | 20    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| __gap                     | uint256[49]              | 52   | 0      | 1568  | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| _paused                   | bool                     | 101  | 0      | 1     | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| __gap                     | uint256[49]              | 102  | 0      | 1568  | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| _status                   | uint256                  | 151  | 0      | 32    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| __gap                     | uint256[49]              | 152  | 0      | 1568  | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| REMOVED_VARIABLE_SPACER_1 | bytes32                  | 201  | 0      | 32    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| REMOVED_VARIABLE_SPACER_2 | bytes32                  | 202  | 0      | 32    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| successfulMessages        | mapping(bytes32 => bool) | 203  | 0      | 32    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| xDomainMsgSender          | address                  | 204  | 0      | 20    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| msgNonce                  | uint256                  | 205  | 0      | 32    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| otherMessenger            | address                  | 206  | 0      | 20    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| receivedMessages          | mapping(bytes32 => bool) | 207  | 0      | 32    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| blockedSystemAddresses    | mapping(address => bool) | 208  | 0      | 32    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| portal                    | contract OptimismPortal  | 209  | 0      | 20    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
-+---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------+
+------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------+
+| Name                   | Type                     | Slot | Offset | Bytes | Contract                                                       |
+============================================================================================================================================+
+| _initialized           | uint8                    | 0    | 0      | 1     | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| _initializing          | bool                     | 0    | 1      | 1     | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| __gap                  | uint256[50]              | 1    | 0      | 1600  | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| _owner                 | address                  | 51   | 0      | 20    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| __gap                  | uint256[49]              | 52   | 0      | 1568  | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| _paused                | bool                     | 101  | 0      | 1     | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| __gap                  | uint256[49]              | 102  | 0      | 1568  | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| _status                | uint256                  | 151  | 0      | 32    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| __gap                  | uint256[49]              | 152  | 0      | 1568  | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| successfulMessages     | mapping(bytes32 => bool) | 201  | 0      | 32    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| xDomainMsgSender       | address                  | 202  | 0      | 20    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| msgNonce               | uint256                  | 203  | 0      | 32    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| otherMessenger         | address                  | 204  | 0      | 20    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| receivedMessages       | mapping(bytes32 => bool) | 205  | 0      | 32    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| blockedSystemAddresses | mapping(address => bool) | 206  | 0      | 32    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| portal                 | contract OptimismPortal  | 207  | 0      | 20    | contracts/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger |
+------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------+

 =======================
 ➡ L1StandardBridge
@@ -173,43 +169,39 @@
 ➡ L2CrossDomainMessenger
 =======================

-+---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------+
-| Name                      | Type                     | Slot | Offset | Bytes | Contract                                                       |
-+===============================================================================================================================================+
-| _initialized              | uint8                    | 0    | 0      | 1     | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| _initializing             | bool                     | 0    | 1      | 1     | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| __gap                     | uint256[50]              | 1    | 0      | 1600  | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| _owner                    | address                  | 51   | 0      | 20    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| __gap                     | uint256[49]              | 52   | 0      | 1568  | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| _paused                   | bool                     | 101  | 0      | 1     | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| __gap                     | uint256[49]              | 102  | 0      | 1568  | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| _status                   | uint256                  | 151  | 0      | 32    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| __gap                     | uint256[49]              | 152  | 0      | 1568  | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| REMOVED_VARIABLE_SPACER_1 | bytes32                  | 201  | 0      | 32    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| REMOVED_VARIABLE_SPACER_2 | bytes32                  | 202  | 0      | 32    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| successfulMessages        | mapping(bytes32 => bool) | 203  | 0      | 32    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| xDomainMsgSender          | address                  | 204  | 0      | 20    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| msgNonce                  | uint256                  | 205  | 0      | 32    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| otherMessenger            | address                  | 206  | 0      | 20    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| receivedMessages          | mapping(bytes32 => bool) | 207  | 0      | 32    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-|---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
-| blockedSystemAddresses    | mapping(address => bool) | 208  | 0      | 32    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
-+---------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------+
+------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------+
+| Name                   | Type                     | Slot | Offset | Bytes | Contract                                                       |
+============================================================================================================================================+
+| _initialized           | uint8                    | 0    | 0      | 1     | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| _initializing          | bool                     | 0    | 1      | 1     | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| __gap                  | uint256[50]              | 1    | 0      | 1600  | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| _owner                 | address                  | 51   | 0      | 20    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| __gap                  | uint256[49]              | 52   | 0      | 1568  | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| _paused                | bool                     | 101  | 0      | 1     | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| __gap                  | uint256[49]              | 102  | 0      | 1568  | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| _status                | uint256                  | 151  | 0      | 32    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| __gap                  | uint256[49]              | 152  | 0      | 1568  | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| successfulMessages     | mapping(bytes32 => bool) | 201  | 0      | 32    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| xDomainMsgSender       | address                  | 202  | 0      | 20    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| msgNonce               | uint256                  | 203  | 0      | 32    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| otherMessenger         | address                  | 204  | 0      | 20    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| receivedMessages       | mapping(bytes32 => bool) | 205  | 0      | 32    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+|------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------|
+| blockedSystemAddresses | mapping(address => bool) | 206  | 0      | 32    | contracts/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger |
+------------------------+--------------------------+------+--------+-------+----------------------------------------------------------------+

 =======================
 ➡ L2StandardBridge

--- a/packages/contracts-bedrock/contracts/universal/CrossDomainMessenger.sol
+++ b/packages/contracts-bedrock/contracts/universal/CrossDomainMessenger.sol
@@ -66,12 +66,6 @@ abstract contract CrossDomainMessenger is
     * Variables *
     *************/

-    // blockedMessages in old L1CrossDomainMessenger
-    bytes32 internal REMOVED_VARIABLE_SPACER_1;
-
-    // relayedMessages in old L1CrossDomainMessenger
-    bytes32 internal REMOVED_VARIABLE_SPACER_2;
-
    /// @notice Mapping of message hash to boolean success value.
    mapping(bytes32 => bool) public successfulMessages;