Skip to content

Commit bdff286

Browse files
committed
docs: add swap size to autoloop documentation
1 parent 87fd637 commit bdff286

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/autoloop.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,33 @@ The default value for this parameter is 24hours, and it can be updated as follow
191191
loop setparams --failurebackoff={backoff in seconds}
192192
```
193193

194+
### Swap Size
195+
By default, the autolooper will execute a swap when the amount that needs to be
196+
rebalanced within a channel is equal to the swap server's minimum swap size.
197+
This means that it will dispatch swaps more regularly, and ensure that channels
198+
are not run down too far below their configured threshold. If you are willing
199+
to allow your liquidity to drop further than the minimum swap amount below your
200+
threshold, a custom minimum swap size can be set. If autolooper is configured
201+
with a larger minimum swap size, it will allow channels to drop further below
202+
their target threshold, but will perform fewer swaps, potentially saving on
203+
fees.
204+
205+
```
206+
loop setparams --minamt={amount in satoshis}
207+
```
208+
209+
Swaps are also limited to the maximum swap amount advertised by the server. If
210+
you would like to reduce the size of swap that autoloop created, this value can
211+
also be configured.
212+
213+
```
214+
loop setparams --maxamt={amount in satoshis}
215+
```
216+
217+
The server's current terms are provided by the `loop terms` cli command. The
218+
values set for minimum and maximum swap amount must be within the range that
219+
the server supports.
220+
194221
## Manual Swap Interaction
195222
The autolooper will not dispatch swaps over channels that are already included
196223
in manually dispatched swaps - for loop out, this would mean the channel is

0 commit comments

Comments
 (0)