core-lightning/doc/lightning-autocleaninvoice.7.md

54 lines
1.5 KiB
Markdown
Raw Normal View History

lightning-autocleaninvoice -- Set up auto-delete of expired invoice
===================================================================
SYNOPSIS
--------
**autocleaninvoice** \[*cycle\_seconds*\] \[*expired\_by*\]
DESCRIPTION
-----------
The **autocleaninvoice** RPC command sets up automatic cleaning of
expired invoices.
Autoclean will be done every *cycle\_seconds* seconds. Setting
*cycle\_seconds* to 0 disables autoclean. If not specified, this
defaults to 3600 (one hour).
Every autoclean cycle, expired invoices, which have already been expired
for at least *expired\_by* seconds, will be deleted. If *expired\_by* is
not specified, this defaults to 86400 (one day).
On startup of the daemon, no autoclean is set up.
RETURN VALUE
------------
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **enabled** (boolean): whether invoice autocleaning is active
If **enabled** is *true*:
- **expired_by** (u64): how long an invoice must be expired (seconds) before we delete it
- **cycle_seconds** (u64): how long an invoice must be expired (seconds) before we delete it
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
------
ZmnSCPxj <<ZmnSCPxj@protonmail.com>> is mainly responsible.
SEE ALSO
--------
lightning-delexpiredinvoice(7), lightning-delinvoice(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:dc9caae8f7ca886630f2685ea972fb1113ffcfd5a5e46c2d212c3c4bbc4e5f44)