Installation
Hoodi is not supported
Please note that SSV Mainnet has enough liquidators at the moment, so the tool is not actively updated. There is no official Hoodi support for ssv-liquidator tool.
Prerequisites
- Wallet funded with sufficient ETH for transaction gas fees on the chosen network (Mainnet or Holesky)
- Execution layer node end-point
- Reliable internet connection
- NodeJS installed on your machine
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
Arguments
| CLI Parameter | .ENV Variable | Description |
|---|---|---|
--node-url | NODE_URL | The Ethereum execution node end-point |
--private-key | ACCOUNT_PRIVATE_KEY | Private key of the liquidator's wallet |
--liquidator-type | LIQUIDATOR_TYPE | The liquidator type. eth ssv |
--ssv-sync-env | SSV_SYNC_ENV | The SSV sync environment. prod (default) or stage |
--ssv-sync | SSV_SYNC | The SSV contract name. v4.hoodi (default) or v4.mainnet |
--gas-price | 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). Default: low |
--hide-table | HIDE_TABLE | Hide/show realtime table |
--max-visible-blocks | MAX_VISIBLE_BLOCKS | Max block range to display active clusters (optional, by default: 50000) |
Running Options
- Option 1: Using CLI Arguments
- Option 2: Using .ENV Variables
yarn cli --liquidator-type=eth --ssv-sync-env=<prod | stage> --ssv-sync=<v4.hoodi | v4.mainnet > --node-url=<NODE_URL> --private-key=<PRIVATE_KEY> --gas-price=low --max-visible-blocks=<MAX_BLOCKS>
The liquidation bot can also be simply launched with the command yarn cli if the following environment variables have their values correctly set:
LIQUIDATOR_TYPE=eth # ssv
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.mainnet # v4.hoodi - is the default
warning
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 Hoodi (using a sample QuickNode RPC endpoint), the command should look like this:
yarn cli \
--ssv-sync-env=prod \
--ssv-sync=v4.hoodi \
--node-url=https://red-silent-dawn.ethereum-hoodi.quiknode.pro/<ACCOUNT_ID>/ \
--private-key=<PRIVATE_KEY> \
--gas-price=slow \
--max-visible-blocks=5000