Add nix env

.gitignore

@@ -15,3 +15,8 @@ node_modules/
 
 relaychain/
 .vscode
+
+.rustup
+.cargo
+
+.DS_Store

README.md

@@ -20,6 +20,25 @@ 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 repeatable and maintainable developer environment.
+
+After [installing](https://nixos.org/download.html) Nix, activate a developer shell here in the root of our repo, where `shell.nix` is located:
+
+```
+nix-shell
+```
+
+To ensure your code editor (such as VS code) can execute tools in the nix env, startup your editor within the interactive shell.
+
+Example for VS Code:
+
+```
+nix-shell
+code .
+```
+
 ## Security
 
 The security policy and procedures can be found in SECURITY.md.

core/package.json

@@ -2,7 +2,7 @@
   "name": "@snowbridge/core",
   "private": true,
   "engines": {
-    "node": "16.18.1",
+    "node": "v18.12.1",
     "pnpm": "7.14.2"
   },
   "scripts": {
@@ -16,13 +16,8 @@
     "coverage": "turbo run coverage"
   },
   "devDependencies": {
+    "husky": "^8.0.1",
     "turbo": "^1.6.3",
-    "husky": "^8.0.1"
-  },
-  "overrides": {
-    "@polkadot-api@9.6.2>@polkadot/util": "10.1.11",
-    "@polkadot-api@9.6.2>@polkadot/util-crypto": "10.1.11",
-    "@polkadot-types@9.6.2>@polkadot/util": "10.1.11",
-    "@polkadot-types@9.6.2>@polkadot/util-crypto": "10.1.11"
+    "pnpm-deduplicate": "^0.4.1"
   }
 }

core/packages/test/README.md

@@ -4,24 +4,19 @@ 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.
+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).
 
-  ```bash
-  apt install moreutils
-  ```
+Make sure to [download](https://nixos.org/download.html) and install the nix package manager.
 
-* direnv - https://direnv.net/
+## Setup
 
-* zombienet - Just download binary from [latest release](https://github.com/paritytech/zombienet/releases/), rename to `zombienet` and copy to $PATH
+### Activate nix developer shell
 
+In the root directory of our repository, where `shell.nix` is located, activate a developer shell:
 
-## Setup
+```
+nix-shell
+```
 
 ### Install NPM dependencies
 

core/packages/test/package.json

@@ -13,16 +13,16 @@
     "test:bootstrap": "mocha --timeout 600000 --parallel --grep Bootstrap --exit"
   },
   "devDependencies": {
-    "@polkadot/api": "9.11.1",
-    "@polkadot/types": "9.11.1",
-    "@polkadot/util": "10.2.3",
-    "@polkadot/util-crypto": "10.2.3",
     "@chainsafe/lodestar": "1.3.0",
+    "@polkadot/api": "^9.12.1",
+    "@polkadot/types": "9.11.1",
     "@types/keccak": "^3.0.1",
     "@types/node": "^16.4.2",
     "@types/yargs": "^17.0.2",
+    "@zombienet/cli": "^1.3.29",
     "bignumber.js": "^9.0.0",
     "bn.js": "^5.2.0",
+    "c-kzg": "^1.0.7",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "chai-bignumber": "^3.0.0",
@@ -32,12 +32,9 @@
     "keccak": "^3.0.2",
     "mocha": "^8.1.3",
     "node-fetch": "^3.3.0",
-    "polkadot-launch": "2.3.0",
     "rlp": "^2.2.6",
     "ts-node": "^10.1.0",
     "typescript": "^4.3.5",
-    "web3": "^1.8.0",
-    "web3-utils": "^1.8.0",
     "ws": "^7.4.6",
     "yargs": "^17.0.1"
   }

core/packages/test/scripts/deploy-ethereum.sh

@@ -38,12 +38,7 @@ start_lodestar() {
             -H 'Content-Type: application/json' \
             -d '{"jsonrpc": "2.0", "id": "1", "method": "eth_getBlockByNumber","params": ["0x0", false]}' | jq -r '.result.hash')
 
-        if [[ "$OSTYPE" =~ ^darwin ]]
-        then
-            timestamp=$(gdate -d'+10second' +%s)
-        else
-            timestamp=$(date -d'+10second' +%s)
-        fi
+        timestamp=$(date -d'+10second' +%s)
 
         npx lodestar dev \
             --genesisValidators 8 \

core/packages/test/scripts/deploy-polkadot.sh

@@ -5,8 +5,8 @@ source scripts/set-env.sh
 
 generate_chain_spec() {
     echo "Generating chain specification"
-    "$parachain_bin" build-spec --chain "$parachain_runtime" --disable-default-bootnode > "$output_dir/spec.json"  
-    
+    "$parachain_bin" build-spec --chain "$parachain_runtime" --disable-default-bootnode > "$output_dir/spec.json"
+
     initial_beacon_block=""
     while [ -z "$initial_beacon_block" ] || [ "$initial_beacon_block" == "0x0000000000000000000000000000000000000000000000000000000000000000" ]
     do
@@ -57,32 +57,8 @@ wait_start() {
     scripts/wait-for-it.sh -t 120 localhost:13144
 }
 
-polkadot_launch() {
-    generate_chain_spec
-    jq \
-        --arg polkadot "$(realpath $relaychain_bin)" \
-        --arg bin "$parachain_bin" \
-        --arg spec "$output_dir/spec.json" \
-        --arg test_collator "$(realpath $test_collator_bin)" \
-        --arg test_spec "$output_dir/test_spec.json" \
-        ' .relaychain.bin = $polkadot
-        | .parachains[0].bin = $bin
-        | .parachains[0].chain = $spec
-        | .parachains[1].bin = $test_collator
-        | .parachains[1].chain = $test_spec
-        ' \
-        config/launch-config.json \
-        > "$output_dir/launch-config.json"
-    npx polkadot-launch "$output_dir/launch-config.json" 2>&1 &
-    wait_start
-}
-
-zombienet_launch() {
+deploy_polkadot() {
     generate_chain_spec
-    zombienet spawn config/launch-config.toml --provider=native 2>&1 &
+    node_modules/.bin/zombienet spawn config/launch-config.toml --provider=native 2>&1 &
     wait_start
 }
-
-deploy_polkadot() {
-    zombienet_launch
-}

core/packages/test/scripts/hack-ethereum.sh

@@ -5,14 +5,8 @@ source scripts/set-env.sh
 
 hack_lodestar() {
    preset_minimal_phase0_file="$core_dir/node_modules/.pnpm/@lodestar+params@$lodestar_version/node_modules/@lodestar/params/lib/presets/minimal.js"
-   if [[ "$OSTYPE" =~ ^darwin ]]
-   then
-      sed_cmd=gsed
-   else
-      sed_cmd=sed
-   fi
    echo "change variable SLOTS_PER_EPOCH from 8 to 4."
-   $sed_cmd -i "s/SLOTS_PER_EPOCH: 8/SLOTS_PER_EPOCH: 4/g" $preset_minimal_phase0_file
+   sed -i "s/SLOTS_PER_EPOCH: 8/SLOTS_PER_EPOCH: 4/g" $preset_minimal_phase0_file
 }
 
 hack_lodestar

core/packages/test/scripts/set-env.sh

@@ -37,42 +37,9 @@ address_for()
     jq -r ".contracts.${1}.address" "$output_dir/contracts.json"
 }
 
-kill_trap() {
-    trap - SIGTERM
-    pkill -P $$
-}
-
 kill_all() {
-    kill_trap
-    kill_chains
-    kill_relayer
-}
-
-kill_chains() {
-    echo "Killing chains"
-    kill_polkadot
-    kill_ethereum
-}
-
-kill_ethereum() {
-    pkill -9 -f lodestar
-    pkill -9 geth
-}
-
-kill_polkadot() {
-    pkill -9 polkadot
-    pkill -9 snowbridge-test-node
-    pkill -9 snowbridge
-    pkill -9 -f polkadot-launch
-    pkill -9 zombienet
-}
-
-kill_relayer() {
-    echo "Killing relayer"
-    kill_trap
-    sleep 3
-    pkill -9 snowbridge-relay
-    sleep 1
+    trap - SIGTERM
+    kill 0
 }
 
 cleanup() {
@@ -117,19 +84,5 @@ check_tool() {
         echo 'Error: pnpm is not installed.'
         exit
     fi
-    if ! [ -x "$(command -v zombienet)" ]; then
-        echo 'Error: zombienet is not installed.'
-        exit
-    fi
-    if [[ "$OSTYPE" =~ ^darwin ]]; then
-        if ! [ -x "$(command -v gdate)" ]; then
-            echo 'Error: gdate is not installed.'
-            exit
-        fi
-        if ! [ -x "$(command -v gsed)" ]; then
-            echo 'Error: gsed is not installed.'
-            exit
-        fi
-    fi
 }
 

core/packages/test/scripts/start-ethereum.sh

@@ -12,7 +12,7 @@ start_chains()
 
 if [ -z "${from_start_services:-}" ]; then
     echo "start ethereum only!"
-    trap kill_ethereum SIGINT SIGTERM EXIT
+    trap kill_all SIGINT SIGTERM EXIT
     check_tool && cleanup && start_chains
     wait
 fi

core/packages/test/scripts/start-polkadot.sh

@@ -7,7 +7,7 @@ source scripts/deploy-polkadot.sh
 source scripts/configure-contracts.sh
 
 start_chains()
-{   
+{
     #1 start polkadot relaychain and snowbridge parachain
     echo "Starting relaychain and snowbridge parachain"
     deploy_polkadot
@@ -19,7 +19,7 @@ start_chains()
 
 if [ -z "${from_start_services:-}" ]; then
     echo "start polkadot only!"
-    trap kill_polkadot SIGINT SIGTERM EXIT
+    trap kill_all SIGINT SIGTERM EXIT
     check_tool && build_relaychain && build_parachain && start_chains
     wait
 fi

core/packages/test/scripts/start-relayer.sh

@@ -131,7 +131,7 @@ start_relayer()
 
 if [ -z "${from_start_services:-}" ]; then
     echo "start relayers only!"
-    trap kill_relayer SIGINT SIGTERM EXIT
+    trap kill_all SIGINT SIGTERM EXIT
     check_tool && build_relayer && kill_relayer && rm -rf *relay.log && start_relayer
     wait
 fi

core/packages/test/scripts/start-services.sh

@@ -8,7 +8,7 @@ source scripts/build-binary.sh
 from_start_services=true
 
 trap kill_all SIGINT SIGTERM EXIT
-kill_all && cleanup
+cleanup
 # 0. check required tools
 echo "Check building tools"
 check_tool