feat: Upgrade contracts to use OpenZeppelin's upgradeable libraries and adjust submodule paths

Author: Le-Caignec

.gitmodules

@@ -10,6 +10,6 @@
 [submodule "lib/rlc-faucet-contract"]
 	path = lib/rlc-faucet-contract
 	url = https://github.com/iExecBlockchainComputing/rlc-faucet-contract
-[submodule "lib/openzeppelin-contracts"]
-	path = lib/openzeppelin-contracts
-	url = https://github.com/OpenZeppelin/openzeppelin-contracts
+[submodule "lib/openzeppelin-contracts-upgradeable"]
+	path = lib/openzeppelin-contracts-upgradeable
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable

foundry.toml

@@ -5,11 +5,13 @@ libs = ["lib"]
 fs_permissions = [{ access = "read-write", path = "./" }]
 
 remappings = [
+    '@layerzerolabs/oft-evm-upgradeable/=lib/devtools/packages/oft-evm-upgradeable/',
     '@layerzerolabs/oft-evm/=lib/devtools/packages/oft-evm/',
+    '@layerzerolabs/oapp-evm-upgradeable/=lib/devtools/packages/oapp-evm-upgradeable/',
     '@layerzerolabs/oapp-evm/=lib/devtools/packages/oapp-evm/',
     '@layerzerolabs/lz-evm-protocol-v2/=lib/layerzero-v2/packages/layerzero-v2/evm/protocol',
-    '@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/',
+    '@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/',
 ]
 
 
-# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options
+# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

src/RLCAdapter.sol

@@ -3,13 +3,48 @@
 
 pragma solidity ^0.8.22;
 
-import {OFTAdapter} from "@layerzerolabs/oft-evm/contracts/OFTAdapter.sol";
-import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
+import {OFTAdapterUpgradeable} from "@layerzerolabs/oft-evm-upgradeable/contracts/oft/OFTAdapterUpgradeable.sol";
+import {AccessControlDefaultAdminRulesUpgradeable} from "@openzeppelin/contracts-upgradeable/access/extensions/AccessControlDefaultAdminRulesUpgradeable.sol";
+import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
+import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 
 /// @notice OFTAdapter uses a deployed ERC-20 token and safeERC20 to interact with the OFTCore contract.
-contract RLCAdapter is Ownable, OFTAdapter {
-    constructor(address _token, address _lzEndpoint, address _owner)
-        Ownable(_owner)
-        OFTAdapter(_token, _lzEndpoint, _owner)
-    {}
+// There can only be one OFT Adapter deployed per chain. Multiple OFT Adapters break omnichain unified
+// liquidity by effectively creating token pools.
+contract RLCAdapter is
+    OFTAdapterUpgradeable,
+    UUPSUpgradeable,
+    AccessControlDefaultAdminRulesUpgradeable
+{
+    // Upgrader Role RLCAdapter contracts.
+    bytes32 public constant UPGRADER_ROLE = keccak256("UPGRADER_ROLE");
+    // Bridge Minter Role required for minting RLC Token
+    bytes32 public constant BRIDGE_ROLE = keccak256("BRIDGE_ROLE");
+
+    /// @custom:oz-upgrades-unsafe-allow constructor
+    constructor(
+        address _token,
+        address _lzEndpoint
+    ) OFTAdapterUpgradeable(_token, _lzEndpoint) {
+        _disableInitializers();
+    }
+
+    /// @notice Initializes the contract
+    /// @param _delegate Address of the contract owner
+    function initialize(address _delegate) public initializer {
+        __OFTAdapter_init(_delegate);
+        __Ownable_init(_delegate);
+        __UUPSUpgradeable_init();
+        __AccessControlDefaultAdminRules_init(0, _delegate);
+        _grantRole(UPGRADER_ROLE, _delegate);
+    }
+
+
+    function owner() public view override(OwnableUpgradeable, AccessControlDefaultAdminRulesUpgradeable) returns (address) {
+        return AccessControlDefaultAdminRulesUpgradeable.owner();
+    }
+
+    function _authorizeUpgrade(
+        address newImplementation
+    ) internal virtual override {}
 }

src/RLCOFT.sol

@@ -2,16 +2,41 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.22;
 
-import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
-import {OFT} from "@layerzerolabs/oft-evm/contracts/OFT.sol";
+import {OFTUpgradeable} from "@layerzerolabs/oft-evm-upgradeable/contracts/oft/OFTUpgradeable.sol";
+import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
+import {AccessControlDefaultAdminRulesUpgradeable} from "@openzeppelin/contracts-upgradeable/access/extensions/AccessControlDefaultAdminRulesUpgradeable.sol";
 import {ITokenSpender} from "src/ITokenSpender.sol";
 
 /// @notice OFT is an ERC-20 token that extends the OFTCore contract.
-contract RLCOFT is Ownable, OFT {
-    constructor(string memory _name, string memory _symbol, address _lzEndpoint, address _delegate)
-        Ownable(_delegate)
-        OFT(_name, _symbol, _lzEndpoint, _delegate)
-    {}
+contract RLCOFT is OFTUpgradeable, UUPSUpgradeable, AccessControlDefaultAdminRulesUpgradeable {
+    // Upgrader Role RLCAdapter contracts.
+    bytes32 public constant UPGRADER_ROLE = keccak256("UPGRADER_ROLE");
+    // Bridge Minter Role required for minting RLC Token
+    bytes32 public constant BRIDGE_ROLE = keccak256("BRIDGE_ROLE");
+
+    /// @custom:oz-upgrades-unsafe-allow constructor
+    constructor(address _lzEndpoint) OFTUpgradeable(_lzEndpoint) {
+        _disableInitializers();
+    }
+
+    /// @notice Initializes the contract
+    /// @param _name Name of the token
+    /// @param _symbol Symbol of the token
+    /// @param _delegate Address of the contract owner
+    function initialize(string memory _name, string memory _symbol, address _delegate) public initializer {
+        __OFT_init(_name, _symbol, _delegate);
+        __Ownable_init(_delegate);
+        __UUPSUpgradeable_init();
+        __AccessControlDefaultAdminRules_init(0, _delegate);
+        _grantRole(UPGRADER_ROLE, _delegate);
+    }
+
+    /// @notice Authorizes an upgrade to a new implementation
+    /// @dev Can only be called by the owner
+    /// @param newImplementation Address of the new implementation
+    function _authorizeUpgrade(
+        address newImplementation
+    ) internal override onlyRole(UPGRADER_ROLE) {}
 
     /**
      * @dev Override the decimals function to return 9 instead of the default 18