mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
3dbf3b057a
core-lightning/doc/lightning-autocleaninvoice.7.md
Rusty Russell 6d1897b796 doc: fix GH/readthedocs rendering of manual pages. 
They render the comment as if it's in the list.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-05 15:02:17 +02:00

1.5 KiB
Raw Blame 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

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

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