mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-21 14:24:09 +01:00
Code Issues Projects Releases Wiki Activity

doc: Correct preimage field name in pay return value

Browse source
This commit is contained in:
darosior 2019-06-15 00:19:28 +02:00 • committed by Christian Decker
parent 57405d7b68
commit 8edf55b34a
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/lightning-pay.7
View file

@ -76,7 +76,7 @@ Shadow route means the payment algorithm will virtually extend the time delays a
Route randomization will never exceed \fImaxfeepercent\fR of the payment\&. Route randomization and shadow routing will not take routes that would exceed \fImaxdelay\fR\&.
.SH "RETURN VALUE"
.sp
On success, this returns the payment \fIpreimage\fR which hashes to the \fIpayment_hash\fR to prove that the payment was successful\&. It will also return, a \fIgetroute_tries\fR and a \fIsendpay_tries\fR statistics for the number of times it internally called \fBgetroute\fR and \fBsendpay\fR\&.
On success, this returns the \fIpayment_preimage\fR which hashes to the \fIpayment_hash\fR to prove that the payment was successful\&. It will also return, a \fIgetroute_tries\fR and a \fIsendpay_tries\fR statistics for the number of times it internally called \fBgetroute\fR and \fBsendpay\fR\&.
.sp
You can monitor the progress and retries of a payment using the lightning\-paystatus(7) command\&.
.sp

2
doc/lightning-pay.7.txt
View file

@ -78,7 +78,7 @@ will not take routes that would exceed 'maxdelay'.
RETURN VALUE
------------
On success, this returns the payment 'preimage' which hashes to the
On success, this returns the 'payment_preimage' which hashes to the
'payment_hash' to prove that the payment was successful.
It will also return, a 'getroute_tries' and a 'sendpay_tries'
statistics for the number of times it internally called *getroute*