Updated README.md for bridges (#2629)

* Updated README.md

* Update BRIDGES.md

Co-authored-by: Squirrel <gilescope@gmail.com>

---------

Co-authored-by: Squirrel <gilescope@gmail.com>
This commit is contained in:
Branislav Kontur
2023-05-24 12:51:30 +02:00
committed by GitHub
parent 15bcea040c
commit 286f727705
2 changed files with 22 additions and 7 deletions
+7 -4
View File
@@ -18,13 +18,16 @@ it easier to import that change back to upstream repo.
# 2. How to pull latest Bridges code to the `bridges` subtree # 2. How to pull latest Bridges code to the `bridges` subtree
(in practice) (in practice)
The `bridges` repo has a stabilized branch `polkadot-staging` dedicated for releasing.
``` ```
cd <cumulus-git-repo-dir> cd <cumulus-git-repo-dir>
# this will update new git branches from bridges repo # this will update new git branches from bridges repo
# there could be unresolved conflicts, but dont worry, # there could be unresolved conflicts, but dont worry,
# lots of them are caused because of removed unneeded files with patch step, # lots of them are caused because of removed unneeded files with patch step,
./scripts/bridges_update_subtree.sh fetch BRANCH=polkadot-staging ./scripts/bridges_update_subtree.sh fetch
# so, after fetch and before solving conflicts just run patch, # so, after fetch and before solving conflicts just run patch,
# this will remove unneeded files and checks if subtree modules compiles # this will remove unneeded files and checks if subtree modules compiles
@@ -68,8 +71,8 @@ $ git remote add -f my-bridges git@github.com:tomusdrw/parity-bridges-common.git
2. To update Bridges: 2. To update Bridges:
``` ```
$ git fetch bridges master $ git fetch bridges polkadot-staging
$ git subtree pull --prefix=bridges bridges master --squash $ git subtree pull --prefix=bridges bridges polkadot-staging --squash
```` ````
We use `--squash` to avoid adding individual commits and rather squashing them We use `--squash` to avoid adding individual commits and rather squashing them
@@ -82,7 +85,7 @@ all into one.
4. Contributing back to Bridges (creating upstream PR) 4. Contributing back to Bridges (creating upstream PR)
``` ```
$ git subtree push --prefix=bridges my-bridges master $ git subtree push --prefix=bridges my-bridges polkadot-staging
``` ```
This command will push changes to your personal fork of Bridges repo, from where This command will push changes to your personal fork of Bridges repo, from where
you can simply create a PR to the main repo. you can simply create a PR to the main repo.
@@ -36,10 +36,12 @@ The current trustless bridges planned for the BridgeHub(s) are:
mkdir -p ~/local_bridge_testing/bin mkdir -p ~/local_bridge_testing/bin
mkdir -p ~/local_bridge_testing/logs mkdir -p ~/local_bridge_testing/logs
---
# 1. Install zombienet # 1. Install zombienet
Go to: https://github.com/paritytech/zombienet/releases Go to: https://github.com/paritytech/zombienet/releases
Copy the apropriate binary (zombienet-linux) from the latest release to ~/local_bridge_testing/bin Copy the apropriate binary (zombienet-linux) from the latest release to ~/local_bridge_testing/bin
---
# 2. Build polkadot binary # 2. Build polkadot binary
git clone https://github.com/paritytech/polkadot.git git clone https://github.com/paritytech/polkadot.git
cd polkadot cd polkadot
@@ -52,23 +54,33 @@ cd polkadot
cargo build --release --features fast-runtime cargo build --release --features fast-runtime
cp target/release/polkadot ~/local_bridge_testing/bin/polkadot cp target/release/polkadot ~/local_bridge_testing/bin/polkadot
---
# 3. Build cumulus polkadot-parachain binary # 3. Build cumulus polkadot-parachain binary
cd <cumulus-git-repo-dir> cd <cumulus-git-repo-dir>
# checkout desired branch or use master: # checkout desired branch or use master:
# git checkout -b bridge-hub-rococo-wococo --track origin/bridge-hub-rococo-wococo # git checkout -b master --track origin/master
git checkout -b master --track origin/master
cargo build --release --locked -p polkadot-parachain-bin cargo build --release --locked -p polkadot-parachain-bin
cp target/release/polkadot-parachain ~/local_bridge_testing/bin/polkadot-parachain cp target/release/polkadot-parachain ~/local_bridge_testing/bin/polkadot-parachain
cp target/release/polkadot-parachain ~/local_bridge_testing/bin/polkadot-parachain-mint cp target/release/polkadot-parachain ~/local_bridge_testing/bin/polkadot-parachain-mint
---
# 4. Build substrate-relay binary # 4. Build substrate-relay binary
git clone https://github.com/paritytech/parity-bridges-common.git git clone https://github.com/paritytech/parity-bridges-common.git
cd parity-bridges-common cd parity-bridges-common
# checkout desired branch or use master:
# git checkout -b master --track origin/master
git checkout -b polkadot-staging --track origin/polkadot-staging
cargo build --release -p substrate-relay cargo build --release -p substrate-relay
cp target/release/substrate-relay ~/local_bridge_testing/bin/substrate-relay cp target/release/substrate-relay ~/local_bridge_testing/bin/substrate-relay
# (Optional) 5. Build polkadot-parachain-mint binary with statemine/westmint for moving assets ---
# 5. Build polkadot-parachain-mint binary with statemine/westmint for moving assets
cd <cumulus-git-repo-dir> cd <cumulus-git-repo-dir>
# TODO:check-parameter - change this when merged to master
git checkout -b bko-transfer-asset-via-bridge --track origin/bko-transfer-asset-via-bridge git checkout -b bko-transfer-asset-via-bridge --track origin/bko-transfer-asset-via-bridge
cargo build --release --locked -p polkadot-parachain-bin cargo build --release --locked -p polkadot-parachain-bin
cp target/release/polkadot-parachain ~/local_bridge_testing/bin/polkadot-parachain-mint cp target/release/polkadot-parachain ~/local_bridge_testing/bin/polkadot-parachain-mint