mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-01-18 21:35:11 +01:00
5e0a5c9111
delinvoice was orginally documented to only allow deletion of unpaid invoices, but there might be reasons to delete paid ones or unexpired ones. But we have to avoid the race where someone pays as it's deleted: the easiest way is to have the caller tell us the status, and fail if it's wrong. Fixes: #477 Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
52 lines
1.9 KiB
Groff
52 lines
1.9 KiB
Groff
'\" t
|
|
.\" Title: lightning-delinvoice
|
|
.\" Author: [see the "AUTHOR" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
|
|
.\" Date: 01/18/2018
|
|
.\" Manual: \ \&
|
|
.\" Source: \ \&
|
|
.\" Language: English
|
|
.\"
|
|
.TH "LIGHTNING\-DELINVOIC" "7" "01/18/2018" "\ \&" "\ \&"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
lightning-delinvoice \- Protocol for removing an invoice\&.
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
\fBdelinvoice\fR \fIlabel\fR \fIstatus\fR
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
The \fBdelinvoice\fR RPC command removes an invoice with \fIstatus\fR as given in \fBlistinvoices\fR\&.
|
|
.sp
|
|
The caller should be particularly aware of the error case caused by the \fIstatus\fR chaning just before this command is invoked!
|
|
.SH "RETURN VALUE"
|
|
.sp
|
|
On success, an invoice description will be returned as per lightning\-listinvoice(7)\&.
|
|
.SH "AUTHOR"
|
|
.sp
|
|
Rusty Russell <rusty@rustcorp\&.com\&.au> is mainly responsible\&.
|
|
.SH "SEE ALSO"
|
|
.sp
|
|
lightning\-listinvoice(7), lightning\-waitinvoice(7), lightning\-invoice(7)\&.
|
|
.SH "RESOURCES"
|
|
.sp
|
|
Main web site: https://github\&.com/ElementsProject/lightning
|