Installation

Prerequisites

• Wallet funded with sufficient ETH for transaction gas fees on the chosen network (Mainnet, Holesky, Goerli, ...)

• Execution layer node end-point

• Reliable internet connection

The minimum hardware requirements are very low. A single board computer could run multiple instances of the bot, along with other tasks and services, without perceiving an impact on performance.

Installation

git clone https://github.com/ssvlabs/ssv-liquidator.git
cd ssv-liquidator
yarn install
yarn cli --help

This installation requires NodeJS on your machine.

Arguments

Parameter	Description
--node-url	The Ethereum execution node end-point
--private-key	Private key of the liquidator's wallet
--ssv-token-address	SSV token contract address
--ssv-network-address	The ssv.network contract address
--ssv-network-views	The ssv.network views contract address
--gas-price	Gas price heuristic according to the median gas price suggested by web3 gas price oracle: Low (*0.1) Med (*0.2) High (*0.3)

Run

The liquidator bot could be initiated with arguments in the yarn cli command or by using the .env variables.

CLI

yarn cli --ssv-sync-env=<prod | stage> --ssv-sync=<v4.holesky | v4.mainnet | v4.prater> --node-url=<NODE_URL>  --private-key=<PRIVATE_KEY>  --gas-price=slow --max-visible-blocks=<MAX_BLOCKS>

.ENV variables

The liquidation bot can also be simply launched with the command yarn cli if the following environment variables have their values correctly set:

NODE_URL=eth.infra.com 
ACCOUNT_PRIVATE_KEY=<PRIVATE_KEY>
GAS_PRICE=medium  # low | medium | high
HIDE_TABLE=false
MAX_VISIBLE_BLOCKS=50000
SSV_SYNC_ENV=prod # prod or stage, prod - is default value
SSV_SYNC=v4.prater # v4.holesky | v4.mainnet | v4.prater

Make sure that --ssv-sync and --node-url parameters (or SSV_SYNC and NODE_URL environment variables) are all relative to the same blockchain.

For example, for Holesky (using a sample QuickNode RPC endpoint), the command should look like this:

yarn cli \
--ssv-sync-env=prod \
--ssv-sync=v4.holesky \
--node-url=https://red-silent-dawn.ethereum-holesky.quiknode.pro/<ACCOUNT_ID>/  \
--private-key=<PRIVATE_KEY>  \
--gas-price=slow    \
--max-visible-blocks=5000

The smart contract addresses were taken from this page, in this instance.