mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-03-12 02:08:15 +01:00
Code Issues Projects Releases Wiki Activity

doc: fix sendonionmessage documentation.

Browse source 
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
This commit is contained in:
Rusty Russell 2022-03-15 19:18:30 +10:30
parent a8aa9bd5ae
commit 508b8cb54a
1 changed files with 2 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/lightning-sendonionmessage.7.md
View file

@ -6,7 +6,7 @@ SYNOPSIS
**(WARNING: experimental-onion-messages only)** **(WARNING: experimental-onion-messages only)**
**sendonionmessage** *hops* [*reply_path*] **sendonionmessage** *first_id* *blinding* *hops*
DESCRIPTION DESCRIPTION
----------- -----------
@ -16,14 +16,7 @@ the lightning network. These are currently used by *offers* to request
and receive invoices. and receive invoices.
*hops* is an array of json objects: *id* as a public key of the node, *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 and *tlv* contains a hexidecimal TLV to include.
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 RETURN VALUE
------------ ------------