Skip to content

Commit 5edc39d

Browse files
committed
loop: update docs and release notes
1 parent 9a97667 commit 5edc39d

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

docs/autoloop.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,24 @@ following command:
99
loop setparams --autoloop=true
1010
```
1111

12+
## Easy Autoloop
13+
14+
If you don't want to bother with setting up specific rules for each of your
15+
channels and peers you can use easy autoloop. This mode of autoloop requires
16+
for you to set only the overall channel balance that you don't wish to exceed
17+
on your lightning node. For example, if you want to keep your node's total
18+
channel balance below 1 million satoshis you can set the following
19+
```
20+
loop setparams --autoloop=true --easyautoloop=true --localbalancesat=1000000
21+
```
22+
23+
This will automatically start dispatching loop-outs whenever you exceed total
24+
channel balance of 1M sats. Keep in mind that on first time use this will use
25+
the default budget parameters. If you wish to configure a custom budget you can
26+
find more info in the [Budget](#budget) section.
27+
28+
## Liquidity Rules
29+
1230
At present, autoloop can be configured to either acquire incoming liquidity
1331
using loop out, or acquire outgoing liquidity using loop in. It cannot support
1432
automated swaps in both directions. To set the type of swaps you would like

release_notes.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ This file tracks release notes for the loop client.
1515
## Next release
1616

1717
#### New Features
18+
- Easy Autoloop: a new mode for autoloop which requires the user to only set a
19+
single target balance. Autoloop will start dispatching loop outs
20+
whenever the total channel balance of the node exceeds that target.
1821

1922
#### Breaking Changes
2023

0 commit comments

Comments
 (0)