From 5edc39dff330478399ffc58f563627053a592dc3 Mon Sep 17 00:00:00 2001 From: George Tsagkarelis Date: Mon, 22 May 2023 15:27:45 +0300 Subject: [PATCH] loop: update docs and release notes --- docs/autoloop.md | 18 ++++++++++++++++++ release_notes.md | 3 +++ 2 files changed, 21 insertions(+) diff --git a/docs/autoloop.md b/docs/autoloop.md index 0c40d37..1d7af90 100644 --- a/docs/autoloop.md +++ b/docs/autoloop.md @@ -9,6 +9,24 @@ following command: loop setparams --autoloop=true ``` +## Easy Autoloop + +If you don't want to bother with setting up specific rules for each of your +channels and peers you can use easy autoloop. This mode of autoloop requires +for you to set only the overall channel balance that you don't wish to exceed +on your lightning node. For example, if you want to keep your node's total +channel balance below 1 million satoshis you can set the following +``` +loop setparams --autoloop=true --easyautoloop=true --localbalancesat=1000000 +``` + +This will automatically start dispatching loop-outs whenever you exceed total +channel balance of 1M sats. Keep in mind that on first time use this will use +the default budget parameters. If you wish to configure a custom budget you can +find more info in the [Budget](#budget) section. + +## Liquidity Rules + At present, autoloop can be configured to either acquire incoming liquidity using loop out, or acquire outgoing liquidity using loop in. It cannot support automated swaps in both directions. To set the type of swaps you would like diff --git a/release_notes.md b/release_notes.md index c71d135..bfcde11 100644 --- a/release_notes.md +++ b/release_notes.md @@ -15,6 +15,9 @@ This file tracks release notes for the loop client. ## Next release #### New Features +- Easy Autoloop: a new mode for autoloop which requires the user to only set a + single target balance. Autoloop will start dispatching loop outs + whenever the total channel balance of the node exceeds that target. #### Breaking Changes