mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity

doc: document the payment_secret argument to sendpay.

Browse Source 
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell 2020-07-21 13:52:56 +09:30 committed by Christian Decker
parent 09eb7110e0
commit 23af241c60
2 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/lightning-sendpay.7 generated
View File

@ -4,7 +4,7 @@ lightning-sendpay - Low-level command for sending a payment via a route
.SH SYNOPSIS
\fBsendpay\fR \fIroute\fR \fIpayment_hash\fR [\fIlabel\fR] [\fImsatoshi\fR]
[\fIbolt11\fR] [\fIpartid\fR]
[\fIbolt11\fR] [\fIpayment_secret\fR] [\fIpartid\fR]
.SH DESCRIPTION
@ -36,6 +36,12 @@ ending in \fImsat\fR or \fIsat\fR, or a number with three decimal places ending
in \fIsat\fR, or a number with 1 to 11 decimal places ending in \fIbtc\fR\.
The \fIpayment_secret\fR is the value that the final recipient requires to
accept the payment, as defined by the \fBpayment_data\fR field in BOLT 4
and the \fBs\fR field in the BOLT 11 invoice format\. It is required if
\fIpartid\fR is non-zero\.
The \fIpartid\fR value, if provided and non-zero, allows for multiple parallel
partial payments with the same \fIpayment_hash\fR\. The \fImsatoshi\fR amount
(which must be provided) for each \fBsendpay\fR with matching

7
doc/lightning-sendpay.7.md
View File

@ -5,7 +5,7 @@ SYNOPSIS
--------
**sendpay** *route* *payment\_hash* \[*label*\] \[*msatoshi*\]
\[*bolt11*\] \[*partid*\]
\[*bolt11*\] \[*payment_secret*\] \[*partid*\]
DESCRIPTION
-----------
@ -33,6 +33,11 @@ amount to the destination. By default it is in millisatoshi precision; it can be
ending in *msat* or *sat*, or a number with three decimal places ending
in *sat*, or a number with 1 to 11 decimal places ending in *btc*.
The *payment_secret* is the value that the final recipient requires to
accept the payment, as defined by the `payment_data` field in BOLT 4
and the `s` field in the BOLT 11 invoice format. It is required if
*partid* is non-zero.
The *partid* value, if provided and non-zero, allows for multiple parallel
partial payments with the same *payment_hash*. The *msatoshi* amount
(which must be provided) for each **sendpay** with matching