@hyperlane-xyz/core 0.5.4-3 → 1.0.0-beta0

package/contracts/middleware/InterchainAccountRouter.sol

@@ -26,16 +26,16 @@ contract InterchainAccountRouter is Router, IInterchainAccountRouter {
     );
 
     function initialize(
-        address _owner,
         address _mailbox,
-        address _interchainGasPaymaster
+        address _interchainGasPaymaster,
+        address _interchainSecurityModule
     ) public initializer {
-        // Transfer ownership of the contract to deployer
-        _transferOwnership(_owner);
-        // Set the addresses for the Mailbox and IGP
-        // Alternatively, this could be done later in an initialize method
-        _setMailbox(_mailbox);
-        _setInterchainGasPaymaster(_interchainGasPaymaster);
+        // Transfer ownership of the contract to `msg.sender`
+        __HyperlaneConnectionClient_initialize(
+            _mailbox,
+            _interchainGasPaymaster,
+            _interchainSecurityModule
+        );
     }
 
     function dispatch(uint32 _destinationDomain, Call[] calldata calls)
@@ -45,6 +45,16 @@ contract InterchainAccountRouter is Router, IInterchainAccountRouter {
         return _dispatch(_destinationDomain, abi.encode(msg.sender, calls));
     }
 
+    function dispatch(
+        uint32 _destinationDomain,
+        address target,
+        bytes calldata data
+    ) external returns (bytes32) {
+        Call[] memory calls = new Call[](1);
+        calls[0] = Call({to: target, data: data});
+        return _dispatch(_destinationDomain, abi.encode(msg.sender, calls));
+    }
+
     function getInterchainAccount(uint32 _origin, address _sender)
         public
         view

package/contracts/middleware/InterchainQueryRouter.sol

@@ -32,16 +32,36 @@ contract InterchainQueryRouter is
     );
 
     function initialize(
-        address _owner,
         address _mailbox,
-        address _interchainGasPaymaster
+        address _interchainGasPaymaster,
+        address _interchainSecurityModule
     ) public initializer {
-        // Transfer ownership of the contract to deployer
-        _transferOwnership(_owner);
-        // Set the addresses for the Mailbox and IGP
-        // Alternatively, this could be done later in an initialize method
-        _setMailbox(_mailbox);
-        _setInterchainGasPaymaster(_interchainGasPaymaster);
+        // Transfer ownership of the contract to `msg.sender`
+        __HyperlaneConnectionClient_initialize(
+            _mailbox,
+            _interchainGasPaymaster,
+            _interchainSecurityModule
+        );
+    }
+
+    /**
+     * @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.
+     */
+    function query(
+        uint32 _destinationDomain,
+        address target,
+        bytes calldata queryData,
+        bytes calldata callback
+    ) external returns (bytes32 messageId) {
+        // TODO: fix this ugly arrayification
+        Call[] memory calls = new Call[](1);
+        calls[0] = Call({to: target, data: queryData});
+        bytes[] memory callbacks = new bytes[](1);
+        callbacks[0] = callback;
+        messageId = query(_destinationDomain, calls, callbacks);
     }
 
     /**

package/contracts/middleware/liquidity-layer/LiquidityLayerRouter.sol

@@ -3,32 +3,33 @@ pragma solidity ^0.8.13;
 
 import {Router} from "../../Router.sol";
 
-import {IMessageRecipient} from "../../../interfaces/IMessageRecipient.sol";
+import {ILiquidityLayerRouter} from "../../../interfaces/ILiquidityLayerRouter.sol";
 import {ICircleBridge} from "./interfaces/circle/ICircleBridge.sol";
 import {ICircleMessageTransmitter} from "./interfaces/circle/ICircleMessageTransmitter.sol";
 import {ILiquidityLayerAdapter} from "./interfaces/ILiquidityLayerAdapter.sol";
-import {ILiquidityLayerMessageRecipient} from "./interfaces/ILiquidityLayerMessageRecipient.sol";
+import {ILiquidityLayerMessageRecipient} from "../../../interfaces/ILiquidityLayerMessageRecipient.sol";
 
 import {TypeCasts} from "../../libs/TypeCasts.sol";
 
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
-contract LiquidityLayerRouter is Router {
+contract LiquidityLayerRouter is Router, ILiquidityLayerRouter {
     // Token bridge => adapter address
     mapping(string => address) public liquidityLayerAdapters;
 
     event LiquidityLayerAdapterSet(string indexed bridge, address adapter);
 
     function initialize(
-        address _owner,
         address _mailbox,
-        address _interchainGasPaymaster
+        address _interchainGasPaymaster,
+        address _interchainSecurityModule
     ) public initializer {
-        // Transfer ownership of the contract to deployer
-        _transferOwnership(_owner);
-        // Alternatively, this could be done later in an initialize method
-        _setMailbox(_mailbox);
-        _setInterchainGasPaymaster(_interchainGasPaymaster);
+        // Transfer ownership of the contract to `msg.sender`
+        __HyperlaneConnectionClient_initialize(
+            _mailbox,
+            _interchainGasPaymaster,
+            _interchainSecurityModule
+        );
     }
 
     function dispatchWithTokens(
@@ -38,7 +39,7 @@ contract LiquidityLayerRouter is Router {
         address _token,
         uint256 _amount,
         string calldata _bridge
-    ) external payable {
+    ) external payable returns (bytes32) {
         ILiquidityLayerAdapter _adapter = _getAdapter(_bridge);
 
         // Transfer the tokens to the adapter
@@ -70,7 +71,14 @@ contract LiquidityLayerRouter is Router {
         );
 
         // Dispatch the _messageWithMetadata to the destination's LiquidityLayerRouter.
-        _dispatchWithGas(_destinationDomain, _messageWithMetadata, msg.value);
+        return
+            _dispatchWithGas(
+                _destinationDomain,
+                _messageWithMetadata,
+                0, // TODO eventually accommodate gas amounts
+                msg.value,
+                msg.sender
+            );
     }
 
     // Handles a message from an enrolled remote LiquidityLayerRouter

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

@@ -74,9 +74,6 @@ contract CircleBridgeAdapter is ILiquidityLayerAdapter, Router {
         // Transfer ownership of the contract to deployer
         _transferOwnership(_owner);
 
-        // Set the addresses for the IGP to address(0) - it's not used.
-        _setInterchainGasPaymaster(address(0));
-
         circleBridge = ICircleBridge(_circleBridge);
         circleMessageTransmitter = ICircleMessageTransmitter(
             _circleMessageTransmitter

package/contracts/mock/MockHyperlaneEnvironment.sol

@@ -3,6 +3,8 @@ pragma solidity ^0.8.13;
 
 import "./MockMailbox.sol";
 import "../middleware/InterchainQueryRouter.sol";
+import "../InterchainGasPaymaster.sol";
+import "../test/TestIsm.sol";
 
 import {TypeCasts} from "../libs/TypeCasts.sol";
 
@@ -11,6 +13,8 @@ contract MockHyperlaneEnvironment {
     uint32 destinationDomain;
 
     mapping(uint32 => MockMailbox) public mailboxes;
+    mapping(uint32 => InterchainGasPaymaster) public igps;
+    mapping(uint32 => IInterchainSecurityModule) public isms;
     mapping(uint32 => InterchainQueryRouter) public queryRouters;
 
     constructor(uint32 _originDomain, uint32 _destinationDomain) {
@@ -20,6 +24,15 @@ contract MockHyperlaneEnvironment {
         MockMailbox originMailbox = new MockMailbox(_originDomain);
         MockMailbox destinationMailbox = new MockMailbox(_destinationDomain);
 
+        originMailbox.addRemoteMailbox(_destinationDomain, destinationMailbox);
+        destinationMailbox.addRemoteMailbox(_originDomain, originMailbox);
+
+        igps[originDomain] = new InterchainGasPaymaster();
+        igps[destinationDomain] = new InterchainGasPaymaster();
+
+        isms[originDomain] = new TestIsm();
+        isms[destinationDomain] = new TestIsm();
+
         mailboxes[_originDomain] = originMailbox;
         mailboxes[_destinationDomain] = destinationMailbox;
 
@@ -27,14 +40,14 @@ contract MockHyperlaneEnvironment {
         InterchainQueryRouter destinationQueryRouter = new InterchainQueryRouter();
 
         originQueryRouter.initialize(
-            address(this),
             address(originMailbox),
-            address(0)
+            address(igps[originDomain]),
+            address(isms[originDomain])
         );
         destinationQueryRouter.initialize(
-            address(this),
             address(destinationMailbox),
-            address(0)
+            address(igps[destinationDomain]),
+            address(isms[destinationDomain])
         );
 
         originQueryRouter.enrollRemoteRouter(

package/contracts/mock/MockInterchainAccountRouter.sol

@@ -38,10 +38,24 @@ contract MockInterchainAccountRouter is IInterchainAccountRouter {
         originDomain = _originDomain;
     }
 
-    function dispatch(uint32, Call[] calldata calls)
-        external
+    function dispatch(uint32 _destinationDomain, Call[] calldata calls)
+        public
         returns (bytes32)
     {
+        return _dispatch(_destinationDomain, calls);
+    }
+
+    function dispatch(
+        uint32 _destinationDomain,
+        address target,
+        bytes calldata data
+    ) external returns (bytes32) {
+        Call[] memory calls = new Call[](1);
+        calls[0] = Call({to: target, data: data});
+        return _dispatch(_destinationDomain, calls);
+    }
+
+    function _dispatch(uint32, Call[] memory calls) internal returns (bytes32) {
         pendingCalls[totalCalls] = PendingCall(
             originDomain,
             msg.sender,

package/contracts/test/TestHyperlaneConnectionClient.sol

@@ -4,8 +4,8 @@ import {HyperlaneConnectionClient} from "../HyperlaneConnectionClient.sol";
 import {IMailbox} from "../../interfaces/IMailbox.sol";
 
 contract TestHyperlaneConnectionClient is HyperlaneConnectionClient {
-    function initialize(address _abacusConnectionManager) external initializer {
-        __HyperlaneConnectionClient_initialize(_abacusConnectionManager);
+    function initialize(address _mailbox) external initializer {
+        __HyperlaneConnectionClient_initialize(_mailbox);
     }
 
     function localDomain() external view returns (uint32) {

package/contracts/test/TestLiquidityLayerMessageRecipient.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.13;
 
-import {ILiquidityLayerMessageRecipient} from "../middleware/liquidity-layer/interfaces/ILiquidityLayerMessageRecipient.sol";
+import {ILiquidityLayerMessageRecipient} from "../../interfaces/ILiquidityLayerMessageRecipient.sol";
 
 contract TestLiquidityLayerMessageRecipient is ILiquidityLayerMessageRecipient {
     event HandledWithTokens(

package/contracts/test/TestRouter.sol

@@ -6,8 +6,8 @@ import "../Router.sol";
 contract TestRouter is Router {
     event InitializeOverload();
 
-    function initialize(address _abacusConnectionManager) external initializer {
-        __Router_initialize(_abacusConnectionManager);
+    function initialize(address _mailbox) external initializer {
+        __Router_initialize(_mailbox);
         emit InitializeOverload();
     }
 
@@ -38,10 +38,18 @@ contract TestRouter is Router {
     }
 
     function dispatchWithGas(
-        uint32 _destination,
-        bytes memory _msg,
-        uint256 _gasPayment
+        uint32 _destinationDomain,
+        bytes memory _messageBody,
+        uint256 _gasAmount,
+        uint256 _gasPayment,
+        address _gasPaymentRefundAddress
     ) external payable {
-        _dispatchWithGas(_destination, _msg, _gasPayment);
+        _dispatchWithGas(
+            _destinationDomain,
+            _messageBody,
+            _gasAmount,
+            _gasPayment,
+            _gasPaymentRefundAddress
+        );
     }
 }

package/contracts/test/TestSendReceiver.sol

@@ -10,15 +10,17 @@ import {IMailbox} from "../../interfaces/IMailbox.sol";
 contract TestSendReceiver is IMessageRecipient {
     using TypeCasts for address;
 
+    uint256 public constant HANDLE_GAS_AMOUNT = 50_000;
+
     event Handled(bytes32 blockHash);
 
     function dispatchToSelf(
-        IMailbox _outbox,
+        IMailbox _mailbox,
         IInterchainGasPaymaster _paymaster,
         uint32 _destinationDomain,
         bytes calldata _messageBody
     ) external payable {
-        bytes32 _messageId = _outbox.dispatch(
+        bytes32 _messageId = _mailbox.dispatch(
             _destinationDomain,
             address(this).addressToBytes32(),
             _messageBody
@@ -27,15 +29,28 @@ contract TestSendReceiver is IMessageRecipient {
         uint256 _value = msg.value;
         if (_blockHashNum % 5 == 0) {
             // Pay in two separate calls, resulting in 2 distinct events
-            uint256 _half = _value / 2;
-            _paymaster.payGasFor{value: _half}(_messageId, _destinationDomain);
-            _paymaster.payGasFor{value: _value - _half}(
+            uint256 _halfPayment = _value / 2;
+            uint256 _halfGasAmount = HANDLE_GAS_AMOUNT / 2;
+            _paymaster.payForGas{value: _halfPayment}(
+                _messageId,
+                _destinationDomain,
+                _halfGasAmount,
+                msg.sender
+            );
+            _paymaster.payForGas{value: _value - _halfPayment}(
                 _messageId,
-                _destinationDomain
+                _destinationDomain,
+                HANDLE_GAS_AMOUNT - _halfGasAmount,
+                msg.sender
             );
         } else {
             // Pay the entire msg.value in one call
-            _paymaster.payGasFor{value: _value}(_messageId, _destinationDomain);
+            _paymaster.payForGas{value: _value}(
+                _messageId,
+                _destinationDomain,
+                HANDLE_GAS_AMOUNT,
+                msg.sender
+            );
         }
     }
 

package/contracts/test/TestTokenRecipient.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.8.0;
 
-import {ILiquidityLayerMessageRecipient} from "../middleware/liquidity-layer/interfaces/ILiquidityLayerMessageRecipient.sol";
+import {ILiquidityLayerMessageRecipient} from "../../interfaces/ILiquidityLayerMessageRecipient.sol";
 
 contract TestTokenRecipient is ILiquidityLayerMessageRecipient {
     bytes32 public lastSender;

package/contracts/upgrade/ProxyAdmin.sol

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: MIT
+// OpenZeppelin Contracts v4.4.1 (proxy/transparent/ProxyAdmin.sol)
+
+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";

package/contracts/upgrade/TransparentUpgradeableProxy.sol

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: MIT
+// OpenZeppelin Contracts (last updated v4.7.0) (proxy/transparent/TransparentUpgradeableProxy.sol)
+
+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";

package/interfaces/IInterchainAccountRouter.sol

@@ -8,6 +8,12 @@ interface IInterchainAccountRouter {
         external
         returns (bytes32);
 
+    function dispatch(
+        uint32 _destinationDomain,
+        address target,
+        bytes calldata data
+    ) external returns (bytes32);
+
     function getInterchainAccount(uint32 _originDomain, address _sender)
         external
         view

package/interfaces/IInterchainGasPaymaster.sol

@@ -7,7 +7,10 @@ pragma solidity >=0.6.11;
  * messages to destination chains.
  */
 interface IInterchainGasPaymaster {
-    function payGasFor(bytes32 _messageId, uint32 _destinationDomain)
-        external
-        payable;
+    function payForGas(
+        bytes32 _messageId,
+        uint32 _destinationDomain,
+        uint256 _gas,
+        address _refundAddress
+    ) external payable;
 }

package/interfaces/IInterchainQueryRouter.sol

@@ -4,6 +4,13 @@ pragma solidity >=0.6.11;
 import {Call} from "../contracts/Call.sol";
 
 interface IInterchainQueryRouter {
+    function query(
+        uint32 _destinationDomain,
+        address target,
+        bytes calldata queryData,
+        bytes calldata callback
+    ) external returns (bytes32);
+
     function query(
         uint32 _destinationDomain,
         Call calldata call,

package/interfaces/ILiquidityLayerRouter.sol

@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.6.11;
+
+import {Call} from "../contracts/Call.sol";
+
+interface ILiquidityLayerRouter {
+    function dispatchWithTokens(
+        uint32 _destinationDomain,
+        bytes32 _recipientAddress,
+        bytes calldata _messageBody,
+        address _token,
+        uint256 _amount,
+        string calldata _bridge
+    ) external payable returns (bytes32);
+}

package/interfaces/IMultisigIsm.sol

@@ -9,7 +9,7 @@ interface IMultisigIsm is IInterchainSecurityModule {
         view
         returns (bool);
 
-    function threshold(uint32 _domain) external view returns (uint256);
+    function threshold(uint32 _domain) external view returns (uint8);
 
     function validators(uint32 _domain)
         external

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@hyperlane-xyz/core",
   "description": "Core solidity contracts for Hyperlane",
-  "version": "0.5.4-3",
+  "version": "1.0.0-beta0",
   "dependencies": {
-    "@hyperlane-xyz/utils": "0.5.4-3",
-    "@openzeppelin/contracts": "^4.6.0",
-    "@openzeppelin/contracts-upgradeable": "^4.6.0"
+    "@hyperlane-xyz/utils": "1.0.0-beta0",
+    "@openzeppelin/contracts": "^4.8.0",
+    "@openzeppelin/contracts-upgradeable": "^4.8.0"
   },
   "devDependencies": {
     "@nomiclabs/hardhat-ethers": "^2.0.5",
@@ -47,8 +47,7 @@
     "clean": "hardhat clean && rm -rf ./dist ./cache",
     "coverage": "hardhat coverage",
     "prettier": "prettier --write ./contracts ./interfaces ./test",
-    "test": "hardhat test"
+    "test": "hardhat test && forge test -vvv"
   },
-  "types": "dist/index.d.ts",
-  "stableVersion": "0.5.3"
+  "types": "dist/index.d.ts"
 }

package/contracts/test/MysteryMath.sol

@@ -1,21 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity >=0.8.0;
-
-abstract contract MysteryMath {
-    uint256 public stateVar;
-
-    function setState(uint256 _var) external {
-        stateVar = _var;
-    }
-
-    function getState() external view returns (uint256) {
-        return stateVar;
-    }
-
-    function doMath(uint256 a, uint256 b)
-        external
-        pure
-        virtual
-        returns (uint256 _result);
-}

package/contracts/test/MysteryMathV1.sol

@@ -1,22 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity >=0.8.0;
-
-import "./MysteryMath.sol";
-
-contract MysteryMathV1 is MysteryMath {
-    uint32 public immutable version;
-
-    constructor() {
-        version = 1;
-    }
-
-    function doMath(uint256 a, uint256 b)
-        external
-        pure
-        override
-        returns (uint256 _result)
-    {
-        _result = a + b;
-    }
-}

package/contracts/test/MysteryMathV2.sol

@@ -1,22 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity >=0.8.0;
-
-import "./MysteryMath.sol";
-
-contract MysteryMathV2 is MysteryMath {
-    uint32 public immutable version;
-
-    constructor() {
-        version = 2;
-    }
-
-    function doMath(uint256 a, uint256 b)
-        external
-        pure
-        override
-        returns (uint256 _result)
-    {
-        _result = a * b;
-    }
-}

package/contracts/upgrade/UpgradeBeacon.sol

@@ -1,98 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity >=0.8.0;
-
-// ============ External Imports ============
-import {Address} from "@openzeppelin/contracts/utils/Address.sol";
-
-/**
- * @title UpgradeBeacon
- * @notice Stores the address of an implementation contract
- * and allows a controller to upgrade the implementation address
- * @dev This implementation combines the gas savings of having no function selectors
- * found in 0age's implementation:
- * https://github.com/dharma-eng/dharma-smart-wallet/blob/master/contracts/proxies/smart-wallet/UpgradeBeaconProxyV1.sol
- * With the added niceties of a safety check that each implementation is a contract
- * and an Upgrade event emitted each time the implementation is changed
- * found in OpenZeppelin's implementation:
- * https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/proxy/beacon/BeaconProxy.sol
- */
-contract UpgradeBeacon {
-    // ============ Immutables ============
-
-    // The controller is capable of modifying the implementation address
-    address private immutable controller;
-
-    // ============ Private Storage Variables ============
-
-    // The implementation address is held in storage slot zero.
-    address private implementation;
-
-    // ============ Events ============
-
-    // Upgrade event is emitted each time the implementation address is set
-    // (including deployment)
-    event Upgrade(address indexed implementation);
-
-    // ============ Constructor ============
-
-    /**
-     * @notice Validate the initial implementation and store it.
-     * Store the controller immutably.
-     * @param _initialImplementation Address of the initial implementation contract
-     * @param _controller Address of the controller who can upgrade the implementation
-     */
-    constructor(address _initialImplementation, address _controller) payable {
-        _setImplementation(_initialImplementation);
-        controller = _controller;
-    }
-
-    // ============ External Functions ============
-
-    /**
-     * @notice For all callers except the controller, return the current implementation address.
-     * If called by the Controller, update the implementation address
-     * to the address passed in the calldata.
-     * Note: this requires inline assembly because Solidity fallback functions
-     * do not natively take arguments or return values.
-     */
-    fallback() external payable {
-        if (msg.sender != controller) {
-            // if not called by the controller,
-            // load implementation address from storage slot zero
-            // and return it.
-            assembly {
-                mstore(0, sload(0))
-                return(0, 32)
-            }
-        } else {
-            // if called by the controller,
-            // load new implementation address from the first word of the calldata
-            address _newImplementation;
-            assembly {
-                _newImplementation := calldataload(0)
-            }
-            // set the new implementation
-            _setImplementation(_newImplementation);
-        }
-    }
-
-    // ============ Private Functions ============
-
-    /**
-     * @notice Perform checks on the new implementation address
-     * then upgrade the stored implementation.
-     * @param _newImplementation Address of the new implementation contract which will replace the old one
-     */
-    function _setImplementation(address _newImplementation) private {
-        // Require that the new implementation is different from the current one
-        require(implementation != _newImplementation, "!upgrade");
-        // Require that the new implementation is a contract
-        require(
-            Address.isContract(_newImplementation),
-            "implementation !contract"
-        );
-        // set the new implementation
-        implementation = _newImplementation;
-        emit Upgrade(_newImplementation);
-    }
-}