Unit Tests - NomadBase, Replica, CI

.github/workflows/tests.yml

@@ -10,12 +10,20 @@ jobs:
         uses: onbjerg/foundry-toolchain@v1
         with:
           version: nightly
-
       - run: |
           yarn install
       - run: |
           yarn lint
+      - run: |
+          yarn build:accumulator-cli
       - run: |
           yarn build
       - run: |
           yarn test
+
+      - name: "Static Analysis: Core"
+        uses: crytic/[email protected]
+        id: slither
+        continue-on-error: true
+        with:
+          target: "packages/contracts-core"

.gitignore

@@ -3,6 +3,7 @@ yarn-error.log
 **/tsconfig.tsbuildinfo
 dist/
 cache/
+scripts/accumulator-cli
 
 .pnp.*
 .yarn/*

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std

foundry.toml

@@ -1,16 +1,35 @@
 [default]
-solc_version = '0.7.6'
-optimizer_runs = 999999
-bytecodeHash = 'none'
+solc_version = '0.7.6'        # Version of solc that we use
+remappings = [                # Libraries that we use from node_modules and are used by the smart contracts
+"@openzeppelin/=node_modules/@openzeppelin/",
+"@summa-tx/=node_modules/@summa-tx/",
+"@nomad-xyz/=packages/"
+]
+offline = true                # Disable downloading of missing solc version(s)
+optimizer = true              # Enable or disable the solc optimizer
+optimizer_runs = 999999       # The number of optimizer runs
+verbosity = 3                 # The verbosity of tests
+bytecode_hash = "none"        # For deterministic code
+block_timestamp = 1622400000  # Timestamp for tests (non-zero)
 
 [core]
 src = 'packages/contracts-core/contracts'
+test = 'packages/contracts-core/contracts/foundry-tests'
 out = 'packages/contracts-core/foundry_artifacts'
+ffi = true
+
+[core-ci]
+src = 'packages/contracts-core/contracts'
+test = 'packages/contracts-core/contracts/foundry-tests'
+out = 'packages/contracts-core/foundry_artifacts'
+fuzz-runs = 10_000
 
 [router]
 src = 'packages/contracts-router/contracts'
 out = 'packages/contracts-router/foundry_artifacts'
 
 [bridge]
 src = 'packages/contracts-bridge/contracts'
-out = 'packages/contracts-bridge/foundry_artifacts'
+out = 'packages/contracts-bridge/foundry_artifacts'
+
+

package.json

@@ -15,9 +15,10 @@
     "packages/indexer"
   ],
   "scripts": {
-    "bootstrap": "yarn workspaces foreach -Apv --exclude @nomad-xyz/local-environment --exclude @nomad-xyz/monitor run bootstrap",
-    "build": "yarn workspaces foreach -Atv  --exclude @nomad-xyz/local-environment --exclude @nomad-xyz/monitor run build",
-    "compile": "yarn workspaces foreach -Apv --exclude @nomad-xyz/local-environment --exclude @nomad-xyz/monitor run compile",
+    "compile": "yarn workspaces foreach -Apv --exclude @nomad-xyz/deploy --exclude @nomad-xyz/local-environment --exclude @nomad-xyz/monitor run compile",
+    "bootstrap": "yarn build:accumulator-cli && yarn workspaces foreach -Atv --exclude @nomad-xyz/deploy --exclude @nomad-xyz/local-environment --exclude @nomad-xyz/monitor run bootstrap",
+    "build": "yarn build:accumulator-cli && yarn workspaces foreach -Atv --exclude @nomad-xyz/deploy --exclude @nomad-xyz/local-environment --exclude @nomad-xyz/monitor run build",
+    "build:accumulator-cli": "cd scripts && ./build-acli.sh",
     "contracts-bridge": "yarn workspace @nomad-xyz/contracts-bridge",
     "contracts-core": "yarn workspace @nomad-xyz/contracts-core",
     "contracts-router": "yarn workspace @nomad-xyz/contracts-router",
@@ -31,7 +32,8 @@
     "sdk": "yarn workspace @nomad-xyz/sdk",
     "sdk-bridge": "yarn workspace @nomad-xyz/sdk-bridge",
     "sdk-govern": "yarn workspace @nomad-xyz/sdk-govern",
-    "test": "yarn workspaces foreach -Apv --exclude @nomad-xyz/local-environment run test"
+    "test": "yarn workspaces foreach -Apv --exclude @nomad-xyz/deploy  --exclude @nomad-xyz/local-environment run test",
+    "gen-proof": "scripts/accumulator-cli"
   },
   "packageManager": "[email protected]"
 }

packages/contracts-core/.env.example

@@ -1,2 +1,3 @@
 ETHERSCAN_API_KEY=
-INFURA_API_KEY=
+FOUNDRY_PROFILE=core
+

packages/contracts-core/.gas-snapshot

@@ -0,0 +1,34 @@
+HomeTest:test_committedRoot() (gas: 7928)
+HomeTest:test_dispatchRejectBigMessage() (gas: 29181)
+HomeTest:test_homeDomain() (gas: 8010)
+HomeTest:test_improperUpdate() (gas: 46103)
+HomeTest:test_nonUpdaterManagerCannotSetUpdater() (gas: 11839)
+HomeTest:test_onlyUpdaterManagerSetUpdater() (gas: 19666)
+HomeTest:test_succesfulDispatch() (gas: 216412)
+HomeTest:test_successfulDispatchAndUpdate() (gas: 228379)
+NomadBaseTest:test_acceptUpdaterSignature() (gas: 27469)
+NomadBaseTest:test_failInitializeTwice() (gas: 13452)
+NomadBaseTest:test_homeDomainHash() (gas: 10078)
+NomadBaseTest:test_ownerIsContractCreator() (gas: 7631)
+NomadBaseTest:test_rejectNonUpdaterSignature() (gas: 27434)
+NomadBaseTest:test_stateIsActiveAfterInit() (gas: 7679)
+ReplicaTest:test_acceptLeafCorrectProof() (gas: 141632)
+ReplicaTest:test_acceptReplicaUpdate() (gas: 66587)
+ReplicaTest:test_acceptableRoot() (gas: 10030)
+ReplicaTest:test_notProcessLegacyProvenMessageEmptyAddress() (gas: 46689)
+ReplicaTest:test_notProcessLegacyProvenMessageRevertingHandlers1() (gas: 49050)
+ReplicaTest:test_notProcessLegacyProvenMessageRevertingHandlers2() (gas: 49200)
+ReplicaTest:test_notProcessLegacyProvenMessageRevertingHandlers3() (gas: 49110)
+ReplicaTest:test_notProcessLegacyProvenMessageRevertingHandlers4() (gas: 49072)
+ReplicaTest:test_notProcessLegacyWrongDestination() (gas: 175511)
+ReplicaTest:test_notProcessUnprovenMessage() (gas: 155331)
+ReplicaTest:test_processLegacyProvenMessageReturnZeroHandler() (gas: 55611)
+ReplicaTest:test_processProvenMessage() (gas: 127896)
+ReplicaTest:test_proveAndProcess() (gas: 130253)
+ReplicaTest:test_rejectLeafWrongProof() (gas: 126638)
+ReplicaTest:test_rejectReplicaNonCurrentUpdate() (gas: 17030)
+ReplicaTest:test_rejectReplicaUpdateInvalidSig() (gas: 27635)
+ReplicaTest:test_setConfirmationOnlyOwner() (gas: 39771)
+ReplicaTest:test_setOptimisticTimeoutOnlyOwner() (gas: 18585)
+ReplicaTest:test_setUpdaterOnlyOwner() (gas: 19624)
+ReplicaTest:test_updateProveAndProcessMessage() (gas: 150113)

packages/contracts-core/.gitignore

@@ -1,4 +1,5 @@
-node_modules/
+/node_modules
+!/node_modules/
 cache/
 artifacts/
 coverage/
@@ -7,4 +8,5 @@ coverage.json
 src.ts/
 src/
 dist/
-foundry_artifacts/
+foundry_artifacts/
+scripts/accumulator-cli

packages/contracts-core/README.md

@@ -1,12 +1,30 @@
-## Nomad Core
+## Nomad Core 𓀃
 
 Solidity implementations of the core Nomad protocol.
 
 ### Setup
 
-- See repo setup
-- `brew install jq`   OR   `sudo apt-get install jq`
+- `yarn bootstrap`: `yarn clean` and `yarn build`
 
 ### Build
 
-- `yarn build`
+- `yarn build`: compile smart contracts and create definitions for the SDK
+
+### Test
+
+For testing, we use [Foundry](https://getfoundry.sh/).
+
+- Run `yarn build:accumulator-cli` from the root directory of the monorepo. It will build a rust-based cli tool that creates Sparse Merkle Tree proofs for arbitrary data. It's used in our testing suite via the `--ffi` flag for Forge. The binary is built in thre `/scripts` top-level directory of the monorepo
+- `yarn test` will run all tests. Note that `--ffi` is enabled by default,
+- `yarn snapshot --check` will run the test suite and verify that it doesn't produce a different gas snapshot from the existing (`.gas-snapshot`)
+- `yarn snapshot` will create a new `.gas-snapshot`. You can inspect the different gas usage via `git diff`
+- `yarn gen-proof` will execute the `accumulator-cli` binary
+
+### Static Analysis
+
+The monorepo is configured to run [slither](https://github.com/crytic/slither) with every PR. We suggest all contributors to use slither while developing, to avoid common mistakes.
+
+- Install Slither
+- Run `yarn test:static-analyze`
+
+We use a `yarn command` because we need to link the top-level `node_modules` directory in the `core-contracts` package. It's a known [issue](https://github.com/crytic/slither/issues/852) for which the workaround is to link the directory.

packages/contracts-core/contracts/test/Home.t.sol

@@ -0,0 +1,124 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.6.11;
+
+import {Home} from "../Home.sol";
+import {NomadTestWithUpdaterManager} from "./utils/NomadTest.sol";
+import {IUpdaterManager} from "../interfaces/IUpdaterManager.sol";
+import {Message} from "../libs/Message.sol";
+
+
+contract HomeTest is NomadTestWithUpdaterManager {
+    Home home;
+
+    function setUp() public override {
+        super.setUp();
+        home = new Home(homeDomain);
+        home.initialize(IUpdaterManager(address(updaterManager)));
+        updaterManager.setHome(address(home));
+        vm.prank(address(updaterManager));
+
+    }
+
+    function test_homeDomain() public {
+        assertEq(
+            keccak256(abi.encodePacked(homeDomain, "NOMAD")),
+            home.homeDomainHash()
+        );
+    }
+
+    function test_onlyUpdaterManagerSetUpdater() public {
+        vm.prank(address(updaterManager));
+        home.setUpdater(vm.addr(420));
+    }
+
+    function test_nonUpdaterManagerCannotSetUpdater() public {
+        vm.prank(vm.addr(40123));
+        vm.expectRevert("!updaterManager");
+        home.setUpdater(vm.addr(420));
+    }
+
+    function test_committedRoot() public{
+      bytes32 emptyRoot;
+      assertEq(abi.encode(home.committedRoot()), abi.encode(emptyRoot));
+    }
+
+    event Dispatch(
+        bytes32 indexed messageHash,
+        uint256 indexed leafIndex,
+        uint64 indexed destinationAndNonce,
+        bytes32 committedRoot,
+        bytes message
+    );
+
+    function test_succesfulDispatch() public {
+        bytes32 recipient = bytes32(uint256(uint160(vm.addr(1505))));
+        address sender = vm.addr(1555);
+        bytes memory messageBody = bytes("hey buddy");
+        uint32 nonce = home.nonces(remoteDomain);
+        bytes memory message = Message.formatMessage(
+          homeDomain,
+          bytes32(uint256(uint160(sender))),
+          nonce,
+          remoteDomain,
+          recipient,
+          messageBody
+        );
+        bytes32 messageHash = keccak256(message);
+        vm.expectEmit(true, true, true, true);
+        emit Dispatch(messageHash, 0,(uint64(remoteDomain) << 32) | nonce, home.committedRoot(), message);
+        vm.prank(sender);
+        home.dispatch(remoteDomain, recipient, messageBody);
+        assert(home.queueContains(home.root()));
+    }
+
+    function test_dispatchRejectBigMessage() public {
+        bytes32 recipient = bytes32(uint256(uint160(vm.addr(1505))));
+        address sender = vm.addr(1555);
+        bytes memory messageBody = new bytes(2 * 2**10 + 1);
+        uint32 nonce = home.nonces(remoteDomain);
+        bytes memory message = Message.formatMessage(
+          homeDomain,
+          bytes32(uint256(uint160(sender))),
+          nonce,
+          remoteDomain,
+          recipient,
+          messageBody
+        );
+        vm.prank(sender);
+        vm.expectRevert("msg too long");
+        home.dispatch(remoteDomain, recipient, messageBody);
+    }
+
+    event ImproperUpdate(bytes32 oldRoot, bytes32 newRoot, bytes signature);
+
+    function test_improperUpdate() public {
+        bytes32 newRoot = "new root";
+        bytes32 oldRoot = home.committedRoot();
+        bytes memory sig = signHomeUpdate(updaterPK, oldRoot, newRoot);
+        vm.expectEmit(false, false, false, true);
+        emit ImproperUpdate(oldRoot, newRoot, sig);
+        home.improperUpdate(oldRoot, newRoot, sig);
+    }
+
+    event Update(
+        uint32 indexed homeDomain,
+        bytes32 indexed oldRoot,
+        bytes32 indexed newRoot,
+        bytes signature
+    );
+
+    function test_successfulDispatchAndUpdate() public {
+        bytes memory messageBody = '';
+        uint32 destinationDomain = remoteDomain;
+        bytes32 recipient = bytes32(uint256(uint160(vm.addr(1505))));
+        home.dispatch(destinationDomain, recipient, messageBody);
+        bytes32 newRoot = home.root();
+        bytes32 oldRoot = home.committedRoot();
+        bytes memory sig = signHomeUpdate(updaterPK, oldRoot, newRoot);
+        vm.expectEmit(true, true, true, true);
+        emit Update(homeDomain, oldRoot, newRoot, sig);
+        home.update(oldRoot, newRoot, sig);
+        assertEq(newRoot, home.committedRoot());
+    }
+
+}