What does this Repo?

This Repo contains an ansible Playbook, that will install Docker on your Ubuntu 22.04 Server, that will create a Hyperbridge-Relayer Container on your Machine.

How to use this Playbook?

Requirements:

To use this Playbook you need:

• ssh access to a Machine with a user that has root permissions
• ansible installed on the Machine you want to execute the Playbook from
• declare some Varibales

Variables to declare

In the file 'group_vars/all.yml' you need to change this variables:

• system_username
• chain
• hyperbridge_node_ws
• etherscan_eth_api_key
• etherscan_bsc_api_key
• eth_rpc
• arbitrum_rpc
• optimism_rpc
• base_rpc
• bsc_rpc
• signer
• minimum_profit_percentage

Examples and explanation

system_username

Thats the username of your Ubuntu/Debian User. If you login into your System for example with the command 'ssh hyperbridge@' your system_username is 'hyperbridge'.

system_username: hyperbridge

chain

The chain you want to start your Relayer in. Allowed Values are Dev, Gargantua, Messier or Nexus.

chain: Gargantua

hyperbridge_node_ws

The Websocket IP and Port of your Hyperbridge Node.

hyperbridge_node_ws: ws://127.0.0.1:9944

etherscan_eth_api_key

You need to specify your Ethereum etherscan API key here.
How to create this key Its used for everything besides BSC.

bscscan_bsc_api_key

You need to specify your Binance etherscan API key here.
How to create this key

eth_rpc and all the other _rpc variables

Here you need to define the RPC http(s) addresses of the Sepolia RPCs you want to connect to the relayer.
You dont have to connect all the chains, two are enough to run the relayer.
Just leave the rpc variables that you dont want to use commented out.

signer

The Privatekey that will deliver the messages. You will need to have the native Token for the Chains on that key.

minimum_profit_percentage

Define your profitability configuration. 0 -> 0% i.e relay all requests, even unprofitable ones. 1 -> 1%. ie fees provided for requests must be profitable by at least 1%. etc.

minimum_profit_percentage: "1"

eth_query_batch_size and all the other query_batch_size

Maximum block range for eth_getLogs in a single rpc call
If this parameter is not supplied the range will not be split into smaller chunks
Default value is 1000

eth_query_batch_size: "1000"

In the file 'inventory.yml' you need to change this variables:

• ansible_host

Examples and explanation

ansible_host

Thats the IP-Address of your Target Machine. Your Machine needs to be accessable using ssh with that IP.

ansible_host: 192.168.1.10

Run the Playbook

Execute Ansible

cd into this Repo and run the Playbook with 'ansible-playbook playbook.yml'

Check your Machine after the run

Have a look in the docker logs of your newly created Container.
Check the running Containers:

hyperbridge@hyperbridge-relayer01:~$ docker ps
CONTAINER ID   IMAGE                           COMMAND                  CREATED        STATUS        PORTS     NAMES
a7953883bbea   polytopelabs/tesseract:latest   "./tesseract --confi…"   22 hours ago   Up 22 hours             hyperbridge-relayer-tesseract_relayer-1

Grab the Container ID or the Name and check the logs.

docker logs -f a7953883bbea