@hyperlane-xyz/core 3.15.0 → 3.16.0

package/contracts/client/GasRouter.sol

@@ -43,13 +43,13 @@ abstract contract GasRouter is Router {
      */
     function quoteGasPayment(
         uint32 _destinationDomain
-    ) external view returns (uint256 _gasPayment) {
-        return _quoteDispatch(_destinationDomain, "");
+    ) external view returns (uint256) {
+        return _GasRouter_quoteDispatch(_destinationDomain, "", address(hook));
     }
 
-    function _metadata(
+    function _GasRouter_hookMetadata(
         uint32 _destination
-    ) internal view virtual override returns (bytes memory) {
+    ) internal view returns (bytes memory) {
         return
             StandardHookMetadata.overrideGasLimit(destinationGas[_destination]);
     }
@@ -57,4 +57,34 @@ abstract contract GasRouter is Router {
     function _setDestinationGas(uint32 domain, uint256 gas) internal {
         destinationGas[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
+            );
+    }
 }

package/contracts/client/MailboxClient.sol

@@ -95,85 +95,4 @@ abstract contract MailboxClient is OwnableUpgradeable {
     function _isDelivered(bytes32 id) internal view returns (bool) {
         return mailbox.delivered(id);
     }
-
-    function _metadata(
-        uint32 /*_destinationDomain*/
-    ) internal view virtual returns (bytes memory) {
-        return "";
-    }
-
-    function _dispatch(
-        uint32 _destinationDomain,
-        bytes32 _recipient,
-        bytes memory _messageBody
-    ) internal virtual returns (bytes32) {
-        return
-            _dispatch(_destinationDomain, _recipient, msg.value, _messageBody);
-    }
-
-    function _dispatch(
-        uint32 _destinationDomain,
-        bytes32 _recipient,
-        uint256 _value,
-        bytes memory _messageBody
-    ) internal virtual returns (bytes32) {
-        return
-            mailbox.dispatch{value: _value}(
-                _destinationDomain,
-                _recipient,
-                _messageBody,
-                _metadata(_destinationDomain),
-                hook
-            );
-    }
-
-    function _dispatch(
-        uint32 _destinationDomain,
-        bytes32 _recipient,
-        uint256 _value,
-        bytes memory _messageBody,
-        bytes memory _hookMetadata,
-        IPostDispatchHook _hook
-    ) internal virtual returns (bytes32) {
-        return
-            mailbox.dispatch{value: _value}(
-                _destinationDomain,
-                _recipient,
-                _messageBody,
-                _hookMetadata,
-                _hook
-            );
-    }
-
-    function _quoteDispatch(
-        uint32 _destinationDomain,
-        bytes32 _recipient,
-        bytes memory _messageBody
-    ) internal view virtual returns (uint256) {
-        return
-            mailbox.quoteDispatch(
-                _destinationDomain,
-                _recipient,
-                _messageBody,
-                _metadata(_destinationDomain),
-                hook
-            );
-    }
-
-    function _quoteDispatch(
-        uint32 _destinationDomain,
-        bytes32 _recipient,
-        bytes memory _messageBody,
-        bytes calldata _hookMetadata,
-        IPostDispatchHook _hook
-    ) internal view virtual returns (uint256) {
-        return
-            mailbox.quoteDispatch(
-                _destinationDomain,
-                _recipient,
-                _messageBody,
-                _hookMetadata,
-                _hook
-            );
-    }
 }

package/contracts/client/Router.sol

@@ -167,28 +167,73 @@ abstract contract Router is MailboxClient, IMessageRecipient {
             );
     }
 
-    function _dispatch(
+    function _Router_dispatch(
         uint32 _destinationDomain,
-        bytes memory _messageBody
-    ) internal virtual returns (bytes32) {
-        return _dispatch(_destinationDomain, msg.value, _messageBody);
+        uint256 _value,
+        bytes memory _messageBody,
+        bytes memory _hookMetadata,
+        address _hook
+    ) internal returns (bytes32) {
+        bytes32 _router = _mustHaveRemoteRouter(_destinationDomain);
+        return
+            mailbox.dispatch{value: _value}(
+                _destinationDomain,
+                _router,
+                _messageBody,
+                _hookMetadata,
+                IPostDispatchHook(_hook)
+            );
     }
 
+    /**
+     * DEPRECATED: Use `_Router_dispatch` instead
+     * @dev For backward compatibility with v2 client contracts
+     */
     function _dispatch(
         uint32 _destinationDomain,
-        uint256 _value,
         bytes memory _messageBody
-    ) internal virtual returns (bytes32) {
+    ) internal returns (bytes32) {
+        return
+            _Router_dispatch(
+                _destinationDomain,
+                msg.value,
+                _messageBody,
+                "",
+                address(hook)
+            );
+    }
+
+    function _Router_quoteDispatch(
+        uint32 _destinationDomain,
+        bytes memory _messageBody,
+        bytes memory _hookMetadata,
+        address _hook
+    ) internal view returns (uint256) {
         bytes32 _router = _mustHaveRemoteRouter(_destinationDomain);
         return
-            super._dispatch(_destinationDomain, _router, _value, _messageBody);
+            mailbox.quoteDispatch(
+                _destinationDomain,
+                _router,
+                _messageBody,
+                _hookMetadata,
+                IPostDispatchHook(_hook)
+            );
     }
 
+    /**
+     * DEPRECATED: Use `_Router_quoteDispatch` instead
+     * @dev For backward compatibility with v2 client contracts
+     */
     function _quoteDispatch(
         uint32 _destinationDomain,
         bytes memory _messageBody
-    ) internal view virtual returns (uint256) {
-        bytes32 _router = _mustHaveRemoteRouter(_destinationDomain);
-        return super._quoteDispatch(_destinationDomain, _router, _messageBody);
+    ) internal view returns (uint256) {
+        return
+            _Router_quoteDispatch(
+                _destinationDomain,
+                _messageBody,
+                "",
+                address(hook)
+            );
     }
 }

package/contracts/test/TestGasRouter.sol

@@ -7,7 +7,7 @@ contract TestGasRouter is GasRouter {
     constructor(address _mailbox) GasRouter(_mailbox) {}
 
     function dispatch(uint32 _destination, bytes memory _msg) external payable {
-        _dispatch(_destination, _msg);
+        _GasRouter_dispatch(_destination, msg.value, _msg, address(hook));
     }
 
     function _handle(uint32, bytes32, bytes calldata) internal pure override {}

package/contracts/token/HypNative.sol

@@ -36,24 +36,16 @@ contract HypNative is TokenRouter {
 
     /**
      * @inheritdoc TokenRouter
-     * @dev uses (`msg.value` - `_amount`) as interchain gas payment and `msg.sender` as refund address.
+     * @dev uses (`msg.value` - `_amount`) as hook payment and `msg.sender` as refund address.
      */
     function transferRemote(
         uint32 _destination,
         bytes32 _recipient,
         uint256 _amount
-    ) public payable virtual override returns (bytes32 messageId) {
+    ) external payable virtual override returns (bytes32 messageId) {
         require(msg.value >= _amount, "Native: amount exceeds msg.value");
-        uint256 gasPayment = msg.value - _amount;
-        return
-            _transferRemote(
-                _destination,
-                _recipient,
-                _amount,
-                gasPayment,
-                bytes(""),
-                address(0)
-            );
+        uint256 _hookPayment = msg.value - _amount;
+        return _transferRemote(_destination, _recipient, _amount, _hookPayment);
     }
 
     function balanceOf(

package/contracts/token/extensions/HypNativeScaled.sol

@@ -25,18 +25,16 @@ contract HypNativeScaled is HypNative {
         uint32 _destination,
         bytes32 _recipient,
         uint256 _amount
-    ) public payable override returns (bytes32 messageId) {
+    ) external payable override returns (bytes32 messageId) {
         require(msg.value >= _amount, "Native: amount exceeds msg.value");
-        uint256 gasPayment = msg.value - _amount;
-        uint256 scaledAmount = _amount / scale;
+        uint256 _hookPayment = msg.value - _amount;
+        uint256 _scaledAmount = _amount / scale;
         return
             _transferRemote(
                 _destination,
                 _recipient,
-                scaledAmount,
-                gasPayment,
-                bytes(""),
-                address(0)
+                _scaledAmount,
+                _hookPayment
             );
     }
 

package/contracts/token/extensions/HypXERC20.sol

@@ -8,7 +8,9 @@ contract HypXERC20 is HypERC20Collateral {
     constructor(
         address _xerc20,
         address _mailbox
-    ) HypERC20Collateral(_xerc20, _mailbox) {}
+    ) HypERC20Collateral(_xerc20, _mailbox) {
+        _disableInitializers();
+    }
 
     function _transferFromSender(
         uint256 _amountOrId

package/contracts/token/extensions/HypXERC20Lockbox.sol

@@ -18,6 +18,7 @@ contract HypXERC20Lockbox is HypERC20Collateral {
         lockbox = IXERC20Lockbox(_lockbox);
         xERC20 = lockbox.XERC20();
         approveLockbox();
+        _disableInitializers();
     }
 
     /**

package/contracts/token/libs/FastTokenRouter.sol

@@ -109,9 +109,11 @@ abstract contract FastTokenRouter is TokenRouter {
             _fastTransferId
         );
 
-        messageId = _dispatch(
+        messageId = _GasRouter_dispatch(
             _destination,
-            TokenMessage.format(_recipient, _amountOrId, metadata)
+            msg.value,
+            TokenMessage.format(_recipient, _amountOrId, metadata),
+            address(hook)
         );
         emit SentTransferRemote(_destination, _recipient, _amountOrId);
     }

package/contracts/token/libs/TokenRouter.sol

@@ -57,14 +57,7 @@ abstract contract TokenRouter is GasRouter {
         uint256 _amountOrId
     ) external payable virtual returns (bytes32 messageId) {
         return
-            _transferRemote(
-                _destination,
-                _recipient,
-                _amountOrId,
-                msg.value,
-                bytes(""),
-                address(0)
-            );
+            _transferRemote(_destination, _recipient, _amountOrId, msg.value);
     }
 
     /**
@@ -97,45 +90,45 @@ abstract contract TokenRouter is GasRouter {
             );
     }
 
-    /**
-     * @notice Transfers `_amountOrId` token to `_recipient` on `_destination` domain.
-     * @dev Delegates transfer logic to `_transferFromSender` implementation.
-     * @dev The metadata is the token metadata, and is DIFFERENT than the hook metadata.
-     * @dev Emits `SentTransferRemote` event on the origin chain.
-     * @param _destination The identifier of the destination chain.
-     * @param _recipient The address of the recipient on the destination chain.
-     * @param _amountOrId The amount or identifier of tokens to be sent to the remote recipient.
-     * @param _gasPayment The amount of native token to pay for interchain gas.
-     * @param _hookMetadata The metadata passed into the hook
-     * @param _hook The post dispatch hook to be called by the Mailbox
-     * @return messageId The identifier of the dispatched message.
-     */
     function _transferRemote(
         uint32 _destination,
         bytes32 _recipient,
         uint256 _amountOrId,
-        uint256 _gasPayment,
-        bytes memory _hookMetadata,
-        address _hook
+        uint256 _value
     ) internal returns (bytes32 messageId) {
-        bytes memory metadata = _transferFromSender(_amountOrId);
-
-        if (address(_hook) == address(0)) {
-            messageId = _dispatch(
-                _destination,
-                _gasPayment,
-                TokenMessage.format(_recipient, _amountOrId, metadata)
-            );
-        } else {
-            messageId = _dispatch(
+        return
+            _transferRemote(
                 _destination,
                 _recipient,
-                _gasPayment,
-                TokenMessage.format(_recipient, _amountOrId, metadata),
-                _hookMetadata,
-                IPostDispatchHook(_hook)
+                _amountOrId,
+                _value,
+                _GasRouter_hookMetadata(_destination),
+                address(hook)
             );
-        }
+    }
+
+    function _transferRemote(
+        uint32 _destination,
+        bytes32 _recipient,
+        uint256 _amountOrId,
+        uint256 _value,
+        bytes memory _hookMetadata,
+        address _hook
+    ) internal virtual returns (bytes32 messageId) {
+        bytes memory _tokenMetadata = _transferFromSender(_amountOrId);
+        bytes memory _tokenMessage = TokenMessage.format(
+            _recipient,
+            _amountOrId,
+            _tokenMetadata
+        );
+
+        messageId = _Router_dispatch(
+            _destination,
+            _value,
+            _tokenMessage,
+            _hookMetadata,
+            _hook
+        );
 
         emit SentTransferRemote(_destination, _recipient, _amountOrId);
     }