-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update document and docker compose for relay
- Loading branch information
Showing
20 changed files
with
351 additions
and
3,779 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.