Link cumulus as submodule (paritytech#793)

* Link cumulus as submodule

* Update submodules when init

* Cleanup

* Update submodule

.gitmodules

@@ -9,3 +9,7 @@
 	path = core/packages/contracts/lib/openzeppelin-contracts
 	url = https://github.com/openzeppelin/openzeppelin-contracts
 	branch = v4.8.2
+[submodule "cumulus"]
+	path = cumulus
+	url = https://github.com/Snowfork/cumulus
+	branch = snowbridge

_typos.toml

@@ -6,5 +6,6 @@ extend-exclude = [
     "**/fixtures/*.js",
     "**/*ffi*.js",
     "**/*mock*.rs",
-    "**/*data*.rs"
+    "**/*data*.rs",
+    "cumulus/**"
 ]

core/init.sh

@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+echo "Update submodules"
+(cd .. && (git submodule update --init --recursive||true))
+
 echo "Install husky hook"
 (cd .. && ./core/node_modules/.bin/husky install)
 

core/packages/test/.envrc-example

@@ -24,3 +24,6 @@ source_up_if_exists
 # 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
+
+# export CUMULUS_VER=snowbridge       # For dev setup change to some feature branch
+

core/packages/test/README.md

@@ -38,31 +38,6 @@ https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944#/explorer
 
 Confirm the block number is > 2.
 
-### Using a custom Cumulus build for BridgeHub and Statemine
-
-By default `scripts/start-services.sh` will use `cargo` to install the `polkadot-parachain` binary from the [Snowbridge/cumulus](https://github.com/Snowfork/cumulus) forks `snowbridge` branch.
-
-To use a custom version of cumulus:
-
-1. Clone a cumulus repo. In the example below we clone the [Snowbridge/cumulus](https://github.com/Snowfork/cumulus) fork.
-
-```console
-git clone https://github.com/Snowfork/cumulus.git -b snowbridge
-```
-
-2. Build `polkadot-parachain` bin.
-
-```console
-cd cumulus
-cargo build --release --bin polkadot-parachain
-```
-
-3.  Set `CUMULUS_BIN` in `core/packages/test/.envrc` and `direnv allow`.
-
-```sh
-export CUMULUS_BIN=/path/to/cumulus/target/release/polkadot-parachain
-```
-
 ## E2E tests
 
 These tests are meant to closely replicate real-world behaviour. This means that they also replicate real-world delays and confirmation times. This can take up to 4 minutes per test and around 40 minutes for all tests.

core/packages/test/scripts/build-binary.sh

@@ -30,6 +30,13 @@ rebuild_cumulus(){
     popd
 }
 
+build_cumulus_from_source(){
+    pushd $root_dir/cumulus
+    cargo build --release --bin polkadot-parachain
+    cp target/release/polkadot-parachain $output_bin_dir/polkadot-parachain
+    popd
+}
+
 rebuild_relaychain(){
     pushd $root_dir/parachain
     mkdir -p $relaychain_dir
@@ -61,7 +68,7 @@ install_binary() {
     echo "Building and installing binaries."
     mkdir -p $output_bin_dir
     build_ethereum
-    build_cumulus
+    build_cumulus_from_source
     build_relaychain
     build_relayer
 }

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

@@ -5,7 +5,7 @@ source scripts/set-env.sh
 
 generate_chain_spec() {
     echo "Generating chain specification"
-    "$cumulus_bin" build-spec --chain "$bridge_hub_runtime" --disable-default-bootnode > "$output_dir/spec.json"
+    "$output_bin_dir/polkadot-parachain" build-spec --chain "$bridge_hub_runtime" --disable-default-bootnode > "$output_dir/spec.json"
 
     initial_beacon_block=""
     while [ -z "$initial_beacon_block" ] || [ "$initial_beacon_block" == "0x0000000000000000000000000000000000000000000000000000000000000000" ]
@@ -23,7 +23,7 @@ generate_chain_spec() {
     do
         echo "Waiting for beacon to get initial bootstrap..."
         bootstrap_data=$(curl -s "$beacon_endpoint_http/eth/v1/beacon/light_client/bootstrap/$initial_beacon_block")
-        # sometimes will get http 503 error from the above bootstrap endpoint in goerli network 
+        # sometimes will get http 503 error from the above bootstrap endpoint in goerli network
         # so add true here to ignore the error and just retry
         bootstrap_header=$(jq -r '.data.header' <<< "$bootstrap_data" || true)
         slot=$(jq -r '.data.header.beacon.slot' <<< "$bootstrap_data" || true)

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

@@ -6,7 +6,7 @@ bridge_hub_runtime="${PARACHAIN_RUNTIME:-bridge-hub-rococo-local}"
 relaychain_version="${POLKADOT_VER:-v0.9.38}"
 relaychain_dir="$root_dir/parachain/.cargo/$relaychain_version"
 relaychain_bin="${POLKADOT_BIN:-$relaychain_dir/bin/polkadot}"
-cumulus_version="${CUMULUS_VER:-snowbridge-v0.9.38}"
+cumulus_version="${CUMULUS_VER:-snowbridge}"
 cumulus_dir="$root_dir/parachain/.cargo/$cumulus_version"
 cumulus_bin="${CUMULUS_BIN:-$cumulus_dir/bin/polkadot-parachain}"
 core_dir="$root_dir/core"