From 754e5ad8c7ea932602cd00fe1ed62b6ba14e298d Mon Sep 17 00:00:00 2001
From: Hernando Castano <HCastano@users.noreply.github.com>
Date: Tue, 6 Jul 2021 14:43:31 -0400
Subject: [PATCH] Yrong README Fixup + M1 Fixes (#1045)
* Fix build error in mac m1 silicon
* Improve readme
* Clean up local script instructions
* Add Docker Hub reference
* Slightly improve send a message wording
* Fix typo
Co-authored-by: ron.yang <yrong1997@gmail.com>
---
bridges/README.md | 123 +++++++++++++++++++++++++---------------------
1 file changed, 68 insertions(+), 55 deletions(-)
diff --git a/bridges/README.md b/bridges/README.md
index 40aa85973f3..e71563705df 100644
--- a/bridges/README.md
+++ b/bridges/README.md
@@ -102,10 +102,9 @@ the `relays` which are used to pass messages between chains.
To run the Bridge you need to be able to connect the bridge relay node to the RPC interface of nodes
on each side of the bridge (source and target chain).
-There are 3 ways to run the bridge, described below:
+There are 2 ways to run the bridge, described below:
-- building & running from source,
-- building or using Docker images for each individual component,
+- building & running from source
- running a Docker Compose setup (recommended).
### Using the Source
@@ -119,88 +118,102 @@ cargo build -p millau-bridge-node
cargo build -p substrate-relay
```
-### Running
+### Running a Dev network
-To run a simple dev network you'll can use the scripts located in
-[the `deployments/local-scripts` folder](./deployments/local-scripts). Since the relayer connects to
-both Substrate chains it must be run last.
+We will launch a dev network to demonstrate how to relay a message between two Substrate based
+chains (named Rialto and Millau).
+
+To do this we will need two nodes, two relayers which will relay headers, and two relayers which
+will relay messages.
+
+#### Running from local scripts
+
+To run a simple dev network you can use the scripts located in the
+[`deployments/local-scripts` folder](./deployments/local-scripts).
+
+First, we must run the two Substrate nodes.
```bash
# In `parity-bridges-common` folder
./deployments/local-scripts/run-rialto-node.sh
./deployments/local-scripts/run-millau-node.sh
+```
+
+After the nodes are up we can run the header relayers.
+
+```bash
./deployments/local-scripts/relay-millau-to-rialto.sh
+./deployments/local-scripts/relay-rialto-to-millau.sh
```
At this point you should see the relayer submitting headers from the Millau Substrate chain to the
Rialto Substrate chain.
-### Local Docker Setup
-
-To get up and running quickly you can use published Docker images for the bridge nodes and relayer.
-The images are published on [Docker Hub](https://hub.docker.com/u/paritytech).
+```
+# Header Relayer Logs
+[Millau_to_Rialto_Sync] [date] DEBUG bridge Going to submit finality proof of Millau header #147 to Rialto
+[...] [date] INFO bridge Synced 147 of 147 headers
+[...] [date] DEBUG bridge Going to submit finality proof of Millau header #148 to Rialto
+[...] [date] INFO bridge Synced 148 of 149 headers
+```
-To run the dev network we first run the two bridge nodes:
+Finally, we can run the message relayers.
```bash
-docker run -p 30333:30333 -p 9933:9933 -p 9944:9944 \
- -it paritytech/rialto-bridge-node --dev --tmp \
- --rpc-cors=all --unsafe-rpc-external --unsafe-ws-external
-
-docker run -p 30334:30333 -p 9934:9933 -p 9945:9944 \
- -it paritytech/millau-bridge-node --dev --tmp \
- --rpc-cors=all --unsafe-rpc-external --unsafe-ws-external
+./deployments/local-scripts/relay-messages-millau-to-rialto.sh
+./deployments/local-scripts/relay-messages-millau-to-rialto.sh
```
-Notice that the `docker run` command will accept all the normal Substrate flags. For local
-development you should at minimum run with the `--dev` flag or else no blocks will be produced.
+You will also see the message lane relayers listening for new messages.
-Then we need to initialize and run the relayer:
+```
+# Message Relayer Logs
+[Millau_to_Rialto_MessageLane_00000000] [date] DEBUG bridge Asking Millau::ReceivingConfirmationsDelivery about best message nonces
+[...] [date] INFO bridge Synced Some(2) of Some(3) nonces in Millau::MessagesDelivery -> Rialto::MessagesDelivery race
+[...] [date] DEBUG bridge Asking Millau::MessagesDelivery about message nonces
+[...] [date] DEBUG bridge Received best nonces from Millau::ReceivingConfirmationsDelivery: TargetClientNonces { latest_nonce: 0, nonces_data: () }
+[...] [date] DEBUG bridge Asking Millau::ReceivingConfirmationsDelivery about finalized message nonces
+[...] [date] DEBUG bridge Received finalized nonces from Millau::ReceivingConfirmationsDelivery: TargetClientNonces { latest_nonce: 0, nonces_data: () }
+[...] [date] DEBUG bridge Received nonces from Millau::MessagesDelivery: SourceClientNonces { new_nonces: {}, confirmed_nonce: Some(0) }
+[...] [date] DEBUG bridge Asking Millau node about its state
+[...] [date] DEBUG bridge Received state from Millau node: ClientState { best_self: HeaderId(1593, 0xacac***), best_finalized_self: HeaderId(1590, 0x0be81d...), best_finalized_peer_at_best_self: HeaderId(0, 0xdcdd89...) }
+```
-```bash
-docker run --network=host -it \
- paritytech/substrate-relay init-bridge rialto-to-millau \
- --target-host localhost \
- --target-port 9945 \
- --source-host localhost \
- --source-port 9944 \
- --target-signer //Alice
+To send a message see the ["How to send a message" section](#how-to-send-a-message).
-docker run --network=host -it \
- paritytech/substrate-relay relay-headers rialto-to-millau \
- --target-host localhost \
- --target-port 9945 \
- --source-host localhost \
- --source-port 9944 \
- --target-signer //Bob \
-```
+### Full Network Docker Compose Setup
-You should now see the relayer submitting headers from the Millau chain to the Rialto chain.
+For a more sophisticated deployment which includes bidirectional header sync, message passing,
+monitoring dashboards, etc. see the [Deployments README](./deployments/README.md).
-If you don't want to use the published Docker images you can build images yourself. You can do this
-by running the following commands at the top level of the repository.
+You should note that you can find images for all the bridge components published on
+[Docker Hub](https://hub.docker.com/u/paritytech).
+
+To run a Rialto node for example, you can use the following command:
```bash
-# In `parity-bridges-common` folder
-docker build . -t local/rialto-bridge-node --build-arg PROJECT=rialto-bridge-node
-docker build . -t local/millau-bridge-node --build-arg PROJECT=millau-bridge-node
-docker build . -t local/substrate-relay --build-arg PROJECT=substrate-relay
+docker run -p 30333:30333 -p 9933:9933 -p 9944:9944 \
+ -it paritytech/rialto-bridge-node --dev --tmp \
+ --rpc-cors=all --unsafe-rpc-external --unsafe-ws-external
```
-_Note: Building the node images will take a long time, so make sure you have some coffee handy._
-
-Once you have the images built you can use them in the previous commands by replacing
-`paritytech/<component_name>` with `local/<component_name>` everywhere.
+### How to send a message
-### Full Network Docker Compose Setup
+In this section we'll show you how to quickly send a bridge message, if you want to
+interact with and test the bridge see more details in [send message](./docs/send-message.md)
-For a more sophisticated deployment which includes bidirectional header sync, message passing,
-monitoring dashboards, etc. see the [Deployments README](./deployments/README.md).
+```bash
+# In `parity-bridges-common` folder
+./scripts/send-message-from-millau-rialto.sh remark
+```
-### How to send a message
+After sending a message you will see the following logs showing a message was successfully sent:
-A straightforward way to interact with and test the bridge is sending messages. This is explained
-in the [send message](./docs/send-message.md) document.
+```
+INFO bridge Sending message to Rialto. Size: 286. Dispatch weight: 1038000. Fee: 275,002,568
+INFO bridge Signed Millau Call: 0x7904...
+TRACE bridge Sent transaction to Millau node: 0x5e68...
+```
## Community
--
GitLab