core-lightning/doc/schemas/lightning-getroutes.json

{
  "$schema": "../rpc-schema-draft.json",
  "type": "object",
  "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 destination with *final_cltv*.",
    "",
    "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 (including those from previous layers) 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."
  ],
  "categories": [
    "readonly"
  ],
  "request": {
    "required": [
      "source",
      "destination",
      "amount_msat",
      "layers",
      "maxfee_msat",
      "final_cltv"
    ],
    "properties": {
      "source": {
        "type": "pubkey",
        "description": [
          "Node pubkey to start the paths"
        ]
      },
      "destination": {
        "type": "pubkey",
        "description": [
          "Node pubkey to end the paths"
        ]
      },
      "amount_msat": {
        "type": "msat",
        "description": [
          "Amount to send. It can be a whole number, or a whole number ending in *msat* or *sat*, or a number with three decimal places ending in *sat*, or a number with 1 to 11 decimal places ending in *btc*."
        ]
      },
      "layers": {
        "type": "array",
        "items": {
          "type": "string",
          "description": [
            "Layer to apply to the gossip map before attempting to find routes."
          ]
        }
      },
      "maxfee_msat": {
        "type": "msat",
        "description": [
          "Maximum fee to spend: we will never return a set of routes more expensive than this. It can be a whole number, or a whole number ending in *msat* or *sat*, or a number with three decimal places ending in *sat*, or a number with 1 to 11 decimal places ending in *btc*."
        ]
      },
      "final_cltv": {
        "type": "u32",
        "description": [
          "Number of blocks for the final node.  We need to know this because no HTLC is allowed to have a CLTV delay more than 2016 blocks."
        ]
      }
    }
  },
  "response": {
    "required": [
      "probability_ppm",
      "routes"
    ],
    "properties": {
      "probability_ppm": {
        "type": "u64",
        "description": [
          "The estimated probability of success using these routes, in millionths."
        ]
      },
      "routes": {
        "type": "array",
        "items": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "probability_ppm",
            "amount_msat",
            "final_cltv",
            "path"
          ],
          "properties": {
            "probability_ppm": {
              "type": "u64",
              "description": [
                "The estimated probability of success using this route, in millionths."
              ]
            },
            "amount_msat": {
              "type": "msat",
              "description": [
                "The amount delivered to the *destination* by this path."
              ]
            },
            "final_cltv": {
              "type": "u32",
              "description": [
                "Number of blocks required by the final node (set by caller)"
              ]
            },
            "path": {
              "type": "array",
              "description": [
                "The hops to get from *source* to *destination*."
              ],
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "short_channel_id_dir",
                  "next_node_id",
                  "amount_msat",
                  "delay"
                ],
                "properties": {
                  "short_channel_id_dir": {
                    "type": "short_channel_id_dir",
                    "description": [
                      "The channel and direction joining these nodes."
                    ]
                  },
                  "amount_msat": {
                    "type": "msat",
                    "description": [
                      "The amount to send into this hop."
                    ]
                  },
                  "next_node_id": {
                    "type": "pubkey",
                    "description": [
                      "The peer id at the end of this hop."
                    ]
                  },
                  "delay": {
                    "type": "u32",
                    "description": [
                      "The total CLTV expected by the node at the start of this hop."
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "author": [
    "<<lagrang3@protonmail.com>> wrote the minimum-cost-flow solver, Rusty Russell <<rusty@rustcorp.com.au>> wrote the API and this documentation."
  ],
  "see_also": [
    "lightning-askrene-reserve(7)",
    "lightning-askrene-unreserve(7)",
    "lightning-askrene-disable-node(7)",
    "lightning-askrene-create-channel(7)",
    "lightning-askrene-inform-channel(7)",
    "lightning-askrene-report(7)",
    "lightning-askrene-age(7)"
  ],
  "resources": [
    "Main web site: <https://github.com/ElementsProject/lightning>"
  ]
}