Skip to content

Commit

Permalink
Adding message relayer scripts, reformating send message scripts (par…
Browse files Browse the repository at this point in the history
…itytech#790)

* Adding message relayer scripts, reformating send message scripts

* Addressing PR feedback

* Update README.md

Valid .

Co-authored-by: Hernando Castano <[email protected]>

* Fixing send-message-from-rialto-millau

* Fixing send message script from millau to rialot

Co-authored-by: Hernando Castano <[email protected]>
  • Loading branch information
2 people authored and serban300 committed Apr 9, 2024
1 parent 10d690e commit b6ee075
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions bridges/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Substrate chains or Ethereum Proof-of-Authority chains.
🚧 The bridges are currently under construction - a hardhat is recommended beyond this point 🚧

## Contents

- [Installation](#installation)
- [High-Level Architecture](#high-level-architecture)
- [Project Layout](#project-layout)
Expand All @@ -19,6 +20,7 @@ Substrate chains or Ethereum Proof-of-Authority chains.
- [Community](#community)

## Installation

To get up and running you need both stable and nightly Rust. Rust nightly is used to build the Web
Assembly (WASM) runtime for the node. You can configure the WASM support as so:

Expand Down Expand Up @@ -70,6 +72,7 @@ Take a look at [Bridge High Level Documentation](./docs/high-level-overview.md)
description of the bridge interaction.

## Project Layout

Here's an overview of how the project is laid out. The main bits are the `node`, 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.
Expand All @@ -91,17 +94,17 @@ the `relays` which are used to pass messages between chains.
β”œβ”€β”€ relays // Application for sending headers and messages between chains
β”‚ └── ...
└── scripts // Useful development and maintenence scripts
```
```

## Running the Bridge

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:
- building & running from source,
- building or using Docker images for each individual component,
- running a Docker Compose setup (recommended).
- building & running from source,
- building or using Docker images for each individual component,
- running a Docker Compose setup (recommended).

### Using the Source

Expand Down Expand Up @@ -196,6 +199,7 @@ monitoring dashboards, etc. see the [Deployments README](./deployments/README.md

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.

## Community

Main hangout for the community is [Element](https://element.io/) (formerly Riot). Element is a chat
Expand All @@ -208,4 +212,3 @@ Element channel.

The [Substrate Technical](https://app.element.io/#/room/#substrate-technical:matrix.org) Element
channel is most suited for discussions regarding Substrate itself.

0 comments on commit b6ee075

Please sign in to comment.