@hyperlane-xyz/core 5.6.0 → 5.7.0

package/contracts/isms/hook/layer-zero/LayerZeroV2Ism.sol

@@ -57,7 +57,7 @@ contract LayerZeroV2Ism is AbstractMessageIdAuthorizedIsm {
     /**
      * @notice Entry point for receiving msg/packet from the LayerZero endpoint.
      * @param _lzMessage The payload of the received message.
-     * @dev Authorization verification is done within verifyMessageId() -> _isAuthorized()
+     * @dev Authorization verification is done within preVerifyMessage() -> _isAuthorized()
      */
     function lzReceive(
         Origin calldata,
@@ -66,25 +66,36 @@ contract LayerZeroV2Ism is AbstractMessageIdAuthorizedIsm {
         address,
         bytes calldata
     ) external payable {
-        verifyMessageId(_messageId(_lzMessage));
+        preVerifyMessage(_messageId(_lzMessage), _msgValue(_lzMessage));
     }
 
     // ============ Internal function ============
 
     /**
      * @notice Slices the messageId from the message delivered from LayerZeroV2Hook
-     * @dev message is created as abi.encodeCall(AbstractMessageIdAuthorizedIsm.verifyMessageId, id)
+     * @dev message is created as abi.encodeCall(AbstractMessageIdAuthorizedIsm.preVerifyMessage, id)
      * @dev _message will be 36 bytes (4 bytes for function selector, and 32 bytes for messageId)
      */
     function _messageId(
         bytes calldata _message
     ) internal pure returns (bytes32) {
-        return bytes32(_message[FUNC_SELECTOR_OFFSET:]);
+        return bytes32(_message[FUNC_SELECTOR_OFFSET:ORIGIN_SENDER_OFFSET]);
+    }
+
+    /**
+     * @notice Slices the msgValue from the message delivered from LayerZeroV2Hook
+     * @dev message is created as abi.encodeCall(AbstractMessageIdAuthorizedIsm.preVerifyMessage, (id,msgValue))
+     * @dev _message will be 68 bytes (4 bytes for function selector, and 32 bytes for messageId, another 32 for msgValue)
+     */
+    function _msgValue(
+        bytes calldata _message
+    ) internal pure returns (uint256) {
+        return uint256(bytes32(_message[ORIGIN_SENDER_OFFSET:]));
     }
 
     /**
      * @notice Validates criteria to verify a message
-     * @dev this is called by AbstractMessageIdAuthorizedIsm.verifyMessageId
+     * @dev this is called by AbstractMessageIdAuthorizedIsm.preVerifyMessage
      * @dev parses msg.value to get parameters from lzReceive()
      */
     function _isAuthorized() internal view override returns (bool) {

package/contracts/libs/OPL2ToL1Metadata.sol

@@ -7,7 +7,7 @@ pragma solidity >=0.8.0;
  */
 library OPL2ToL1Metadata {
     // bottom offset to the start of message id in the metadata
-    uint256 private constant MESSAGE_ID_OFFSET = 88;
+    uint256 private constant MESSAGE_ID_OFFSET = 120;
     // from IOptimismPortal.WithdrawalTransaction
     // Σ {
     //      nonce                          = 32 bytes
@@ -20,7 +20,7 @@ library OPL2ToL1Metadata {
     //          LENGTH                      = 32 bytes
     // } = 252 bytes
     uint256 private constant FIXED_METADATA_LENGTH = 252;
-    // metadata here is double encoded call relayMessage(..., verifyMessageId)
+    // metadata here is double encoded call relayMessage(..., preVerifyMessage)
     // Σ {
     //      _selector                       =  4 bytes
     //      _nonce                          = 32 bytes
@@ -31,9 +31,9 @@ library OPL2ToL1Metadata {
     //      _data
     //          OFFSET                      = 32 bytes
     //          LENGTH                      = 32 bytes
-    //          PADDING + verifyMessageId   = 64 bytes
-    // } = 292 bytes
-    uint256 private constant MESSENGER_CALLDATA_LENGTH = 292;
+    //          PADDING + preVerifyMessage   = 96 bytes
+    // } = 324 bytes
+    uint256 private constant MESSENGER_CALLDATA_LENGTH = 324;
 
     /**
      * @notice Returns the message ID.

package/contracts/middleware/InterchainAccountRouter.sol

@@ -22,6 +22,7 @@ import {TypeCasts} from "../libs/TypeCasts.sol";
 import {StandardHookMetadata} from "../hooks/libs/StandardHookMetadata.sol";
 import {EnumerableMapExtended} from "../libs/EnumerableMapExtended.sol";
 import {Router} from "../client/Router.sol";
+import {IPostDispatchHook} from "../interfaces/hooks/IPostDispatchHook.sol";
 
 // ============ External Imports ============
 import {Create2} from "@openzeppelin/contracts/utils/Create2.sol";
@@ -160,6 +161,12 @@ contract InterchainAccountRouter is Router {
         }
     }
 
+    function setHook(
+        address _hook
+    ) public override onlyContractOrNull(_hook) onlyOwner {
+        hook = IPostDispatchHook(_hook);
+    }
+
     // ============ External Functions ============
     /**
      * @notice Dispatches a single remote call to be made by an owner's
@@ -600,7 +607,14 @@ contract InterchainAccountRouter is Router {
     ) private returns (bytes32) {
         require(_router != bytes32(0), "no router specified for destination");
         emit RemoteCallDispatched(_destination, msg.sender, _router, _ism);
-        return mailbox.dispatch{value: msg.value}(_destination, _router, _body);
+        return
+            mailbox.dispatch{value: msg.value}(
+                _destination,
+                _router,
+                _body,
+                new bytes(0),
+                hook
+            );
     }
 
     /**
@@ -625,7 +639,8 @@ contract InterchainAccountRouter is Router {
                 _destination,
                 _router,
                 _body,
-                _hookMetadata
+                _hookMetadata,
+                hook
             );
     }
 
@@ -665,7 +680,13 @@ contract InterchainAccountRouter is Router {
     function quoteGasPayment(
         uint32 _destination
     ) external view returns (uint256 _gasPayment) {
-        return _quoteDispatch(_destination, "");
+        return
+            _Router_quoteDispatch(
+                _destination,
+                new bytes(0),
+                new bytes(0),
+                address(hook)
+            );
     }
 
     /**
@@ -679,13 +700,12 @@ contract InterchainAccountRouter is Router {
         bytes calldata _messageBody,
         uint256 gasLimit
     ) external view returns (uint256 _gasPayment) {
-        bytes32 _router = _mustHaveRemoteRouter(_destination);
         return
-            mailbox.quoteDispatch(
+            _Router_quoteDispatch(
                 _destination,
-                _router,
                 _messageBody,
-                StandardHookMetadata.overrideGasLimit(gasLimit)
+                StandardHookMetadata.overrideGasLimit(gasLimit),
+                address(hook)
             );
     }
 }

package/contracts/mock/MockMailbox.sol

@@ -78,8 +78,8 @@ contract MockMailbox is Mailbox {
         inboundProcessedNonce++;
     }
 
-    function processInboundMessage(uint32 _nonce) public {
+    function processInboundMessage(uint32 _nonce) public payable {
         bytes memory _message = inboundMessages[_nonce];
-        Mailbox(address(this)).process("", _message);
+        Mailbox(address(this)).process{value: msg.value}("", _message);
     }
 }

package/contracts/test/TestPostDispatchHook.sol

@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.8.0;
+
 import {Message} from "../libs/Message.sol";
 
 import {IPostDispatchHook} from "../interfaces/hooks/IPostDispatchHook.sol";
@@ -35,15 +36,15 @@ contract TestPostDispatchHook is AbstractPostDispatchHook {
 
     // ============ Internal functions ============
     function _postDispatch(
-        bytes calldata /*metadata*/,
-        bytes calldata message
+        bytes calldata,
+        /*metadata*/ bytes calldata message
     ) internal override {
         messageDispatched[message.id()] = true;
     }
 
     function _quoteDispatch(
-        bytes calldata /*metadata*/,
-        bytes calldata /*message*/
+        bytes calldata,
+        /*metadata*/ bytes calldata /*message*/
     ) internal view override returns (uint256) {
         return fee;
     }

package/contracts/token/extensions/HypERC4626.sol

@@ -22,10 +22,13 @@ import {TokenRouter} from "../libs/TokenRouter.sol";
 
 // ============ External Imports ============
 import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {ERC20Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
 
 /**
  * @title Hyperlane ERC20 Rebasing Token
  * @author Abacus Works
+ * @notice This contract implements a rebasing token that reflects yields from the origin chain
  */
 contract HypERC4626 is HypERC20 {
     using Math for uint256;
@@ -49,6 +52,67 @@ contract HypERC4626 is HypERC20 {
         _disableInitializers();
     }
 
+    // ============ Public Functions ============
+
+    /// Override transfer to handle underlying amounts while using shares internally
+    /// @inheritdoc ERC20Upgradeable
+    /// @dev the Transfer event emitted from ERC20Upgradeable will be in terms of shares not assets, so it may be misleading
+    function transfer(
+        address to,
+        uint256 amount
+    ) public virtual override returns (bool) {
+        _transfer(_msgSender(), to, assetsToShares(amount));
+        return true;
+    }
+
+    /// Override transferFrom to handle underlying amounts while using shares internally
+    /// @inheritdoc ERC20Upgradeable
+    function transferFrom(
+        address sender,
+        address recipient,
+        uint256 amount
+    ) public virtual override returns (bool) {
+        address spender = _msgSender();
+        uint256 shares = assetsToShares(amount);
+        _spendAllowance(sender, spender, amount);
+        _transfer(sender, recipient, shares);
+        return true;
+    }
+
+    /// Override totalSupply to return the total assets instead of shares. This reflects the actual circulating supply in terms of assets, accounting for rebasing
+    /// @inheritdoc ERC20Upgradeable
+    function totalSupply() public view virtual override returns (uint256) {
+        return sharesToAssets(totalShares());
+    }
+
+    /// This returns the balance of the account in terms of assets, accounting for rebasing
+    /// @inheritdoc ERC20Upgradeable
+    function balanceOf(
+        address account
+    ) public view virtual override returns (uint256) {
+        return sharesToAssets(shareBalanceOf(account));
+    }
+
+    /// This function provides the total supply in terms of shares
+    function totalShares() public view returns (uint256) {
+        return super.totalSupply();
+    }
+
+    ///  This returns the balance of the account in terms of shares
+    function shareBalanceOf(address account) public view returns (uint256) {
+        return super.balanceOf(account);
+    }
+
+    function assetsToShares(uint256 _amount) public view returns (uint256) {
+        return _amount.mulDiv(PRECISION, exchangeRate);
+    }
+
+    function sharesToAssets(uint256 _shares) public view returns (uint256) {
+        return _shares.mulDiv(exchangeRate, PRECISION);
+    }
+
+    // ============ Internal Functions ============
+
     /// Override to send shares instead of assets from synthetic
     /// @inheritdoc TokenRouter
     function _transferRemote(
@@ -78,6 +142,8 @@ contract HypERC4626 is HypERC20 {
         emit SentTransferRemote(_destination, _recipient, _amountOrId);
     }
 
+    /// override _handle to update exchange rate
+    /// @inheritdoc TokenRouter
     function _handle(
         uint32 _origin,
         bytes32 _sender,
@@ -97,33 +163,4 @@ contract HypERC4626 is HypERC20 {
         }
         super._handle(_origin, _sender, _message);
     }
-
-    // Override to send shares locally instead of assets
-    function transfer(
-        address to,
-        uint256 amount
-    ) public virtual override returns (bool) {
-        address owner = _msgSender();
-        _transfer(owner, to, assetsToShares(amount));
-        return true;
-    }
-
-    function shareBalanceOf(address account) public view returns (uint256) {
-        return super.balanceOf(account);
-    }
-
-    function balanceOf(
-        address account
-    ) public view virtual override returns (uint256) {
-        uint256 _balance = super.balanceOf(account);
-        return sharesToAssets(_balance);
-    }
-
-    function assetsToShares(uint256 _amount) public view returns (uint256) {
-        return _amount.mulDiv(PRECISION, exchangeRate);
-    }
-
-    function sharesToAssets(uint256 _shares) public view returns (uint256) {
-        return _shares.mulDiv(exchangeRate, PRECISION);
-    }
 }