Documentation Portal
API Reference

lightning-getroutes

lightning-getroutes -- Command for routing a payment (EXPERIMENTAL)

SYNOPSIS

getroutes source destination amount_msat layers maxfee_msat final_cltv

DESCRIPTION

Command added in v24.08.

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 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.

  • source (pubkey): Node pubkey to start the paths
  • destination (pubkey): Node pubkey to end the paths
  • amount_msat (msat): 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 (array of strings):
    • (string, optional): Layer to apply to the gossip map before attempting to find routes.
  • maxfee_msat (msat): 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 (u32): 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.

RETURN VALUE

On success, an object is returned, containing:

  • probability_ppm (u64): The estimated probability of success using these routes, in millionths.
  • routes (array of objects):
    • probability_ppm (u64): The estimated probability of success using this route, in millionths.
    • amount_msat (msat): The amount delivered to the destination by this path.
    • final_cltv (u32): Number of blocks required by the final node (set by caller)
    • path (array of objects): The hops to get from source to destination.:
      • short_channel_id (short_channel_id): The channel joining these nodes.
      • direction (u32): 0 if this channel is traversed from lesser to greater id, otherwise 1.
      • amount_msat (msat): The amount to send into this hop.
      • next_node_id (pubkey): The peer id at the end of this hop.
      • delay (u32): The total CLTV expected by the node at the start of this hop.

AUTHOR

<[email protected]> wrote the minimum-cost-flow solver, Rusty Russell <[email protected]> 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