Skip to content

Commit 078e345

Browse files
svyatonikbkontur
authored andcommitted
Add codebase specific explanations to Readme.md (#2763)
* added some words on codebase specific + refs to other ecosystem bridges * added lost crate to headCargo.toml
1 parent b455290 commit 078e345

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

β€ŽCargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ members = [
3737
"primitives/runtime",
3838
"primitives/test-utils",
3939
"primitives/xcm-bridge-hub",
40+
"primitives/xcm-bridge-hub-router",
4041
"relays/bin-substrate",
4142
"relays/client-bridge-hub-kusama",
4243
"relays/client-bridge-hub-polkadot",

β€ŽREADME.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,18 @@ This is a collection of components for building bridges.
55
These components include Substrate pallets for syncing headers, passing arbitrary messages, as well as libraries for
66
building relayers to provide cross-chain communication capabilities.
77

8-
Three bridge nodes are also available. The nodes can be used to run test networks which bridge other Substrate chains.
8+
This codebase is used to build bridges between Substrate-based chains. Such chains are built using
9+
[Substrate framework](https://docs.substrate.io/) and are sharing some common features. Those features include:
10+
11+
- ability to plugin our pallets there (see https://docs.substrate.io/reference/frame-pallets/);
12+
13+
- using GRANDPA or parachain finality for their blocks (BEEFY finality support is planned).
14+
15+
There are other bridges in the Dotsama ecosystem. Including, but not limited to:
16+
17+
- Snowfork bridge with Ethereum: https://github.com/Snowfork/snowbridge;
18+
19+
- Interlay bridge with Bitcoin: https://github.com/interlay/interbtc.
920

1021
🚧 The bridges are currently under construction - a hardhat is recommended beyond this point 🚧
1122

@@ -15,8 +26,6 @@ Three bridge nodes are also available. The nodes can be used to run test network
1526
- [High-Level Architecture](#high-level-architecture)
1627
- [Project Layout](#project-layout)
1728
- [Running the Bridge](#running-the-bridge)
18-
- [How to send a message](#how-to-send-a-message)
19-
- [Community](#community)
2029

2130
## Installation
2231

@@ -89,11 +98,12 @@ bridge interaction.
8998

9099
## Project Layout
91100

92-
Here's an overview of how the project is laid out. The main bits are the `bin`, which is the actual "blockchain", the
93-
`modules` which are used to build the blockchain's logic (a.k.a the runtime) and the `relays` which are used to pass
94-
messages between chains.
101+
Here's an overview of how the project is laid out. The main bits are `modules` which are used to build the blockchain's
102+
logic (a.k.a the runtime) and the `relays` which are used to pass messages between chains.
95103

96104
```
105+
β”œβ”€β”€ bin // Substrate Runtime Modules (a.k.a Pallets)
106+
β”‚ β”œβ”€β”€ runtime-common // Helpers for plugging-in our pallets into runtime
97107
β”œβ”€β”€ modules // Substrate Runtime Modules (a.k.a Pallets)
98108
β”‚ β”œβ”€β”€ beefy // On-Chain BEEFY Light Client (in progress)
99109
β”‚ β”œβ”€β”€ grandpa // On-Chain GRANDPA Light Client

0 commit comments

Comments
Β (0)