- Install Node.js version higher than 18: https://nodejs.org/en/download/package-manager
- Install yarn package manager: https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable
- Clone project: $ git clone https://github.com/dhedge/flatcoin-liquidation-keeper.git
- Install dependencies: $ yarn install
- Configure .env file properties:
| Variable | Required | Description | Example |
|---|---|---|---|
| PORT | Yes | Port to deploy application | 3000 |
| DB_NAME | Yes | Local path to SQLite storage | ../../positions.db |
| BLOCKCHAIN_NETWORK_NAME | Yes | Network name | Base |
| CHAIN_ID | Yes | Chain id | 8453 |
| PROVIDER_HTTPS_URL | Yes | Provider URL | https://mainnet.base.org |
| PYTH_NETWORK_PRICE_URI | Yes | Off-chain HTTP API endpoint used to fetch Pyth oracle prices | See https://hermes.pyth.network/docs/ |
| PYTH_NETWORK_ETH_USD_PRICE_ID | Yes | RETH/USD price feed ID | See https://pyth.network/developers/price-feed-ids (can be used 0xa0255134973f4fdf2f8f7808354274a3b1ebc6ee438be898d045e8b56ba1fe13) |
| LIQUIDATION_MODULE_CONTRACT_ADDRESS | Yes | LiquidationModule contract address | See https://github.com/dhedge/flatcoin-v1/blob/master/deployments/8453/8453.toml |
| LEVERAGE_MODULE_CONTRACT_ADDRESS | Yes | LeverageModule contract address | See https://github.com/dhedge/flatcoin-v1/blob/master/deployments/8453/8453.toml |
| VIEWER_CONTRACT_ADDRESS | Yes | Viewer contract address | See https://github.com/dhedge/flatcoin-v1/blob/master/deployments/8453/8453.toml |
| SIGNER_WALLET_PK | Yes | Signer wallet private key | |
| MAX_BATCH_SIZE_FOR_LIQUIDATION_QUEUE | Yes | Batch size of positions to be liquidated via RPC batch request | 5 |
| MAX_BATCH_SIZE_FOR_RPC_BATCH_REQUEST | Yes | Batch size of positions to call via other RPC batch requests | 5 |
| BATCH_WAIT_TIME | Yes | Wait time between batches, ms | 500 |
| ETH_PRICE_UPDATE_INTERVAL | Yes | Interval to update current ETH price, sec | 4 |
| LIQUIDATION_BUFFER_RATIO | Yes | Buffer ratio between current ETH price and position with top liquidation price If lower, all positions are checked for the possibility of liquidation |
0.01 |
- Run project: $ yarn run start