core-lightning/doc/lightning-sendonionmessage.7.md

47 lines
1.1 KiB
Markdown
Raw Normal View History

lightning-sendonionmessage -- low-level command to send an onion message
================================================================
SYNOPSIS
--------
**(WARNING: experimental-onion-messages only)**
**sendonionmessage** *first_id* *blinding* *hops*
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 *tlv* contains a hexidecimal TLV to include.
RETURN VALUE
------------
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an empty object is returned.
[comment]: # (GENERATE-FROM-SCHEMA-END)
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
[comment]: # ( SHA256STAMP:8e7f2c4372f12ee7f79df114e9ac9539ad6b19821e6c808e47d1ba9f7981e8ea)