From e7e7697a98b5f231036a0b6437f9fcb348eff970 Mon Sep 17 00:00:00 2001 From: Branislav Kontur Date: Tue, 4 Jul 2023 16:06:07 +0200 Subject: [PATCH] Update docs (#2242) --- .../docs/polkadot-kusama-bridge-overview.md | 12 ++++----- bridges/docs/polkadot-kusama-bridge.html | 26 +++++++++---------- bridges/modules/messages/README.md | 4 +-- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/bridges/docs/polkadot-kusama-bridge-overview.md b/bridges/docs/polkadot-kusama-bridge-overview.md index e59e0058530a..b469720f65b2 100644 --- a/bridges/docs/polkadot-kusama-bridge-overview.md +++ b/bridges/docs/polkadot-kusama-bridge-overview.md @@ -24,9 +24,9 @@ You won't be able to directly use bridge hub transactions to send XCM messages o to use other parachains transactions, which will use HRMP to deliver messages to the Bridge Hub. The Bridge Hub will just queue these messages in its outbound lane, which is dedicated to deliver messages between two parachains. -Our first planned bridge will connect the Polkadot' AssetHub and Kusama' AssetHub. Bridge between those two -parachains would allow AssetHubPolkadot accounts to hold wrapped KSM tokens and AssetHubKusama accounts to hold wrapped DOT -tokens. +Our first planned bridge will connect the Polkadot and Kusama Asset Hubs. A bridge between those two +parachains would allow Asset Hub Polkadot accounts to hold wrapped KSM tokens and Asset Hub Kusama +accounts to hold wrapped DOT tokens. For that bridge (pair of parachains under different consensus systems) we'll be using the lane 00000000. Later, when other parachains will join the bridge, they will be using other lanes for their messages. @@ -93,13 +93,13 @@ Obviously, there should be someone who is paying relayer rewards. We want bridge can't use fees for rewards. Instead, the parachains using the bridge, use sovereign accounts on both sides of the bridge to cover relayer rewards. -Bridged Parachains will have sovereign accounts at bridge hubs. For example, the AssetHubKusama (Kusama Parachain) will -have an account at the Polkadot Bridge Hub. The AssetHubPolkadot (Polkadot Parachain) will have an account at the Kusama +Bridged Parachains will have sovereign accounts at bridge hubs. For example, the Kusama Asset Hub will +have an account at the Polkadot Bridge Hub. The Polkadot Asset Hub will have an account at the Kusama Bridge Hub. The sovereign accounts are used as a source of funds when the relayer is calling the `pallet_bridge_relayers::claim_rewards`. Since messages lane is only used by the pair of parachains, there's no collision between different bridges. E.g. -AssetHubKusama will only reward relayers that are delivering messages from AssetHubKusama. The AssetHubKusama sovereign account +Kusama Asset Hub will only reward relayers that are delivering messages from Kusama Asset Hub. The Kusama Asset Hub sovereign account is not used to cover rewards of bridging with some other Polkadot Parachain. ### Multiple Relayers and Rewards diff --git a/bridges/docs/polkadot-kusama-bridge.html b/bridges/docs/polkadot-kusama-bridge.html index 272412226f67..bf248adb5716 100644 --- a/bridges/docs/polkadot-kusama-bridge.html +++ b/bridges/docs/polkadot-kusama-bridge.html @@ -16,7 +16,7 @@

Polkadot <> Kusama Bridge

In our architecture, the lane that is used to relay messages over the bridge is determined by - the XCM source and destinations. So e.g. bridge between AssetHubPolkadot and AssetHubKusama (and opposite direction) + the XCM source and destinations. So e.g. bridge between Asset Hubs Polkadot and Kusama (and opposite direction) will use the lane 00000000, bridge between some other Polkadot Parachain and some other Kusama Parachain will use the lane 00000001 and so on.

@@ -24,33 +24,33 @@

Polkadot <> Kusama Bridge

flowchart LR subgraph Polkadot Consensus polkadot(((Polkadot))) - statemint(((Statemint))) + asset_hub_polkadot(((Polkadot Asset Hub))) polkadot_bh(((Polkadot Bridge Hub))) - polkadot---statemint + polkadot---asset_hub_polkadot polkadot---polkadot_bh - statemint-->|Send Message Using HRMP|polkadot_bh + asset_hub_polkadot-->|Send Message Using HRMP|polkadot_bh - polkadot_bh-->|Send Message Using HRMP|statemint - statemint-->|Dispatch the Message|statemint + polkadot_bh-->|Send Message Using HRMP|asset_hub_polkadot + asset_hub_polkadot-->|Dispatch the Message|asset_hub_polkadot end subgraph Kusama Consensus kusama_bh(((Kusama Bridge Hub))) - statemine(((Statemine))) + asset_hub_kusama(((Kusama Asset Hub))) kusama(((Kusama))) - kusama---statemine + kusama---asset_hub_kusama kusama---kusama_bh - kusama_bh-->|Send Message Using HRMP|statemine - statemine-->|Dispatch the Message|statemine + kusama_bh-->|Send Message Using HRMP|asset_hub_kusama + asset_hub_kusama-->|Dispatch the Message|asset_hub_kusama - statemine-->|Send Message Using HRMP|kusama_bh + asset_hub_kusama-->|Send Message Using HRMP|kusama_bh end polkadot_bh<===>|Message is relayed to the Bridged Chain using lane 00000000|kusama_bh - + linkStyle 2 stroke:red linkStyle 7 stroke:red linkStyle 8 stroke:red @@ -64,4 +64,4 @@

Polkadot <> Kusama Bridge

mermaid.initialize({ startOnLoad: true }); - + \ No newline at end of file diff --git a/bridges/modules/messages/README.md b/bridges/modules/messages/README.md index 3b84656025ff..b5250d0dca0b 100644 --- a/bridges/modules/messages/README.md +++ b/bridges/modules/messages/README.md @@ -33,8 +33,8 @@ is the runtime developer who defines what message lane and message mean for this In our [Kusama<>Polkadot bridge](../../docs/polkadot-kusama-bridge-overview.md) we are using lane as a channel of communication between two parachains of different relay chains. For example, lane -`[0, 0, 0, 0]` is used for AssetHubPolkadot <> AssetHubKusama communications. Other lanes may be used to bridge -another parachains. +`[0, 0, 0, 0]` is used for Polkadot <> Kusama Asset Hub communications. Other lanes may be used to +bridge other parachains. ## Message Workflow