@hyperlane-xyz/core 5.2.1-beta.0 → 5.3.0

package/contracts/middleware/README.md

@@ -3,13 +3,13 @@
 ## Interchain Accounts
 
 An interchain account is a smart contract that is deployed on a remote chain controlled exclusively by the origin chain's deployer account.
-Interchain accounts provide developers with a [transparent multicall API](../OwnableMulticall.sol) to remote smart contracts.
+Interchain accounts provide developers with a [transparent multicall API](libs/OwnableMulticall.sol) to remote smart contracts.
 This avoids the need to deploy application specific smart contracts on remote chains while simultaneously enabling cross-chain composability.
 
 See [IBC Interchain Accounts](https://github.com/cosmos/ibc/blob/main/spec/app/ics-027-interchain-accounts/README.md) for the Cosmos ecosystem equivalent.
 
 ## Interchain Query System
 
-The interchain query system generalizes view calls to contracts on remote chains. It is a [transparent multicall API](../OwnableMulticall.sol) that can be used to query remote smart contracts. This avoids the need to deploy application specific smart contracts on remote chains while simultaneously enabling cross-chain composability.
+The interchain query system generalizes view calls to contracts on remote chains. It is a [transparent multicall API](libs/OwnableMulticall.sol) that can be used to query remote smart contracts. This avoids the need to deploy application specific smart contracts on remote chains while simultaneously enabling cross-chain composability.
 
 See [IBC Interchain Query System](https://github.com/cosmos/ibc/tree/main/spec/app/ics-031-crosschain-queries) for the Cosmos ecosystem equivalent.

package/contracts/token/HypNative.sol

@@ -48,6 +48,30 @@ contract HypNative is TokenRouter {
         return _transferRemote(_destination, _recipient, _amount, _hookPayment);
     }
 
+    /**
+     * @inheritdoc TokenRouter
+     * @dev uses (`msg.value` - `_amount`) as hook payment.
+     */
+    function transferRemote(
+        uint32 _destination,
+        bytes32 _recipient,
+        uint256 _amount,
+        bytes calldata _hookMetadata,
+        address _hook
+    ) external payable virtual override returns (bytes32 messageId) {
+        require(msg.value >= _amount, "Native: amount exceeds msg.value");
+        uint256 _hookPayment = msg.value - _amount;
+        return
+            _transferRemote(
+                _destination,
+                _recipient,
+                _amount,
+                _hookPayment,
+                _hookMetadata,
+                _hook
+            );
+    }
+
     function balanceOf(
         address _account
     ) external view override returns (uint256) {

package/contracts/token/README.md

@@ -45,9 +45,9 @@ graph LR
 
 The Token Router contract comes in several flavors and a warp route can be composed of a combination of these flavors.
 
-- [`Native`](./contracts/HypNative.sol) - for warping native assets (e.g. ETH) from the canonical chain
-- [`Collateral`](./contracts/HypERC20Collateral.sol) - for warping tokens, ERC20 or ERC721, from the canonical chain
-- [`Synthetic`](./contracts/HypERC20.sol) - for representing tokens, Native/ERC20 or ERC721, on a non-canonical chain
+- [`Native`](./HypNative.sol) - for warping native assets (e.g. ETH) from the canonical chain
+- [`Collateral`](./HypERC20Collateral.sol) - for warping tokens, ERC20 or ERC721, from the canonical chain
+- [`Synthetic`](./HypERC20.sol) - for representing tokens, Native/ERC20 or ERC721, on a non-canonical chain
 
 ## Interchain Security Models
 

package/contracts/token/extensions/HypNativeScaled.sol

@@ -38,6 +38,31 @@ contract HypNativeScaled is HypNative {
             );
     }
 
+    /**
+     * @inheritdoc TokenRouter
+     * @dev uses (`msg.value` - `_amount`) as hook payment.
+     */
+    function transferRemote(
+        uint32 _destination,
+        bytes32 _recipient,
+        uint256 _amount,
+        bytes calldata _hookMetadata,
+        address _hook
+    ) external payable override returns (bytes32 messageId) {
+        require(msg.value >= _amount, "Native: amount exceeds msg.value");
+        uint256 _hookPayment = msg.value - _amount;
+        uint256 _scaledAmount = _amount / scale;
+        return
+            _transferRemote(
+                _destination,
+                _recipient,
+                _scaledAmount,
+                _hookPayment,
+                _hookMetadata,
+                _hook
+            );
+    }
+
     /**
      * @dev Sends scaled `_amount` (multiplied by `scale`) to `_recipient`.
      * @inheritdoc TokenRouter