@hyperlane-xyz/core 1.5.4-beta0 → 1.5.5-beta0

package/contracts/middleware/liquidity-layer/adapters/PortalAdapter.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.13;
 
-import {Router} from "../../../Router.sol";
+import {Router} from "../../../client/Router.sol";
 
 import {IPortalTokenBridge} from "../interfaces/portal/IPortalTokenBridge.sol";
 import {ILiquidityLayerAdapter} from "../interfaces/ILiquidityLayerAdapter.sol";
@@ -21,14 +21,14 @@ contract PortalAdapter is ILiquidityLayerAdapter, Router {
     /// @notice transferId => token address
     mapping(bytes32 => address) public portalTransfersProcessed;
 
-    uint32 public localDomain;
-
     // We could technically use Portal's sequence number here but it doesn't
     // get passed through, so we would have to parse the VAA twice
     // 224 bits should be large enough and allows us to pack into a single slot
     // with a Hyperlane domain
     uint224 public nonce = 0;
 
+    constructor(address _mailbox) Router(_mailbox) {}
+
     /**
      * @notice Emits the nonce of the Portal message when a token is bridged.
      * @param nonce The nonce of the Portal message.
@@ -54,13 +54,11 @@ contract PortalAdapter is ILiquidityLayerAdapter, Router {
     }
 
     /**
-     * @param _localDomain The local hyperlane domain
      * @param _owner The new owner.
      * @param _portalTokenBridge The Portal TokenBridge contract.
      * @param _liquidityLayerRouter The LiquidityLayerRouter contract.
      */
     function initialize(
-        uint32 _localDomain,
         address _owner,
         address _portalTokenBridge,
         address _liquidityLayerRouter
@@ -68,7 +66,6 @@ contract PortalAdapter is ILiquidityLayerAdapter, Router {
         // Transfer ownership of the contract to deployer
         _transferOwnership(_owner);
 
-        localDomain = _localDomain;
         portalTokenBridge = IPortalTokenBridge(_portalTokenBridge);
         liquidityLayerRouter = _liquidityLayerRouter;
     }

package/contracts/mock/MockERC5164.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT or Apache-2.0
 pragma solidity ^0.8.13;
 
-import {IMessageDispatcher} from "../hooks/ERC5164/interfaces/IMessageDispatcher.sol";
+import {IMessageDispatcher} from "../interfaces/hooks/IMessageDispatcher.sol";
 
 contract MockMessageDispatcher is IMessageDispatcher {
     function dispatchMessage(

package/contracts/mock/MockHyperlaneEnvironment.sol

@@ -2,7 +2,6 @@
 pragma solidity ^0.8.13;
 
 import "./MockMailbox.sol";
-import "../middleware/InterchainQueryRouter.sol";
 import "../test/TestInterchainGasPaymaster.sol";
 import "../test/TestMultisigIsm.sol";
 
@@ -15,7 +14,6 @@ contract MockHyperlaneEnvironment {
     mapping(uint32 => MockMailbox) public mailboxes;
     mapping(uint32 => TestInterchainGasPaymaster) public igps;
     mapping(uint32 => IInterchainSecurityModule) public isms;
-    mapping(uint32 => InterchainQueryRouter) public queryRouters;
 
     constructor(uint32 _originDomain, uint32 _destinationDomain) {
         originDomain = _originDomain;
@@ -27,46 +25,24 @@ contract MockHyperlaneEnvironment {
         originMailbox.addRemoteMailbox(_destinationDomain, destinationMailbox);
         destinationMailbox.addRemoteMailbox(_originDomain, originMailbox);
 
-        igps[originDomain] = new TestInterchainGasPaymaster(address(this));
-        igps[destinationDomain] = new TestInterchainGasPaymaster(address(this));
-
         isms[originDomain] = new TestMultisigIsm();
         isms[destinationDomain] = new TestMultisigIsm();
 
-        originMailbox.setDefaultIsm(isms[originDomain]);
-        destinationMailbox.setDefaultIsm(isms[destinationDomain]);
-
-        mailboxes[_originDomain] = originMailbox;
-        mailboxes[_destinationDomain] = destinationMailbox;
+        originMailbox.setDefaultIsm(address(isms[originDomain]));
+        destinationMailbox.setDefaultIsm(address(isms[destinationDomain]));
 
-        InterchainQueryRouter originQueryRouter = new InterchainQueryRouter();
-        InterchainQueryRouter destinationQueryRouter = new InterchainQueryRouter();
+        igps[originDomain] = new TestInterchainGasPaymaster();
+        igps[destinationDomain] = new TestInterchainGasPaymaster();
 
-        address owner = address(this);
-        originQueryRouter.initialize(
-            address(originMailbox),
-            address(igps[originDomain]),
-            address(isms[originDomain]),
-            owner
-        );
-        destinationQueryRouter.initialize(
-            address(destinationMailbox),
-            address(igps[destinationDomain]),
-            address(isms[destinationDomain]),
-            owner
-        );
+        // TODO: update routers with IGP paymentss
+        // originMailbox.setDefaultHook(address(igps[originDomain]));
+        // destinationMailbox.setDefaultHook(address(igps[destinationDomain]));
 
-        originQueryRouter.enrollRemoteRouter(
-            _destinationDomain,
-            TypeCasts.addressToBytes32(address(destinationQueryRouter))
-        );
-        destinationQueryRouter.enrollRemoteRouter(
-            _originDomain,
-            TypeCasts.addressToBytes32(address(originQueryRouter))
-        );
+        originMailbox.transferOwnership(msg.sender);
+        destinationMailbox.transferOwnership(msg.sender);
 
-        queryRouters[_originDomain] = originQueryRouter;
-        queryRouters[_destinationDomain] = destinationQueryRouter;
+        mailboxes[_originDomain] = originMailbox;
+        mailboxes[_destinationDomain] = destinationMailbox;
     }
 
     function processNextPendingMessage() public {

package/contracts/mock/MockMailbox.sol

@@ -3,39 +3,34 @@ pragma solidity ^0.8.0;
 
 import {Versioned} from "../upgrade/Versioned.sol";
 import {TypeCasts} from "../libs/TypeCasts.sol";
+import {Message} from "../libs/Message.sol";
 import {IMessageRecipient} from "../interfaces/IMessageRecipient.sol";
 import {IInterchainSecurityModule, ISpecifiesInterchainSecurityModule} from "../interfaces/IInterchainSecurityModule.sol";
+import {Mailbox} from "../Mailbox.sol";
+import {IPostDispatchHook} from "../interfaces/hooks/IPostDispatchHook.sol";
 
-contract MockMailbox is Versioned {
-    using TypeCasts for address;
-    using TypeCasts for bytes32;
-    // Domain of chain on which the contract is deployed
+import {TestIsm} from "../test/TestIsm.sol";
+import {TestPostDispatchHook} from "../test/TestPostDispatchHook.sol";
 
-    // ============ Constants ============
-    uint32 public immutable localDomain;
-    uint256 public constant MAX_MESSAGE_BODY_BYTES = 2 * 2**10;
+contract MockMailbox is Mailbox {
+    using Message for bytes;
 
-    uint32 public outboundNonce = 0;
     uint32 public inboundUnprocessedNonce = 0;
     uint32 public inboundProcessedNonce = 0;
-    IInterchainSecurityModule public defaultIsm;
+
     mapping(uint32 => MockMailbox) public remoteMailboxes;
-    mapping(uint256 => MockMessage) public inboundMessages;
+    mapping(uint256 => bytes) public inboundMessages;
 
-    struct MockMessage {
-        uint32 nonce;
-        uint32 origin;
-        address sender;
-        address recipient;
-        bytes body;
-    }
+    constructor(uint32 _domain) Mailbox(_domain) {
+        TestIsm ism = new TestIsm();
+        defaultIsm = ism;
 
-    constructor(uint32 _domain) {
-        localDomain = _domain;
-    }
+        TestPostDispatchHook hook = new TestPostDispatchHook();
+        defaultHook = hook;
+        requiredHook = hook;
 
-    function setDefaultIsm(IInterchainSecurityModule _module) external {
-        defaultIsm = _module;
+        _transferOwnership(msg.sender);
+        _disableInitializers();
     }
 
     function addRemoteMailbox(uint32 _domain, MockMailbox _mailbox) external {
@@ -43,92 +38,43 @@ contract MockMailbox is Versioned {
     }
 
     function dispatch(
-        uint32 _destinationDomain,
-        bytes32 _recipientAddress,
-        bytes calldata _messageBody
-    ) external returns (bytes32) {
-        require(_messageBody.length <= MAX_MESSAGE_BODY_BYTES, "msg too long");
-        MockMailbox _destinationMailbox = remoteMailboxes[_destinationDomain];
+        uint32 destinationDomain,
+        bytes32 recipientAddress,
+        bytes calldata messageBody,
+        bytes calldata metadata,
+        IPostDispatchHook hook
+    ) public payable override returns (bytes32) {
+        bytes memory message = _buildMessage(
+            destinationDomain,
+            recipientAddress,
+            messageBody
+        );
+        bytes32 id = super.dispatch(
+            destinationDomain,
+            recipientAddress,
+            messageBody,
+            metadata,
+            hook
+        );
+
+        MockMailbox _destinationMailbox = remoteMailboxes[destinationDomain];
         require(
             address(_destinationMailbox) != address(0),
             "Missing remote mailbox"
         );
-        _destinationMailbox.addInboundMessage(
-            outboundNonce,
-            localDomain,
-            msg.sender,
-            _recipientAddress.bytes32ToAddress(),
-            _messageBody
-        );
-        outboundNonce++;
-        return bytes32(0);
+        _destinationMailbox.addInboundMessage(message);
+
+        return id;
     }
 
-    function addInboundMessage(
-        uint32 _nonce,
-        uint32 _origin,
-        address _sender,
-        address _recipient,
-        bytes calldata _body
-    ) external {
-        inboundMessages[inboundUnprocessedNonce] = MockMessage(
-            _nonce,
-            _origin,
-            _sender,
-            _recipient,
-            _body
-        );
+    function addInboundMessage(bytes calldata message) external {
+        inboundMessages[inboundUnprocessedNonce] = message;
         inboundUnprocessedNonce++;
     }
 
     function processNextInboundMessage() public {
-        MockMessage memory _message = inboundMessages[inboundProcessedNonce];
-        address _recipient = _message.recipient;
-        IInterchainSecurityModule _ism = _recipientIsm(_recipient);
-        if (address(_ism) != address(0)) {
-            // Do not pass any metadata because we expect to
-            // be using TestIsms
-            require(_ism.verify("", _encode(_message)), "ISM verify failed");
-        }
-
-        IMessageRecipient(_message.recipient).handle(
-            _message.origin,
-            _message.sender.addressToBytes32(),
-            _message.body
-        );
+        bytes memory _message = inboundMessages[inboundProcessedNonce];
+        Mailbox(address(this)).process("", _message);
         inboundProcessedNonce++;
     }
-
-    function _encode(MockMessage memory _message)
-        private
-        view
-        returns (bytes memory)
-    {
-        return
-            abi.encodePacked(
-                VERSION,
-                _message.nonce,
-                _message.origin,
-                TypeCasts.addressToBytes32(_message.sender),
-                localDomain,
-                TypeCasts.addressToBytes32(_message.recipient),
-                _message.body
-            );
-    }
-
-    function _recipientIsm(address _recipient)
-        private
-        view
-        returns (IInterchainSecurityModule)
-    {
-        try
-            ISpecifiesInterchainSecurityModule(_recipient)
-                .interchainSecurityModule()
-        returns (IInterchainSecurityModule _val) {
-            if (address(_val) != address(0)) {
-                return _val;
-            }
-        } catch {}
-        return defaultIsm;
-    }
 }

package/contracts/test/ERC20Test.sol

@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity >=0.8.0;
+
+import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+
+contract ERC20Test is ERC20 {
+    uint8 public immutable _decimals;
+
+    constructor(
+        string memory name,
+        string memory symbol,
+        uint256 totalSupply,
+        uint8 __decimals
+    ) ERC20(name, symbol) {
+        _decimals = __decimals;
+        _mint(msg.sender, totalSupply);
+    }
+
+    function decimals() public view override returns (uint8) {
+        return _decimals;
+    }
+}

package/contracts/test/ERC721Test.sol

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity >=0.8.0;
+
+import "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
+
+contract ERC721Test is ERC721Enumerable {
+    constructor(
+        string memory name,
+        string memory symbol,
+        uint256 _mintAmount
+    ) ERC721(name, symbol) {
+        for (uint256 i = 0; i < _mintAmount; i++) {
+            _mint(msg.sender, i);
+        }
+    }
+
+    function _baseURI() internal pure override returns (string memory) {
+        return "TEST-BASE-URI";
+    }
+}

package/contracts/test/LightTestRecipient.sol

@@ -9,7 +9,7 @@ contract LightTestRecipient is TestRecipient {
         uint32 _origin,
         bytes32 _sender,
         bytes calldata _data
-    ) external override {
+    ) external payable override {
         // do nothing
     }
 }

package/contracts/test/TestGasRouter.sol

@@ -1,28 +1,18 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.6.11;
 
-import "./TestRouter.sol";
-import "../GasRouter.sol";
+import "../client/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
-        );
-    }
+contract TestGasRouter is GasRouter {
+    constructor(address _mailbox) GasRouter(_mailbox) {}
 
-    function dispatchWithGas(
-        uint32 _destinationDomain,
-        bytes memory _messageBody
-    ) external payable {
-        _dispatchWithGas(_destinationDomain, _messageBody);
+    function dispatch(uint32 _destination, bytes memory _msg) external payable {
+        _dispatch(_destination, _msg);
     }
+
+    function _handle(
+        uint32,
+        bytes32,
+        bytes calldata
+    ) internal pure override {}
 }

package/contracts/test/TestInterchainGasPaymaster.sol

@@ -2,14 +2,13 @@
 pragma solidity >=0.8.0;
 
 // ============ Internal Imports ============
-import {InterchainGasPaymaster} from "../igps/InterchainGasPaymaster.sol";
+import {InterchainGasPaymaster} from "../hooks/igp/InterchainGasPaymaster.sol";
 
 contract TestInterchainGasPaymaster is InterchainGasPaymaster {
     uint256 public constant gasPrice = 10;
 
-    // Ensure the same constructor interface as the inherited InterchainGasPaymaster
-    constructor(address _beneficiary) {
-        initialize(msg.sender, _beneficiary);
+    constructor() {
+        initialize(msg.sender, msg.sender);
     }
 
     function quoteGasPayment(uint32, uint256 gasAmount)

package/contracts/test/TestIsm.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.6.11;
+
+import {IInterchainSecurityModule} from "../interfaces/IInterchainSecurityModule.sol";
+
+contract TestIsm is IInterchainSecurityModule {
+    uint8 public moduleType = uint8(Types.NULL);
+
+    bool verifyResult = true;
+
+    function setVerify(bool _verify) public {
+        verifyResult = _verify;
+    }
+
+    function verify(bytes calldata, bytes calldata) public view returns (bool) {
+        return verifyResult;
+    }
+}

package/contracts/test/TestMailbox.sol

@@ -3,28 +3,15 @@ pragma solidity >=0.8.0;
 
 import {Mailbox} from "../Mailbox.sol";
 import {TypeCasts} from "../libs/TypeCasts.sol";
+import {Message} from "../libs/Message.sol";
 import {MerkleLib} from "../libs/Merkle.sol";
 import {IMessageRecipient} from "../interfaces/IMessageRecipient.sol";
 
 contract TestMailbox is Mailbox {
     using TypeCasts for bytes32;
 
-    constructor(uint32 _localDomain) Mailbox(_localDomain) {} // solhint-disable-line no-empty-blocks
-
-    function proof() external view returns (bytes32[32] memory) {
-        bytes32[32] memory _zeroes = MerkleLib.zeroHashes();
-        uint256 _index = tree.count - 1;
-        bytes32[32] memory _proof;
-
-        for (uint256 i = 0; i < 32; i++) {
-            uint256 _ithBit = (_index >> i) & 0x01;
-            if (_ithBit == 1) {
-                _proof[i] = tree.branch[i];
-            } else {
-                _proof[i] = _zeroes[i];
-            }
-        }
-        return _proof;
+    constructor(uint32 _localDomain) Mailbox(_localDomain) {
+        _transferOwnership(msg.sender);
     }
 
     function testHandle(
@@ -39,4 +26,34 @@ contract TestMailbox is Mailbox {
             _body
         );
     }
+
+    function buildOutboundMessage(
+        uint32 destinationDomain,
+        bytes32 recipientAddress,
+        bytes calldata body
+    ) external view returns (bytes memory) {
+        return _buildMessage(destinationDomain, recipientAddress, body);
+    }
+
+    function buildInboundMessage(
+        uint32 originDomain,
+        bytes32 recipientAddress,
+        bytes32 senderAddress,
+        bytes calldata body
+    ) external view returns (bytes memory) {
+        return
+            Message.formatMessage(
+                VERSION,
+                nonce,
+                originDomain,
+                senderAddress,
+                localDomain,
+                recipientAddress,
+                body
+            );
+    }
+
+    function updateLatestDispatchedId(bytes32 _id) external {
+        latestDispatchedId = _id;
+    }
 }

package/contracts/test/TestMerkleTreeHook.sol

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+import {MerkleLib} from "../libs/Merkle.sol";
+import {MerkleTreeHook} from "../hooks/MerkleTreeHook.sol";
+
+contract TestMerkleTreeHook is MerkleTreeHook {
+    using MerkleLib for MerkleLib.Tree;
+
+    constructor(address _mailbox) MerkleTreeHook(_mailbox) {}
+
+    function proof() external view returns (bytes32[32] memory) {
+        bytes32[32] memory _zeroes = MerkleLib.zeroHashes();
+        uint256 _index = _tree.count - 1;
+        bytes32[32] memory _proof;
+
+        for (uint256 i = 0; i < 32; i++) {
+            uint256 _ithBit = (_index >> i) & 0x01;
+            if (_ithBit == 1) {
+                _proof[i] = _tree.branch[i];
+            } else {
+                _proof[i] = _zeroes[i];
+            }
+        }
+        return _proof;
+    }
+
+    function insert(bytes32 _id) external {
+        _tree.insert(_id);
+    }
+}

package/contracts/test/TestPostDispatchHook.sol

@@ -0,0 +1,41 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+import {AbstractPostDispatchHook} from "../hooks/libs/AbstractPostDispatchHook.sol";
+
+contract TestPostDispatchHook is AbstractPostDispatchHook {
+    // ============ Public Storage ============
+
+    // test fees for quoteDispatch
+    uint256 public fee = 0;
+
+    function supportsMetadata(bytes calldata)
+        public
+        pure
+        override
+        returns (bool)
+    {
+        return true;
+    }
+
+    function setFee(uint256 _fee) external {
+        fee = _fee;
+    }
+
+    // ============ Internal functions ============
+    function _postDispatch(
+        bytes calldata,
+        /*metadata*/
+        bytes calldata /*message*/
+    ) internal pure override {
+        // test - empty
+    }
+
+    function _quoteDispatch(
+        bytes calldata,
+        /*metadata*/
+        bytes calldata /*message*/
+    ) internal view override returns (uint256) {
+        return fee;
+    }
+}

package/contracts/test/TestQuery.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.13;
 
 import {InterchainQueryRouter} from "../middleware/InterchainQueryRouter.sol";
 import {TypeCasts} from "../libs/TypeCasts.sol";
-import {CallLib} from "../libs/Call.sol";
+import {CallLib} from "../middleware/libs/Call.sol";
 
 import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
 

package/contracts/test/TestQuerySender.sol

@@ -1,13 +1,11 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.8.0;
 
-import {IInterchainGasPaymaster} from "../interfaces/IInterchainGasPaymaster.sol";
-import {IInterchainQueryRouter} from "../interfaces/middleware/IInterchainQueryRouter.sol";
-import {CallLib} from "../libs/Call.sol";
+import {InterchainQueryRouter} from "../middleware/InterchainQueryRouter.sol";
+import {CallLib} from "../middleware/libs/Call.sol";
 
 contract TestQuerySender {
-    IInterchainQueryRouter queryRouter;
-    IInterchainGasPaymaster interchainGasPaymaster;
+    InterchainQueryRouter queryRouter;
 
     address public lastAddressResult;
     uint256 public lastUint256Result;
@@ -17,14 +15,8 @@ contract TestQuerySender {
     event ReceivedUint256Result(uint256 result);
     event ReceivedBytes32Result(bytes32 result);
 
-    function initialize(
-        address _queryRouterAddress,
-        address _interchainGasPaymaster
-    ) external {
-        queryRouter = IInterchainQueryRouter(_queryRouterAddress);
-        interchainGasPaymaster = IInterchainGasPaymaster(
-            _interchainGasPaymaster
-        );
+    function initialize(address _queryRouterAddress) external {
+        queryRouter = InterchainQueryRouter(_queryRouterAddress);
     }
 
     function queryAddress(
@@ -92,21 +84,13 @@ contract TestQuerySender {
         address _target,
         bytes calldata _targetData,
         bytes4 _callbackSelector,
-        uint256 _gasAmount
+        uint256 /*_gasAmount*/
     ) internal {
-        CallLib.StaticCallWithCallback[]
-            memory calls = new CallLib.StaticCallWithCallback[](1);
-        calls[0] = CallLib.build(
+        queryRouter.query(
+            _destinationDomain,
             _target,
             _targetData,
             abi.encodePacked(_callbackSelector)
         );
-        bytes32 _messageId = queryRouter.query(_destinationDomain, calls);
-        interchainGasPaymaster.payForGas{value: msg.value}(
-            _messageId,
-            _destinationDomain,
-            _gasAmount,
-            msg.sender
-        );
     }
 }

package/contracts/test/TestRecipient.sol

@@ -21,6 +21,7 @@ contract TestRecipient is
     event ReceivedMessage(
         uint32 indexed origin,
         bytes32 indexed sender,
+        uint256 indexed value,
         string message
     );
 
@@ -30,8 +31,8 @@ contract TestRecipient is
         uint32 _origin,
         bytes32 _sender,
         bytes calldata _data
-    ) external virtual override {
-        emit ReceivedMessage(_origin, _sender, string(_data));
+    ) external payable virtual override {
+        emit ReceivedMessage(_origin, _sender, msg.value, string(_data));
         lastSender = _sender;
         lastData = _data;
     }