@@ -5,7 +5,18 @@ This is a collection of components for building bridges.
5
5
These components include Substrate pallets for syncing headers, passing arbitrary messages, as well as libraries for
6
6
building relayers to provide cross-chain communication capabilities.
7
7
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 .
9
20
10
21
π§ The bridges are currently under construction - a hardhat is recommended beyond this point π§
11
22
@@ -15,8 +26,6 @@ Three bridge nodes are also available. The nodes can be used to run test network
15
26
- [ High-Level Architecture] ( #high-level-architecture )
16
27
- [ Project Layout] ( #project-layout )
17
28
- [ Running the Bridge] ( #running-the-bridge )
18
- - [ How to send a message] ( #how-to-send-a-message )
19
- - [ Community] ( #community )
20
29
21
30
## Installation
22
31
@@ -89,11 +98,12 @@ bridge interaction.
89
98
90
99
## Project Layout
91
100
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.
95
103
96
104
```
105
+ βββ bin // Substrate Runtime Modules (a.k.a Pallets)
106
+ β βββ runtime-common // Helpers for plugging-in our pallets into runtime
97
107
βββ modules // Substrate Runtime Modules (a.k.a Pallets)
98
108
β βββ beefy // On-Chain BEEFY Light Client (in progress)
99
109
β βββ grandpa // On-Chain GRANDPA Light Client
0 commit comments