@hyperlane-xyz/core 1.5.7-beta1 → 3.0.0-beta0

package/contracts/hooks/MerkleTreeHook.sol

@@ -17,6 +17,7 @@ import {MerkleLib} from "../libs/Merkle.sol";
 import {Message} from "../libs/Message.sol";
 import {MailboxClient} from "../client/MailboxClient.sol";
 import {Indexed} from "../libs/Indexed.sol";
+import {IPostDispatchHook} from "../interfaces/hooks/IPostDispatchHook.sol";
 import {AbstractPostDispatchHook} from "./libs/AbstractPostDispatchHook.sol";
 import {StandardHookMetadata} from "./libs/StandardHookMetadata.sol";
 
@@ -49,6 +50,13 @@ contract MerkleTreeHook is AbstractPostDispatchHook, MailboxClient, Indexed {
         return (root(), count() - 1);
     }
 
+    // ============ External Functions ============
+
+    /// @inheritdoc IPostDispatchHook
+    function hookType() external pure override returns (uint8) {
+        return uint8(IPostDispatchHook.Types.MERKLE_TREE);
+    }
+
     // ============ Internal Functions ============
 
     /// @inheritdoc AbstractPostDispatchHook

package/contracts/hooks/OPStackHook.sol

@@ -48,7 +48,7 @@ contract OPStackHook is AbstractMessageIdAuthHook {
     constructor(
         address _mailbox,
         uint32 _destinationDomain,
-        address _ism,
+        bytes32 _ism,
         address _l1Messenger
     ) AbstractMessageIdAuthHook(_mailbox, _destinationDomain, _ism) {
         require(
@@ -58,8 +58,7 @@ contract OPStackHook is AbstractMessageIdAuthHook {
         l1Messenger = ICrossDomainMessenger(_l1Messenger);
     }
 
-    // ============ External functions ============
-
+    // ============ Internal functions ============
     function _quoteDispatch(bytes calldata, bytes calldata)
         internal
         pure
@@ -69,8 +68,6 @@ contract OPStackHook is AbstractMessageIdAuthHook {
         return 0; // gas subsidized by the L2
     }
 
-    // ============ Internal functions ============
-
     /// @inheritdoc AbstractMessageIdAuthHook
     function _sendMessageId(bytes calldata metadata, bytes memory payload)
         internal
@@ -81,7 +78,7 @@ contract OPStackHook is AbstractMessageIdAuthHook {
             "OPStackHook: msgValue must be less than 2 ** 255"
         );
         l1Messenger.sendMessage{value: metadata.msgValue(0)}(
-            ism,
+            TypeCasts.bytes32ToAddress(ism),
             payload,
             GAS_LIMIT
         );

package/contracts/hooks/PausableHook.sol

@@ -14,6 +14,7 @@ pragma solidity >=0.8.0;
 @@@@@@@@@       @@@@@@@@*/
 
 import {StandardHookMetadata} from "../hooks/libs/StandardHookMetadata.sol";
+import {IPostDispatchHook} from "../interfaces/hooks/IPostDispatchHook.sol";
 import {AbstractPostDispatchHook} from "./libs/AbstractPostDispatchHook.sol";
 
 import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
@@ -32,6 +33,13 @@ contract PausableHook is AbstractPostDispatchHook, Ownable, Pausable {
         _unpause();
     }
 
+    // ============ External Functions ============
+
+    /// @inheritdoc IPostDispatchHook
+    function hookType() external pure override returns (uint8) {
+        return uint8(IPostDispatchHook.Types.PAUSABLE);
+    }
+
     // ============ Internal functions ============
 
     /// @inheritdoc AbstractPostDispatchHook

package/contracts/hooks/StaticProtocolFee.sol

@@ -17,6 +17,7 @@ pragma solidity >=0.8.0;
 import {Message} from "../libs/Message.sol";
 import {StandardHookMetadata} from "./libs/StandardHookMetadata.sol";
 import {AbstractPostDispatchHook} from "./libs/AbstractPostDispatchHook.sol";
+import {IPostDispatchHook} from "../interfaces/hooks/IPostDispatchHook.sol";
 
 // ============ External Imports ============
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
@@ -59,6 +60,11 @@ contract StaticProtocolFee is AbstractPostDispatchHook, Ownable {
 
     // ============ External Functions ============
 
+    /// @inheritdoc IPostDispatchHook
+    function hookType() external pure override returns (uint8) {
+        return uint8(IPostDispatchHook.Types.PROTOCOL_FEE);
+    }
+
     /**
      * @notice Sets the protocol fee.
      * @param _protocolFee The new protocol fee.

package/contracts/hooks/aggregation/ERC5164Hook.sol

@@ -33,7 +33,7 @@ contract ERC5164Hook is AbstractMessageIdAuthHook {
     constructor(
         address _mailbox,
         uint32 _destinationDomain,
-        address _ism,
+        bytes32 _ism,
         address _dispatcher
     ) AbstractMessageIdAuthHook(_mailbox, _destinationDomain, _ism) {
         require(
@@ -43,13 +43,15 @@ contract ERC5164Hook is AbstractMessageIdAuthHook {
         dispatcher = IMessageDispatcher(_dispatcher);
     }
 
+    // ============ Internal Functions ============
+
     function _quoteDispatch(bytes calldata, bytes calldata)
         internal
         pure
         override
         returns (uint256)
     {
-        revert("not implemented");
+        return 0; // EIP-5164 doesn't enforce a gas abstraction
     }
 
     function _sendMessageId(
@@ -58,6 +60,10 @@ contract ERC5164Hook is AbstractMessageIdAuthHook {
         bytes memory payload
     ) internal override {
         require(msg.value == 0, "ERC5164Hook: no value allowed");
-        dispatcher.dispatchMessage(destinationDomain, ism, payload);
+        dispatcher.dispatchMessage(
+            destinationDomain,
+            TypeCasts.bytes32ToAddress(ism),
+            payload
+        );
     }
 }

package/contracts/hooks/aggregation/StaticAggregationHook.sol

@@ -23,6 +23,11 @@ contract StaticAggregationHook is AbstractPostDispatchHook {
 
     // ============ External functions ============
 
+    /// @inheritdoc IPostDispatchHook
+    function hookType() external pure override returns (uint8) {
+        return uint8(IPostDispatchHook.Types.AGGREGATION);
+    }
+
     /// @inheritdoc AbstractPostDispatchHook
     function _postDispatch(bytes calldata metadata, bytes calldata message)
         internal

package/contracts/hooks/igp/InterchainGasPaymaster.sol

@@ -92,6 +92,11 @@ contract InterchainGasPaymaster is
 
     // ============ External Functions ============
 
+    /// @inheritdoc IPostDispatchHook
+    function hookType() external pure override returns (uint8) {
+        return uint8(IPostDispatchHook.Types.INTERCHAIN_GAS_PAYMASTER);
+    }
+
     /**
      * @param _owner The owner of the contract.
      * @param _beneficiary The beneficiary.

package/contracts/hooks/libs/AbstractMessageIdAuthHook.sol

@@ -14,6 +14,7 @@ pragma solidity >=0.8.0;
 @@@@@@@@@       @@@@@@@@*/
 
 // ============ Internal Imports ============
+import {IPostDispatchHook} from "../../interfaces/hooks/IPostDispatchHook.sol";
 import {AbstractPostDispatchHook} from "./AbstractPostDispatchHook.sol";
 import {AbstractMessageIdAuthorizedIsm} from "../../isms/hook/AbstractMessageIdAuthorizedIsm.sol";
 import {TypeCasts} from "../../libs/TypeCasts.sol";
@@ -35,8 +36,8 @@ abstract contract AbstractMessageIdAuthHook is
 
     // ============ Constants ============
 
-    // address for ISM to verify messages
-    address public immutable ism;
+    // left-padded address for ISM to verify messages
+    bytes32 public immutable ism;
     // Domain of chain on which the ISM is deployed
     uint32 public immutable destinationDomain;
 
@@ -45,9 +46,9 @@ abstract contract AbstractMessageIdAuthHook is
     constructor(
         address _mailbox,
         uint32 _destinationDomain,
-        address _ism
+        bytes32 _ism
     ) MailboxClient(_mailbox) {
-        require(_ism != address(0), "AbstractMessageIdAuthHook: invalid ISM");
+        require(_ism != bytes32(0), "AbstractMessageIdAuthHook: invalid ISM");
         require(
             _destinationDomain != 0,
             "AbstractMessageIdAuthHook: invalid destination domain"
@@ -56,6 +57,11 @@ abstract contract AbstractMessageIdAuthHook is
         destinationDomain = _destinationDomain;
     }
 
+    /// @inheritdoc IPostDispatchHook
+    function hookType() external pure returns (uint8) {
+        return uint8(IPostDispatchHook.Types.ID_AUTH_ISM);
+    }
+
     // ============ Internal functions ============
 
     /// @inheritdoc AbstractPostDispatchHook

package/contracts/hooks/routing/DomainRoutingHook.sol

@@ -42,8 +42,15 @@ contract DomainRoutingHook is AbstractPostDispatchHook, MailboxClient {
         _transferOwnership(_owner);
     }
 
-    function setHook(uint32 destination, address hook) public onlyOwner {
-        hooks[destination] = IPostDispatchHook(hook);
+    // ============ External Functions ============
+
+    /// @inheritdoc IPostDispatchHook
+    function hookType() external pure virtual override returns (uint8) {
+        return uint8(IPostDispatchHook.Types.ROUTING);
+    }
+
+    function setHook(uint32 _destination, address _hook) public onlyOwner {
+        hooks[_destination] = IPostDispatchHook(_hook);
     }
 
     function setHooks(HookConfig[] calldata configs) external onlyOwner {

package/contracts/hooks/routing/FallbackDomainRoutingHook.sol

@@ -36,17 +36,25 @@ contract FallbackDomainRoutingHook is DomainRoutingHook {
         fallbackHook = IPostDispatchHook(_fallback);
     }
 
+    // ============ External Functions ============
+
+    /// @inheritdoc IPostDispatchHook
+    function hookType() external pure override returns (uint8) {
+        return uint8(IPostDispatchHook.Types.FALLBACK_ROUTING);
+    }
+
     // ============ Internal Functions ============
 
     function _getConfiguredHook(bytes calldata message)
         internal
         view
         override
-        returns (IPostDispatchHook hook)
+        returns (IPostDispatchHook)
     {
-        hook = hooks[message.destination()];
-        if (address(hook) == address(0)) {
-            hook = fallbackHook;
+        IPostDispatchHook _hook = hooks[message.destination()];
+        if (address(_hook) == address(0)) {
+            _hook = fallbackHook;
         }
+        return _hook;
     }
 }

package/contracts/interfaces/hooks/IPostDispatchHook.sol

@@ -14,6 +14,23 @@ pragma solidity >=0.8.0;
 @@@@@@@@@       @@@@@@@@*/
 
 interface IPostDispatchHook {
+    enum Types {
+        UNUSED,
+        ROUTING,
+        AGGREGATION,
+        MERKLE_TREE,
+        INTERCHAIN_GAS_PAYMASTER,
+        FALLBACK_ROUTING,
+        ID_AUTH_ISM,
+        PAUSABLE,
+        PROTOCOL_FEE
+    }
+
+    /**
+     * @notice Returns an enum that represents the type of hook
+     */
+    function hookType() external view returns (uint8);
+
     /**
      * @notice Returns whether the hook supports metadata
      * @param metadata metadata

package/contracts/interfaces/optimism/ICrossDomainMessenger.sol

@@ -27,13 +27,13 @@ interface ICrossDomainMessenger {
         bytes calldata _message
     ) external payable;
 
-    /*************
-     * Variables *
-     *************/
-
     function xDomainMessageSender() external view returns (address);
+
+    function OTHER_MESSENGER() external view returns (address);
 }
 
+interface IL1CrossDomainMessenger is ICrossDomainMessenger {}
+
 interface IL2CrossDomainMessenger is ICrossDomainMessenger {
     function messageNonce() external view returns (uint256);
 }

package/contracts/isms/hook/AbstractMessageIdAuthorizedIsm.sol

@@ -18,7 +18,6 @@ pragma solidity >=0.8.0;
 import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
 import {LibBit} from "../../libs/LibBit.sol";
 import {Message} from "../../libs/Message.sol";
-import {TypeCasts} from "../../libs/TypeCasts.sol";
 
 // ============ External Imports ============
 
@@ -46,9 +45,9 @@ abstract contract AbstractMessageIdAuthorizedIsm is
     /// @dev the first bit is reserved for verification and the rest 255 bits are for the msg.value
     mapping(bytes32 => uint256) public verifiedMessages;
     /// @notice Index of verification bit in verifiedMessages
-    uint256 public constant MASK_INDEX = 255;
-    /// @notice Address for the authorized hook
-    address public authorizedHook;
+    uint256 public constant VERIFIED_MASK_INDEX = 255;
+    /// @notice address for the authorized hook
+    bytes32 public authorizedHook;
 
     // ============ Events ============
 
@@ -57,9 +56,9 @@ abstract contract AbstractMessageIdAuthorizedIsm is
 
     // ============ Initializer ============
 
-    function setAuthorizedHook(address _hook) external initializer {
+    function setAuthorizedHook(bytes32 _hook) external initializer {
         require(
-            _hook != address(0),
+            _hook != bytes32(0),
             "AbstractMessageIdAuthorizedIsm: invalid authorized hook"
         );
         authorizedHook = _hook;
@@ -79,12 +78,18 @@ abstract contract AbstractMessageIdAuthorizedIsm is
         bytes32 messageId = message.id();
 
         // check for the first bit (used for verification)
-        bool verified = verifiedMessages[messageId].isBitSet(MASK_INDEX);
+        bool verified = verifiedMessages[messageId].isBitSet(
+            VERIFIED_MASK_INDEX
+        );
         // rest 255 bits contains the msg.value passed from the hook
         if (verified) {
-            payable(message.recipientAddress()).sendValue(
-                verifiedMessages[messageId].clearBit(MASK_INDEX)
+            uint256 _msgValue = verifiedMessages[messageId].clearBit(
+                VERIFIED_MASK_INDEX
             );
+            if (_msgValue > 0) {
+                verifiedMessages[messageId] -= _msgValue;
+                payable(message.recipientAddress()).sendValue(_msgValue);
+            }
         }
         return verified;
     }
@@ -99,8 +104,12 @@ abstract contract AbstractMessageIdAuthorizedIsm is
             _isAuthorized(),
             "AbstractMessageIdAuthorizedIsm: sender is not the hook"
         );
+        require(
+            msg.value < 2**VERIFIED_MASK_INDEX,
+            "AbstractMessageIdAuthorizedIsm: msg.value must be less than 2^255"
+        );
 
-        verifiedMessages[messageId] = msg.value.setBit(MASK_INDEX);
+        verifiedMessages[messageId] = msg.value.setBit(VERIFIED_MASK_INDEX);
         emit ReceivedMessage(messageId);
     }
 

package/contracts/isms/hook/OPStackIsm.sol

@@ -52,6 +52,7 @@ contract OPStackIsm is
      * @notice Check if sender is authorized to message `verifyMessageId`.
      */
     function _isAuthorized() internal view override returns (bool) {
-        return _crossChainSender() == authorizedHook;
+        return
+            _crossChainSender() == TypeCasts.bytes32ToAddress(authorizedHook);
     }
 }

package/contracts/mock/MockHyperlaneEnvironment.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.13;
 
 import "./MockMailbox.sol";
 import "../test/TestInterchainGasPaymaster.sol";
-import "../test/TestMultisigIsm.sol";
+import "../test/TestIsm.sol";
 
 import {TypeCasts} from "../libs/TypeCasts.sol";
 
@@ -25,8 +25,8 @@ contract MockHyperlaneEnvironment {
         originMailbox.addRemoteMailbox(_destinationDomain, destinationMailbox);
         destinationMailbox.addRemoteMailbox(_originDomain, originMailbox);
 
-        isms[originDomain] = new TestMultisigIsm();
-        isms[destinationDomain] = new TestMultisigIsm();
+        isms[originDomain] = new TestIsm();
+        isms[destinationDomain] = new TestIsm();
 
         originMailbox.setDefaultIsm(address(isms[originDomain]));
         destinationMailbox.setDefaultIsm(address(isms[destinationDomain]));
@@ -34,10 +34,6 @@ contract MockHyperlaneEnvironment {
         igps[originDomain] = new TestInterchainGasPaymaster();
         igps[destinationDomain] = new TestInterchainGasPaymaster();
 
-        // TODO: update routers with IGP paymentss
-        // originMailbox.setDefaultHook(address(igps[originDomain]));
-        // destinationMailbox.setDefaultHook(address(igps[destinationDomain]));
-
         originMailbox.transferOwnership(msg.sender);
         destinationMailbox.transferOwnership(msg.sender);
 

package/contracts/test/TestPostDispatchHook.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.8.0;
 
+import {IPostDispatchHook} from "../interfaces/hooks/IPostDispatchHook.sol";
 import {AbstractPostDispatchHook} from "../hooks/libs/AbstractPostDispatchHook.sol";
 
 contract TestPostDispatchHook is AbstractPostDispatchHook {
@@ -9,6 +10,13 @@ contract TestPostDispatchHook is AbstractPostDispatchHook {
     // test fees for quoteDispatch
     uint256 public fee = 0;
 
+    // ============ External Functions ============
+
+    /// @inheritdoc IPostDispatchHook
+    function hookType() external pure override returns (uint8) {
+        return uint8(IPostDispatchHook.Types.UNUSED);
+    }
+
     function supportsMetadata(bytes calldata)
         public
         pure

package/contracts/test/TestSendReceiver.sol

@@ -6,8 +6,11 @@ import {TypeCasts} from "../libs/TypeCasts.sol";
 import {IInterchainGasPaymaster} from "../interfaces/IInterchainGasPaymaster.sol";
 import {IMessageRecipient} from "../interfaces/IMessageRecipient.sol";
 import {IMailbox} from "../interfaces/IMailbox.sol";
+import {IPostDispatchHook} from "../interfaces/hooks/IPostDispatchHook.sol";
+import {IInterchainSecurityModule, ISpecifiesInterchainSecurityModule} from "../interfaces/IInterchainSecurityModule.sol";
 
 import {StandardHookMetadata} from "../hooks/libs/StandardHookMetadata.sol";
+import {MailboxClient} from "../client/MailboxClient.sol";
 
 contract TestSendReceiver is IMessageRecipient {
     using TypeCasts for address;
@@ -34,6 +37,26 @@ contract TestSendReceiver is IMessageRecipient {
         );
     }
 
+    function dispatchToSelf(
+        IMailbox _mailbox,
+        uint32 _destinationDomain,
+        bytes calldata _messageBody,
+        IPostDispatchHook hook
+    ) external payable {
+        bytes memory hookMetadata = StandardHookMetadata.formatMetadata(
+            HANDLE_GAS_AMOUNT,
+            msg.sender
+        );
+        // TODO: handle topping up?
+        _mailbox.dispatch{value: msg.value}(
+            _destinationDomain,
+            address(this).addressToBytes32(),
+            _messageBody,
+            hookMetadata,
+            hook
+        );
+    }
+
     function handle(
         uint32,
         bytes32,

package/contracts/token/HypERC20.sol

@@ -40,6 +40,7 @@ contract HypERC20 is ERC20Upgradeable, TokenRouter {
     function balanceOf(address _account)
         public
         view
+        virtual
         override(TokenRouter, ERC20Upgradeable)
         returns (uint256)
     {
@@ -67,7 +68,7 @@ contract HypERC20 is ERC20Upgradeable, TokenRouter {
         address _recipient,
         uint256 _amount,
         bytes calldata // no metadata
-    ) internal override {
+    ) internal virtual override {
         _mint(_recipient, _amount);
     }
 }

package/contracts/token/HypERC20Collateral.sol

@@ -55,7 +55,7 @@ contract HypERC20Collateral is TokenRouter {
         address _recipient,
         uint256 _amount,
         bytes calldata // no metadata
-    ) internal override {
+    ) internal virtual override {
         wrappedToken.safeTransfer(_recipient, _amount);
     }
 }

package/contracts/token/extensions/FastHypERC20.sol

@@ -0,0 +1,63 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity >=0.8.0;
+
+import {HypERC20} from "../HypERC20.sol";
+import {FastTokenRouter} from "../libs/FastTokenRouter.sol";
+import {TokenRouter} from "../libs/TokenRouter.sol";
+
+import {ERC20Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
+
+/**
+ * @title Hyperlane ERC20 Token Router that extends ERC20 with remote transfer functionality.
+ * @author Abacus Works
+ * @dev Supply on each chain is not constant but the aggregate supply across all chains is.
+ */
+contract FastHypERC20 is FastTokenRouter, HypERC20 {
+    constructor(uint8 __decimals, address _mailbox)
+        HypERC20(__decimals, _mailbox)
+    {}
+
+    /**
+     * @dev delegates transfer logic to `_transferTo`.
+     * @inheritdoc TokenRouter
+     */
+    function _handle(
+        uint32 _origin,
+        bytes32 _sender,
+        bytes calldata _message
+    ) internal virtual override(FastTokenRouter, TokenRouter) {
+        FastTokenRouter._handle(_origin, _sender, _message);
+    }
+
+    /**
+     * @dev Mints `_amount` of tokens to `_recipient`.
+     * @inheritdoc FastTokenRouter
+     */
+    function _fastTransferTo(address _recipient, uint256 _amount)
+        internal
+        override
+    {
+        _mint(_recipient, _amount);
+    }
+
+    /**
+     * @dev Burns `_amount` of tokens from `_recipient`.
+     * @inheritdoc FastTokenRouter
+     */
+    function _fastRecieveFrom(address _sender, uint256 _amount)
+        internal
+        override
+    {
+        _burn(_sender, _amount);
+    }
+
+    function balanceOf(address _account)
+        public
+        view
+        virtual
+        override(HypERC20, TokenRouter)
+        returns (uint256)
+    {
+        return ERC20Upgradeable.balanceOf(_account);
+    }
+}

package/contracts/token/extensions/FastHypERC20Collateral.sol

@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity >=0.8.0;
+
+import {HypERC20Collateral} from "../HypERC20Collateral.sol";
+import {FastTokenRouter} from "../libs/FastTokenRouter.sol";
+import {TokenRouter} from "../libs/TokenRouter.sol";
+
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+
+/**
+ * @title Hyperlane ERC20 Token Collateral that wraps an existing ERC20 with remote transfer functionality.
+ * @author Abacus Works
+ */
+contract FastHypERC20Collateral is FastTokenRouter, HypERC20Collateral {
+    using SafeERC20 for IERC20;
+
+    /**
+     * @notice Constructor
+     * @param erc20 Address of the token to keep as collateral
+     */
+    constructor(address erc20, address _mailbox)
+        HypERC20Collateral(erc20, _mailbox)
+    {}
+
+    /**
+     * @dev delegates transfer logic to `_transferTo`.
+     * @inheritdoc FastTokenRouter
+     */
+    function _handle(
+        uint32 _origin,
+        bytes32 _sender,
+        bytes calldata _message
+    ) internal virtual override(FastTokenRouter, TokenRouter) {
+        FastTokenRouter._handle(_origin, _sender, _message);
+    }
+
+    /**
+     * @dev Transfers `_amount` of `wrappedToken` to `_recipient`.
+     * @inheritdoc FastTokenRouter
+     */
+    function _fastTransferTo(address _recipient, uint256 _amount)
+        internal
+        override
+    {
+        wrappedToken.safeTransfer(_recipient, _amount);
+    }
+
+    /**
+     * @dev Transfers in `_amount` of `wrappedToken` from `_recipient`.
+     * @inheritdoc FastTokenRouter
+     */
+    function _fastRecieveFrom(address _sender, uint256 _amount)
+        internal
+        override
+    {
+        wrappedToken.safeTransferFrom(_sender, address(this), _amount);
+    }
+}