bmr.md

BMR (BTP Message Relay)

Introduction

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

Platform preparation

• GoLang 1.19

  Mac OSX

  brew install go
  

Source checkout

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

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

Build

cd ${PROJECT_ROOT}
make relay

Output binaries are placed under bin/ directory.

Docker Image Build

cd ${PROJECT_ROOT}
make relay-image

• Docker Compose example

Relay CLI

• Relay command line

Tutorial

• End-to-End Testing Demo

Relay start

Create network configuration

${PROJECT_ROOT}/bin/relay save ./config/relay_config.json

• Configuration example
  • Icon to Icon configuration
  • Icon to Eth-Bridge configuration

Configuration setting

1. 'relay_config' setting [Relay config]

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

${PROJECT_ROOT}/bin/relay start --config ./config/relay_config.json