Skip to content

Latest commit

 

History

History
169 lines (117 loc) · 5.44 KB

btp-development-instructions.md

File metadata and controls

169 lines (117 loc) · 5.44 KB
Raw

BTP Development Instructions

Setup and Installation

This section guides you through a setup of a Blockchain Transmission Protocol (BTP) connecting two networks. ICON and Moonriver networks would be used to demonstrate the scheme in this example. This document is aimed to support various groups of people who might be not developers but requires minimum knowledge of computer skills. As of now, we attempt to make these instructions as simple and detail as possible so everyone can do it manually and can be easy to catch up on. Please follow these instructions and do not skip any steps unless you understand what you are currently doing.

We have a script to make this example get easier. Please follow this instruction [link] if you are interested in running via docker. Otherwise, please continue following instructions below

Supporting Operating Systems:

  • MacOS
  • Linux

Software Requirements:

  • Docker: please click on this link [Docker] and follow the instructions to install Docker on your local machine
  • Docker Compose: please click on this [Docker Compose] and follow the instructions to install Docker Compose on your local machine
  • Java (JDK 11): please click on this [JDK11] and download a version that matches the operating system of your local machine

After install JDK11, please check your version:

$ java --version
java 11.0.11 2021-04-20 LTS
Java(TM) SE Runtime Environment 18.9 (build 11.0.11+9-LTS-194)
Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.11+9-LTS-194, mixed mode)
  • NodeJS (requires Node >= 10.x): You can use this link [NodeJS] and download a version that matches the operating system of your local machine

Please check your current version:

$ node -v
v15.12.0
$ npm -v
7.6.3
  • Yarn and Truffle: run a command as below to install these util libraries:
$ npm install --global yarn [email protected]

Please check your current version:

$ truffle version
Truffle v5.3.0 (core: 5.3.0)
Solidity - 0.7.6 (solc-js)
Node v15.12.0
Web3.js v1.2.9
$ yarn -v
1.22.10
  • Gradle: please click on this [Gradle] and install the version 6.7.1
$ gradle -v
------------------------------------------------------------
Gradle 6.7.1
------------------------------------------------------------

Build time:   2020-11-16 17:09:24 UTC
Revision:     2972ff02f3210d2ceed2f1ea880f026acfbab5c0

Kotlin:       1.3.72
Groovy:       2.5.12
Ant:          Apache Ant(TM) version 1.10.8 compiled on May 10 2020
JVM:          11.0.11 (Oracle Corporation 11.0.11+9-LTS-194)
OS:           Mac OS X 10.16 x86_64
  • Golang: requires version GoLang 1.13+. You can use this link [Go] and download a version that matches the operating system of your local machine

Please check your current version:

$ go version
go version go1.16 darwin/amd64
  • jq: requires version jq 1.6. You can use this link [jq] and download a version that matches the operating system of your local machine
  • Download CLI tools:
# Get goloop-cli
go get github.com/icon-project/goloop/cmd/goloop

# Get ethkey-cli
go get github.com/ethereum/go-ethereum/cmd/ethkey

# **** NOTE ****:
# Add 'path/to/folder/go/bin' to the PATH environment variable.
# For example: 
# export GOPATH=~/go
# export GOBIN=$GOPATH/bin
# export PATH=$PATH:$GOBIN

Deployment Instructions

The next following will provide instructions on how to deploy:

  • Deploy a node in ICON's network
  • Deploy a node in Moonriver's network
  • Deploy smart contracts on ICON's network
  • Deploy smart contracts on Moonriver's network
  • Deploy the BTP Message Relay (BMR)

Attention: The deployments and settings might have some dependencies, which mean that one setting/deployment must complete prior another ones. Hence, please follow the below order to completely and safely deploy and set up configurations. If you mess up or skip one step, it might affect your deployment and setting which, in fact, lead to failure consequence

Create Blockchain Nodes

1. Deploy ICON Node

  • Preparation
mkdir BTPExample && cd BTPExample

PROJECT_DIR=${PWD}

# Clone project
git clone https://github.com/icon-project/btp.git

cd $PROJECT_DIR/btp

git checkout icondao
  • ICON's configuration files are located in $PROJECT_DIR/btp/docker-compose/goloop2moonbeam/goloop/config. You can modify these files for your settings
    • icon.genesis.json: ICON's genesis configuration file
    • goloop.server.json: ICON's node configuration file
    • goloop.keystore.json: node's keystore
    • goloop.keysecret: node's password key
  • Run below commands to make btpsimple-image:
cd $PROJECT_DIR/btp

make btpsimple-image
  • Start ICON's Node
cd $PROJECT_DIR/btp/docker-compose/goloop2moonbeam

docker-compose up goloop

2. Deploy Moonriver Node

A node on Moonriver can be easily deployed by running the below command:

cd $PROJECT_DIR/btp/docker-compose/goloop2moonbeam

docker-compose up moonbeam