diff --git a/docs/autoloop.md b/docs/autoloop.md index bc09324..fb44846 100644 --- a/docs/autoloop.md +++ b/docs/autoloop.md @@ -55,10 +55,16 @@ loop setrule {short channel id/ peer pubkey} --clear ``` ## Fees -Fee control is one of the most important features of the autolooper, so we expose -multiple fee related settings which can be used to tune the autolooper to your -preference. Note that these fees are expressed on a per-swap basis, rather than -as an overall budget. +The amount of fees that an automatically dispatched swap consumes can be limited +to a percentage of the swap amount using the fee percentage parameter: +``` +loop setparams --feepercent={percentage of swap amount} +``` + +If you would like finer grained control over swap fees, there are multiple fee +related settings which can be used to tune the autolooper to your preference. +The sections that follow explain these settings in detail. Note that these fees +are expressed on a per-swap basis, rather than as an overall budget. ### On-Chain Fees When performing a successful loop out swap, the loop client needs to sweep the @@ -277,6 +283,10 @@ following reasons will be displayed: * Liquidity ok: if a channel's current liquidity balance is within the bound set by the rule that it applies to, then a liquidity ok reason will be displayed to indicate that no action is required for that channel. +* Fee insufficient: if the fees that a swap will cost are more than the + percentage of total swap amount that we allow, this reason will be displayed. + See [fees](#fees) to update this value. + Further details for all of these reasons can be found in loopd's debug level logs. diff --git a/release_notes.md b/release_notes.md index aaab42e..b2190ac 100644 --- a/release_notes.md +++ b/release_notes.md @@ -20,6 +20,10 @@ This file tracks release notes for the loop client. to be set for an individual peer, rather than a specific channel, and leverages multi-loop-out to more efficiently manage liquidity. To configure peer-level rules, provide the 'setrule' command with the peer's pubkey. +* Autoloop's fee API has been simplified to allow setting a single percentage + which will be used to limit total swap fees to a percentage of the amount + being swapped. Use `loop setparams --feepercent={percentage}` to update + this value. This fee setting has been updated to the default for autoloop. #### Breaking Changes