feat: deployment script

contracts/foundry.toml

@@ -10,6 +10,7 @@ cache_path = 'foundry-cache'
 libs = ['node_modules', 'foundry-lib']
 bytecode_hash = "none"
 ffi = false
+allow_internal_expect_revert = true
 
 # default is zero, using a non-zero amount enables us to test e.g. billing based on gas prices.
 gas_price = 1
@@ -26,8 +27,10 @@ single_line_statement_blocks = "preserve"
 solc_version = '0.8.24'
 src = 'src/v0.8/ccip'
 test = 'src/v0.8/ccip/test'
+script = 'script'
 optimizer_runs = 800
 evm_version = 'paris'
+fs_permissions = [{ access = "read", path = "./script/config.json" }]
 
 [profile.functions]
 solc_version = '0.8.19'
@@ -97,5 +100,34 @@ src = 'src/v0.8/shared'
 test = 'src/v0.8/shared/test'
 solc_version = '0.8.24'
 
+[rpc_endpoints]
+mainnet = "${RPC_MAINNET}"
+optimism = "${RPC_OPTIMISM}"
+avalanche = "${RPC_AVALANCHE}"
+polygon = "${RPC_POLYGON}"
+arbitrum = "${RPC_ARBITRUM}"
+fantom = "${RPC_FANTOM}"
+harmony = "${RPC_HARMONY}"
+metis = "${RPC_METIS}"
+base = "${RPC_BASE}"
+zkevm = "${RPC_ZKEVM}"
+gnosis = "${RPC_GNOSIS}"
+bnb = "${RPC_BNB}"
+celo = "${RPC_CELO}"
+
+[etherscan]
+mainnet = { key = "${ETHERSCAN_API_KEY_MAINNET}", chainId = 1 }
+optimism = { key = "${ETHERSCAN_API_KEY_OPTIMISM}", chainId = 10 }
+avalanche = { key = "${ETHERSCAN_API_KEY_AVALANCHE}", chainId = 43114 }
+polygon = { key = "${ETHERSCAN_API_KEY_POLYGON}", chainId = 137 }
+arbitrum = { key = "${ETHERSCAN_API_KEY_ARBITRUM}", chainId = 42161 }
+fantom = { key = "${ETHERSCAN_API_KEY_FANTOM}", chainId = 250 }
+metis = { key = "any", chainId = 1088, url = 'https://andromeda-explorer.metis.io/' }
+base = { key = "${ETHERSCAN_API_KEY_BASE}", chainId = 8453 }
+zkevm = { key = "${ETHERSCAN_API_KEY_ZKEVM}", chainId = 1101 }
+gnosis = { key = "${ETHERSCAN_API_KEY_GNOSIS}", chainId = 100 }
+bnb = { key = "${ETHERSCAN_API_KEY_BNB}", chainId = 56 }
+celo = { key = "${ETHERSCAN_API_KEY_CELO}", chainId = 42220 }
+
 
 # See more config options https://github.com/foundry-rs/foundry/tree/master/config

contracts/package.json

@@ -125,8 +125,8 @@
     "@changesets/cli": "~2.27.7",
     "@eth-optimism/contracts": "0.6.0",
     "@matterlabs/hardhat-zksync-verify": "^1.6.0",
-    "@openzeppelin/contracts": "4.9.3",
-    "@openzeppelin/contracts-upgradeable": "4.9.3",
+    "@openzeppelin/contracts": "5.1.0",
+    "@openzeppelin/contracts-upgradeable": "5.1.0",
     "@scroll-tech/contracts": "0.1.0",
     "@zksync/contracts": "git+https://github.com/matter-labs/era-contracts.git#446d391d34bdb48255d5f8fef8a8248925fc98b9",
     "semver": "^7.6.3"

contracts/remappings.txt

@@ -1,13 +1,14 @@
 forge-std/=src/v0.8/vendor/forge-std/src/
 
-@openzeppelin/=node_modules/@openzeppelin/
+@oz/=node_modules/@openzeppelin/
 @arbitrum/=node_modules/@arbitrum/
 hardhat/=node_modules/hardhat/
 @eth-optimism/=node_modules/@eth-optimism/
 @scroll-tech/=node_modules/@scroll-tech/
 @zksync/=node_modules/@zksync/
 
 @aave/=foundry-lib/gho-core/lib/aave-token/
+@openzeppelin/=foundry-lib/gho-core/lib/openzeppelin-contracts/
 @aave-gho-core/=foundry-lib/gho-core/src/contracts/
 @aave/core-v3/=foundry-lib/gho-core/lib/aave-v3-core/
 @aave/periphery-v3/=foundry-lib/gho-core/lib/aave-v3-periphery/

contracts/script/DeployUpgradableBurnMintTokenPool.s.sol

@@ -0,0 +1,82 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity ^0.8.0;
+
+import {Script} from "forge-std/Script.sol";
+import {console2 as console} from "forge-std/console2.sol";
+
+import {TransparentUpgradeableProxy, ProxyAdmin} from "@oz/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+import {UpgradeableBurnMintTokenPool} from "./../src/v0.8/ccip/pools/GHO/UpgradeableBurnMintTokenPool.sol";
+
+import {IERC20Metadata} from "solidity-utils/contracts/oz-common/interfaces/IERC20Metadata.sol";
+import {ITypeAndVersion} from "./../src/v0.8/shared/interfaces/ITypeAndVersion.sol";
+
+struct Config {
+  address GHO_TOKEN;
+  address OWNER;
+  address PROXY_ADMIN_OWNER;
+  address RMN_PROXY;
+  address ROUTER;
+}
+
+/// @notice Deploys UpgradeableBurnMintTokenPool behind a transparent upgradable proxy for GHO.
+/// Pre-requisite: add parameters to config.json, the with key as `chainId` of the target network.
+/// Usage: FOUNDRY_PROFILE=ccip forge script DeployUpgradableBurnMintTokenPool --rpc-url <RPC_URL> --private-key <PRIVATE_KEY> --broadcast --verify --etherscan-api-key <ETHERSCAN_API_KEY> --slow
+contract DeployUpgradableBurnMintTokenPool is Script {
+  function run() external {
+    Config memory config = _parseConfig();
+
+    uint8 TOKEN_DECIMALS = IERC20Metadata(config.GHO_TOKEN).decimals();
+    address[] memory ALLOW_LIST = new address[](0);
+    bool ALLOW_LIST_ENABLED = false;
+
+    vm.startBroadcast();
+    address tokenPool = address(
+      new UpgradeableBurnMintTokenPool(config.GHO_TOKEN, TOKEN_DECIMALS, config.RMN_PROXY, ALLOW_LIST_ENABLED)
+    );
+    address tokenPoolProxy = address(
+      new TransparentUpgradeableProxy({
+        _logic: tokenPool,
+        initialOwner: config.PROXY_ADMIN_OWNER,
+        _data: abi.encodeCall(UpgradeableBurnMintTokenPool.initialize, (config.OWNER, ALLOW_LIST, config.ROUTER))
+      })
+    );
+    vm.stopBroadcast();
+
+    console.log("tokenPoolProxy          ", tokenPoolProxy);
+    console.log("tokenPoolImplementation ", tokenPool);
+
+    _validate(tokenPoolProxy, config);
+  }
+
+  function _parseConfig() internal view returns (Config memory) {
+    string memory config = vm.readFile(string.concat(vm.projectRoot(), "/script/config.json"));
+    return _validate(abi.decode(vm.parseJson(config, string.concat(".", vm.toString(block.chainid))), (Config)));
+  }
+
+  function _validate(Config memory config) internal view returns (Config memory) {
+    require(address(config.OWNER) != address(0), "InvalidOwner");
+    require(address(config.PROXY_ADMIN_OWNER) != address(0), "InvalidOwner");
+    require(_cmp(IERC20Metadata(config.GHO_TOKEN).name(), "Gho Token"), "InvalidToken");
+    require(_cmp(IERC20Metadata(config.GHO_TOKEN).symbol(), "GHO"), "InvalidToken");
+    require(_cmp(ITypeAndVersion(config.RMN_PROXY).typeAndVersion(), "ARMProxy 1.0.0"), "InvalidRmnProxy");
+    require(_cmp(ITypeAndVersion(config.ROUTER).typeAndVersion(), "Router 1.2.0"), "InvalidRouter");
+    return config;
+  }
+
+  function _validate(address proxy, Config memory config) internal view {
+    require(_cmp(_getProxyAdmin(proxy).UPGRADE_INTERFACE_VERSION(), "5.0.0"), "InvalidProxyAdminVersion");
+    require(_getProxyAdmin(proxy).owner() == config.PROXY_ADMIN_OWNER, "InvalidProxyAdminOwner");
+    require(address(UpgradeableBurnMintTokenPool(proxy).getToken()) == config.GHO_TOKEN, "InvalidToken");
+    require(UpgradeableBurnMintTokenPool(proxy).getRmnProxy() == config.RMN_PROXY, "InvalidRmnProxy");
+    require(UpgradeableBurnMintTokenPool(proxy).getRouter() == config.ROUTER, "InvalidRouter");
+  }
+
+  function _getProxyAdmin(address proxy) internal view returns (ProxyAdmin) {
+    bytes32 slot = bytes32(uint256(keccak256("eip1967.proxy.admin")) - 1);
+    return ProxyAdmin(address(uint160(uint256(vm.load(proxy, slot)))));
+  }
+
+  function _cmp(string memory a, string memory b) internal pure returns (bool) {
+    return keccak256(abi.encodePacked(a)) == keccak256(abi.encodePacked(b));
+  }
+}

contracts/script/config.json

@@ -0,0 +1,23 @@
+{
+    "42161": {
+        "GHO_TOKEN": "0x7dfF72693f6A4149b17e7C6314655f6A9F7c8B33",
+        "OWNER": "0xFF1137243698CaA18EE364Cc966CF0e02A4e6327",
+        "PROXY_ADMIN_OWNER": "0xFF1137243698CaA18EE364Cc966CF0e02A4e6327",
+        "RMN_PROXY": "0xC311a21e6fEf769344EB1515588B9d535662a145",
+        "ROUTER": "0x141fa059441E0ca23ce184B6A78bafD2A517DdE8"
+    },
+    "8453": {
+        "GHO_TOKEN": "0x6Bb7a212910682DCFdbd5BCBb3e28FB4E8da10Ee",
+        "OWNER": "0x9390B1735def18560c509E2d0bc090E9d6BA257a",
+        "PROXY_ADMIN_OWNER": "0x9390B1735def18560c509E2d0bc090E9d6BA257a",
+        "RMN_PROXY": "0xC842c69d54F83170C42C4d556B4F6B2ca53Dd3E8",
+        "ROUTER": "0x881e3A65B4d4a04dD529061dd0071cf975F58bCD"
+    },
+    "100": {
+        "GHO_TOKEN": "0xfc421aD3C883Bf9E7C4f42dE845C4e4405799e73",
+        "OWNER": "0x1dF462e2712496373A347f8ad10802a5E95f053D",
+        "PROXY_ADMIN_OWNER": "0x1dF462e2712496373A347f8ad10802a5E95f053D",
+        "RMN_PROXY": "0xf5e5e1676942520995c1e39aFaC58A75Fe1cd2bB",
+        "ROUTER": "0x4aAD6071085df840abD9Baf1697d5D5992bDadce"
+    }
+}