@hyperlane-xyz/core 1.1.3 → 1.2.0

package/contracts/middleware/InterchainQueryRouter.sol

@@ -5,6 +5,8 @@ pragma solidity ^0.8.13;
 import {CallLib} from "../libs/Call.sol";
 import {Router} from "../Router.sol";
 import {IInterchainQueryRouter} from "../../interfaces/IInterchainQueryRouter.sol";
+import {InterchainCallMessage} from "./InterchainCallMessage.sol";
+import {TypeCasts} from "../libs/TypeCasts.sol";
 
 // ============ External Imports ============
 import {Create2} from "@openzeppelin/contracts/utils/Create2.sol";
@@ -16,13 +18,8 @@ import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Ini
  * @dev Currently does not support Sovereign Consensus (user specified Interchain Security Modules).
  */
 contract InterchainQueryRouter is Router, IInterchainQueryRouter {
-    using CallLib for address;
-    using CallLib for CallLib.Call[];
-
-    enum Action {
-        DISPATCH,
-        RESOLVE
-    }
+    using TypeCasts for address;
+    using TypeCasts for bytes32;
 
     /**
      * @notice Emitted when a query is dispatched to another chain.
@@ -34,11 +31,11 @@ contract InterchainQueryRouter is Router, IInterchainQueryRouter {
         address indexed sender
     );
     /**
-     * @notice Emitted when a query is returned to the origin chain.
-     * @param originDomain The domain of the chain to return the result to.
+     * @notice Emitted when a query is executed on the and callback dispatched to the origin chain.
+     * @param originDomain The domain of the chain that dispatched the query and receives the callback.
      * @param sender The address to receive the result.
      */
-    event QueryReturned(uint32 indexed originDomain, address indexed sender);
+    event QueryExecuted(uint32 indexed originDomain, bytes32 indexed sender);
     /**
      * @notice Emitted when a query is resolved on the origin chain.
      * @param destinationDomain The domain of the chain that was queried.
@@ -71,63 +68,21 @@ contract InterchainQueryRouter is Router, IInterchainQueryRouter {
     }
 
     /**
-     * @param _destinationDomain Domain of destination chain
-     * @param target The address of the contract to query on destination chain.
-     * @param queryData The calldata of the view call to make on the destination chain.
-     * @param callback Callback function selector on `msg.sender` and optionally abi-encoded prefix arguments.
-     * @return messageId The ID of the message encoding the query.
+     * @notice Dispatches a sequence of static calls (query) to the destination domain and set of callbacks to resolve the results on the dispatcher.
+     * @param _destinationDomain The domain of the chain to query.
+     * @param calls The sequence of static calls to dispatch and callbacks on the sender to resolve the results.
+     * @dev Recommend using CallLib.build to format the interchain calls.
+     * @dev Callbacks must be returned to the `msg.sender` for security reasons. Require this contract is the `msg.sender` on callbacks.
      */
     function query(
         uint32 _destinationDomain,
-        address target,
-        bytes calldata queryData,
-        bytes calldata callback
-    ) external returns (bytes32 messageId) {
-        // TODO: fix this ugly arrayification
-        CallLib.Call[] memory calls = new CallLib.Call[](1);
-        calls[0] = CallLib.Call({to: target, data: queryData});
-        bytes[] memory callbacks = new bytes[](1);
-        callbacks[0] = callback;
-        messageId = query(_destinationDomain, calls, callbacks);
-    }
-
-    /**
-     * @param _destinationDomain Domain of destination chain
-     * @param call Call (to and data packed struct) to be made on destination chain.
-     * @param callback Callback function selector on `msg.sender` and optionally abi-encoded prefix arguments.
-     */
-    function query(
-        uint32 _destinationDomain,
-        CallLib.Call calldata call,
-        bytes calldata callback
-    ) external returns (bytes32 messageId) {
-        // TODO: fix this ugly arrayification
-        CallLib.Call[] memory calls = new CallLib.Call[](1);
-        calls[0] = call;
-        bytes[] memory callbacks = new bytes[](1);
-        callbacks[0] = callback;
-        messageId = query(_destinationDomain, calls, callbacks);
-    }
-
-    /**
-     * @param _destinationDomain Domain of destination chain
-     * @param calls Array of calls (to and data packed struct) to be made on destination chain in sequence.
-     * @param callbacks Array of callback function selectors on `msg.sender` and optionally abi-encoded prefix arguments.
-     */
-    function query(
-        uint32 _destinationDomain,
-        CallLib.Call[] memory calls,
-        bytes[] memory callbacks
+        CallLib.StaticCallWithCallback[] calldata calls
     ) public returns (bytes32 messageId) {
-        require(
-            calls.length == callbacks.length,
-            "InterchainQueryRouter: calls and callbacks must be same length"
-        );
+        emit QueryDispatched(_destinationDomain, msg.sender);
         messageId = _dispatch(
             _destinationDomain,
-            abi.encode(Action.DISPATCH, msg.sender, calls, callbacks)
+            InterchainCallMessage.format(calls, msg.sender.addressToBytes32())
         );
-        emit QueryDispatched(_destinationDomain, msg.sender);
     }
 
     /**
@@ -140,27 +95,28 @@ contract InterchainQueryRouter is Router, IInterchainQueryRouter {
         bytes32, // router sender
         bytes calldata _message
     ) internal override {
-        Action action = Action(uint8(bytes1(_message[31])));
-        if (action == Action.DISPATCH) {
-            (
-                ,
-                address sender,
-                CallLib.Call[] memory calls,
-                bytes[] memory callbacks
-            ) = abi.decode(
-                    _message,
-                    (Action, address, CallLib.Call[], bytes[])
-                );
-            callbacks = calls._multicallAndResolve(callbacks);
-            _dispatch(_origin, abi.encode(Action.RESOLVE, sender, callbacks));
-            emit QueryReturned(_origin, sender);
-        } else if (action == Action.RESOLVE) {
-            (, address sender, bytes[] memory resolveCallbacks) = abi.decode(
-                _message,
-                (Action, address, bytes[])
+        InterchainCallMessage.CallType calltype = InterchainCallMessage
+            .calltype(_message);
+        bytes32 sender = InterchainCallMessage.sender(_message);
+        if (
+            calltype == InterchainCallMessage.CallType.STATIC_CALL_WITH_CALLBACK
+        ) {
+            CallLib.StaticCallWithCallback[]
+                memory callsWithCallback = InterchainCallMessage
+                    .callsWithCallbacks(_message);
+            bytes[] memory callbacks = CallLib.multistaticcall(
+                callsWithCallback
             );
-            sender._multicall(resolveCallbacks);
-            emit QueryResolved(_origin, sender);
+            emit QueryExecuted(_origin, sender);
+            _dispatch(_origin, InterchainCallMessage.format(callbacks, sender));
+        } else if (calltype == InterchainCallMessage.CallType.RAW_CALLDATA) {
+            address senderAddress = sender.bytes32ToAddress();
+            bytes[] memory rawCalls = InterchainCallMessage.rawCalls(_message);
+            CallLib.multicallto(senderAddress, rawCalls);
+            //
+            emit QueryResolved(_origin, senderAddress);
+        } else {
+            assert(false);
         }
     }
 }

package/contracts/mock/MockHyperlaneEnvironment.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.13;
 
 import "./MockMailbox.sol";
 import "../middleware/InterchainQueryRouter.sol";
-import "../igps/InterchainGasPaymaster.sol";
+import "../test/TestInterchainGasPaymaster.sol";
 import "../test/TestIsm.sol";
 
 import {TypeCasts} from "../libs/TypeCasts.sol";
@@ -13,7 +13,7 @@ contract MockHyperlaneEnvironment {
     uint32 destinationDomain;
 
     mapping(uint32 => MockMailbox) public mailboxes;
-    mapping(uint32 => InterchainGasPaymaster) public igps;
+    mapping(uint32 => TestInterchainGasPaymaster) public igps;
     mapping(uint32 => IInterchainSecurityModule) public isms;
     mapping(uint32 => InterchainQueryRouter) public queryRouters;
 
@@ -27,8 +27,8 @@ contract MockHyperlaneEnvironment {
         originMailbox.addRemoteMailbox(_destinationDomain, destinationMailbox);
         destinationMailbox.addRemoteMailbox(_originDomain, originMailbox);
 
-        igps[originDomain] = new InterchainGasPaymaster();
-        igps[destinationDomain] = new InterchainGasPaymaster();
+        igps[originDomain] = new TestInterchainGasPaymaster();
+        igps[destinationDomain] = new TestInterchainGasPaymaster();
 
         isms[originDomain] = new TestIsm();
         isms[destinationDomain] = new TestIsm();

package/contracts/mock/MockMailbox.sol

@@ -8,8 +8,11 @@ contract MockMailbox {
     using TypeCasts for address;
     using TypeCasts for bytes32;
     // Domain of chain on which the contract is deployed
+
+    // ============ Constants ============
     uint32 public immutable localDomain;
     uint32 public immutable VERSION = 0;
+    uint256 public constant MAX_MESSAGE_BODY_BYTES = 2 * 2**10;
 
     uint256 public outboundNonce = 0;
     uint256 public inboundUnprocessedNonce = 0;
@@ -37,6 +40,7 @@ contract MockMailbox {
         bytes32 _recipientAddress,
         bytes calldata _messageBody
     ) external returns (bytes32) {
+        require(_messageBody.length <= MAX_MESSAGE_BODY_BYTES, "msg too long");
         MockMailbox _destinationMailbox = remoteMailboxes[_destinationDomain];
         require(
             address(_destinationMailbox) != address(0),

package/contracts/test/TestGasRouter.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.6.11;
+
+import "./TestRouter.sol";
+import "../GasRouter.sol";
+
+contract TestGasRouter is TestRouter, GasRouter {
+    function dispatchWithGas(
+        uint32 _destinationDomain,
+        bytes memory _messageBody,
+        uint256 _gasPayment,
+        address _gasPaymentRefundAddress
+    ) external payable {
+        _dispatchWithGas(
+            _destinationDomain,
+            _messageBody,
+            _gasPayment,
+            _gasPaymentRefundAddress
+        );
+    }
+
+    function dispatchWithGas(
+        uint32 _destinationDomain,
+        bytes memory _messageBody
+    ) external payable {
+        _dispatchWithGas(_destinationDomain, _messageBody);
+    }
+}

package/contracts/test/TestInterchainGasPaymaster.sol

@@ -2,30 +2,21 @@
 pragma solidity >=0.8.0;
 
 // ============ Internal Imports ============
-import {IInterchainGasPaymaster} from "../../interfaces/IInterchainGasPaymaster.sol";
+import {InterchainGasPaymaster} from "../igps/InterchainGasPaymaster.sol";
 
-contract TestInterchainGasPaymaster is IInterchainGasPaymaster {
-    event GasPayment(
-        bytes32 indexed messageId,
-        uint256 gasAmount,
-        uint256 payment
-    );
+contract TestInterchainGasPaymaster is InterchainGasPaymaster {
+    uint256 gasPrice = 0;
 
-    function payForGas(
-        bytes32 _messageId,
-        uint32,
-        uint256 _gasAmount,
-        address
-    ) external payable override {
-        emit GasPayment(_messageId, _gasAmount, msg.value);
+    function setGasPrice(uint256 _gasPrice) external {
+        gasPrice = _gasPrice;
     }
 
-    function quoteGasPayment(uint32, uint256)
+    function quoteGasPayment(uint32, uint256 gasAmount)
         public
-        pure
+        view
         override
         returns (uint256)
     {
-        return 0;
+        return gasPrice * gasAmount;
     }
 }

package/contracts/test/TestQuery.sol

@@ -3,6 +3,9 @@ pragma solidity ^0.8.13;
 
 import {InterchainQueryRouter} from "../middleware/InterchainQueryRouter.sol";
 import {TypeCasts} from "../libs/TypeCasts.sol";
+import {CallLib} from "../libs/Call.sol";
+
+import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
 
 contract TestQuery {
     InterchainQueryRouter public router;
@@ -18,18 +21,20 @@ contract TestQuery {
      */
     function queryRouterOwner(uint32 domain, uint256 secret) external {
         address target = TypeCasts.bytes32ToAddress(router.routers(domain));
-        bytes memory data = abi.encodeWithSignature("owner()");
-        bytes memory callback = bytes.concat(
-            this.receiveRouterOwer.selector,
-            bytes32(secret)
+        CallLib.StaticCallWithCallback[]
+            memory calls = new CallLib.StaticCallWithCallback[](1);
+        calls[0] = CallLib.build(
+            target,
+            abi.encodeWithSelector(Ownable.owner.selector),
+            abi.encodeWithSelector(this.receiveRouterOwner.selector, secret)
         );
-        router.query(domain, target, data, callback);
+        router.query(domain, calls);
     }
 
     /**
      * @dev `msg.sender` must be restricted to `this.router` to prevent any local account from spoofing query data.
      */
-    function receiveRouterOwer(uint256 secret, address owner) external {
+    function receiveRouterOwner(uint256 secret, address owner) external {
         require(msg.sender == address(router), "TestQuery: not from router");
         emit Owner(secret, owner);
     }

package/contracts/test/TestQuerySender.sol

@@ -3,6 +3,7 @@ pragma solidity >=0.8.0;
 
 import {IInterchainGasPaymaster} from "../../interfaces/IInterchainGasPaymaster.sol";
 import {IInterchainQueryRouter} from "../../interfaces/IInterchainQueryRouter.sol";
+import {CallLib} from "../libs/Call.sol";
 
 contract TestQuerySender {
     IInterchainQueryRouter queryRouter;
@@ -32,13 +33,13 @@ contract TestQuerySender {
         bytes calldata _targetData,
         uint256 _gasAmount
     ) external payable {
-        bytes32 _messageId = queryRouter.query(
+        queryAndPayFor(
             _destinationDomain,
             _target,
             _targetData,
-            abi.encodePacked(this.handleQueryAddressResult.selector)
+            this.handleQueryAddressResult.selector,
+            _gasAmount
         );
-        _payForGas(_messageId, _destinationDomain, _gasAmount);
     }
 
     function handleQueryAddressResult(address _result) external {
@@ -52,13 +53,13 @@ contract TestQuerySender {
         bytes calldata _targetData,
         uint256 _gasAmount
     ) external payable {
-        bytes32 _messageId = queryRouter.query(
+        queryAndPayFor(
             _destinationDomain,
             _target,
             _targetData,
-            abi.encodePacked(this.handleQueryUint256Result.selector)
+            this.handleQueryUint256Result.selector,
+            _gasAmount
         );
-        _payForGas(_messageId, _destinationDomain, _gasAmount);
     }
 
     function handleQueryUint256Result(uint256 _result) external {
@@ -72,13 +73,13 @@ contract TestQuerySender {
         bytes calldata _targetData,
         uint256 _gasAmount
     ) external payable {
-        bytes32 _messageId = queryRouter.query(
+        queryAndPayFor(
             _destinationDomain,
             _target,
             _targetData,
-            abi.encodePacked(this.handleQueryBytes32Result.selector)
+            this.handleQueryBytes32Result.selector,
+            _gasAmount
         );
-        _payForGas(_messageId, _destinationDomain, _gasAmount);
     }
 
     function handleQueryBytes32Result(bytes32 _result) external {
@@ -86,11 +87,21 @@ contract TestQuerySender {
         lastBytes32Result = _result;
     }
 
-    function _payForGas(
-        bytes32 _messageId,
+    function queryAndPayFor(
         uint32 _destinationDomain,
+        address _target,
+        bytes calldata _targetData,
+        bytes4 _callbackSelector,
         uint256 _gasAmount
     ) internal {
+        CallLib.StaticCallWithCallback[]
+            memory calls = new CallLib.StaticCallWithCallback[](1);
+        calls[0] = CallLib.build(
+            _target,
+            _targetData,
+            abi.encodePacked(_callbackSelector)
+        );
+        bytes32 _messageId = queryRouter.query(_destinationDomain, calls);
         interchainGasPaymaster.payForGas{value: msg.value}(
             _messageId,
             _destinationDomain,