Skip to content

Add codebase specific explanations to Readme.md #2763

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
acatangiu merged 2 commits into from
Dec 28, 2023
Merged

Add codebase specific explanations to Readme.md #2763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26b167d
added some words on codebase specific + refs to other ecosystem bridges
svyatonik Dec 28, 2023
fff407b
added lost crate to headCargo.toml
svyatonik Dec 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ members = [
"primitives/runtime",
"primitives/test-utils",
"primitives/xcm-bridge-hub",
"primitives/xcm-bridge-hub-router",
"relays/bin-substrate",
"relays/client-bridge-hub-kusama",
"relays/client-bridge-hub-polkadot",
Expand Down
22 changes: 16 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,18 @@ This is a collection of components for building bridges.
These components include Substrate pallets for syncing headers, passing arbitrary messages, as well as libraries for
building relayers to provide cross-chain communication capabilities.

Three bridge nodes are also available. The nodes can be used to run test networks which bridge other Substrate chains.
This codebase is used to build bridges between Substrate-based chains. Such chains are built using
[Substrate framework](https://docs.substrate.io/) and are sharing some common features. Those features include:

- ability to plugin our pallets there (see https://docs.substrate.io/reference/frame-pallets/);

- using GRANDPA or parachain finality for their blocks (BEEFY finality support is planned).

There are other bridges in the Dotsama ecosystem. Including, but not limited to:

- Snowfork bridge with Ethereum: https://github.com/Snowfork/snowbridge;

- Interlay bridge with Bitcoin: https://github.com/interlay/interbtc.

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

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

## Installation

Expand Down Expand Up @@ -89,11 +98,12 @@ bridge interaction.

## Project Layout

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

```
├── bin // Substrate Runtime Modules (a.k.a Pallets)
│ ├── runtime-common // Helpers for plugging-in our pallets into runtime
├── modules // Substrate Runtime Modules (a.k.a Pallets)
│ ├── beefy // On-Chain BEEFY Light Client (in progress)
│ ├── grandpa // On-Chain GRANDPA Light Client
Expand Down