Interface Route

A path through the channel graph which runs over one or more channels in succession. This struct carries all the information required to craft the Sphinx onion packet, and send the payment along the first hop in the path. A route is only selected as valid if all the channels have sufficient capacity to carry the initial payment amount after fees are accounted for.

Hierarchy

  • Route

Properties

hops: Hop[]

Contains details concerning the specific forwarding details at each hop.

totalAmtMsat: string | number

The total amount in millisatoshis.

totalFeesMsat: string | number

The total fees in millisatoshis.

totalTimeLock: string | number

The cumulative (final) time lock across the entire route. This is the CLTV value that should be extended to the first hop in the route. All other hops will decrement the time-lock as advertised, leaving enough time for all hops to wait for or present the payment preimage to complete the payment.

Generated using TypeDoc