Skip to content
This repository has been archived by the owner on May 29, 2023. It is now read-only.

Latest commit

 

History

History
76 lines (47 loc) · 2.32 KB

installation.md

File metadata and controls

76 lines (47 loc) · 2.32 KB
Raw

Installation

Before anything further can be done, we need to download some necessary software.

ChainBridge Binary

In this step, we will build the ChainBridge-Core-Example binary.

This binary will function as the bridge remote control, so-to-speak, and is designed to showcase compatibility of our core bridge code alongside network-specific modules.

For this example, the binary includes the following components:

1. Core: general code necessary to operating the bridge

2. Celo-Module: the Celo-specific code

3. EVM-Module: the EVM-specific code

If you wish to bridge different networks other than the example provided, simply clone the ChainBridge-Core-Example repository, checkout one of the other pre-configured branches (e.g. evm-evm, evm-substrate), and then follow the instructions provided in the Makefile to install the binary.

Clone Repository

Navigate to the ChainBridge-Core-Example repo in GitHub and clone it.

git clone https://github.com/ChainSafe/chainbridge-core-example.git

Checkout Pre-configured Branch

Now we will cd into the chainbridge-core-example repo and checkout a pre-configured branch for the networks we are wishing to bridge.

Since we are bridging Celo and Ethereum, we will use the evm-celo-dev branch.

cd chainbridge-core-example && git checkout evm-celo-dev

Build Binary

Once the branch is checked out, we will build the binary from the source.

make build

Run Binary

To ensure everything downloaded correctly and will work on your system, try executing the ChainBridge-Core-Example binary and print the help instructions.

./chainbridge-core-example -h

Output

Below is a proper output of the CLI help screen.

Usage:
   [command]

Available Commands:
  celo-cli    Celo CLI
  completion  generate the autocompletion script for the specified shell
  evm-cli     EVM CLI
  help        Help about any command
  run         Run example app

Flags:
  -h, --help   help for this command

Use " [command] --help" for more information about a command.

If any part of the installation fails or if the instructions are unclear, feel free to reach out to us directly via our shared Slack channel for assistance.