Skip to content

Commit

Permalink
Update document and docker compose for relay
Browse files Browse the repository at this point in the history
  • Loading branch information
kwon528 committed Oct 27, 2023
1 parent 46de32e commit 66e83b6
Show file tree
Hide file tree
Showing 20 changed files with 351 additions and 3,779 deletions.
231 changes: 0 additions & 231 deletions doc/bmc.md

This file was deleted.

82 changes: 71 additions & 11 deletions doc/bmr.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,78 @@
# BMR (BTP Message Relay)

## Introduction

* Unidirectional relay
* Monitor BTP events
* Relay direction setting ( both,front,reverse )
* Monitor BTP events
* Send BTP Relay Message
* Gather proofs for the events

## Integrated blockchain
* [ICON](icon.md)
* [ICON Enterprise Edition](iconee.md)
## Platform preparation

* GoLang 1.19

**Mac OSX**
```
brew install go
```

## Source checkout
First of all, you need to check out the source.

```bash
git clone https://github.com/icon-project/btp2.git --recurse-submodules
```

## Build

```bash
cd ${PROJECT_ROOT}
make relay
```

Output binaries are placed under `bin/` directory.

## Docker Image Build
```bash
cd ${PROJECT_ROOT}
make relay-image
```
* [Docker Compose example](../docker-compose)

## Relay CLI
* [Relay command line](relay_cli.md)

## Tutorial
* [End-to-End Testing Demo](../e2edemo/README.md)

## Relay start

### Create network configuration

```bash
${PROJECT_ROOT}/bin/relay save ./config/relay_config.json
```
* Configuration example
* [Icon to Icon configuration](../docker-compose/relay/config/icon_to_icon_config.json)
* [Icon to Eth-Bridge configuration](../docker-compose/relay/config/icon_to_hardhat_config.json)

#### Configuration setting
1. 'relay_config' setting
[[Relay config]](relay_cli.md#options)

2. 'chains_config' setting

| Key | Description |
|:-------------|:-----------------------------------------------|
| address | BTPAddress ( btp://${Network}/${BMC Address} ) |
| endpoint | Network endpoint |
| key_store | Relay keystore |
| key_password | Relay keystore password |
| type | BTP2 contract type |

#### Relay Start
```bash
${PROJECT_ROOT}/bin/relay start --config ./config/relay_config.json
```


## General
* [Build Guide](build.md)
* [Tutorial](tutorial.md)

## Management
* [btpsimple command line](btpsimple_cli.md)
47 changes: 0 additions & 47 deletions doc/bmv.md

This file was deleted.

Loading

0 comments on commit 66e83b6

Please sign in to comment.