Rebasable Token

.editorconfig

@@ -0,0 +1,15 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+[*.{js,yml,json,cjs}]
+indent_size = 2
+max_line_length = 120

.env.example

@@ -21,9 +21,39 @@ ETHERSCAN_API_KEY_OPT=
 # Bridge/Gateway Deployment
 # ############################
 
-# Address of the token to deploy the bridge/gateway for
+# Address of the token on L1 to deploy the bridge/gateway for
 TOKEN=
 
+# Address of the rebasable token on L1 to deploy the bridge/gateway for
+REBASABLE_TOKEN=
+
+# Address of token rate pusher. Required to config TokenRateOracle.
+L1_OP_STACK_TOKEN_RATE_PUSHER=
+
+# Gas limit required to complete pushing token rate on L2.
+# Default is: 300_000.
+# This value was calculated by formula:
+# l2GasLimit = (gas cost of L2Bridge.finalizeDeposit() + OptimismPortal.minimumGasLimit(depositData.length)) * 1.5
+L2_GAS_LIMIT_FOR_PUSHING_TOKEN_RATE=300000
+
+# A time period when token rate can be considered outdated.
+TOKEN_RATE_OUTDATED_DELAY=86400 # default is 86400 (24 hours)
+
+# Address of L1 token bridge proxy.
+L1_TOKEN_BRIDGE=
+
+# Address of L2 token bridge proxy.
+L2_TOKEN_BRIDGE=
+
+# Address of the non-rebasable token proxy on L2.
+L2_TOKEN=
+
+# Address of token rate oracle on L2
+L2_TOKEN_RATE_ORACLE=
+
+# Address of bridge executor.
+GOV_BRIDGE_EXECUTOR=
+
 # Name of the network environments used by deployment scripts.
 # Might be one of: "mainnet", "sepolia".
 NETWORK=mainnet
@@ -61,6 +91,10 @@ L2_WITHDRAWALS_DISABLERS=[]
 TESTING_OPT_NETWORK=
 TESTING_OPT_L1_TOKEN=0xaF8a2F0aE374b03376155BF745A3421Dac711C12
 TESTING_OPT_L2_TOKEN=0xAED5F9aaF167923D34174b8E636aaF040A11f6F7
+TESTING_OPT_L1_TOKEN_RATE_NOTIFIER=0x554f2C7D58522c050d38Ebea4FF072ED7C4e61cb
+TESTING_OPT_L1_REBASABLE_TOKEN=0xB82381A3fBD3FaFA77B3a7bE693342618240067b
+TESTING_OPT_L2_REBASABLE_TOKEN=0x6696Cb7bb602FC744254Ad9E07EfC474FBF78857
+TESTING_OPT_L2_TOKEN_RATE_ORACLE=0x8ea513d1e5Be31fb5FC2f2971897594720de9E70
 TESTING_OPT_L1_ERC20_TOKEN_BRIDGE=0x243b661276670bD17399C488E7287ea4D416115b
 TESTING_OPT_L2_ERC20_TOKEN_BRIDGE=0x447CD1794d209Ac4E6B4097B34658bc00C4d0a51
 
@@ -78,4 +112,4 @@ TESTING_OPT_GOV_BRIDGE_EXECUTOR=
 # ############################
 
 TESTING_PRIVATE_KEY=
-TESTING_OPT_LDO_HOLDER_PRIVATE_KEY=
+TESTING_OPT_LDO_HOLDER_PRIVATE_KEY=

.env.wsteth.opt_mainnet

@@ -21,6 +21,9 @@ ETHERSCAN_API_KEY_OPT=
 # Address of the token to deploy the bridge/gateway for
 TOKEN=0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0
 
+# Address of the rebasable token to deploy the bridge/gateway for
+REBASABLE_TOKEN=
+
 # Name of the network environments used by deployment scripts.
 # Might be one of: "mainnet", "sepolia".
 NETWORK=mainnet

.storage-layout

@@ -33,6 +33,19 @@
 | balanceOf   | mapping(address => uint256)                     | 1    | 0      | 32    | contracts/token/ERC20Bridged.sol:ERC20Bridged |
 | allowance   | mapping(address => mapping(address => uint256)) | 2    | 0      | 32    | contracts/token/ERC20Bridged.sol:ERC20Bridged |
 
+=======================
+➡ ERC20BridgedPermit
+=======================
+
+| Name             | Type                                            | Slot | Offset | Bytes | Contract                                                  |
+|------------------|-------------------------------------------------|------|--------|-------|-----------------------------------------------------------|
+| totalSupply      | uint256                                         | 0    | 0      | 32    | contracts/token/ERC20BridgedPermit.sol:ERC20BridgedPermit |
+| balanceOf        | mapping(address => uint256)                     | 1    | 0      | 32    | contracts/token/ERC20BridgedPermit.sol:ERC20BridgedPermit |
+| allowance        | mapping(address => mapping(address => uint256)) | 2    | 0      | 32    | contracts/token/ERC20BridgedPermit.sol:ERC20BridgedPermit |
+| _nameFallback    | string                                          | 3    | 0      | 32    | contracts/token/ERC20BridgedPermit.sol:ERC20BridgedPermit |
+| _versionFallback | string                                          | 4    | 0      | 32    | contracts/token/ERC20BridgedPermit.sol:ERC20BridgedPermit |
+| noncesByAddress  | mapping(address => uint256)                     | 5    | 0      | 32    | contracts/token/ERC20BridgedPermit.sol:ERC20BridgedPermit |
+
 =======================
 ➡ ERC20Core
 =======================
@@ -51,24 +64,73 @@
 |------|------|------|--------|-------|----------|
 
 =======================
-➡ L1ERC20TokenBridge
+➡ ERC20RebasableBridged
 =======================
 
-| Name   | Type                                              | Slot | Offset | Bytes | Contract                                                     |
-|--------|---------------------------------------------------|------|--------|-------|--------------------------------------------------------------|
-| _roles | mapping(bytes32 => struct AccessControl.RoleData) | 0    | 0      | 32    | contracts/optimism/L1ERC20TokenBridge.sol:L1ERC20TokenBridge |
+| Name | Type | Slot | Offset | Bytes | Contract |
+|------|------|------|--------|-------|----------|
+
+=======================
+➡ ERC20RebasableBridgedPermit
+=======================
+
+| Name             | Type                        | Slot | Offset | Bytes | Contract                                                                    |
+|------------------|-----------------------------|------|--------|-------|-----------------------------------------------------------------------------|
+| _nameFallback    | string                      | 0    | 0      | 32    | contracts/token/ERC20RebasableBridgedPermit.sol:ERC20RebasableBridgedPermit |
+| _versionFallback | string                      | 1    | 0      | 32    | contracts/token/ERC20RebasableBridgedPermit.sol:ERC20RebasableBridgedPermit |
+| noncesByAddress  | mapping(address => uint256) | 2    | 0      | 32    | contracts/token/ERC20RebasableBridgedPermit.sol:ERC20RebasableBridgedPermit |
 
 =======================
-➡ L2ERC20TokenBridge
+➡ L1LidoTokensBridge
 =======================
 
 | Name   | Type                                              | Slot | Offset | Bytes | Contract                                                     |
 |--------|---------------------------------------------------|------|--------|-------|--------------------------------------------------------------|
-| _roles | mapping(bytes32 => struct AccessControl.RoleData) | 0    | 0      | 32    | contracts/optimism/L2ERC20TokenBridge.sol:L2ERC20TokenBridge |
+| _roles | mapping(bytes32 => struct AccessControl.RoleData) | 0    | 0      | 32    | contracts/optimism/L1LidoTokensBridge.sol:L1LidoTokensBridge |
+
+=======================
+➡ L2ERC20ExtendedTokensBridge
+=======================
+
+| Name   | Type                                              | Slot | Offset | Bytes | Contract                                                                       |
+|--------|---------------------------------------------------|------|--------|-------|--------------------------------------------------------------------------------|
+| _roles | mapping(bytes32 => struct AccessControl.RoleData) | 0    | 0      | 32    | contracts/optimism/L2ERC20ExtendedTokensBridge.sol:L2ERC20ExtendedTokensBridge |
+
+=======================
+➡ OpStackTokenRatePusher
+=======================
+
+| Name | Type | Slot | Offset | Bytes | Contract |
+|------|------|------|--------|-------|----------|
 
 =======================
 ➡ OssifiableProxy
 =======================
 
 | Name | Type | Slot | Offset | Bytes | Contract |
 |------|------|------|--------|-------|----------|
+
+=======================
+➡ RebasableAndNonRebasableTokens
+=======================
+
+| Name | Type | Slot | Offset | Bytes | Contract |
+|------|------|------|--------|-------|----------|
+
+=======================
+➡ TokenRateNotifier
+=======================
+
+| Name      | Type      | Slot | Offset | Bytes | Contract                                               |
+|-----------|-----------|------|--------|-------|--------------------------------------------------------|
+| _owner    | address   | 0    | 0      | 20    | contracts/lido/TokenRateNotifier.sol:TokenRateNotifier |
+| observers | address[] | 1    | 0      | 32    | contracts/lido/TokenRateNotifier.sol:TokenRateNotifier |
+
+=======================
+➡ TokenRateOracle
+=======================
+
+| Name            | Type    | Slot | Offset | Bytes | Contract                                               |
+|-----------------|---------|------|--------|-------|--------------------------------------------------------|
+| tokenRate       | uint256 | 0    | 0      | 32    | contracts/optimism/TokenRateOracle.sol:TokenRateOracle |
+| rateL1Timestamp | uint256 | 1    | 0      | 32    | contracts/optimism/TokenRateOracle.sol:TokenRateOracle |

README.md

@@ -5,6 +5,7 @@ This project contains the implementations of the L2 ERC20 token bridge for Optim
 To retrieve more detailed info about the bridging process, see the specifications for certain chains:
 
 - [Lido's Optimism Bridge](https://github.com/lidofinance/lido-l2/blob/main/contracts/optimism/README.md).
+- [wstETH Bridging Guide](https://docs.lido.fi/token-guides/wsteth-bridging-guide/#r-5-bridging-l1-lido-dao-decisions)
 
 ## Project setup
 
@@ -41,7 +42,16 @@ Fill the newly created `.env` file with the required variables. See the [Project
 
 The configuration of the deployment scripts happens via the ENV variables. The following variables are required:
 
-- [`TOKEN`](#TOKEN) - address of the token to deploy a new bridge on the Ethereum chain.
+- [`TOKEN`](#TOKEN) - address of the non-rebasable token to deploy a new bridge on the Ethereum chain.
+- [`REBASABLE_TOKEN`] (#REBASABLE_TOKEN) - address of the rebasable token to deploy new bridge on the Ethereum chain.
+- [`L1_OP_STACK_TOKEN_RATE_PUSHER`](#L1_OP_STACK_TOKEN_RATE_PUSHER) - address of token rate pusher. Required to config TokenRateOracle.
+- [`L2_GAS_LIMIT_FOR_PUSHING_TOKEN_RATE`](#L2_GAS_LIMIT_FOR_PUSHING_TOKEN_RATE) - gas limit required to complete pushing token rate on L2.This value was calculated by formula: l2GasLimit = (gas cost of L2Bridge.finalizeDeposit() + OptimismPortal.minimumGasLimit(depositData.length)) * 1.5
+- [`TOKEN_RATE_OUTDATED_DELAY`](#TOKEN_RATE_OUTDATED_DELAY) - a time period when token rate can be considered outdated. Default is 86400 (24 hours).
+- [`L1_TOKEN_BRIDGE`](#L1_TOKEN_BRIDGE) - address of L1 token bridge.
+- [`L2_TOKEN_BRIDGE`](#L2_TOKEN_BRIDGE) - address of L2 token bridge.
+- [`L2_TOKEN`](#L2_TOKEN) - address of the non-rebasable token on L2.
+- [`L2_TOKEN_RATE_ORACLE`](#L2_TOKEN_RATE_ORACLE) - address of token rate oracle on L2.
+- [`GOV_BRIDGE_EXECUTOR`](#GOV_BRIDGE_EXECUTOR) - address of bridge executor.
 - [`NETWORK`](#NETWORK) - name of the network environments used by deployment scripts. Allowed values: `mainnet`, `sepolia`.
 - [`FORKING`](#FORKING) - run deployment in the forking network instead of real ones
 - [`ETH_DEPLOYER_PRIVATE_KEY`](#ETH_DEPLOYER_PRIVATE_KEY) - The private key of the deployer account in the Ethereum network is used during the deployment process.
@@ -234,7 +244,11 @@ Below variables used in the Optimism bridge deployment process.
 
 #### `TOKEN`
 
-Address of the token to deploy a new bridge on the Ethereum chain.
+Address of the existing non-rebasable token to deploy a new bridge for on the Ethereum chain.
+
+#### `REBASABLE_TOKEN`
+
+Address of the existing rebasable token to deploy new bridge for on the Ethereum chain.
 
 #### `NETWORK`
 

artifacts-opt.json

@@ -2,13 +2,13 @@
   {
     "artifactPath": "artifacts/contracts/proxy/OssifiableProxy.sol/OssifiableProxy.json",
     "sourcePath": "contracts/proxy/OssifiableProxy.sol",
-    "name": "L2ERC20TokenBridge proxy",
+    "name": "L2ERC20ExtendedTokensBridge proxy",
     "address": "0x8E01013243a96601a86eb3153F0d9Fa4fbFb6957"
   },
   {
-    "artifactPath": "artifacts/contracts/optimism/L2ERC20TokenBridge.sol/L2ERC20TokenBridge.json",
-    "sourcePath": "contracts/optimism/L2ERC20TokenBridge.sol",
-    "name": "L2ERC20TokenBridge",
+    "artifactPath": "artifacts/contracts/optimism/L2ERC20ExtendedTokensBridge.sol/L2ERC20ExtendedTokensBridge.json",
+    "sourcePath": "contracts/optimism/L2ERC20ExtendedTokensBridge.sol",
+    "name": "L2ERC20ExtendedTokensBridge",
     "address": "0x23B96aDD54c479C6784Dd504670B5376B808f4C7",
     "txHash": "0x5d69e9c6ec1d634f0d90812c2189c925993d1fffbc9b0b416fdc123e15407c56"
   },

contracts/BridgingManager.sol

@@ -13,7 +13,7 @@
     /// @param isDepositsEnabled Stores the state of the deposits
     /// @param isWithdrawalsEnabled Stores the state of the withdrawals
     struct State {
-        bool isInitialized;
+        bool isInitialized; /// @dev DEPRECATED since bridges have their own code for versioning.
         bool isDepositsEnabled;
         bool isWithdrawalsEnabled;
     }
@@ -34,7 +34,7 @@
     /// @notice Initializes the contract to grant DEFAULT_ADMIN_ROLE to the admin_ address
     /// @dev This method might be called only once
     /// @param admin_ Address of the account to grant the DEFAULT_ADMIN_ROLE
-    function initialize(address admin_) external {
+    function _initialize(address admin_) internal {
         State storage s = _loadState();
         if (s.isInitialized) {
             revert ErrorAlreadyInitialized();
@@ -97,10 +97,15 @@
         emit WithdrawalsDisabled(msg.sender);
     }
 
+    function _isBridgingManagerInitialized() internal view returns (bool) {
+        State storage s = _loadState();
+        return s.isInitialized;
+    }
+
     /// @dev Returns the reference to the slot with State struct
     function _loadState() private pure returns (State storage r) {
         bytes32 slot = STATE_SLOT;
         assembly {
             r.slot := slot
         }
     }
@@ -132,4 +137,5 @@
     error ErrorWithdrawalsEnabled();
     error ErrorWithdrawalsDisabled();
     error ErrorAlreadyInitialized();
+    error ErrorBridgingManagerWasInitialized();
 }

contracts/lib/DepositDataCodec.sol

@@ -0,0 +1,44 @@
+// SPDX-FileCopyrightText: 2024 Lido <[email protected]>
+// SPDX-License-Identifier: GPL-3.0
+
+pragma solidity 0.8.10;
+
+/// @author kovalgek
+/// @notice encodes and decodes DepositData for crosschain transfering.
+library DepositDataCodec {
+
+    uint8 internal constant RATE_FIELD_SIZE = 12;
+    uint8 internal constant TIMESTAMP_FIELD_SIZE = 5;
+
+    struct DepositData {
+        uint96 rate;
+        uint40 timestamp;
+        bytes data;
+    }
+
+    function encodeDepositData(DepositData memory depositData) internal pure returns (bytes memory) {
+        bytes memory data = bytes.concat(
+            abi.encodePacked(depositData.rate),
+            abi.encodePacked(depositData.timestamp),
+            abi.encodePacked(depositData.data)
+        );
+        return data;
+    }
+
+    function decodeDepositData(bytes calldata buffer) internal pure returns (DepositData memory) {
+
+        if (buffer.length < RATE_FIELD_SIZE + TIMESTAMP_FIELD_SIZE) {
+            revert ErrorDepositDataLength();
+        }
+
+        DepositData memory depositData = DepositData({
+            rate: uint96(bytes12(buffer[0:RATE_FIELD_SIZE])),
+            timestamp: uint40(bytes5(buffer[RATE_FIELD_SIZE:RATE_FIELD_SIZE + TIMESTAMP_FIELD_SIZE])),
+            data: buffer[RATE_FIELD_SIZE + TIMESTAMP_FIELD_SIZE:]
+        });
+
+        return depositData;
+    }
+
+    error ErrorDepositDataLength();
+}