doc: Manual page for sendonionmessage.

Signed-off-by: Rusty Russell <[email protected]>

Author: rustyrussell

doc/Makefile

@@ -54,6 +54,7 @@ MANPAGES := doc/lightning-cli.1 \
 	doc/lightning-reserveinputs.7 \
 	doc/lightning-sendinvoice.7 \
 	doc/lightning-sendonion.7 \
+	doc/lightning-sendonionmessage.7 \
 	doc/lightning-sendpay.7 \
 	doc/lightning-setchannelfee.7 \
 	doc/lightning-signmessage.7 \

doc/index.rst

@@ -84,6 +84,7 @@ c-lightning Documentation
    lightning-reserveinputs <lightning-reserveinputs.7.md>
    lightning-sendinvoice <lightning-sendinvoice.7.md>
    lightning-sendonion <lightning-sendonion.7.md>
+   lightning-sendonionmessage <lightning-sendonionmessage.7.md>
    lightning-sendpay <lightning-sendpay.7.md>
    lightning-sendpsbt <lightning-sendpsbt.7.md>
    lightning-setchannelfee <lightning-setchannelfee.7.md>

doc/lightning-sendonionmessage.7

@@ -0,0 +1,49 @@
+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 <<[email protected]>> 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
+

doc/lightning-sendonionmessage.7.md

@@ -559,6 +559,29 @@ if C-lightning terminates\.
 Built-in plugins, which are installed with \fBlightningd\fR(8), are automatically
 considered important\.
 
+.SH Experimental Options
+
+Experimental options are subject to breakage between releases: they
+are made available for advanced users who want to test proposed
+features\.  If lightningd is built configured with
+\fB--enable-experimental-features\fR these are on by default\.
+
+
+ \fBexperimental-onion-messages\fR
+
+
+Specifying this enables sending, forwarding and receiving onion messages,
+which are in draft status in the BOLT specifications\.
+
+
+ \fBexperimental-offers\fR
+
+
+Specifying this enables the \fBoffers\fR and \fBfetchinvoice\fR plugins and
+corresponding functionality, which are in draft status as BOLT12\. 
+This usually requires \fBexperimental-onion-messages\fR as well\.  See
+\fBlightning-offer\fR(7) and \fBlightning-fetchinvoice\fR(7)\.
+
 .SH BUGS
 
 You should report bugs on our github issues page, and maybe submit a fix
@@ -584,4 +607,4 @@ Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
 Note: the modules in the ccan/ directory have their own licenses, but
 the rest of the code is covered by the BSD-style MIT license\.
 
-\" SHA256STAMP:c927bd3afb61288bb67d941d113cdeefe1363b0c7a28936ef30d43af3ce66098
+\" SHA256STAMP:e9f294f15d8873a2332b5748179be09c1496c9e81576dc0e4546c047474289fd

doc/lightningd-config.5

@@ -463,6 +463,25 @@ if C-lightning terminates.
 Built-in plugins, which are installed with lightningd(8), are automatically
 considered important.
 
+### Experimental Options
+
+Experimental options are subject to breakage between releases: they
+are made available for advanced users who want to test proposed
+features.  If lightningd is built configured with
+`--enable-experimental-features` these are on by default.
+
+ **experimental-onion-messages**
+
+Specifying this enables sending, forwarding and receiving onion messages,
+which are in draft status in the BOLT specifications.
+
+ **experimental-offers**
+
+Specifying this enables the `offers` and `fetchinvoice` plugins and
+corresponding functionality, which are in draft status as BOLT12. 
+This usually requires **experimental-onion-messages** as well.  See
+lightning-offer(7) and lightning-fetchinvoice(7).
+
 BUGS
 ----