rgb-cln/doc/lightning-sendonionmessage....

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/lightning/bolts/blob/master/04-onion-routing.md

[comment]: # ( SHA256STAMP:636acc798ed7ae1cd307ada4dbde424c1ed8aa514600bec9adeacd5778f4d036)
doc: Manual page for sendonionmessage. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-01-14 03:36:49 +00:00			`lightning-sendonionmessage -- low-level command to send an onion message`
			`================================================================`

			`SYNOPSIS`
			`--------`

			`(WARNING: experimental-onion-messages only)`

doc: escape more naughty underscores The only time underscores aren't special in Markdown is when they appear in preformatted text. We have gotten away with not escaping underscores where an asterisk-enclosed span or the paragraph ends before the next underscore appears, but this is fragile and bad practice. Conversely, there are many places where we have not escaped underscores but needed to. Escape all underscores that do not appear in preformatted blocks or preformatted spans and are not themselves delineating emphasized spans. The changes in this commit are exactly the result of executing the following Bash code: ```bash e=':x;' # begin loop e+='s/^' # anchor match at beginning of line e+='(' # begin capturing subexpression e+='(' # begin list of alternatives e+='[^`_\\]\|' # any mundane character, or e+='`([^`\\]\|\\.)`\|' # backtick-enclosed span, or e+='\b_\|_\b\|' # underscore at boundary, or e+='\\.' # backslash-escaped character e+=')' # any number of the preceding alternatives e+=')' # end capturing subexpression e+='\B_\B/\1\\_/;' # escape non-formatting underscore e+='tx' # repeat loop if we escaped an underscore escape_underscores=( sed # use extended regular expressions -E # skip over indented blocks (following an empty line) -e '/^$/{:i;n;/^( {4,}\|\t)/bi}' # skip over preformatted blocks -e '/^\s```/,/^\s```/{p;d}' # skip over generated sections -e '/GENERATE-FROM-SCHEMA-START/,/GENERATE-FROM-SCHEMA-END/{p;d}' # escape underscores -e "${e}" ) "${escape_underscores[@]}" -i doc/*.[0-9].md ``` Changelog-None 2022-11-11 01:44:56 +00:00			`sendonionmessage first\_id blinding hops`
doc: Manual page for sendonionmessage. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-01-14 03:36:49 +00:00
			`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,`
doc: fix sendonionmessage documentation. It's a low-level interface now, expecting you to build your own TLVs. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Reported-by: @valentinewallace 2022-03-15 08:48:30 +00:00			`and tlv contains a hexidecimal TLV to include.`
doc: Manual page for sendonionmessage. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-01-14 03:36:49 +00:00
			`RETURN VALUE`
			`------------`

doc: schemas for everything else. 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. 2021-06-16 02:10:17 +01:00			`[comment]: # (GENERATE-FROM-SCHEMA-START)`
			`On success, an empty object is returned.`
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-09-03 11:07:59 +01:00
doc: schemas for everything else. 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. 2021-06-16 02:10:17 +01:00			`[comment]: # (GENERATE-FROM-SCHEMA-END)`
doc: Manual page for sendonionmessage. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-01-14 03:36:49 +00:00
			`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>`

doc: update references to old BOLTs repo. This reveals that common/test/run-bolt12_merkle-json.c was broken! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2022-09-29 04:49:03 +01:00			`[bolt04]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md`
doc: Manual page for sendonionmessage. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2021-01-14 03:36:49 +00:00
tools/fromschema.py: don't try to handle more complex cases. We only handle top-level objects with an array of objects: make sure it is one before we call the routines. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2023-01-30 06:24:16 +00:00			`[comment]: # ( SHA256STAMP:636acc798ed7ae1cd307ada4dbde424c1ed8aa514600bec9adeacd5778f4d036)`