How to setup the OmniBridge

Basic Requirements

OmniBridge is a component that allows to bridge assets from other blockchains (e.g. 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

Linux

If you use Graphical User Interface(GUI), open terminal

  1. Press CTRL + ALT + T to open the terminal
  2. Or open Show Application in the Dash Bar & find out Terminal Application.
  3. Go to the directory where you want to push the repository:
cd "YOUR_DIRECTORY"

You can print your current working directory with:

pwd
  1. Clone the repository
git clone https://gitlab.com/q-dev/mainnet-public-tools
Windows (if you don't have git installed):

Open PowerShell

  1. Press Windows+R to open the "Run" tool
  2. Type "powershell" and press Enter to open terminal
  3. Go to the directory where you want to push the repository:
cd "YOUR_DISK:\YOUR_DIRECTORY"

If you work with cmd instead of PowerShell, use command:

cd /d "YOUR_DISK:\YOUR_DIRECTORY"

Replace YOUR_DISK and YOUR_DIRECTORY with real names.
You can print the current working directory and its contents using the command:

dir
  1. Clone the repository(PowerShell)
# Download the contents of the Git repository
Invoke-WebRequest -Uri https://gitlab.com/q-dev/mainnet-public-tools/-/archive/master/mainnet-public-tools-master.zip -OutFile mainnet-public-tools-master.zip

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

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

Open Terminal on Mac

  1. Click the Launchpad icon in the Dock, type Terminal in the search field, then click Terminal.
  2. In the Finder, open the /Applications/Utilities folder, then double-click Terminal.
  3. Go to the directory where you want to push the repository:
cd "YOUR_DIRECTORY"

You can print your current working directory with:

pwd
  1. Clone the repository
git clone https://gitlab.com/q-dev/mainnet-public-tools


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

Directory Name Description
/omnibridge-oracle The core Q OmniBridge client
/omnibridge-ui A graphical user interface to use the bridge on your local server
/omnibridge-alm The monitor component to track the status of bridge transactions on the blockchain

Configure OmniBridge Oracle

Go into the /omnibridge-oracle directory.

Linux, macOS, other Unix-like systems 
cd  "testnet-public-tools/omnibridge-oracle"
Windows 
cd "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.mainnet locally to .env.

Linux, macOS, other Unix-like systems 
cp .env.mainnet .env
Windows 
# This will copy the .env.mainnet file to a new file named .env.
copy ".\env.mainnet" ".\env"


Adjust the following parameters in .env:

Parameter Name Value
ORACLE_VALIDATOR_ADDRESS Provide your Q validator address. Example: 0xac8e5047d122f801...
ORACLE_VALIDATOR_ADDRESS_PRIVATE_KEY Provide your Q validator private key. Example: a385db8296ceb9a....
COMMON_HOME_RPC_URL You can keep the default, use https://rpc.q.org or use the RPC endpoint of our own full node if you are operating one.
COMMON_FOREIGN_RPC_URL Provide an RPC endpoint of a client of the blockchain on the other side of the bridge. Q mainnet bridges to the Ethereum mainnet. You can use your own ethereum client, a public endpoint or create an infura account for free to get a personal Ethereum mainnet access point (e.g. https://mainnet.infura.io/v3/1673abc....).

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

To stop viewing logs, press Ctrl+C

Setup and launch the OmniBridge-UI

Now change to the folder /omnibridge-ui

Linux, macOS, other Unix-like systems 
cd  "../omnibridge-ui"
Windows 
cd "..\omnibridge-ui"


and copy the file .env.mainnet to .env.

Linux, macOS, other Unix-like systems 
cp .env.mainnet .env
Windows 
# This will copy the .env.mainnet file to a new file named .env.
copy ".\env.mainnet" ".\env"


Adjust the following parameters in .env:

Parameter Name Value
REACT_APP_FOREIGN_RPC_URL Provide an RPC endpoint of a client of the blockchain on the other side of the bridge, e.g. https://mainnet.infura.io/v3/1673abc....

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 
cd "..\omnibridge-alm"


and copy the file .env.mainnet to .env.

Linux, macOS, other Unix-like systems 
cp .env.mainnet .env
Windows 
# This will copy the .env.mainnet file to a new file named .env.
copy ".\env.mainnet" ".\env"


Adjust the following parameters in .env:

Parameter Name Value
PORT You can keep the default 8090 or change to some other port.
COMMON_HOME_RPC_URL You can keep the default, use https://rpc.q.org or use the RPC endpoint of our own full node if you are operating one.
COMMON_FOREIGN_RPC_URL Provide an RPC endpoint of a client of the blockchain on the other side of the bridge, e.g. https://mainnet.infura.io/v3/1673abc....
ALM_HOME_EXPLORER_TX_TEMPLATE You can keep the default https://explorer.q.org/tx/%s or change with the IP of your own full node block explorer.

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.