mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-20 13:54:36 +01:00
Code Issues Projects Releases Wiki Activity

doc: note that getroutes return is different than getroute.

Browse source 
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell 2024-08-16 09:33:36 +09:30 • committed by ShahanaFarooqui
parent 62a86cc47f
commit 96f3637184
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/schemas/lightning-getroutes.json
View file

@ -4,11 +4,14 @@
"additionalProperties": false,
"rpc": "getroutes",
"title": "Command for routing a payment (EXPERIMENTAL)",
"added": "v24.08",
"description": [
"WARNING: experimental, so API may change.",
"",
"The **getroutes** RPC command attempts to find the best set of paths for the payment from *source* to *destination* of *amount_msat*, using the given *layers* on top of the gossip information. The result is constrained by *maxfee*, and will arrive at the destiation with *finalcltv*.",
"",
"NOTE: The returned paths are a different format then *getroute*, being more appropriate for creating intermediary onion layers.",
"",
"Layers are generally maintained by plugins, either to contain persistent information about capacities which have been discovered, or to contain transient information for this particular payment (such as blinded paths or routehints).",
"",
"There are two automatic layers: *auto.localchans* contains information on local channels from this node (including non-public ones), and their exact current spendable capacities, and *auto.sourcefree* overrides all channels leading out of the *source* to be zero fee and zero delay. These are both useful in the case where the source is the current node."