blockworks-foundation
/
liquidator-v3
mirror of https://github.com/blockworks-foundation/liquidator-v3.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Expand readme to cover liquidatable-accounts-feed

This commit is contained in:
Christian Kamm 2022-02-22 12:53:23 +01:00
parent 1a957787e2
commit 84c07c81e8
1 changed files with 42 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -1,5 +1,5 @@
# liquidator-v3
A script for liquidating undercollateralized account on Mango Markets
A script for liquidating undercollateralized account on Mango Markets.
## Setup
To run the liquidator you will need:
@ -10,6 +10,45 @@ To run the liquidator you will need:
* A clone of this repository
* Dependencies installed with `yarn install`
## Rebalancing
The liquidator will attempt to close all perp positions, and balance the tokens in the liqor account after each liquidation. By default it will sell all token assets into USDC. You can choose to maintain a certain amount of each asset through this process by editing the value in the `TARGETS` environment variable at the position of the asset. You can find the order of the assets in the 'oracles' property of the group in [ids.json](https://github.com/blockworks-foundation/mango-client-v3/blob/main/src/ids.json#L81) The program will attempt to make buy/sell orders during balancing to maintain this level.
## Advanced Orders Triggering
The liquidator triggers advanced orders for users when their trigger condition is met. Upon successfully triggering the order, the liquidator wallet will receive 100x the transaction fee as a reward.
## Run
```
yarn liquidator
```
The liquidator can be run in two different modes:
### Mode 1: Scan for liquidatable accounts directly
The liquidator will connect to an RPC node websocket feed itself and request
snapshots occasionally. This is simpler to get started with, as no separate
service is needed to watch for potentially liquidatable accounts, but scanning
for accounts can be slow.
To use this mode, leave `LIQUIDATABLE_FEED_WEBSOCKET_ADDRESS` unset.
Only this mode allows advanced order triggering.
### Mode 2: Use a separate service to find liquidatable accounts
In this mode the https://github.com/blockworks-foundation/liquidatable-accounts-feed
service provides information about potentially liquidatable accounts to the liquidator.
The external service is much faster at scanning for newly liquidatable accounts
when the price cache is updated than Mode 1.
To use it, set up the liquidatable-accounts-feed service (probably on the same
machine) and then set the liquidator's `LIQUIDATABLE_FEED_WEBSOCKET_ADDRESS` to
the other service's `websocket_server_bind_address`.
This mode never triggers advanced orders.
## Environment Variables
| Variable | Default | Description |
| -------- | ------- | ----------- |
@ -25,20 +64,11 @@ To run the liquidator you will need:
| `LIQOR_PK` | N/A | Liqor Mango Account Public Key, by default uses the largest value account owned by the keypair |
| `WEBHOOK_URL` | N/A | Discord webhook URL to post liquidation events and errors to |
| `LIAB_LIMIT` | `0.9` | Percentage of your available margin to use when taking on liabilities |
| `LIQUIDATABLE_FEED_WEBSOCKET_ADDRESS` | N/A | Websocket URL of the liquidatable-accounts-feed service, see above |
You can add these variables to a `.env` file in the project root to load automatically on liquidator startup. For example:
```bash
ENDPOINT_URL=https://solana-api.projectserum.com
KEYPAIR=${HOME}/.config/solana/my-keypair.json
KEYPAIR=${HOME}/.config/solana/my-keypair.json
TARGETS=500 0.1 0.75 0 0 0 0 0
```
## Rebalancing
The liquidator will attempt to close all perp positions, and balance the tokens in the liqor account after each liquidation. By default it will sell all token assets into USDC. You can choose to maintain a certain amount of each asset through this process by editing the value in the `TARGETS` environment variable at the position of the asset. You can find the order of the assets in the 'oracles' property of the group in [ids.json](https://github.com/blockworks-foundation/mango-client-v3/blob/main/src/ids.json#L81) The program will attempt to make buy/sell orders during balancing to maintain this level.
## Advanced Orders Triggering
The liquidator triggers advanced orders for users when their trigger condition is met. Upon successfully triggering the order, the liquidator wallet will receive 100x the transaction fee as a reward.
## Run
```
yarn liquidator
```