@hyperlane-xyz/core 1.5.6-beta0 → 1.5.8

package/contracts/middleware/libs/Call.sol

@@ -1,145 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.13;
-
-import {Address} from "@openzeppelin/contracts/utils/Address.sol";
-
-import {TypeCasts} from "../../libs/TypeCasts.sol";
-
-library CallLib {
-    struct StaticCall {
-        // supporting non EVM targets
-        bytes32 to;
-        bytes data;
-    }
-
-    struct Call {
-        // supporting non EVM targets
-        bytes32 to;
-        uint256 value;
-        bytes data;
-    }
-
-    struct StaticCallWithCallback {
-        StaticCall _call;
-        bytes callback;
-    }
-
-    function call(Call memory _call)
-        internal
-        returns (bytes memory returnData)
-    {
-        return
-            Address.functionCallWithValue(
-                TypeCasts.bytes32ToAddress(_call.to),
-                _call.data,
-                _call.value
-            );
-    }
-
-    function staticcall(StaticCall memory _call)
-        private
-        view
-        returns (bytes memory)
-    {
-        return
-            Address.functionStaticCall(
-                TypeCasts.bytes32ToAddress(_call.to),
-                _call.data
-            );
-    }
-
-    function staticcall(StaticCallWithCallback memory _call)
-        internal
-        view
-        returns (bytes memory callback)
-    {
-        return bytes.concat(_call.callback, staticcall(_call._call));
-    }
-
-    function multicall(Call[] memory calls) internal {
-        uint256 i = 0;
-        uint256 len = calls.length;
-        while (i < len) {
-            call(calls[i]);
-            unchecked {
-                ++i;
-            }
-        }
-    }
-
-    function multistaticcall(StaticCallWithCallback[] memory _calls)
-        internal
-        view
-        returns (bytes[] memory)
-    {
-        uint256 i = 0;
-        uint256 len = _calls.length;
-        bytes[] memory callbacks = new bytes[](len);
-        while (i < len) {
-            callbacks[i] = staticcall(_calls[i]);
-            unchecked {
-                ++i;
-            }
-        }
-        return callbacks;
-    }
-
-    function multicallto(address to, bytes[] memory calls) internal {
-        uint256 i = 0;
-        uint256 len = calls.length;
-        while (i < len) {
-            Address.functionCall(to, calls[i]);
-            unchecked {
-                ++i;
-            }
-        }
-    }
-
-    function build(bytes32 to, bytes memory data)
-        internal
-        pure
-        returns (StaticCall memory)
-    {
-        return StaticCall(to, data);
-    }
-
-    function build(address to, bytes memory data)
-        internal
-        pure
-        returns (StaticCall memory)
-    {
-        return build(TypeCasts.addressToBytes32(to), data);
-    }
-
-    function build(
-        bytes32 to,
-        uint256 value,
-        bytes memory data
-    ) internal pure returns (Call memory) {
-        return Call(to, value, data);
-    }
-
-    function build(
-        address to,
-        uint256 value,
-        bytes memory data
-    ) internal pure returns (Call memory) {
-        return Call(TypeCasts.addressToBytes32(to), value, data);
-    }
-
-    function build(
-        bytes32 to,
-        bytes memory data,
-        bytes memory callback
-    ) internal pure returns (StaticCallWithCallback memory) {
-        return StaticCallWithCallback(build(to, data), callback);
-    }
-
-    function build(
-        address to,
-        bytes memory data,
-        bytes memory callback
-    ) internal pure returns (StaticCallWithCallback memory) {
-        return StaticCallWithCallback(build(to, data), callback);
-    }
-}

package/contracts/middleware/libs/InterchainAccountMessage.sol

@@ -1,95 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-import {CallLib} from "./Call.sol";
-import {TypeCasts} from "../../libs/TypeCasts.sol";
-
-/**
- * Format of message:
- * [   0:  32] ICA owner
- * [  32:  64] ICA ISM
- * [  64:????] Calls, abi encoded
- */
-library InterchainAccountMessage {
-    using TypeCasts for bytes32;
-
-    /**
-     * @notice Returns formatted (packed) InterchainAccountMessage
-     * @dev This function should only be used in memory message construction.
-     * @param _owner The owner of the interchain account
-     * @param _ism The address of the remote ISM
-     * @param _to The address of the contract to call
-     * @param _value The value to include in the call
-     * @param _data The calldata
-     * @return Formatted message body
-     */
-    function encode(
-        address _owner,
-        bytes32 _ism,
-        address _to,
-        uint256 _value,
-        bytes memory _data
-    ) internal pure returns (bytes memory) {
-        CallLib.Call[] memory _calls = new CallLib.Call[](1);
-        _calls[0] = CallLib.build(_to, _value, _data);
-        return abi.encode(TypeCasts.addressToBytes32(_owner), _ism, _calls);
-    }
-
-    /**
-     * @notice Returns formatted (packed) InterchainAccountMessage
-     * @dev This function should only be used in memory message construction.
-     * @param _owner The owner of the interchain account
-     * @param _ism The address of the remote ISM
-     * @param _calls The sequence of calls to make
-     * @return Formatted message body
-     */
-    function encode(
-        bytes32 _owner,
-        bytes32 _ism,
-        CallLib.Call[] calldata _calls
-    ) internal pure returns (bytes memory) {
-        return abi.encode(_owner, _ism, _calls);
-    }
-
-    /**
-     * @notice Returns formatted (packed) InterchainAccountMessage
-     * @dev This function should only be used in memory message construction.
-     * @param _owner The owner of the interchain account
-     * @param _ism The address of the remote ISM
-     * @param _calls The sequence of calls to make
-     * @return Formatted message body
-     */
-    function encode(
-        address _owner,
-        bytes32 _ism,
-        CallLib.Call[] calldata _calls
-    ) internal pure returns (bytes memory) {
-        return encode(TypeCasts.addressToBytes32(_owner), _ism, _calls);
-    }
-
-    /**
-     * @notice Parses and returns the calls from the provided message
-     * @param _message The interchain account message
-     * @return The array of calls
-     */
-    function decode(bytes calldata _message)
-        internal
-        pure
-        returns (
-            bytes32,
-            bytes32,
-            CallLib.Call[] memory
-        )
-    {
-        return abi.decode(_message, (bytes32, bytes32, CallLib.Call[]));
-    }
-
-    /**
-     * @notice Parses and returns the ISM address from the provided message
-     * @param _message The interchain account message
-     * @return The ISM encoded in the message
-     */
-    function ism(bytes calldata _message) internal pure returns (address) {
-        return address(bytes20(_message[44:64]));
-    }
-}

package/contracts/middleware/libs/InterchainQueryMessage.sol

@@ -1,125 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.13;
-
-import {CallLib} from "./Call.sol";
-
-/**
- * Format of message:
- * [   0: 32] Sender address
- * [  32: 64] Message type (left padded with zeroes)
- * [  64:???] Encoded call array
- */
-library InterchainQueryMessage {
-    uint256 private constant SENDER_OFFSET = 0;
-    uint256 private constant TYPE_OFFSET = 32;
-    uint256 private constant CALLS_OFFSET = 64;
-
-    enum MessageType {
-        QUERY,
-        RESPONSE
-    }
-
-    /**
-     * @notice Parses and returns the query sender from the provided message
-     * @param _message The interchain query message
-     * @return The query sender as bytes32
-     */
-    function sender(bytes calldata _message) internal pure returns (bytes32) {
-        return bytes32(_message[SENDER_OFFSET:TYPE_OFFSET]);
-    }
-
-    /**
-     * @notice Parses and returns the message type from the provided message
-     * @param _message The interchain query message
-     * @return The message type (query or response)
-     */
-    function messageType(bytes calldata _message)
-        internal
-        pure
-        returns (MessageType)
-    {
-        // left padded with zeroes
-        return MessageType(uint8(bytes1(_message[CALLS_OFFSET - 1])));
-    }
-
-    /**
-     * @notice Returns formatted InterchainQueryMessage, type == QUERY
-     * @param _sender The query sender as bytes32
-     * @param _calls The sequence of queries to make, with the corresponding
-     * response callbacks
-     * @return Formatted message body
-     */
-    function encode(
-        bytes32 _sender,
-        CallLib.StaticCallWithCallback[] calldata _calls
-    ) internal pure returns (bytes memory) {
-        return abi.encode(_sender, MessageType.QUERY, _calls);
-    }
-
-    /**
-     * @notice Returns formatted InterchainQueryMessage, type == QUERY
-     * @param _sender The query sender as bytes32
-     * @param _to The address of the contract to query
-     * @param _data The calldata encoding the query
-     * @param _callback The calldata of the callback that will be made on the sender.
-     * The return value of the query will be appended.
-     * @return Formatted message body
-     */
-    function encode(
-        bytes32 _sender,
-        address _to,
-        bytes memory _data,
-        bytes memory _callback
-    ) internal pure returns (bytes memory) {
-        CallLib.StaticCallWithCallback[]
-            memory _calls = new CallLib.StaticCallWithCallback[](1);
-        _calls[0] = CallLib.build(_to, _data, _callback);
-        return abi.encode(_sender, MessageType.QUERY, _calls);
-    }
-
-    /**
-     * @notice Parses and returns the calls and callbacks from the message
-     * @param _message The interchain query message, type == QUERY
-     * @return _calls The sequence of queries to make with the corresponding
-     * response callbacks
-     */
-    function callsWithCallbacks(bytes calldata _message)
-        internal
-        pure
-        returns (CallLib.StaticCallWithCallback[] memory _calls)
-    {
-        assert(messageType(_message) == MessageType.QUERY);
-        (, , _calls) = abi.decode(
-            _message,
-            (bytes32, MessageType, CallLib.StaticCallWithCallback[])
-        );
-    }
-
-    /**
-     * @notice Returns formatted InterchainQueryMessage, type == RESPONSE
-     * @param _sender The query sender as bytes32
-     * @param _calls The sequence of callbacks to make
-     * @return Formatted message body
-     */
-    function encode(bytes32 _sender, bytes[] memory _calls)
-        internal
-        pure
-        returns (bytes memory)
-    {
-        return abi.encode(_sender, MessageType.RESPONSE, _calls);
-    }
-
-    /**
-     * @notice Parses and returns the callbacks from the message
-     * @param _message The interchain query message, type == RESPONSE
-     * @return _calls The sequence of callbacks to make
-     */
-    function rawCalls(bytes calldata _message)
-        internal
-        pure
-        returns (bytes[] memory _calls)
-    {
-        assert(messageType(_message) == MessageType.RESPONSE);
-        (, , _calls) = abi.decode(_message, (bytes32, MessageType, bytes[]));
-    }
-}

package/contracts/middleware/libs/OwnableMulticall.sol

@@ -1,29 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.13;
-
-// ============ Internal Imports ============
-import {CallLib} from "./Call.sol";
-
-/*
- * @title OwnableMulticall
- * @dev Permits immutable owner address to execute calls with value to other contracts.
- */
-contract OwnableMulticall {
-    address public immutable owner;
-
-    constructor(address _owner) {
-        owner = _owner;
-    }
-
-    modifier onlyOwner() {
-        require(msg.sender == owner, "!owner");
-        _;
-    }
-
-    function multicall(CallLib.Call[] calldata calls) external onlyOwner {
-        return CallLib.multicall(calls);
-    }
-
-    // solhint-disable-next-line no-empty-blocks
-    receive() external payable {}
-}

package/contracts/test/ERC20Test.sol

@@ -1,22 +0,0 @@
-// 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

@@ -1,20 +0,0 @@
-// 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/TestIsm.sol

@@ -1,18 +0,0 @@
-// 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/TestMerkleTreeHook.sol

@@ -1,31 +0,0 @@
-// 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

@@ -1,41 +0,0 @@
-// 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/token/HypERC20.sol

@@ -1,73 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity >=0.8.0;
-
-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 HypERC20 is ERC20Upgradeable, TokenRouter {
-    uint8 private immutable _decimals;
-
-    constructor(uint8 __decimals, address _mailbox) TokenRouter(_mailbox) {
-        _decimals = __decimals;
-    }
-
-    /**
-     * @notice Initializes the Hyperlane router, ERC20 metadata, and mints initial supply to deployer.
-     * @param _totalSupply The initial supply of the token.
-     * @param _name The name of the token.
-     * @param _symbol The symbol of the token.
-     */
-    function initialize(
-        uint256 _totalSupply,
-        string memory _name,
-        string memory _symbol
-    ) external initializer {
-        // Initialize ERC20 metadata
-        __ERC20_init(_name, _symbol);
-        _mint(msg.sender, _totalSupply);
-    }
-
-    function decimals() public view override returns (uint8) {
-        return _decimals;
-    }
-
-    function balanceOf(address _account)
-        public
-        view
-        override(TokenRouter, ERC20Upgradeable)
-        returns (uint256)
-    {
-        return ERC20Upgradeable.balanceOf(_account);
-    }
-
-    /**
-     * @dev Burns `_amount` of token from `msg.sender` balance.
-     * @inheritdoc TokenRouter
-     */
-    function _transferFromSender(uint256 _amount)
-        internal
-        override
-        returns (bytes memory)
-    {
-        _burn(msg.sender, _amount);
-        return bytes(""); // no metadata
-    }
-
-    /**
-     * @dev Mints `_amount` of token to `_recipient` balance.
-     * @inheritdoc TokenRouter
-     */
-    function _transferTo(
-        address _recipient,
-        uint256 _amount,
-        bytes calldata // no metadata
-    ) internal override {
-        _mint(_recipient, _amount);
-    }
-}

package/contracts/token/HypERC20Collateral.sol

@@ -1,61 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity >=0.8.0;
-
-import {TokenRouter} from "./libs/TokenRouter.sol";
-import {TokenMessage} from "./libs/TokenMessage.sol";
-import {MailboxClient} from "../client/MailboxClient.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 HypERC20Collateral is TokenRouter {
-    using SafeERC20 for IERC20;
-
-    IERC20 public immutable wrappedToken;
-
-    /**
-     * @notice Constructor
-     * @param erc20 Address of the token to keep as collateral
-     */
-    constructor(address erc20, address _mailbox) TokenRouter(_mailbox) {
-        wrappedToken = IERC20(erc20);
-    }
-
-    function balanceOf(address _account)
-        external
-        view
-        override
-        returns (uint256)
-    {
-        return wrappedToken.balanceOf(_account);
-    }
-
-    /**
-     * @dev Transfers `_amount` of `wrappedToken` from `msg.sender` to this contract.
-     * @inheritdoc TokenRouter
-     */
-    function _transferFromSender(uint256 _amount)
-        internal
-        override
-        returns (bytes memory)
-    {
-        wrappedToken.safeTransferFrom(msg.sender, address(this), _amount);
-        return bytes(""); // no metadata
-    }
-
-    /**
-     * @dev Transfers `_amount` of `wrappedToken` from this contract to `_recipient`.
-     * @inheritdoc TokenRouter
-     */
-    function _transferTo(
-        address _recipient,
-        uint256 _amount,
-        bytes calldata // no metadata
-    ) internal override {
-        wrappedToken.safeTransfer(_recipient, _amount);
-    }
-}