Skip to content

Commit cf50ffd

Browse files
committed
multi: add disqualified swaps to docs and release notes
1 parent 22bd4ca commit cf50ffd

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

docs/autoloop.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,3 +225,50 @@ specified in the outgoing channel swap, and for loop in the channel's peer is
225225
specified as the last hop for an ongoing swap. This check is put in place to
226226
prevent the autolooper from interfering with swaps you have created yourself.
227227

228+
## Disqualified Swaps
229+
There are various restrictions placed on the client's autoloop functionality.
230+
If a channel is not eligible for a swap at present, or it does not need one
231+
based on the current set of liquidity rules, it will be listed in the
232+
`Disqualified` section of the output of the `SuggestSwaps` API. One of the
233+
following reasons will be displayed:
234+
235+
* Budget not started: if the start date for your budget is in the future,
236+
no swaps will be executed until the start date is reached. See [budget](#budget) to
237+
update.
238+
* Budget elapsed: if the autolooper has elapsed the budget assigned to it for
239+
fees, this reason will be returned. See [budget](#budget) to update.
240+
* Sweep fees: this reason will be displayed if the estimated chain fee rate for
241+
sweeping a loop out swap is higher than the current limit. See [sweep fees](#fee-market-awareness)
242+
to update.
243+
* In flight: there is a limit to the number of automatically dispatched swaps
244+
that the client allows. If this limit has been reached, no further swaps
245+
will be automatically dispatched until the in-flight swaps complete. See
246+
[in flight limit](#in-flight-limit) to update.
247+
* Budget insufficient: if there is not enough remaining budget for a swap,
248+
including the amount currently reserved for in flight swaps, an insufficient
249+
reason will be displayed. This differs from budget elapsed because there is
250+
still budget remaining, just not enough to execute a specific swap.
251+
* Swap fee: there is a limit placed on the fee that the client will pay to the
252+
server for automatically dispatched swaps. The swap fee reason will be shown
253+
if the fees advertised by the server are too high. See [swap fee](#swap-fee)
254+
to update.
255+
* Miner fee: if the estimated on-chain fees for a swap are too high, autoloop
256+
will display a miner fee reason. See [miner fee](#miner-fee) to update.
257+
* Prepay: if the no-show fee that the server will pay in the unlikely event
258+
that the client fails to complete a swap is too high, a prepay reason will
259+
be returned. See [no show fees](#no-show-fee) to update.
260+
* Backoff: if an automatically dispatched swap has recently failed for a channel,
261+
autoloop will backoff for a period before retrying. See [failure backoff](#failure-backoff)
262+
to update.
263+
* Loop out: if there is currently a loop out swap in-flight on a channel, it
264+
will not be used for automated swaps. This issue will resolve itself once the
265+
in-flight swap completes.
266+
* Loop in: if there is currently a loop in swap in-flight for a peer, it will
267+
not be used for automated swaps. This will resolve itself once the swap is
268+
completed.
269+
* Liquidity ok: if a channel's current liquidity balance is within the bound set
270+
by the rule that it applies to, then a liquidity ok reason will be displayed
271+
to indicate that no action is required for that channel.
272+
273+
Further details for all of these reasons can be found in loopd's debug level
274+
logs.

release_notes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ This file tracks release notes for the loop client.
2828
swaps even if there are manually initiated swaps that are not limited to a
2929
single channel in progress. This change was made to allow autoloop to coexist
3030
with manual swaps.
31+
* The `SuggestSwaps` endpoint has been updated to include reasons that indicate
32+
why the Autolooper is not currently dispatching swaps for the set of rules
33+
that the client is configured with. See the [autoloop documentation](docs/autoloop.md) for a
34+
detailed explanations of these reasons.
3135

3236
#### Breaking Changes
3337
* The `AutoOut`, `AutoOutBudgetSat` and `AutoOutBudgetStartSec` fields in the

0 commit comments

Comments
 (0)