chore: refactor warp route inheritance tree (#7064)

Co-authored-by: nambrot <[email protected]>

Author: yorhodes

.changeset/big-papayas-grow.md

@@ -0,0 +1,15 @@
+---
+"@hyperlane-xyz/core": major
+---
+
+Refactor warp route contracts for shallower inheritance tree and smaller bytecode size.
+
+Deprecated `Router` and `GasRouter` internal functions have been removed.
+
+`FungibleTokenRouter` has been removed and functionality lifted into `TokenRouter`.
+
+`quoteTransferRemote` and `transferRemote` can no longer be overriden with optional `hook` and `hookMetadata` for simplicity.
+
+`quoteTransferRemote` returns a consistent shape of `[nativeMailboxDispatchFee, internalTokenFee, externalTokenFee]`.
+
+`HypNative` and `HypERC20Collateral` inherit from `MovableCollateral` and `LpCollateral` but other extensions (eg `HypXERC20`) do not. Storage layouts have been preserved to ensure upgrade compatibility.

.changeset/mean-pigs-check.md

@@ -0,0 +1,5 @@
+---
+"@hyperlane-xyz/helloworld": patch
+---
+
+Update HelloWorld to use new Router utils

.changeset/sharp-clouds-pay.md

@@ -0,0 +1,6 @@
+---
+"@hyperlane-xyz/sdk": minor
+"@hyperlane-xyz/cli": patch
+---
+
+Decouple movable collateral and hyp collateral token adapters

solidity/contracts/client/GasRouter.sol

@@ -59,7 +59,13 @@ abstract contract GasRouter is Router {
     function quoteGasPayment(
         uint32 _destinationDomain
     ) public view virtual returns (uint256) {
-        return _GasRouter_quoteDispatch(_destinationDomain, "", address(hook));
+        return
+            _Router_quoteDispatch(
+                _destinationDomain,
+                "",
+                _GasRouter_hookMetadata(_destinationDomain),
+                address(hook)
+            );
     }
 
     function _GasRouter_hookMetadata(
@@ -73,34 +79,4 @@ abstract contract GasRouter is Router {
         destinationGas[domain] = gas;
         emit GasSet(domain, gas);
     }
-
-    function _GasRouter_dispatch(
-        uint32 _destination,
-        uint256 _value,
-        bytes memory _messageBody,
-        address _hook
-    ) internal returns (bytes32) {
-        return
-            _Router_dispatch(
-                _destination,
-                _value,
-                _messageBody,
-                _GasRouter_hookMetadata(_destination),
-                _hook
-            );
-    }
-
-    function _GasRouter_quoteDispatch(
-        uint32 _destination,
-        bytes memory _messageBody,
-        address _hook
-    ) internal view returns (uint256) {
-        return
-            _Router_quoteDispatch(
-                _destination,
-                _messageBody,
-                _GasRouter_hookMetadata(_destination),
-                _hook
-            );
-    }
 }

solidity/contracts/client/Router.sol

@@ -169,6 +169,21 @@ abstract contract Router is MailboxClient, IMessageRecipient {
             );
     }
 
+    function _Router_dispatch(
+        uint32 _destinationDomain,
+        uint256 _value,
+        bytes memory _messageBody
+    ) internal returns (bytes32) {
+        return
+            _Router_dispatch(
+                _destinationDomain,
+                _value,
+                _messageBody,
+                "",
+                address(hook)
+            );
+    }
+
     function _Router_dispatch(
         uint32 _destinationDomain,
         uint256 _value,
@@ -187,18 +202,13 @@ abstract contract Router is MailboxClient, IMessageRecipient {
             );
     }
 
-    /**
-     * DEPRECATED: Use `_Router_dispatch` instead
-     * @dev For backward compatibility with v2 client contracts
-     */
-    function _dispatch(
+    function _Router_quoteDispatch(
         uint32 _destinationDomain,
         bytes memory _messageBody
-    ) internal returns (bytes32) {
+    ) internal view returns (uint256) {
         return
-            _Router_dispatch(
+            _Router_quoteDispatch(
                 _destinationDomain,
-                msg.value,
                 _messageBody,
                 "",
                 address(hook)
@@ -221,21 +231,4 @@ abstract contract Router is MailboxClient, IMessageRecipient {
                 IPostDispatchHook(_hook)
             );
     }
-
-    /**
-     * DEPRECATED: Use `_Router_quoteDispatch` instead
-     * @dev For backward compatibility with v2 client contracts
-     */
-    function _quoteDispatch(
-        uint32 _destinationDomain,
-        bytes memory _messageBody
-    ) internal view returns (uint256) {
-        return
-            _Router_quoteDispatch(
-                _destinationDomain,
-                _messageBody,
-                "",
-                address(hook)
-            );
-    }
 }

solidity/contracts/middleware/InterchainQueryRouter.sol

@@ -69,11 +69,12 @@ contract InterchainQueryRouter is Router {
         address _to,
         bytes memory _data,
         bytes memory _callback
-    ) public returns (bytes32 messageId) {
+    ) public payable returns (bytes32 messageId) {
         emit QueryDispatched(_destination, msg.sender);
 
-        messageId = _dispatch(
+        messageId = _Router_dispatch(
             _destination,
+            msg.value,
             InterchainQueryMessage.encode(
                 msg.sender.addressToBytes32(),
                 _to,
@@ -93,10 +94,11 @@ contract InterchainQueryRouter is Router {
     function query(
         uint32 _destination,
         CallLib.StaticCallWithCallback[] calldata calls
-    ) public returns (bytes32 messageId) {
+    ) public payable returns (bytes32 messageId) {
         emit QueryDispatched(_destination, msg.sender);
-        messageId = _dispatch(
+        messageId = _Router_dispatch(
             _destination,
+            msg.value,
             InterchainQueryMessage.encode(msg.sender.addressToBytes32(), calls)
         );
     }
@@ -121,8 +123,9 @@ contract InterchainQueryRouter is Router {
                 callsWithCallback
             );
             emit QueryExecuted(_origin, sender);
-            _dispatch(
+            _Router_dispatch(
                 _origin,
+                msg.value,
                 InterchainQueryMessage.encode(sender, callbacks)
             );
         } else if (messageType == InterchainQueryMessage.MessageType.RESPONSE) {

solidity/contracts/test/TestGasRouter.sol

@@ -7,7 +7,26 @@ contract TestGasRouter is GasRouter {
     constructor(address _mailbox) GasRouter(_mailbox) {}
 
     function dispatch(uint32 _destination, bytes memory _msg) external payable {
-        _GasRouter_dispatch(_destination, msg.value, _msg, address(hook));
+        _Router_dispatch(
+            _destination,
+            msg.value,
+            _msg,
+            _GasRouter_hookMetadata(_destination),
+            address(hook)
+        );
+    }
+
+    function quoteDispatch(
+        uint32 _destination,
+        bytes memory _msg
+    ) external view returns (uint256) {
+        return
+            _Router_quoteDispatch(
+                _destination,
+                _msg,
+                _GasRouter_hookMetadata(_destination),
+                address(hook)
+            );
     }
 
     function _handle(uint32, bytes32, bytes calldata) internal pure override {}

solidity/contracts/test/TestLpCollateralRouter.sol

@@ -2,13 +2,13 @@
 pragma solidity >=0.8.0;
 
 import {LpCollateralRouter} from "../token/libs/LpCollateralRouter.sol";
-import {FungibleTokenRouter} from "../token/libs/FungibleTokenRouter.sol";
+import {TokenRouter} from "../token/libs/TokenRouter.sol";
 
 contract TestLpCollateralRouter is LpCollateralRouter {
     constructor(
         uint256 _scale,
         address _mailbox
-    ) FungibleTokenRouter(_scale, _mailbox) initializer {
+    ) TokenRouter(_scale, _mailbox) initializer {
         _LpCollateralRouter_initialize();
     }
 

solidity/contracts/test/TestLpTokenRouter.sol

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.0;
+
+import {LpCollateralRouter} from "../token/libs/LpCollateralRouter.sol";
+import {TokenRouter} from "../token/libs/TokenRouter.sol";
+
+contract TestLpCollateralRouter is LpCollateralRouter {
+    constructor(
+        uint256 _scale,
+        address _mailbox
+    ) TokenRouter(_scale, _mailbox) initializer {
+        _LpCollateralRouter_initialize();
+    }
+
+    function token() public view override returns (address) {
+        return address(0);
+    }
+
+    function _transferFromSender(uint256 _amount) internal override {}
+
+    function _transferTo(
+        address _recipient,
+        uint256 _amount
+    ) internal override {}
+}

solidity/contracts/test/TestRouter.sol

@@ -31,6 +31,6 @@ contract TestRouter is Router {
     }
 
     function dispatch(uint32 _destination, bytes memory _msg) external payable {
-        _dispatch(_destination, _msg);
+        _Router_dispatch(_destination, msg.value, _msg);
     }
 }