Add nix env

.envrc.example

@@ -0,0 +1,5 @@
+if ! has nix_direnv_version || ! nix_direnv_version 2.2.1; then
+  source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/2.2.1/direnvrc" "sha256-zelF0vLbEl5uaqrfIzbgNzJWGmLzCmYAkInj/LNxvKs="
+fi
+
+use flake

.github/workflows/ethereum.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Setup Node.js environment
         uses: actions/setup-node@v3
         with:
-          node-version: 16.18.1
+          node-version: 18.12.1
           cache: 'pnpm'
           cache-dependency-path: core/pnpm-lock.yaml
       - name: Install dependencies

.gitignore

@@ -15,3 +15,11 @@ node_modules/
 
 relaychain/
 .vscode
+
+.rustup
+.cargo
+
+.DS_Store
+
+.direnv
+.envrc

.gitmodules

@@ -0,0 +1,7 @@
+[submodule "core/packages/contracts/lib/forge-std"]
+	path = core/packages/contracts/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+	branch = v1.4.0
+[submodule "core/packages/contracts/lib/ds-test"]
+	path = core/packages/contracts/lib/ds-test
+	url = https://github.com/dapphub/ds-test

.husky/pre-commit

@@ -1,12 +1,17 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
+set -e
+
+echo 'Running pre-commit hook...'
+
 # check typos
-typos .
+chronic typos .
 
 # lint and format for core contracts and typescript codes
-cd core && pnpm lint && pnpm format && cd ..
+cd core && chronic pnpm lint && chronic pnpm format && cd ..
 
 # lint and format for relayer codes
-cd relayer && mage lint && go fmt ./...
+cd relayer && chronic mage lint && chronic go fmt ./...
 
+echo 'Pre-commit hook successful!'

README.md

@@ -20,6 +20,50 @@ Ethereum contracts and unit tests. See [core/packages/contracts/README.md](core/
 
 This component includes our end to end tests, that pull together all the above services and set them up easily through scripts for automated E2E tests. See [core/packages/test/README.md](core/packages/test/README.md).
 
+## Development
+
+We use the Nix package manager to provide a reproducible and maintainable developer environment.
+
+After [installing nix](https://nixos.org/download.html) Nix, enable [flakes](https://nixos.wiki/wiki/Flakes):
+
+```sh
+mkdir -p ~/.config/nix
+echo 'experimental-features = nix-command flakes' >> ~/.config/nix/nix.conf
+```
+
+(if you don't want to use flakes, you can instead pass the flag `--experimental-features nix-command flakes` to nix, eg.
+`nix --experimental-features 'nix-command flakes' develop`)
+
+Then activate a developer shell in the root of our repo, where [`flake.nix`](./flake.nix) is located:
+
+```sh
+nix develop
+```
+
+To ensure your code editor (such as VS Code) can execute tools in the nix shell, startup your editor within the
+interactive shell.
+
+Example for VS Code:
+
+```sh
+nix develop
+code .
+```
+
+The developer shell is bash by default. To preserve your existing shell:
+
+```sh
+nix develop --command $SHELL
+```
+
+To automatically enter the developer shell whenever you open the project, install
+[`direnv`](https://direnv.net/docs/installation.html) and use the template `.envrc`:
+
+```sh
+cp .envrc.example .envrc
+direnv allow
+````
+
 ## Security
 
 The security policy and procedures can be found in SECURITY.md.

core/README.md

@@ -2,31 +2,13 @@
 
 Packages:
 
-- Solidity Contracts
-- API client
-- Integration tests
+- [Solidity Contracts](packages/contracts/README.md)
+- [API Client](packages/api/README.md)
+- [Integration tests](packages/test/README.md)
 
-## Getting Started
-
-Install [nvm](https://github.com/nvm-sh/) and activate nodejs:
+See the [main README's Development section](../README.md#Development) for setup instructions.
 
-```bash
-nvm use
-```
-
-Install [pnpm](https://pnpm.io/):
-
-```bash
-corepack enable
-corepack prepare pnpm@7.14.2 --activate
-```
-
-Install [foundry](https://book.getfoundry.sh/getting-started/installation):
-
-```bash
-curl -L https://foundry.paradigm.xyz | bash
-foundryup
-```
+## Getting Started
 
 Install all dependencies:
 

core/package.json

@@ -2,7 +2,7 @@
   "name": "@snowbridge/core",
   "private": true,
   "engines": {
-    "node": "16.18.1",
+    "node": "v18.13.0",
     "pnpm": "7.14.2"
   },
   "scripts": {
@@ -16,7 +16,8 @@
     "coverage": "turbo run coverage"
   },
   "devDependencies": {
+    "husky": "^8.0.1",
     "turbo": "^1.6.3",
-    "husky": "^8.0.1"
+    "pnpm-deduplicate": "^0.4.1"
   }
 }

core/packages/api/package.json

@@ -14,7 +14,7 @@
     "lint": "eslint ."
   },
   "devDependencies": {
-    "@types/node": "^18.11.9",
+    "@types/node": "^18.13.0",
     "@typescript-eslint/eslint-plugin": "^5.42.0",
     "@typescript-eslint/parser": "^5.42.0",
     "eslint": "^8.26.0",

core/packages/contracts/.envrc-example

@@ -1,3 +1,5 @@
+source_up_if_exists
+
 export PRIVATE_KEY=0x4e9444a6efd6d42725a250b650a781da2737ea308c839eaccb0f7f3dbd2fea77
 export RANDAO_COMMIT_DELAY=3
 export RANDAO_COMMIT_EXP=8

core/packages/contracts/.gitignore

@@ -11,7 +11,6 @@ coverage/
 src/
 .vscode/
 deployments/
-lib/
 out/
 cache/
 broadcast/

core/packages/contracts/package.json

@@ -42,15 +42,16 @@
     "@types/keccak": "^3.0.1",
     "@types/lodash": "^4.14.186",
     "@types/mocha": "^10.0.0",
-    "@types/node": "^16.3.3",
+    "@types/node": "^18.13.0",
     "@types/secp256k1": "^4.0.3",
+    "@types/seedrandom": "^3.0.2",
     "@typescript-eslint/eslint-plugin": "^5.42.0",
     "@typescript-eslint/parser": "^5.42.0",
-    "@types/seedrandom": "^3.0.2",
     "bitfield": "^4.1.0",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "chai-bignumber": "^3.0.0",
+    "esbuild": "^0.17.4",
     "eslint": "^8.26.0",
     "eslint-config-prettier": "^8.5.0",
     "ethereumjs-abi": "^0.6.8",
@@ -78,8 +79,7 @@
     "tsconfig-paths": "^4.1.0",
     "typechain": "^8.1.0",
     "typescript": "^4.3.2",
-    "unique-filename": "^1.1.1",
-    "esbuild": "^0.17.4"
+    "unique-filename": "^1.1.1"
   },
   "dependencies": {
     "@ethersproject/bytes": "^5.0.0",

core/packages/contracts/scripts/configure-beefy.ts

@@ -10,7 +10,7 @@ import type {
 import fs from "fs"
 import path from "path"
 
-let endpoint = process.env.RELAYCHAIN_ENDPOINT || "ws://localhost:9944"
+let endpoint = process.env.RELAYCHAIN_ENDPOINT || "ws://127.0.0.1:9944"
 const beefyStartBlock = process.env.BEEFY_START_BLOCK ? parseInt(process.env.BEEFY_START_BLOCK) : 15
 const BeefyStateFile =
     process.env.BEEFY_STATE_FILE || path.join(process.env.output_dir!, "beefy-state.json")

core/packages/test/.envrc-example

@@ -1,6 +1,11 @@
+source_up_if_exists
+
 ## Config for E2E stack
 
-export POLKADOT_BIN=/path/to/polkadot/target/release/polkadot
+# export POLKADOT_VER=                # Relaychain version, default value: v0.9.30
+# export POLKADOT_BIN=                # Relaychain binary, default value: $POLKADOT_DIR/target/release/polkadot
+# export BEEFY_START_BLOCK=           # Start block to configure beefy client, default value: 15
+# export RELAYCHAIN_ENDPOINT=         # Relaychain endpoint, default value: ws://localhost:9944
 
 ## Run E2E on Ropsten
 
@@ -17,13 +22,3 @@ export POLKADOT_BIN=/path/to/polkadot/target/release/polkadot
 # export BEEFY_RELAY_ETH_KEY=         # Your Beefy relayer account private key
 # export PARACHAIN_RELAY_ETH_KEY=     # Your Parachain relayer account private key
 # export E2E_TEST_ETH_KEY=            # Your E2E test account private key
-
-# BEEFY_START_BLOCK=                  # Start block to configure beefy client, default value: 15
-
-# RELAYCHAIN_ENDPOINT=                # Relaychain endpoint, default value: ws://localhost:9944
-
-# POLKADOT_DIR=                       # Relaychain dir, default value: $root_dir/relaychain
-
-# POLKADOT_BIN=                       # Relaychain binary, default value: $POLKADOT_DIR/target/release/polkadot
-
-# POLKADOT_VER=                       # Relaychain version, default value: v0.9.30

core/packages/test/README.md

@@ -4,43 +4,16 @@ The E2E tests run against local deployments of the parachain, relayer, the ether
 
 ## Requirements
 
-* Ubuntu 20.04 or later. MacOS may work, but it's not currently a supported configuration.
-* Development environment for Rust and Substrate. See parachain [requirements](../../../parachain/README.md#requirements).
-* Development environment for the relay services. See setup [instructions](../../../relayer/README.md#Development).
-* `jq` - https://stedolan.github.io/jq/download/
-* geth - https://geth.ethereum.org/docs/install-and-build/installing-geth `go install github.com/ethereum/go-ethereum/cmd/geth@v1.10.23`
-* g++ (required for lodestar) is available in the `build-essential` package: `apt install build-essential`
-* sponge - Is available in the `moreutils` package.
-
-  ```bash
-  apt install moreutils
-  ```
-
-* direnv - https://direnv.net/
-
-* zombienet - Just download binary from [latest release](https://github.com/paritytech/zombienet/releases/), rename to `zombienet` and copy to $PATH
-
+The E2E stack can be run on any system that supports the [Nix](https://nixos.org/explore.html) package manager. This
+includes Linux, MacOS, and Windows (WSL2). See the [main README's Development section](../../../README.md#Development) for
+setup instructions. Ensure that you are in a Nix development shell for the remaining instructions.
 
 ## Setup
 
-### Install NPM dependencies
-
-Make sure to install dependencies for all packages (contracts, api, test):
-
-```bash
-cd ../.. && pnpm install
-```
-
 ### Configure testnet
 
 All required environment variables have reasonable defaults so normally there is no need to configure them. If necessary, you can override them with an `.envrc` file, using [.envrc-example](.envrc-example) as a template.
 
-e.g: if a `polkadot` binary already built and exist in your local host, override the `POLKADOT_BIN` variable in `.envrc` to the location of the binary:
-
-```
-POLKADOT_BIN=/home/sally/code/polkadot/target/release/polkadot
-```
-
 Once the `.envrc` has been created, let `direnv` load it automatically:
 
 ```bash
@@ -49,19 +22,21 @@ direnv allow
 
 ## Launch the testnet
 
-Run the following script
+Run the following script:
+
 ```bash
 scripts/start-services.sh
 ```
 
-Wait until the "Testnet has been initialized" message
+Wait until the "Testnet has been initialized" message.
 
 Go to polkadot-js and wait until the parachain has started producing blocks:
 https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A11144#/explorer
 
-You can see the relay chain by connecting to https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944#/explorer
+You can see the relay chain here:
+https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944#/explorer
 
-Confirm the block number is > 2
+Confirm the block number is > 2.
 
 ## E2E tests
 
@@ -76,6 +51,7 @@ pnpm test:bootstrap
 ```
 
 Now individual tests can be run, like the following:
+
 ```bash
 pnpm test:integration --grep 'should transfer ETH from Ethereum to Substrate \(basic channel\)'
 ```
@@ -103,7 +79,7 @@ The `start-services.sh` script writes the following logs:
 
 Sometimes during development tests will fail for transfers in the substrate->ethereum direction. If you see this, look in `parachain-relay.log` for the following error:
 ```
-{"@timestamp":"2022-08-26T15:10:50.263740077+02:00","args":"[--api ws://localhost:11144 --block 0xe2e21a61b017699961b6d87c6aecbae18f2ce0c89bd87e0e8b0d808c26e2aad3]","level":"error","message":"Failed to query events.","name":"snowbridge-query-events","stdErr":"Error: Metadata(IncompatibleMetadata)\n","stdOut":""}
+{"@timestamp":"2022-08-26T15:10:50.263740077+02:00","args":"[--api ws://127.0.0.1:11144 --block 0xe2e21a61b017699961b6d87c6aecbae18f2ce0c89bd87e0e8b0d808c26e2aad3]","level":"error","message":"Failed to query events.","name":"snowbridge-query-events","stdErr":"Error: Metadata(IncompatibleMetadata)\n","stdOut":""}
 ```
 
 That means a dependency of the relayer has obsolete parachain metadata and needs to be refreshed. Please refer [here](../../../parachain/README.md#Chain_metadata) for steps to fix.

core/packages/test/config/beacon-relay.json

@@ -1,7 +1,7 @@
 {
   "source": {
     "beacon": {
-      "endpoint": "http://localhost:9596",
+      "endpoint": "http://127.0.0.1:9596",
       "spec": {
         "minimal": {
           "slotsInEpoch": 4,
@@ -17,7 +17,7 @@
   },
   "sink": {
     "parachain": {
-      "endpoint": "ws://localhost:11144",
+      "endpoint": "ws://127.0.0.1:11144",
       "maxWatchedExtrinsics": 32
     }
   }

core/packages/test/config/beefy-relay.json

@@ -1,14 +1,14 @@
 {
   "source": {
     "polkadot": {
-      "endpoint": "ws://localhost:9944"
+      "endpoint": "ws://127.0.0.1:9944"
     },
     "beefy-activation-block": 0,
     "fast-forward-depth": 20
   },
   "sink": {
     "ethereum": {
-      "endpoint": "ws://localhost:8546",
+      "endpoint": "ws://127.0.0.1:8546",
       "gas-limit": 5000000
     },
     "start-block": 0,