mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +01:00
50 lines
1.3 KiB
Markdown
50 lines
1.3 KiB
Markdown
lightning-sendonionmessage -- low-level command to send an onion message
|
|
================================================================
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
**(WARNING: experimental-onion-messages only)**
|
|
|
|
**sendonionmessage** *hops* \[*reply_path*\]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
The **sendonionmessage** RPC command can be used to send a message via
|
|
the lightning network. These are currently used by *offers* to request
|
|
and receive invoices.
|
|
|
|
*hops* is an array of json objects: *id* as a public key of the node,
|
|
and either *rawtlv* containing a hexidecimal TLV to include, or any of
|
|
the fields *short_channel_id*, *blinding*, *enctlv*, *invoice*,
|
|
*invoice_request* and *invoice_error* to construct the onionmessage
|
|
TLV with.
|
|
|
|
*reply_path* is a json object, containing a pubkey *blinding*, and an
|
|
array *path* of objects containing *id* (a pubkey) and *enctlv* (a hex
|
|
value, optional for final element).
|
|
|
|
RETURN VALUE
|
|
------------
|
|
|
|
On success, an empty JSON object is returned.
|
|
|
|
AUTHOR
|
|
------
|
|
|
|
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
lightning-fetchinvoice(7), lightning-offer(7).
|
|
|
|
RESOURCES
|
|
---------
|
|
|
|
Main web site: <https://github.com/ElementsProject/lightning>
|
|
|
|
[bolt04]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md
|
|
|