mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 09:54:16 +01:00
Code Issues Projects Releases Wiki Activity

doc: Fix a documentation error in sendonion

Browse Source 
Te `sendonion` docs where claiming that the `first_hop` needs to specify a
`channel_id` whereas it should really be the `node_id` of the peer we are
trying to contact.
This commit is contained in:
Christian Decker 2020-05-13 19:00:36 +02:00
parent 5ef7297e51
commit 9d36e49770
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/lightning-sendonion.7 generated
View File

@ -31,13 +31,13 @@ further details\.
The \fIfirst_hop\fR parameter instructs c-lightning which peer to send the onion
to\. It is a JSON dictionary that corresponds to the first element of the route
array returned by \fIgetroute\fR\. The following is a minimal example telling
c-lightning to use channel \fB103x1x1\fR to add an HTLC for 1002 millisatoshis and
a delay of 21 blocks on top of the current blockheight:
c-lightning to use any available channel to \fB022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59\fR
to add an HTLC for 1002 millisatoshis and a delay of 21 blocks on top of the current blockheight:
.nf
.RS
{
"channel": "103x1x1",
"id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59",
"direction": 1,
"amount_msat": "1002msat",
"delay": 21,

6
doc/lightning-sendonion.7.md
View File

@ -30,12 +30,12 @@ further details.
The *first_hop* parameter instructs c-lightning which peer to send the onion
to. It is a JSON dictionary that corresponds to the first element of the route
array returned by *getroute*. The following is a minimal example telling
c-lightning to use channel `103x1x1` to add an HTLC for 1002 millisatoshis and
a delay of 21 blocks on top of the current blockheight:
c-lightning to use any available channel to `022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59`
to add an HTLC for 1002 millisatoshis and a delay of 21 blocks on top of the current blockheight:
```json
{
"channel": "103x1x1",
"id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59",
"direction": 1,
"amount_msat": "1002msat",
"delay": 21,