mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +01:00
2ddecdc95a
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
46 lines
1.3 KiB
Groff
Generated
46 lines
1.3 KiB
Groff
Generated
.TH "LIGHTNING-SENDONIONMESSAGE" "7" "" "" "lightning-sendonionmessage"
|
|
.SH NAME
|
|
lightning-sendonionmessage - low-level command to send an onion message
|
|
.SH SYNOPSIS
|
|
|
|
\fB(WARNING: experimental-onion-messages only)\fR
|
|
|
|
|
|
\fBsendonionmessage\fR \fIhops\fR [\fIreply_path\fR]
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The \fBsendonionmessage\fR RPC command can be used to send a message via
|
|
the lightning network\. These are currently used by \fIoffers\fR to request
|
|
and receive invoices\.
|
|
|
|
|
|
\fIhops\fR is an array of json objects: \fIid\fR as a public key of the node,
|
|
and either \fIrawtlv\fR containing a hexidecimal TLV to include, or any of
|
|
the fields \fIshort_channel_id\fR, \fIblinding\fR, \fIenctlv\fR, \fIinvoice\fR,
|
|
\fIinvoice_request\fR and \fIinvoice_error\fR to construct the onionmessage
|
|
TLV with\.
|
|
|
|
|
|
\fIreply_path\fR is a json object, containing a pubkey \fIblinding\fR, and an
|
|
array \fIpath\fR of objects containing \fIid\fR (a pubkey) and \fIenctlv\fR (a hex
|
|
value, optional for final element)\.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, an empty object is returned\.
|
|
|
|
.SH AUTHOR
|
|
|
|
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBlightning-fetchinvoice\fR(7), \fBlightning-offer\fR(7)\.
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|
|
\" SHA256STAMP:c792b84bb590ab7ec719c75db1c54a5147688688b10dd4cd01b10bf3f4e5f357
|