Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds new flags to Docs #64

Merged
merged 1 commit into from
Nov 20, 2023
Merged

Adds new flags to Docs #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,15 @@ Usage:
Flags:
-h, --help help for liquidator
--lndconnecturis string CSV of lndconnect strings to connect to lnd(s)
--backoffCoefficient float Coefficient to apply to the backoff (default: 0.95)
--backoffLimit float Limit coefficient of the backoff (default: 0.1)
--limitFees float Limit to total Swap Fees (default 0.007 -> 0.7% Swap size)
--logFormat string Log format from: {text, json} (default "text")
--logLevel string Log level from values: {trace, debug, info, warn, error, fatal, panic} (default "info")
--loopdconnecturis string CSV of loopdconnect strings to connect to loopd(s)
--nodeguardHost string Hostname:port to connect to nodeguard
--pollingInterval string Interval to poll data (default "15s")
--retriesBeforeBackoff int Number of retries before applying backoff to the swap (default: 3)
--swapPublicationOffset string Swap publication deadline offset (Maximum time for the swap provider to publish the swap) (default "30m")
```
# Requirements
Expand Down Expand Up @@ -49,12 +53,16 @@ Available recipes:

All the flags can be set as environment variables, with the following format, except stated, they are all mandatory:

- LNDCONNECTURIS : CSV of lndconnect strings to connect to lnd(s)
- LNDCONNECTURIS : CSV of lndconnect strings to connect to lnd(s)\
- LIMITFEES (optional) : Limit to total Swap Fees (default 0.007 -> 0.7% Swap size)
- LOOPDCONNECTURIS : CSV of loopdconnect strings to connect to loopd(s)
- POLLINGINTERVAL (optional) : Interval to poll data(default 15s)
- LOGLEVEL (optional) : Log level (default info) from: {trace, debug, info, warn, error, fatal, panic}
- LOGFORMAT (optional) : Log format (default json) from: {json, text}
- SWAPPUBLICATIONOFFSET (optional) : Swap publication deadline offset (Maximum time for the swap provider to publish the swap) (default 30m)
- RETRIESBEFOREBACKOFF (optional) : Number of retries before applying backoff to the swap (default: 3)
- BACKOFFCOEFFICIENT (optional) : Coefficient to apply to the backoff (default: 0.95)
- BACKOFFLIMIT (optional) : Limit coefficient of the backoff (default: 0.1)

# Build & test
## Build
Expand Down