🔨 contracts: allow safe to deploy hyperlane components

Author: patitonar

contracts/.gas-snapshot

@@ -1,4 +1,4 @@
-ExaAccountFactoryTest:testFuzz_createAccount_EOAOwners(uint256,address[63]) (runs: 256, μ: 5847848, ~: 5347535)
+ExaAccountFactoryTest:testFuzz_createAccount_EOAOwners(uint256,address[63]) (runs: 256, μ: 5888117, ~: 5393451)
 ExaAccountFactoryTest:test_deploy_deploysToSameAddress() (gas: 15501257)
 ExaPluginTest:testFork_claimAndVestEscrowedEXA_claimsAndVests() (gas: 38700546)
 ExaPluginTest:testFork_collectCollateral_collects() (gas: 32196281)
@@ -202,20 +202,23 @@ ExaPreviewerTest:test_collect_reverts_whenProposalsLeaveNoLiquidity() (gas: 1437
 ExaPreviewerTest:test_markets_returnsMarkets() (gas: 150447)
 ExaPreviewerTest:test_pendingProposals_returnsPendingProposals() (gas: 1984093)
 ExaPreviewerTest:test_utilizations_returns() (gas: 134922)
-HypEXATest:test_deployRouter_setsHookAndIsm() (gas: 177970)
-HypEXATest:test_handle_reverts_withoutBridgeRole() (gas: 574363)
-HypEXATest:test_pause_pausesHookAndIsmViaPauser() (gas: 144889)
-HypEXATest:test_process_reverts_whenIsmPaused() (gas: 678724)
-HypEXATest:test_proposeBridgeRole_reverts_whenAlreadyGranted() (gas: 71828)
-HypEXATest:test_proposeBridgeRole_reverts_whenRouterNotDeployed() (gas: 17501362)
-HypEXATest:test_proposeBridgeRole_schedulesGrantOnTimelock() (gas: 1908590)
-HypEXATest:test_refreshDefaults_updatesMailboxDefaults() (gas: 635375)
-HypEXATest:test_rotateRouterPausable_restoresProcessAfterPauserIsmPaused() (gas: 19193761)
-HypEXATest:test_rotateRouterPausable_restoresTransferRemoteAfterPauserHookPaused() (gas: 2030732)
-HypEXATest:test_roundTrip_opToBaseToOp() (gas: 1175537)
-HypEXATest:test_roundTrip_opToPolygonToBaseToOp() (gas: 1742730)
-HypEXATest:test_transferRemote_reverts_whenHookPaused() (gas: 1041866)
-HypEXATest:test_transferRemote_reverts_withoutBridgeRole() (gas: 720315)
+HypEXATest:test_deployRouter_enrollsBase_whenNoRemotesOnOptimism() (gas: 30654748)
+HypEXATest:test_deployRouter_enrollsOptimism_whenNoRemotesOnBase() (gas: 30758707)
+HypEXATest:test_deployRouter_reverts_whenNoRemotesOnUnsupportedChain() (gas: 20601101)
+HypEXATest:test_deployRouter_setsHookAndIsm() (gas: 270936)
+HypEXATest:test_handle_reverts_withoutBridgeRole() (gas: 578581)
+HypEXATest:test_hookAndIsm_trackMailboxDefaults_withoutRedeploy() (gas: 154299)
+HypEXATest:test_pause_pausesHookAndIsmViaPauser() (gas: 144877)
+HypEXATest:test_process_reverts_whenIsmPaused() (gas: 712859)
+HypEXATest:test_proposeBridgeRole_reverts_whenAlreadyGranted() (gas: 247221)
+HypEXATest:test_proposeBridgeRole_reverts_whenRouterNotDeployed() (gas: 20387421)
+HypEXATest:test_proposeBridgeRole_schedulesGrantOnTimelock() (gas: 2263986)
+HypEXATest:test_rotateRouterPausable_restoresProcessAfterPauserIsmPaused() (gas: 22139948)
+HypEXATest:test_rotateRouterPausable_restoresTransferRemoteAfterPauserHookPaused() (gas: 2126569)
+HypEXATest:test_roundTrip_opToBaseToOp() (gas: 1312360)
+HypEXATest:test_roundTrip_opToPolygonToBaseToOp() (gas: 1960009)
+HypEXATest:test_transferRemote_reverts_whenHookPaused() (gas: 1106969)
+HypEXATest:test_transferRemote_reverts_withoutBridgeRole() (gas: 754963)
 IssuerCheckerTest:test_setIssuer_emits_IssuerSet() (gas: 82935)
 IssuerCheckerTest:test_setIssuer_reverts_whenNotAdmin() (gas: 43708)
 IssuerCheckerTest:test_setIssuer_reverts_whenZeroAddress() (gas: 35130)
@@ -226,24 +229,24 @@ IssuerCheckerTest:test_setPrevIssuerWindow_emits_PrevIssuerWindowSet() (gas: 526
 IssuerCheckerTest:test_setPrevIssuerWindow_reverts_whenNotAdmin() (gas: 45548)
 MockSwapperTest:test_swapExactAmountIn_swaps() (gas: 269414)
 MockSwapperTest:test_swapExactAmountOut_swaps() (gas: 269410)
-RedeployerTest:test_deployEXA_allowsProxyAdminV4Upgrade_onBase() (gas: 26759980)
-RedeployerTest:test_deployEXA_deploysAtSameAddress_onBase() (gas: 56684340)
-RedeployerTest:test_deployEXA_migratesProxyAdmin_onBase() (gas: 24041787)
-RedeployerTest:test_deployEXA_preservesERC20_onBase() (gas: 24024274)
-RedeployerTest:test_deployEXA_revokesOldProxyAdmin_onBase() (gas: 25633694)
-RedeployerTest:test_deployExaFactoryWithProxy_reverts_whenNotPrepared() (gas: 16342253)
-RedeployerTest:test_deployExaFactoryWithProxy_succeeds_whenAlreadyUpgraded() (gas: 31628388)
-RedeployerTest:test_deployExaFactory_deploysAtSameAddress_onEthereum() (gas: 260788684)
-RedeployerTest:test_deployExaFactory_deploysAtSameAddress_onPolygon() (gas: 356380326)
-RedeployerTest:test_deployExaFactory_deploysViaCreate3AtSameAddress_onPolygon() (gas: 34819889)
-RedeployerTest:test_deployExaFactory_reverts_whenNotPrepared() (gas: 16367196)
-RedeployerTest:test_deployExaFactory_succeeds_whenVersionAlreadyDeployed() (gas: 32176524)
-RedeployerTest:test_prepare_reusesExistingDeps_onBase() (gas: 19883553)
-RedeployerTest:test_prepare_reverts_whenAdminIsDeployer() (gas: 16372538)
-RedeployerTest:test_prepare_succeeds_whenCalledTwice() (gas: 31120230)
-RedeployerTest:test_recoversNativeETHOnPolygon() (gas: 34991733)
-RedeployerTest:test_serialProxies_reverts_whenAttackerUpgradesProxy() (gas: 40027233)
-RedeployerTest:test_serialProxies_reverts_whenTargetNonceTooLow() (gas: 44571529)
+RedeployerTest:test_deployEXA_allowsProxyAdminV4Upgrade_onBase() (gas: 26756929)
+RedeployerTest:test_deployEXA_deploysAtSameAddress_onBase() (gas: 56681289)
+RedeployerTest:test_deployEXA_migratesProxyAdmin_onBase() (gas: 24038736)
+RedeployerTest:test_deployEXA_preservesERC20_onBase() (gas: 24021223)
+RedeployerTest:test_deployEXA_revokesOldProxyAdmin_onBase() (gas: 25630643)
+RedeployerTest:test_deployExaFactoryWithProxy_reverts_whenNotPrepared() (gas: 16339201)
+RedeployerTest:test_deployExaFactoryWithProxy_succeeds_whenAlreadyUpgraded() (gas: 31625336)
+RedeployerTest:test_deployExaFactory_deploysAtSameAddress_onEthereum() (gas: 260785642)
+RedeployerTest:test_deployExaFactory_deploysAtSameAddress_onPolygon() (gas: 356377284)
+RedeployerTest:test_deployExaFactory_deploysViaCreate3AtSameAddress_onPolygon() (gas: 34816837)
+RedeployerTest:test_deployExaFactory_reverts_whenNotPrepared() (gas: 16364144)
+RedeployerTest:test_deployExaFactory_succeeds_whenVersionAlreadyDeployed() (gas: 32173472)
+RedeployerTest:test_prepare_reusesExistingDeps_onBase() (gas: 19880501)
+RedeployerTest:test_prepare_reverts_whenAdminIsDeployer() (gas: 16369486)
+RedeployerTest:test_prepare_succeeds_whenCalledTwice() (gas: 31117178)
+RedeployerTest:test_recoversNativeETHOnPolygon() (gas: 34988681)
+RedeployerTest:test_serialProxies_reverts_whenAttackerUpgradesProxy() (gas: 40024170)
+RedeployerTest:test_serialProxies_reverts_whenTargetNonceTooLow() (gas: 44565432)
 RefunderTest:test_refund_refunds() (gas: 263363)
 RefunderTest:test_refund_reverts_whenExpired() (gas: 88359)
 RefunderTest:test_refund_reverts_whenNotKeeper() (gas: 68861)

contracts/script/HypEXA.s.sol

@@ -7,10 +7,11 @@ import {
 import { IAccessControl } from "openzeppelin-contracts/contracts/access/IAccessControl.sol";
 import { TimelockController } from "openzeppelin-contracts/contracts/governance/TimelockController.sol";
 
+import { DefaultHook } from "@hyperlane-xyz/core/contracts/hooks/DefaultHook.sol";
 import { PausableHook } from "@hyperlane-xyz/core/contracts/hooks/PausableHook.sol";
 import { StaticAggregationHook } from "@hyperlane-xyz/core/contracts/hooks/aggregation/StaticAggregationHook.sol";
-import { IMailbox } from "@hyperlane-xyz/core/contracts/interfaces/IMailbox.sol";
 import { PausableIsm } from "@hyperlane-xyz/core/contracts/isms/PausableIsm.sol";
+import { DefaultFallbackRoutingIsm } from "@hyperlane-xyz/core/contracts/isms/routing/DefaultFallbackRoutingIsm.sol";
 import { HypERC20Collateral } from "@hyperlane-xyz/core/contracts/token/HypERC20Collateral.sol";
 import { HypXERC20 } from "@hyperlane-xyz/core/contracts/token/extensions/HypXERC20.sol";
 
@@ -19,55 +20,70 @@ import { BaseScript } from "./Base.s.sol";
 /// @title HypEXA
 /// @notice Deploys and maintains the Hyperlane HypXERC20 router for EXA.
 contract HypEXA is BaseScript {
-  function deployRouter(address token, uint32[] calldata remoteDomains) external returns (HypXERC20 router) {
+  function deployRouter(uint32[] calldata remoteDomains) external returns (HypXERC20 router) {
     address admin = acct("admin");
+    address exa = protocol("EXA", true, getChain("optimism").chainId);
     router = HypXERC20(CREATE3_FACTORY.getDeployed(admin, keccak256(abi.encode("HypEXA"))));
     if (address(router).code.length != 0) return router;
+
+    uint32[] memory domains = remoteDomains;
+    if (domains.length == 0) {
+      domains = new uint32[](1);
+      if (block.chainid == getChain("optimism").chainId) domains[0] = uint32(getChain("base").chainId);
+      else if (block.chainid == getChain("base").chainId) domains[0] = uint32(getChain("optimism").chainId);
+      else revert UnsupportedChain(block.chainid);
+    }
+
     vm.startBroadcast(admin);
 
     (address hook, address ism) = _deployAggregations(
       _deployPausableHook(acct("exactly")),
       _deployPausableHook(acct("pauser")),
+      _deployDefaultHook(),
       _deployPausableIsm(acct("exactly")),
-      _deployPausableIsm(acct("pauser"))
+      _deployPausableIsm(acct("pauser")),
+      _deployDefaultIsm()
     );
 
+    address impl = CREATE3_FACTORY.getDeployed(admin, keccak256(abi.encode("HypEXAImpl")));
+    if (impl.code.length == 0) {
+      impl = CREATE3_FACTORY.deploy(
+        keccak256(abi.encode("HypEXAImpl")),
+        abi.encodePacked(type(HypXERC20).creationCode, abi.encode(exa, 1, 1, acct("hyperlaneMailbox")))
+      );
+    }
+
     router = HypXERC20(
       CREATE3_FACTORY.deploy(
         keccak256(abi.encode("HypEXA")),
         abi.encodePacked(
           type(TransparentUpgradeableProxy).creationCode,
-          abi.encode(
-            address(new HypXERC20(token, 1, 1, acct("hyperlaneMailbox"))),
-            protocol("ProxyAdmin"),
-            abi.encodeCall(HypERC20Collateral.initialize, (hook, ism, admin))
-          )
+          abi.encode(impl, protocol("ProxyAdmin"), abi.encodeCall(HypERC20Collateral.initialize, (hook, ism, admin)))
         )
       )
     );
 
-    if (remoteDomains.length > 0) {
-      bytes32[] memory addresses = new bytes32[](remoteDomains.length);
-      bytes32 remote = bytes32(uint256(uint160(address(router))));
-      for (uint256 i = 0; i < remoteDomains.length; ++i) {
-        addresses[i] = remote;
-      }
-      router.enrollRemoteRouters(remoteDomains, addresses);
+    bytes32[] memory addresses = new bytes32[](domains.length);
+    bytes32 remote = bytes32(uint256(uint160(address(router))));
+    for (uint256 i = 0; i < domains.length; ++i) {
+      addresses[i] = remote;
     }
+    router.enrollRemoteRouters(domains, addresses);
 
     router.transferOwnership(acct("exactly"));
     vm.stopBroadcast();
   }
 
-  function proposeBridgeRole(address token, bytes32 salt) external {
+  function proposeBridgeRole(bytes32 salt) external {
     address router = CREATE3_FACTORY.getDeployed(acct("admin"), keccak256(abi.encode("HypEXA")));
     if (router.code.length == 0) revert RouterNotDeployed();
-    if (IAccessControl(token).hasRole(keccak256("BRIDGE_ROLE"), router)) revert AlreadyGranted();
+    address exa = protocol("EXA", true, getChain("optimism").chainId);
+    if (IAccessControl(exa).hasRole(keccak256("BRIDGE_ROLE"), router)) revert AlreadyGranted();
     TimelockController timelock = TimelockController(payable(protocol("TimelockController")));
     uint256 delay = timelock.getMinDelay();
     vm.broadcast(acct("deployer"));
     timelock.schedule(
-      token, 0, abi.encodeCall(IAccessControl.grantRole, (keccak256("BRIDGE_ROLE"), router)), bytes32(0), salt, delay
+      exa, 0, abi.encodeCall(IAccessControl.grantRole, (keccak256("BRIDGE_ROLE"), router)), bytes32(0), salt, delay
     );
   }
 
@@ -83,59 +99,88 @@ contract HypEXA is BaseScript {
     _expectOwner(hooks[0], acct("exactly"));
     _expectOwner(modules[0], acct("exactly"));
     (hook, ism) = _deployAggregations(
-      hooks[0], _deployPausableHook(acct("pauser")), modules[0], _deployPausableIsm(acct("pauser"))
+      hooks[0],
+      _deployPausableHook(acct("pauser")),
+      hooks[2],
+      modules[0],
+      _deployPausableIsm(acct("pauser")),
+      modules[2]
     );
     HypXERC20(router).setHook(hook);
     HypXERC20(router).setInterchainSecurityModule(ism);
 
     vm.stopBroadcast();
   }
 
-  /// @notice Refreshes router hook and ism with new defaults from the Mailbox.
-  function refreshDefaults() external returns (address hook, address ism) {
-    address router = CREATE3_FACTORY.getDeployed(acct("admin"), keccak256(abi.encode("HypEXA")));
-    if (router.code.length == 0) revert RouterNotDeployed();
-    vm.startBroadcast(acct("exactly"));
-
-    address[] memory hooks = StaticAggregationHook(address(HypXERC20(router).hook())).hooks("");
-    (address[] memory modules,) =
-      IStaticAggregationIsm(address(HypXERC20(router).interchainSecurityModule())).modulesAndThreshold("");
-    _expectOwner(hooks[0], acct("exactly"));
-    _expectOwner(hooks[1], acct("pauser"));
-    _expectOwner(modules[0], acct("exactly"));
-    _expectOwner(modules[1], acct("pauser"));
-    (hook, ism) = _deployAggregations(hooks[0], hooks[1], modules[0], modules[1]);
-    HypXERC20(router).setHook(hook);
-    HypXERC20(router).setInterchainSecurityModule(ism);
-
-    vm.stopBroadcast();
-  }
-
-  function _deployAggregations(address exactlyHook, address pauserHook, address exactlyIsm, address pauserIsm)
-    internal
-    returns (address aggregationHook, address aggregationIsm)
-  {
-    address mailbox = acct("hyperlaneMailbox");
+  function _deployAggregations(
+    address exactlyHook,
+    address pauserHook,
+    address defaultHook,
+    address exactlyIsm,
+    address pauserIsm,
+    address defaultIsm
+  ) internal returns (address aggregationHook, address aggregationIsm) {
     address[] memory hooks = new address[](3);
     hooks[0] = exactlyHook;
     hooks[1] = pauserHook;
-    hooks[2] = address(IMailbox(mailbox).defaultHook());
+    hooks[2] = defaultHook;
     aggregationHook = IStaticAggregationHookFactory(acct("hyperlaneAggregationHookFactory")).deploy(hooks);
 
     address[] memory isms = new address[](3);
     isms[0] = exactlyIsm;
     isms[1] = pauserIsm;
-    isms[2] = address(IMailbox(mailbox).defaultIsm());
+    isms[2] = defaultIsm;
     aggregationIsm = IStaticAggregationIsmFactory(acct("hyperlaneAggregationIsmFactory")).deploy(isms, 3);
   }
 
+  function _deployDefaultHook() internal returns (address hook) {
+    address admin = acct("admin");
+    hook = CREATE3_FACTORY.getDeployed(admin, keccak256(abi.encode("HypEXADefaultHook")));
+    if (hook.code.length == 0) {
+      hook = CREATE3_FACTORY.deploy(
+        keccak256(abi.encode("HypEXADefaultHook")),
+        abi.encodePacked(type(DefaultHook).creationCode, abi.encode(acct("hyperlaneMailbox")))
+      );
+    }
+  }
+
+  function _deployDefaultIsm() internal returns (address ism) {
+    address admin = acct("admin");
+    address impl = CREATE3_FACTORY.getDeployed(admin, keccak256(abi.encode("HypEXADefaultIsmImpl")));
+    if (impl.code.length == 0) {
+      impl = CREATE3_FACTORY.deploy(
+        keccak256(abi.encode("HypEXADefaultIsmImpl")),
+        abi.encodePacked(type(DefaultFallbackRoutingIsm).creationCode, abi.encode(acct("hyperlaneMailbox")))
+      );
+    }
+    ism = CREATE3_FACTORY.getDeployed(admin, keccak256(abi.encode("HypEXADefaultIsm")));
+    if (ism.code.length == 0) {
+      ism = CREATE3_FACTORY.deploy(
+        keccak256(abi.encode("HypEXADefaultIsm")),
+        abi.encodePacked(
+          type(TransparentUpgradeableProxy).creationCode,
+          abi.encode(impl, protocol("ProxyAdmin"), abi.encodeCall(IRoutingIsmInitializer.initialize, (acct("exactly"))))
+        )
+      );
+    }
+  }
+
   function _deployPausableHook(address owner) internal returns (address hook) {
-    hook = address(new PausableHook());
-    PausableHook(hook).transferOwnership(owner);
+    address factory = CREATE3_FACTORY.getDeployed(acct("admin"), keccak256(abi.encode("PausableHookFactory")));
+    if (factory.code.length == 0) {
+      factory =
+        CREATE3_FACTORY.deploy(keccak256(abi.encode("PausableHookFactory")), type(PausableHookFactory).creationCode);
+    }
+    hook = address(PausableHookFactory(factory).deploy(owner));
   }
 
   function _deployPausableIsm(address owner) internal returns (address ism) {
-    ism = address(new PausableIsm(owner));
+    address factory = CREATE3_FACTORY.getDeployed(acct("admin"), keccak256(abi.encode("PausableIsmFactory")));
+    if (factory.code.length == 0) {
+      factory =
+        CREATE3_FACTORY.deploy(keccak256(abi.encode("PausableIsmFactory")), type(PausableIsmFactory).creationCode);
+    }
+    ism = address(PausableIsmFactory(factory).deploy(owner));
   }
 
   function _expectOwner(address target, address owner) internal view {
@@ -146,12 +191,30 @@ contract HypEXA is BaseScript {
 error AlreadyGranted();
 error RouterNotDeployed();
 error UnexpectedOwner(address target, address owner);
+error UnsupportedChain(uint256 chainid);
+
+contract PausableHookFactory {
+  function deploy(address owner) external returns (PausableHook hook) {
+    hook = new PausableHook();
+    hook.transferOwnership(owner);
+  }
+}
+
+contract PausableIsmFactory {
+  function deploy(address owner) external returns (PausableIsm ism) {
+    ism = new PausableIsm(owner);
+  }
+}
 
 interface IStaticAggregationHookFactory {
   function deploy(address[] calldata values) external returns (address);
   function getAddress(address[] calldata values) external view returns (address);
 }
 
+interface IRoutingIsmInitializer {
+  function initialize(address owner) external;
+}
+
 interface IStaticAggregationIsm {
   function modulesAndThreshold(bytes calldata) external view returns (address[] memory, uint8);
 }