Skip to content

Commit b393102

Browse files
committed
multi: update docs and release notes to include peer level management
1 parent b9aae4f commit b393102

File tree

2 files changed

+29
-16
lines changed

2 files changed

+29
-16
lines changed

docs/autoloop.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,35 @@ Note that autoloop parameters and rules are not persisted, so must be set on
2323
restart. We recommend running loopd with `--debuglevel=debug` when using this
2424
feature.
2525

26-
### Channel Thresholds
27-
To setup the autolooper to dispatch swaps on your behalf, you need to tell it
28-
which channels you would like it to perform swaps on, and the liquidity balance
29-
you would like on each channel. Desired liqudity balance is expressed using
30-
threshold incoming and outgoing percentages of channel capacity. The incoming
31-
threshold you specify indicates the minimum percentage of your channel capacity
32-
that you would like in incoming capacity. The outgoing thresold allows you to
33-
reserve a percentage of your balance for outgoing capacity, but may be set to
34-
zero if you are only concerned with incoming capcity.
35-
36-
The autolooper will perform swaps that push your incoming channel capacity to
37-
at least the incoming threshold you specify, while reserving at least the
38-
outgoing capacity threshold. Rules can be set as follows:
26+
### Liquidity Targets
27+
Autoloop can be configured to manage liquidity for individual channels, or for
28+
a peer as a whole. Peer-level liquidity management will examine the liquidity
29+
balance of all the channels you have with a peer. This differs from channel-level
30+
liquidity, where each channel's individual balance is checked. Note that if you
31+
set a liquidity rule for a peer, you cannot also set a specific rule for one of
32+
its channels.
33+
34+
### Liqudity Thresholds
35+
To setup the autolooper to dispatch swaps on your behalf, you need to set the
36+
liquidity balance you would like for each channel or peer. Desired liquidity
37+
balance is expressed using threshold incoming and outgoing percentages of
38+
capacity. The incoming threshold you specify indicates the minimum percentage
39+
of your capacity that you would like in incoming capacity. The outgoing
40+
threshold allows you to reserve a percentage of your balance for outgoing
41+
capacity, but may be set to zero if you are only concerned with incoming
42+
capacity.
43+
44+
The autolooper will perform swaps that push your incoming capacity to at least
45+
the incoming threshold you specify, while reserving at least the outgoing
46+
capacity threshold. Rules can be set as follows:
3947

4048
```
41-
loop setrule {short channel id} --incoming_threshold={minimum % incoming} --outgoing_threshold={minimum % outgoing}
49+
loop setrule {short channel id/ peer pubkey} --incoming_threshold={minimum % incoming} --outgoing_threshold={minimum % outgoing}
4250
```
4351

44-
To remove a channel from consideration, its rule can simply be cleared:
52+
To remove a rule from consideration, its rule can simply be cleared:
4553
```
46-
loop setrule {short channel id} --clear
54+
loop setrule {short channel id/ peer pubkey} --clear
4755
```
4856

4957
## Fees

release_notes.md

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

1717
#### New Features
18+
* Autoloop can now be configured on a per-peer basis, rather than only on an
19+
individual channel level. This change allows desired liquidity thresholds
20+
to be set for an individual peer, rather than a specific channel, and
21+
leverages multi-loop-out to more efficiently manage liquidity. To configure
22+
peer-level rules, provide the 'setrule' command with the peer's pubkey.
1823

1924
#### Breaking Changes
2025

0 commit comments

Comments
 (0)