Run forge tests in CI (#1355)

* Move foundry workflow so it is picked up by github

* Require ISM in router config

Co-authored-by: Asa Oines <asaoines@gmail.com>

.github/workflows/node.yml

@@ -106,5 +106,13 @@ jobs:
           path: ./*
           key: ${{ github.sha }}
 
+      - name: Install Foundry
+        uses: onbjerg/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Install dependencies
+        run: cd solidity && forge install
+
       - name: core
         run: yarn workspace @hyperlane-xyz/core run test

solidity/contracts/HyperlaneConnectionClient.sol

@@ -18,7 +18,7 @@ abstract contract HyperlaneConnectionClient is
 
     IMailbox public mailbox;
     // Interchain Gas Paymaster contract. The relayer associated with this contract
-    // must be willing to relay messages dispatched from the current Outbox contract,
+    // must be willing to relay messages dispatched from the current Mailbox contract,
     // otherwise payments made to the paymaster will not result in relayed messages.
     IInterchainGasPaymaster public interchainGasPaymaster;
 
@@ -136,7 +136,7 @@ abstract contract HyperlaneConnectionClient is
     }
 
     /**
-     * @notice Modify the contract the Application uses to validate Inbox contracts
+     * @notice Modify the contract the Application uses to validate Mailbox contracts
      * @param _mailbox The address of the mailbox contract
      */
     function _setMailbox(address _mailbox) internal onlyContract(_mailbox) {

solidity/contracts/Mailbox.sol

@@ -211,7 +211,7 @@ contract Mailbox is
 
     /**
      * @notice Returns a checkpoint representing the current merkle tree.
-     * @return root The root of the Outbox's merkle tree.
+     * @return root The root of the Mailbox's merkle tree.
      * @return index The index of the last element in the tree.
      */
     function latestCheckpoint() public view returns (bytes32, uint32) {

solidity/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
+        // Transfer ownership of the contract to `msg.sender`
-        _transferOwnership(_owner);
+        __HyperlaneConnectionClient_initialize(
-        // Set the addresses for the Mailbox and IGP
+            _mailbox,
-        // Alternatively, this could be done later in an initialize method
+            _interchainGasPaymaster,
-        _setMailbox(_mailbox);
+            _interchainSecurityModule
-        _setInterchainGasPaymaster(_interchainGasPaymaster);
+        );
     }
 
     function dispatch(uint32 _destinationDomain, Call[] calldata calls)

solidity/contracts/middleware/InterchainQueryRouter.sol

@@ -32,16 +32,16 @@ contract InterchainQueryRouter is
     );
 
     function initialize(
-        address _owner,
         address _mailbox,
-        address _interchainGasPaymaster
+        address _interchainGasPaymaster,
+        address _interchainSecurityModule
     ) public initializer {
-        // Transfer ownership of the contract to deployer
+        // Transfer ownership of the contract to `msg.sender`
-        _transferOwnership(_owner);
+        __HyperlaneConnectionClient_initialize(
-        // Set the addresses for the Mailbox and IGP
+            _mailbox,
-        // Alternatively, this could be done later in an initialize method
+            _interchainGasPaymaster,
-        _setMailbox(_mailbox);
+            _interchainSecurityModule
-        _setInterchainGasPaymaster(_interchainGasPaymaster);
+        );
     }
 
     /**

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

@@ -20,15 +20,15 @@ contract LiquidityLayerRouter is Router {
     event LiquidityLayerAdapterSet(string indexed bridge, address adapter);
 
     function initialize(
-        address _owner,
         address _mailbox,
-        address _interchainGasPaymaster
+        address _interchainGasPaymaster,
+        address _interchainSecurityModule
     ) public initializer {
         __HyperlaneConnectionClient_initialize(
             _mailbox,
-            _interchainGasPaymaster
+            _interchainGasPaymaster,
+            _interchainSecurityModule
         );
-        _transferOwnership(_owner);
     }
 
     function dispatchWithTokens(

solidity/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(

solidity/contracts/test/TestSendReceiver.sol

@@ -15,12 +15,12 @@ contract TestSendReceiver is IMessageRecipient {
     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

solidity/lib/forge-std/.github/workflows/tests.yml

@@ -1,26 +0,0 @@
-name: Tests
-on: [push, pull_request]
-
-jobs:
-  check:
-    name: Foundry project
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: recursive
-
-      - name: Install Foundry
-        uses: onbjerg/foundry-toolchain@v1
-        with:
-          version: nightly
-
-      - name: Install dependencies
-        run: forge install
-      - name: Run tests
-        run: forge test -vvv
-      - name: Build Test with older solc versions
-        run: |
-          forge build --contracts src/Test.sol --use solc:0.8.0
-          forge build --contracts src/Test.sol --use solc:0.7.0
-          forge build --contracts src/Test.sol --use solc:0.6.0

solidity/package.json

@@ -47,7 +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"
 }

solidity/test/InterchainAccountRouter.t.sol

@@ -2,17 +2,16 @@
 pragma solidity ^0.8.13;
 
 import "forge-std/Test.sol";
-import "../contracts/mock/MockOutbox.sol";
+import "../contracts/mock/MockMailbox.sol";
-import "../contracts/mock/MockInbox.sol";
+import "../contracts/HyperlaneConnectionClient.sol";
-import "../contracts/AbacusConnectionManager.sol";
+import "../contracts/mock/MockHyperlaneEnvironment.sol";
 import {TypeCasts} from "../contracts/libs/TypeCasts.sol";
 import "../contracts/test/TestRecipient.sol";
 import "../contracts/middleware/InterchainAccountRouter.sol";
 import {OwnableMulticall, Call} from "../contracts/OwnableMulticall.sol";
 
 contract InterchainAccountRouterTest is Test {
-    MockOutbox outbox;
+    MockHyperlaneEnvironment environment;
-    MockInbox inbox;
 
     uint32 originDomain = 1;
     uint32 remoteDomain = 2;
@@ -20,20 +19,10 @@ contract InterchainAccountRouterTest is Test {
     InterchainAccountRouter originRouter;
     InterchainAccountRouter remoteRouter;
 
-    AbacusConnectionManager originManager;
-    AbacusConnectionManager remoteManager;
-
     TestRecipient recipient;
 
     function setUp() public {
-        inbox = new MockInbox();
+        environment = new MockHyperlaneEnvironment(originDomain, remoteDomain);
-        outbox = new MockOutbox(originDomain, address(inbox));
-
-        originManager = new AbacusConnectionManager();
-        remoteManager = new AbacusConnectionManager();
-
-        originManager.setOutbox(address(outbox));
-        remoteManager.enrollInbox(remoteDomain, address(inbox));
 
         recipient = new TestRecipient();
 
@@ -41,14 +30,14 @@ contract InterchainAccountRouterTest is Test {
         remoteRouter = new InterchainAccountRouter();
 
         originRouter.initialize(
-            address(this),
+            address(environment.mailboxes(originDomain)),
-            address(originManager),
+            address(environment.igps(originDomain)),
-            address(0)
+            address(environment.isms(originDomain))
         );
         remoteRouter.initialize(
-            address(this),
+            address(environment.mailboxes(remoteDomain)),
-            address(remoteManager),
+            address(environment.igps(remoteDomain)),
-            address(0)
+            address(environment.isms(remoteDomain))
         );
 
         originRouter.enrollRemoteRouter(
@@ -68,7 +57,7 @@ contract InterchainAccountRouterTest is Test {
             data: abi.encodeCall(recipient.fooBar, (1, "Test"))
         });
         originRouter.dispatch(remoteDomain, calls);
-        inbox.processNextPendingMessage();
+        environment.processNextPendingMessage();
         assertEq(recipient.lastCallMessage(), "Test");
     }
 }

solidity/test/LiquidityLayerRouter.t.sol

@@ -53,16 +53,15 @@ contract LiquidityLayerRouterTest is Test {
             destinationDomain
         );
 
-        // TODO: set IGP?
         originLiquidityLayerRouter.initialize(
-            address(this),
+            address(testEnvironment.mailboxes(originDomain)),
-            address(testEnvironment.connectionManager(originDomain)),
+            address(testEnvironment.igps(originDomain)),
-            address(0)
+            address(testEnvironment.isms(originDomain))
         );
         destinationLiquidityLayerRouter.initialize(
-            address(this),
+            address(testEnvironment.mailboxes(destinationDomain)),
-            address(testEnvironment.connectionManager(destinationDomain)),
+            address(testEnvironment.igps(destinationDomain)),
-            address(0)
+            address(testEnvironment.isms(destinationDomain))
         );
 
         originLiquidityLayerRouter.enrollRemoteRouter(

solidity/test/Messaging.t.sol

@@ -2,16 +2,16 @@
 pragma solidity ^0.8.13;
 
 import "forge-std/Test.sol";
-import "../contracts/mock/MockOutbox.sol";
+import "../contracts/mock/MockMailbox.sol";
-import "../contracts/mock/MockInbox.sol";
+import "../contracts/mock/MockMailbox.sol";
 import "../contracts/test/TestRecipient.sol";
-import "../interfaces/IInbox.sol";
+import "../interfaces/IMailbox.sol";
-import "../interfaces/IOutbox.sol";
+import "../interfaces/IMailbox.sol";
 import {TypeCasts} from "../contracts/libs/TypeCasts.sol";
 
 contract MessagingTest is Test {
-    MockOutbox outbox;
+    MockMailbox originMailbox;
-    MockInbox inbox;
+    MockMailbox remoteMailbox;
 
     TestRecipient receiver;
 
@@ -19,19 +19,20 @@ contract MessagingTest is Test {
     uint32 remoteDomain = 2;
 
     function setUp() public {
-        inbox = new MockInbox();
+        originMailbox = new MockMailbox(originDomain);
-        outbox = new MockOutbox(originDomain, address(inbox));
+        remoteMailbox = new MockMailbox(remoteDomain);
+        originMailbox.addRemoteMailbox(remoteDomain, remoteMailbox);
 
         receiver = new TestRecipient();
     }
 
     function testSendMessage(string calldata _message) public {
-        outbox.dispatch(
+        originMailbox.dispatch(
             remoteDomain,
             TypeCasts.addressToBytes32(address(receiver)),
             bytes(_message)
         );
-        inbox.processNextPendingMessage();
+        remoteMailbox.processNextInboundMessage();
         assertEq(string(receiver.lastData()), _message);
     }
 }

typescript/sdk/src/core/TestCoreDeployer.ts

@@ -1,10 +1,12 @@
 import { ethers } from 'ethers';
 
 import {
+  MultisigIsm,
   TestIsm__factory,
   TestMailbox,
   TestMailbox__factory,
 } from '@hyperlane-xyz/core';
+import { types } from '@hyperlane-xyz/utils';
 
 import { chainMetadata } from '../consts/chainMetadata';
 import { HyperlaneCoreDeployer } from '../deploy/core/HyperlaneCoreDeployer';
@@ -51,12 +53,10 @@ export class TestCoreDeployer<
     super(multiProvider, configs, testCoreFactories);
   }
 
-  // skip proxying
+  // deploy a test ISM in place of a multisig ISM
-  async deployMailbox<LocalChain extends TestChain>(
+  async deployMultisigIsm<LocalChain extends TestChain>(
     chain: LocalChain,
-  ): Promise<ProxiedContract<TestMailbox, BeaconProxyAddresses>> {
+  ): Promise<MultisigIsm> {
-    const localDomain = chainMetadata[chain].id;
-
     const testIsm = await this.deployContractFromFactory(
       chain,
       testCoreFactories.testIsm,
@@ -64,9 +64,18 @@ export class TestCoreDeployer<
       [],
     );
     await testIsm.setAccept(true);
+    return testIsm as unknown as MultisigIsm;
+  }
+
+  // skip proxying
+  async deployMailbox<LocalChain extends TestChain>(
+    chain: LocalChain,
+    defaultIsmAddress: types.Address,
+  ): Promise<ProxiedContract<TestMailbox, BeaconProxyAddresses>> {
+    const localDomain = chainMetadata[chain].id;
 
     const mailbox = await this.deployContract(chain, 'mailbox', [localDomain]);
-    await mailbox.initialize(testIsm.address);
+    await mailbox.initialize(defaultIsmAddress);
     return new ProxiedContract(mailbox, {
       kind: ProxyKind.UpgradeBeacon,
       proxy: mailbox.address,

typescript/sdk/src/deploy/middleware/LiquidityLayerRouterDeployer.ts

@@ -80,7 +80,11 @@ export class LiquidityLayerDeployer<
     const initCalldata =
       LiquidityLayerRouter__factory.createInterface().encodeFunctionData(
         'initialize',
-        [config.owner, config.mailbox, config.interchainGasPaymaster],
+        [
+          config.mailbox,
+          config.interchainGasPaymaster,
+          config.interchainSecurityModule,
+        ],
       );
     const router = await this.deployContract(chain, 'router', [], {
       create2Salt: this.create2salt,

typescript/sdk/src/deploy/middleware/deploy.ts

@@ -45,7 +45,11 @@ export class InterchainAccountDeployer<
     const initCalldata =
       InterchainAccountRouter__factory.createInterface().encodeFunctionData(
         'initialize',
-        [config.owner, config.mailbox, config.interchainGasPaymaster],
+        [
+          config.mailbox,
+          config.interchainGasPaymaster,
+          config.interchainSecurityModule,
+        ],
       );
     const router = await this.deployContract(chain, 'router', [], {
       create2Salt: this.create2salt + 'router',
@@ -86,7 +90,11 @@ export class InterchainQueryDeployer<
     const initCalldata =
       InterchainQueryRouter__factory.createInterface().encodeFunctionData(
         'initialize',
-        [config.owner, config.mailbox, config.interchainGasPaymaster],
+        [
+          config.mailbox,
+          config.interchainGasPaymaster,
+          config.interchainSecurityModule,
+        ],
       );
     const router = await this.deployContract(chain, 'router', [], {
       create2Salt: this.create2salt + 'router',

typescript/sdk/src/router.ts

@@ -23,7 +23,7 @@ export type RouterFactories<RouterContract extends Router = Router> =
 export type ConnectionClientConfig = {
   mailbox: types.Address;
   interchainGasPaymaster: types.Address;
-  interchainSecurityModule?: types.Address;
+  interchainSecurityModule: types.Address;
 };
 
 export { Router } from '@hyperlane-xyz/core';