How to setup the OmniBridge

Basic Requirements

OmniBridge is a component that allows to bridge assets from other blockchains (e.g. Ethereum Rinkeby, Ethereum Mainnet, ..) onto Q. This is used for bridging and transferring collaterals for the creation of Q synthetic assets. Due to their role within Q, validators are predisposed to run an OmniBridge instance.

First please make sure you have a running validator node as described here.

Also please make sure that you have the private key of the validator account as you need it in the config later. If you have a keystore file, you can use extract-get-private-key.js + manual to extract your private key from it.

Download Repo and Configuration

Clone the repository

git clone https://gitlab.com/q-dev/testnet-public-tools

Windows (if you don't have git installed):

# Download the contents of the Git repository
Invoke-WebRequest -Uri https://gitlab.com/q-dev/testnet-public-tools/-/archive/master/testnet-public-tools-master.zip -OutFile testnet-public-tools-master.zip

# Extract the contents of the ZIP file
Expand-Archive -Path testnet-public-tools-master.zip -DestinationPath .

# Remove the ZIP file
Remove-Item -Path testnet-public-tools-master.zip

It should contain, amongst others, the three following folders:

Configure OmniBridge Oracle

Go into the /omnibridge-oracle directory.

Linux, macOS, other Unix-like systems:

cd omnibridge-oracle

Windows:

Set-Location -Path "testnet-public-tools\omnibridge-oracle"

This directory contains a docker-compose.yaml file for quickly launching the bridge oracle and some example environment configurations.

Copy the file .env.testnet locally to .env.

Linux, macOS, other Unix-like systems:

cp .env.testnet .env

Windows:

# This will copy the .env.example file to a new file named .env.
Copy-Item -Path ".\env.example" -Destination ".\env"

Adjust the following parameters in .env:

Launch the Oracle

To start the client with docker-compose make the call

docker-compose up -d

You can track the status of your bridge client by following the logs:

docker-compose logs -f --tail 100

Setup and Launch the OmniBridge-UI

Now change to the folder /omnibridge-ui

Linux, macOS, other Unix-like systems:

cd ../omnibridge-ui

Windows:

Set-Location -Path "../omnibridge-ui"

and copy the file .env.testnet to .env.

Linux, macOS, other Unix-like systems:

cp .env.testnet .env

Windows:

# This will copy the .env.testnet file to a new file named .env.
Copy-Item -Path ".\env.testnet" -Destination ".\env"

Adjust the following parameters in .env:

Start the service

docker-compose up -d

You can find the UI running on your machine on port :8080, try accessing it with a browser.

Setup and Launch the Omnibridge-ALM

Now change to the folder /omnibridge-alm

Linux, macOS, other Unix-like systems:

cd ../omnibridge-alm

Windows:

Set-Location -Path "../omnibridge-alm"

and copy the file .env.testnet to .env.

Linux, macOS, other Unix-like systems:

cp .env.testnet .env

Windows:

# This will copy the .env.testnet file to a new file named .env.
Copy-Item -Path ".\env.testnet" -Destination ".\env"

Adjust the following parameters in .env:

Start the monitor service with docker-compose

docker-compose up -d

You can find the monitor running on your machine on port :8090, try accessing it with a browser. It can be used to look for bridge transactions once the bridge is in use.