GHO CCIP 1.5.1 Upgrade Eth<>Arb

diffs/AaveV3Arbitrum_GHOCCIP151Upgrade_20241209_before_AaveV3Arbitrum_GHOCCIP151Upgrade_20241209_after.md

@@ -0,0 +1,5 @@
+## Raw diff
+
+```json
+{}
+```

diffs/AaveV3Ethereum_GHOCCIP151Upgrade_20241209_before_AaveV3Ethereum_GHOCCIP151Upgrade_20241209_after.md

@@ -0,0 +1,5 @@
+## Raw diff
+
+```json
+{}
+```

src/20241209_Multi_GHOCCIP151Upgrade/AaveV3Arbitrum_GHOCCIP151Upgrade_20241209.sol

@@ -0,0 +1,127 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import {ITransparentUpgradeableProxy} from 'solidity-utils/contracts/transparent-proxy/TransparentUpgradeableProxy.sol';
+import {IUpgradeableBurnMintTokenPool_1_4, IUpgradeableBurnMintTokenPool_1_5_1} from 'src/interfaces/ccip/tokenPool/IUpgradeableBurnMintTokenPool.sol';
+import {IProposalGenericExecutor} from 'aave-helpers/src/interfaces/IProposalGenericExecutor.sol';
+import {ITokenAdminRegistry} from 'src/interfaces/ccip/ITokenAdminRegistry.sol';
+import {IRateLimiter} from 'src/interfaces/ccip/IRateLimiter.sol';
+import {IProxyPool} from 'src/interfaces/ccip/IProxyPool.sol';
+import {ILegacyProxyAdmin} from 'src/interfaces/ILegacyProxyAdmin.sol';
+import {IGhoToken} from 'src/interfaces/IGhoToken.sol';
+import {MiscArbitrum} from 'aave-address-book/MiscArbitrum.sol';
+import {GhoArbitrum} from 'aave-address-book/GhoArbitrum.sol';
+import {AaveV3EthereumAssets} from 'aave-address-book/AaveV3Ethereum.sol';
+import {AaveV3ArbitrumAssets} from 'aave-address-book/AaveV3Arbitrum.sol';
+
+/**
+ * @title GHO CCIP 1.5.1 Upgrade
+ * @author Aave Labs
+ * - Discussion: TODO
+ */
+contract AaveV3Arbitrum_GHOCCIP151Upgrade_20241209 is IProposalGenericExecutor {
+  uint64 public constant ETH_CHAIN_SELECTOR = 5009297550715157269;
+
+  // https://arbiscan.io/address/0x39AE1032cF4B334a1Ed41cdD0833bdD7c7E7751E
+  ITokenAdminRegistry public constant TOKEN_ADMIN_REGISTRY =
+    ITokenAdminRegistry(0x39AE1032cF4B334a1Ed41cdD0833bdD7c7E7751E);
+
+  // https://arbiscan.io/address/0x26329558f08cbb40d6a4CCA0E0C67b29D64A8c50
+  IProxyPool public constant EXISTING_PROXY_POOL =
+    IProxyPool(0x26329558f08cbb40d6a4CCA0E0C67b29D64A8c50);
+  // https://arbiscan.io/address/0xF168B83598516A532a85995b52504a2Fa058C068
+  IUpgradeableBurnMintTokenPool_1_4 public constant EXISTING_TOKEN_POOL =
+    IUpgradeableBurnMintTokenPool_1_4(GhoArbitrum.GHO_CCIP_TOKEN_POOL); // will be updated in address-book after AIP
+  // https://arbiscan.io/address/0x6Bb7a212910682DCFdbd5BCBb3e28FB4E8da10Ee
+  IUpgradeableBurnMintTokenPool_1_5_1 public constant NEW_TOKEN_POOL =
+    IUpgradeableBurnMintTokenPool_1_5_1(0x6Bb7a212910682DCFdbd5BCBb3e28FB4E8da10Ee);
+
+  // https://arbiscan.io/address/0x06179f7C1be40863405f374E7f5F8806c728660A
+  address public constant NEW_GHO_CCIP_STEWARD = 0x06179f7C1be40863405f374E7f5F8806c728660A;
+
+  // https://etherscan.io/address/0x9Ec9F9804733df96D1641666818eFb5198eC50f0
+  address public constant EXISTING_REMOTE_POOL_ETH = 0x9Ec9F9804733df96D1641666818eFb5198eC50f0; // ProxyPool on ETH
+  // https://etherscan.io/address/0x20fd5f3FCac8883a3A0A2bBcD658A2d2c6EFa6B6
+  address public constant NEW_REMOTE_POOL_ETH = 0x20fd5f3FCac8883a3A0A2bBcD658A2d2c6EFa6B6;
+
+  // https://arbiscan.io/address/0xA5Ba213867E175A182a5dd6A9193C6158738105A
+  // https://github.com/aave/ccip/commit/ca73ec8c4f7dc0f6a99ae1ea0acde43776c7b9bb
+  address public constant EXISTING_TOKEN_POOL_UPGRADE_IMPL =
+    0xA5Ba213867E175A182a5dd6A9193C6158738105A;
+
+  // https://arbiscan.io/address/0x7dfF72693f6A4149b17e7C6314655f6A9F7c8B33
+  IGhoToken public constant GHO = IGhoToken(AaveV3ArbitrumAssets.GHO_UNDERLYING);
+
+  // Token Rate Limit Capacity: 300_000 GHO
+  uint128 public constant CCIP_RATE_LIMIT_CAPACITY = 300_000e18;
+  // Token Rate Limit Refill Rate: 60 GHO per second (=> 216_000 GHO per hour)
+  uint128 public constant CCIP_RATE_LIMIT_REFILL_RATE = 60e18;
+
+  function execute() external {
+    _acceptOwnership();
+    _migrateLiquidity();
+    _setupAndRegisterNewPool();
+  }
+
+  // pre-req - chainlink transfers gho token pool ownership on token admin registry
+  function _acceptOwnership() internal {
+    EXISTING_PROXY_POOL.acceptOwnership();
+    NEW_TOKEN_POOL.acceptOwnership();
+    TOKEN_ADMIN_REGISTRY.acceptAdminRole(AaveV3ArbitrumAssets.GHO_UNDERLYING);
+  }
+
+  function _migrateLiquidity() internal {
+    // bucketLevel === bridgedAmount
+    (uint256 bucketCapacity, uint256 bucketLevel) = GHO.getFacilitatorBucket(
+      address(EXISTING_TOKEN_POOL)
+    );
+
+    GHO.addFacilitator(address(NEW_TOKEN_POOL), 'CCIP TokenPool v1.5.1', uint128(bucketCapacity));
+    NEW_TOKEN_POOL.directMint(address(EXISTING_TOKEN_POOL), bucketLevel); // increase facilitator level
+
+    _upgradeExistingTokenPool(); // introduce `directBurn` method
+    EXISTING_TOKEN_POOL.directBurn(bucketLevel); // decrease facilitator level
+
+    GHO.removeFacilitator(address(EXISTING_TOKEN_POOL));
+  }
+
+  function _setupAndRegisterNewPool() internal {
+    IRateLimiter.Config memory rateLimiterConfig = IRateLimiter.Config({
+      isEnabled: true,
+      capacity: CCIP_RATE_LIMIT_CAPACITY,
+      rate: CCIP_RATE_LIMIT_REFILL_RATE
+    });
+
+    IUpgradeableBurnMintTokenPool_1_5_1.ChainUpdate[]
+      memory chains = new IUpgradeableBurnMintTokenPool_1_5_1.ChainUpdate[](1);
+
+    bytes[] memory remotePoolAddresses = new bytes[](2);
+    remotePoolAddresses[0] = abi.encode(EXISTING_REMOTE_POOL_ETH);
+    remotePoolAddresses[1] = abi.encode(NEW_REMOTE_POOL_ETH);
+
+    chains[0] = IUpgradeableBurnMintTokenPool_1_5_1.ChainUpdate({
+      remoteChainSelector: ETH_CHAIN_SELECTOR,
+      remotePoolAddresses: remotePoolAddresses,
+      remoteTokenAddress: abi.encode(AaveV3EthereumAssets.GHO_UNDERLYING),
+      outboundRateLimiterConfig: rateLimiterConfig,
+      inboundRateLimiterConfig: rateLimiterConfig
+    });
+
+    // setup new pool
+    NEW_TOKEN_POOL.applyChainUpdates({
+      remoteChainSelectorsToRemove: new uint64[](0),
+      chainsToAdd: chains
+    });
+    NEW_TOKEN_POOL.setRateLimitAdmin(NEW_GHO_CCIP_STEWARD);
+
+    // register new pool
+    TOKEN_ADMIN_REGISTRY.setPool(address(GHO), address(NEW_TOKEN_POOL));
+  }
+
+  function _upgradeExistingTokenPool() internal {
+    ILegacyProxyAdmin(MiscArbitrum.PROXY_ADMIN).upgrade(
+      ITransparentUpgradeableProxy(payable(address(EXISTING_TOKEN_POOL))),
+      EXISTING_TOKEN_POOL_UPGRADE_IMPL
+    );
+  }
+}