Relay3r Jobs

This repo contains everything you need to run be a Relayer.

Available Jobs

Relayer

• GetBackETHRelayer
• UnitradeRelayer
• NISTRelayer

Keep3r

• CrvStrategyKeep3r
• DForceStrategyKeep3r
• HegicPoolKeeper
• Keep3rV1Oracle
• YearnV1Keeper
• YearnGenericKeep3rV2
• MMStrategyKeeperV1
• SushiswapV1Oracle
• LidoKeep3r
• YearnLiquidationKeep3r
• VaultKeep3r

Minimum Bonds:

Job	Min Bond
Keep3rV1Oracle	200 KP3R
SushiswapV1Oracle	200 KP3R
UnitradeRelayer	200 RLR
NISTRelayerJob	500 RLR

Getting started

With Docker

You will need to have Docker and Docker-Compose installed. Refer to the Docker installation guide. If you are running the relayer on a Linux server, you will have to install docker-compose separately. Refer to docker-compose installation guide

Steps to launch your relayer

• Rename the file env.example to .env

Default .env:

MNEMONIC=
INFURA_PROJECT_ID=
JOBS=NISTRelayerJob,UnitradeRelayer
GAS_INCREASE=

• GAS_INCREASE arg is in GWEI,if you want to add 1 gwei to the rapid gas price set GAS_INCREASE in .env file to 1.Do not enter wei amounts for GAS_INCREASE
• If you want to use an existing wallet set your MNEMONIC in the .env
• Get an Infura Project Id from Infura and set it to INFURA_PROJECT_ID key
• Set the jobs you want to work on in the .env, concat the names with comma. Refer to the "Available Jobs" section for the names.
• Run docker-compose up -d to start the container in the background.
• If you did not supply a wallet, one will be created automatically. The mnemonic will be set in the .env file. Make sure to note it in case you loose the file. You will be able to see the address by looking at the log files with docker-compose logs

Your container is set to restart everytime if it crashes or when Docker is launching. If you want to disable this behavior change restart: always to restart: "no" in the docker-compose.yml file.

Without Docker

• First create a wallet by running node createwallet,this will give you the mnemonic,privatekey and public address of the newly created wallet.
• Rename the file env.example to .env
• Configure the .env file with the previously generated mnemonic and Infura Project Id from Infura.
• Set the jobs you want to work on in the .env, concat the names with comma.
• open a tmux session with tmux
• execute npm start.
• detach from tmux and let the script run in the background.