Browse Source

doc: Document the `msatoshi` parameter for `sendonion`

sendonion-msatoshi
Christian Decker 5 years ago
committed by Rusty Russell
parent
commit
315f1d3ba7
  1. 6
      doc/lightning-sendonion.7
  2. 5
      doc/lightning-sendonion.7.md

6
doc/lightning-sendonion.7

@ -3,7 +3,7 @@
lightning-sendonion - Send a payment with a custom onion packet lightning-sendonion - Send a payment with a custom onion packet
.SH SYNOPSIS .SH SYNOPSIS
\fBsendonion\fR \fIonion\fR \fIfirst_hop\fR \fIpayment_hash\fR [\fIlabel\fR] [\fIshared_secrets\fR] [\fIpartid\fR] [\fIbolt11\fR] \fBsendonion\fR \fIonion\fR \fIfirst_hop\fR \fIpayment_hash\fR [\fIlabel\fR] [\fIshared_secrets\fR] [\fIpartid\fR] [\fIbolt11\fR] [\fImsatoshi\fR]
.SH DESCRIPTION .SH DESCRIPTION
@ -89,6 +89,10 @@ partial payments with the same \fIpayment_hash\fR\.
The \fIbolt11\fR parameter, if provided, will be returned in The \fIbolt11\fR parameter, if provided, will be returned in
\fIwaitsendpay\fR and \fIlistsendpays\fR results\. \fIwaitsendpay\fR and \fIlistsendpays\fR results\.
The \fImsatoshi\fR parameter is used to annotate the payment, and is returned by
\fIwaitsendpay\fR and \fIlistsendpays\fR\.
.SH RETURN VALUE .SH RETURN VALUE
On success, an object similar to the output of \fBsendpay\fR will be On success, an object similar to the output of \fBsendpay\fR will be

5
doc/lightning-sendonion.7.md

@ -4,7 +4,7 @@ lightning-sendonion -- Send a payment with a custom onion packet
SYNOPSIS SYNOPSIS
-------- --------
**sendonion** *onion* *first_hop* *payment_hash* \[*label*\] \[*shared_secrets*\] \[*partid*\] \[*bolt11*\] **sendonion** *onion* *first_hop* *payment_hash* \[*label*\] \[*shared_secrets*\] \[*partid*\] \[*bolt11*\] \[*msatoshi*\]
DESCRIPTION DESCRIPTION
----------- -----------
@ -78,6 +78,9 @@ partial payments with the same *payment_hash*.
The *bolt11* parameter, if provided, will be returned in The *bolt11* parameter, if provided, will be returned in
*waitsendpay* and *listsendpays* results. *waitsendpay* and *listsendpays* results.
The *msatoshi* parameter is used to annotate the payment, and is returned by
*waitsendpay* and *listsendpays*.
RETURN VALUE RETURN VALUE
------------ ------------

Loading…
Cancel
Save