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

doc: Update the document of getrouteabout excluding nodes

Browse source
This commit is contained in:
trueptolemy 2019-09-01 21:51:25 +08:00 • committed by ZmnSCPxj, ZmnSCPxj jxPCSmnZ
parent 059a6e0e0d
commit a795f5e600
2 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/lightning-getroute.7
View file

@ -45,8 +45,10 @@ default is 5\.0, or up to 5% fee distortion\.
\fIexclude\fR is a JSON array of short-channel-id/direction (e\.g\. [
"564334x877x1/0", "564195x1292x0/1" ]) which should be excluded from
consideration for routing\. The default is not to exclude any channels\.
"564334x877x1/0", "564195x1292x0/1" ]) or node-id which should be excluded
from consideration for routing\. The default is not to exclude any channels
or nodes\. Note if the source or destination is excluded, the command result
is undefined\.
\fImaxhops\fR is the maximum number of channels to return; default is 20\.

6
doc/lightning-getroute.7.md
View file

@ -40,8 +40,10 @@ route generated. 0.0 means the exact fee of that channel is used, while
default is 5.0, or up to 5% fee distortion.
*exclude* is a JSON array of short-channel-id/direction (e.g. \[
"564334x877x1/0", "564195x1292x0/1" \]) which should be excluded from
consideration for routing. The default is not to exclude any channels.
"564334x877x1/0", "564195x1292x0/1" \]) or node-id which should be excluded
from consideration for routing. The default is not to exclude any channels
or nodes. Note if the source or destination is excluded, the command result
is undefined.
*maxhops* is the maximum number of channels to return; default is 20.