Skip to content

Commit 1ff2e5c

Browse files
committed
docs: add recurring budget and release note
1 parent 3b896ba commit 1ff2e5c

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

docs/autoloop.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -157,31 +157,28 @@ The autolooper operates within a set budget, and will stop executing swaps when
157157
this budget is reached. This budget includes the fees paid to the swap server,
158158
on-chain sweep costs and off-chain routing fees. Note that the budget does not
159159
include the actual swap amount, as this balance is simply shifted from off-chain
160-
to on-chain, rather than used up.
160+
to on-chain, rather than used up.
161161

162162
The budget value is expressed in satoshis, and can be set using the `setparams`
163163
loop command:
164164
```
165165
loop setparams --autobudget={budget in satoshis}
166166
```
167167

168-
Your autoloop budget can optionally be paired with a start time, which
169-
determines the time from which we will count autoloop swaps as being part of
170-
the budget. If this value is zero, it will consider all automatically
171-
dispatched swaps as being part of the budget.
172-
173-
The start time is expressed as a unix timestamp, and can be set using the
174-
`setparams` loop command:
168+
Your autoloop budget is refreshed based on a configurable interval. You can
169+
specify how often the budget is going to refresh by using the `setparams` loop
170+
command:
175171
```
176-
loop setparams --budgetstart={start time in seconds}
172+
loop setparams --autobudgetrefreshperiod={duration in seconds}
177173
```
178174

175+
179176
If your autolooper has used up its budget, and you would like to top it up, you
180-
can do so by either increasing the overall budget amount, or by increasing the
181-
start time to the present. For example, if you want to set your autolooper to
182-
have a budget of 100k sats for the month, you could set the following:
177+
can do so by either increasing the overall budget amount, or by decreasing the
178+
refresh interval. For example, if you want to set your autolooper to
179+
have a budget of 100k sats per 7 days (or 604800 seconds), you could set the following:
183180
```
184-
loop setparams --autobudget=100000 --autostart={beginning of month ts}
181+
loop setparams --autobudget=100000 --autobudgetrefreshperiod=604800
185182
```
186183

187184
## Dispatch Control

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+
* Autoloop now uses a recurring budget. Users can now specify `autobudget` and
19+
`autobudgetrefreshperiod` to specify the amount of the budget and the period
20+
over which it will refresh.
1821

1922
#### Breaking Changes
2023

0 commit comments

Comments
 (0)