Skip to content

Commit 34726a4

Browse files
committed
multi: update release notes and docs to include fee percentage
1 parent d4b7f9a commit 34726a4

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

docs/autoloop.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,16 @@ loop setrule {short channel id/ peer pubkey} --clear
5555
```
5656

5757
## Fees
58-
Fee control is one of the most important features of the autolooper, so we expose
59-
multiple fee related settings which can be used to tune the autolooper to your
60-
preference. Note that these fees are expressed on a per-swap basis, rather than
61-
as an overall budget.
58+
The amount of fees that an automatically dispatched swap consumes can be limited
59+
to a percentage of the swap amount using the fee percentage parameter:
60+
```
61+
loop setparams --feepercent={percentage of swap amount}
62+
```
63+
64+
If you would like finer grained control over swap fees, there are multiple fee
65+
related settings which can be used to tune the autolooper to your preference.
66+
The sections that follow explain these settings in detail. Note that these fees
67+
are expressed on a per-swap basis, rather than as an overall budget.
6268

6369
### On-Chain Fees
6470
When performing a successful loop out swap, the loop client needs to sweep the
@@ -277,6 +283,10 @@ following reasons will be displayed:
277283
* Liquidity ok: if a channel's current liquidity balance is within the bound set
278284
by the rule that it applies to, then a liquidity ok reason will be displayed
279285
to indicate that no action is required for that channel.
286+
* Fee insufficient: if the fees that a swap will cost are more than the
287+
percentage of total swap amount that we allow, this reason will be displayed.
288+
See [fees](#fees) to update this value.
289+
280290

281291
Further details for all of these reasons can be found in loopd's debug level
282292
logs.

release_notes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ This file tracks release notes for the loop client.
2020
to be set for an individual peer, rather than a specific channel, and
2121
leverages multi-loop-out to more efficiently manage liquidity. To configure
2222
peer-level rules, provide the 'setrule' command with the peer's pubkey.
23+
* Autoloop's fee API has been simplified to allow setting a single percentage
24+
which will be used to limit total swap fees to a percentage of the amount
25+
being swapped. Use `loop setparams --feepercent={percentage}` to update
26+
this value. This fee setting has been updated to the default for autoloop.
2327

2428
#### Breaking Changes
2529

0 commit comments

Comments
 (0)