From 2981184fac145b7dc574a5ffb9e6c3be6b68eb86 Mon Sep 17 00:00:00 2001 From: Christian Decker Date: Tue, 5 Jan 2021 18:58:13 +0100 Subject: [PATCH] docs: Document `bolt11` and `payment_hash` arguments of listinvoices --- doc/lightning-listinvoices.7 | 10 ++++++++-- doc/lightning-listinvoices.7.md | 7 ++++++- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/doc/lightning-listinvoices.7 b/doc/lightning-listinvoices.7 index e760c7390..639602f1b 100644 --- a/doc/lightning-listinvoices.7 +++ b/doc/lightning-listinvoices.7 @@ -3,13 +3,19 @@ lightning-listinvoices - Command for querying invoice status .SH SYNOPSIS -\fBlistinvoices\fR [\fIlabel\fR] +\fBlistinvoices\fR [\fIlabel\fR] [\fIinvstring\fR] [\fIpayment_hash\fR] .SH DESCRIPTION The \fBlistinvoices\fR RPC command gets the status of a specific invoice, if it exists, or the status of all invoices if given no argument\. + +A specific invoice can be queried by providing either the \fBlabel\fR +provided when creating the invoice, the \fBinvstring\fR string representing +the invoice, or the \fBpayment_hash\fR of the invoice\. Only one of the +query parameters can be used at once\. + .SH RETURN VALUE On success, an array \fIinvoices\fR of objects is returned\. Each object contains @@ -35,4 +41,4 @@ Rusty Russell \fI is mainly responsible\. Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:de5a19a60e141b582228650442680a6c966edbab2340894db3b532495c5f462c +\" SHA256STAMP:24dc46a53eed1dd689d7fb371a3da52242f306126d54bba3d8c6ba5a75b6b795 diff --git a/doc/lightning-listinvoices.7.md b/doc/lightning-listinvoices.7.md index 0bb82e1ff..e9b288971 100644 --- a/doc/lightning-listinvoices.7.md +++ b/doc/lightning-listinvoices.7.md @@ -4,7 +4,7 @@ lightning-listinvoices -- Command for querying invoice status SYNOPSIS -------- -**listinvoices** \[*label*\] +**listinvoices** \[*label*\] \[*invstring*\] \[*payment_hash*\] DESCRIPTION ----------- @@ -12,6 +12,11 @@ DESCRIPTION The **listinvoices** RPC command gets the status of a specific invoice, if it exists, or the status of all invoices if given no argument. +A specific invoice can be queried by providing either the `label` +provided when creating the invoice, the `invstring` string representing +the invoice, or the `payment_hash` of the invoice. Only one of the +query parameters can be used at once. + RETURN VALUE ------------