From 710e91f25550dd64f32bbb67a21d5098ec49dc53 Mon Sep 17 00:00:00 2001 From: windsok Date: Tue, 16 Jan 2018 00:56:01 -0800 Subject: [PATCH] update invoice manpage to match current RPC and CLI interface --- doc/lightning-invoice.7 | 10 +++++++--- doc/lightning-invoice.7.txt | 9 ++++++++- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/doc/lightning-invoice.7 b/doc/lightning-invoice.7 index b9680aa25..e038aea46 100644 --- a/doc/lightning-invoice.7 +++ b/doc/lightning-invoice.7 @@ -2,12 +2,12 @@ .\" Title: lightning-invoice .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 01/13/2018 +.\" Date: 01/16/2018 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "LIGHTNING\-INVOICE" "7" "01/13/2018" "\ \&" "\ \&" +.TH "LIGHTNING\-INVOICE" "7" "01/16/2018" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -31,7 +31,7 @@ lightning-invoice \- Protocol for accepting payments\&. .SH "SYNOPSIS" .sp -\fBinvoice\fR \fImsatoshi\fR \fIlabel\fR +\fBinvoice\fR \fImsatoshi\fR \fIlabel\fR \fIdescription\fR [\fIexpiry\fR] .SH "DESCRIPTION" .sp The \fBinvoice\fR RPC command creates the expectation of a payment of a given amount of milli\-satoshi: it returns a unique token which another lightning daemon can use to pay this invoice\&. @@ -39,6 +39,10 @@ The \fBinvoice\fR RPC command creates the expectation of a payment of a given am The \fImsatoshi\fR can be the string "any", which creates an invoice that can be paid with any amount\&. .sp The \fIlabel\fR must be unique; it is never revealed to other nodes on the lightning network, but it can be used to query the status of this invoice\&. +.sp +The \fIdescription\fR is a short description of purpose of payment, e\&.g\&. \fI1 cup of coffee\fR\&. This value is encoded into the BOLT11 invoice and is viewable by any node you send this invoice to\&. +.sp +The \fIexpiry\fR is optionally the number of seconds the invoice is valid for\&. If no value is provided the default of 3600 (1 Hour) is used\&. .SH "RETURN VALUE" .sp On success, a hash is returned as \fIpayment_hash\fR to be given to the payer, and the \fIexpiry_time\fR as a UNIX timestamp\&. It also returns a BOLT11 invoice as \fIbolt11\fR to be given to the payer\&. On failure, an error is returned and no invoice is created\&. If the lightning process fails before responding, the caller should use lightning\-listinvoice(7) to query whether this invoice was created or not\&. diff --git a/doc/lightning-invoice.7.txt b/doc/lightning-invoice.7.txt index 07329fe13..38910707e 100644 --- a/doc/lightning-invoice.7.txt +++ b/doc/lightning-invoice.7.txt @@ -8,7 +8,7 @@ lightning-invoice - Protocol for accepting payments. SYNOPSIS -------- -*invoice* 'msatoshi' 'label' +*invoice* 'msatoshi' 'label' 'description' ['expiry'] DESCRIPTION ----------- @@ -23,6 +23,13 @@ The 'label' must be unique; it is never revealed to other nodes on the lightning network, but it can be used to query the status of this invoice. +The 'description' is a short description of purpose of payment, +e.g. '1 cup of coffee'. This value is encoded into the BOLT11 invoice +and is viewable by any node you send this invoice to. + +The 'expiry' is optionally the number of seconds the invoice is valid for. +If no value is provided the default of 3600 (1 Hour) is used. + RETURN VALUE ------------