Browse Source

doc: Correct preimage field name in pay return value

pull/2938/head
darosior 6 years ago
committed by Christian Decker
parent
commit
8edf55b34a
  1. 2
      doc/lightning-pay.7
  2. 2
      doc/lightning-pay.7.txt

2
doc/lightning-pay.7

@ -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\&. 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" .SH "RETURN VALUE"
.sp .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 .sp
You can monitor the progress and retries of a payment using the lightning\-paystatus(7) command\&. You can monitor the progress and retries of a payment using the lightning\-paystatus(7) command\&.
.sp .sp

2
doc/lightning-pay.7.txt

@ -78,7 +78,7 @@ will not take routes that would exceed 'maxdelay'.
RETURN VALUE 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. 'payment_hash' to prove that the payment was successful.
It will also return, a 'getroute_tries' and a 'sendpay_tries' It will also return, a 'getroute_tries' and a 'sendpay_tries'
statistics for the number of times it internally called *getroute* statistics for the number of times it internally called *getroute*

Loading…
Cancel
Save