1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The router finds paths within a [`NetworkGraph`] for a payment.
12 use bitcoin::secp256k1::{PublicKey, Secp256k1, self};
14 use crate::blinded_path::{BlindedHop, BlindedPath, Direction, IntroductionNode};
15 use crate::blinded_path::payment::{ForwardNode, ForwardTlvs, PaymentConstraints, PaymentRelay, ReceiveTlvs};
16 use crate::ln::{PaymentHash, PaymentPreimage};
17 use crate::ln::channelmanager::{ChannelDetails, PaymentId, MIN_FINAL_CLTV_EXPIRY_DELTA, RecipientOnionFields};
18 use crate::ln::features::{BlindedHopFeatures, Bolt11InvoiceFeatures, Bolt12InvoiceFeatures, ChannelFeatures, NodeFeatures};
19 use crate::ln::msgs::{DecodeError, ErrorAction, LightningError, MAX_VALUE_MSAT};
20 use crate::ln::onion_utils;
21 use crate::offers::invoice::{BlindedPayInfo, Bolt12Invoice};
22 use crate::onion_message::messenger::{DefaultMessageRouter, Destination, MessageRouter, OnionMessagePath};
23 use crate::routing::gossip::{DirectedChannelInfo, EffectiveCapacity, ReadOnlyNetworkGraph, NetworkGraph, NodeId, RoutingFees};
24 use crate::routing::scoring::{ChannelUsage, LockableScore, ScoreLookUp};
25 use crate::sign::EntropySource;
26 use crate::util::ser::{Writeable, Readable, ReadableArgs, Writer};
27 use crate::util::logger::{Level, Logger};
28 use crate::crypto::chacha20::ChaCha20;
31 use crate::prelude::*;
32 use alloc::collections::BinaryHeap;
36 /// A [`Router`] implemented using [`find_route`].
37 pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>> + Clone, L: Deref, ES: Deref, S: Deref, SP: Sized, Sc: ScoreLookUp<ScoreParams = SP>> where
39 S::Target: for <'a> LockableScore<'a, ScoreLookUp = Sc>,
40 ES::Target: EntropySource,
47 message_router: DefaultMessageRouter<G, L, ES>,
50 impl<G: Deref<Target = NetworkGraph<L>> + Clone, L: Deref, ES: Deref + Clone, S: Deref, SP: Sized, Sc: ScoreLookUp<ScoreParams = SP>> DefaultRouter<G, L, ES, S, SP, Sc> where
52 S::Target: for <'a> LockableScore<'a, ScoreLookUp = Sc>,
53 ES::Target: EntropySource,
55 /// Creates a new router.
56 pub fn new(network_graph: G, logger: L, entropy_source: ES, scorer: S, score_params: SP) -> Self {
57 let message_router = DefaultMessageRouter::new(network_graph.clone(), entropy_source.clone());
58 Self { network_graph, logger, entropy_source, scorer, score_params, message_router }
62 impl<G: Deref<Target = NetworkGraph<L>> + Clone, L: Deref, ES: Deref, S: Deref, SP: Sized, Sc: ScoreLookUp<ScoreParams = SP>> Router for DefaultRouter<G, L, ES, S, SP, Sc> where
64 S::Target: for <'a> LockableScore<'a, ScoreLookUp = Sc>,
65 ES::Target: EntropySource,
70 params: &RouteParameters,
71 first_hops: Option<&[&ChannelDetails]>,
72 inflight_htlcs: InFlightHtlcs
73 ) -> Result<Route, LightningError> {
74 let random_seed_bytes = self.entropy_source.get_secure_random_bytes();
76 payer, params, &self.network_graph, first_hops, &*self.logger,
77 &ScorerAccountingForInFlightHtlcs::new(self.scorer.read_lock(), &inflight_htlcs),
83 fn create_blinded_payment_paths<
84 T: secp256k1::Signing + secp256k1::Verification
86 &self, recipient: PublicKey, first_hops: Vec<ChannelDetails>, tlvs: ReceiveTlvs,
87 amount_msats: u64, secp_ctx: &Secp256k1<T>
88 ) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()> {
89 // Limit the number of blinded paths that are computed.
90 const MAX_PAYMENT_PATHS: usize = 3;
92 // Ensure peers have at least three channels so that it is more difficult to infer the
93 // recipient's node_id.
94 const MIN_PEER_CHANNELS: usize = 3;
96 let network_graph = self.network_graph.deref().read_only();
97 let paths = first_hops.into_iter()
98 .filter(|details| details.counterparty.features.supports_route_blinding())
99 .filter(|details| amount_msats <= details.inbound_capacity_msat)
100 .filter(|details| amount_msats >= details.inbound_htlc_minimum_msat.unwrap_or(0))
101 .filter(|details| amount_msats <= details.inbound_htlc_maximum_msat.unwrap_or(u64::MAX))
102 .filter(|details| network_graph
103 .node(&NodeId::from_pubkey(&details.counterparty.node_id))
104 .map(|node_info| node_info.channels.len() >= MIN_PEER_CHANNELS)
107 .filter_map(|details| {
108 let short_channel_id = match details.get_inbound_payment_scid() {
109 Some(short_channel_id) => short_channel_id,
112 let payment_relay: PaymentRelay = match details.counterparty.forwarding_info {
113 Some(forwarding_info) => match forwarding_info.try_into() {
114 Ok(payment_relay) => payment_relay,
115 Err(()) => return None,
120 let cltv_expiry_delta = payment_relay.cltv_expiry_delta as u32;
121 let payment_constraints = PaymentConstraints {
122 max_cltv_expiry: tlvs.payment_constraints.max_cltv_expiry + cltv_expiry_delta,
123 htlc_minimum_msat: details.inbound_htlc_minimum_msat.unwrap_or(0),
130 features: BlindedHopFeatures::empty(),
132 node_id: details.counterparty.node_id,
133 htlc_maximum_msat: details.inbound_htlc_maximum_msat.unwrap_or(u64::MAX),
136 .map(|forward_node| {
137 BlindedPath::new_for_payment(
138 &[forward_node], recipient, tlvs.clone(), u64::MAX, MIN_FINAL_CLTV_EXPIRY_DELTA,
139 &*self.entropy_source, secp_ctx
142 .take(MAX_PAYMENT_PATHS)
143 .collect::<Result<Vec<_>, _>>();
146 Ok(paths) if !paths.is_empty() => Ok(paths),
148 if network_graph.nodes().contains_key(&NodeId::from_pubkey(&recipient)) {
149 BlindedPath::one_hop_for_payment(
150 recipient, tlvs, MIN_FINAL_CLTV_EXPIRY_DELTA, &*self.entropy_source, secp_ctx
151 ).map(|path| vec![path])
160 impl< G: Deref<Target = NetworkGraph<L>> + Clone, L: Deref, ES: Deref, S: Deref, SP: Sized, Sc: ScoreLookUp<ScoreParams = SP>> MessageRouter for DefaultRouter<G, L, ES, S, SP, Sc> where
162 S::Target: for <'a> LockableScore<'a, ScoreLookUp = Sc>,
163 ES::Target: EntropySource,
166 &self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
167 ) -> Result<OnionMessagePath, ()> {
168 self.message_router.find_path(sender, peers, destination)
171 fn create_blinded_paths<
172 T: secp256k1::Signing + secp256k1::Verification
174 &self, recipient: PublicKey, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
175 ) -> Result<Vec<BlindedPath>, ()> {
176 self.message_router.create_blinded_paths(recipient, peers, secp_ctx)
180 /// A trait defining behavior for routing a payment.
181 pub trait Router: MessageRouter {
182 /// Finds a [`Route`] for a payment between the given `payer` and a payee.
184 /// The `payee` and the payment's value are given in [`RouteParameters::payment_params`]
185 /// and [`RouteParameters::final_value_msat`], respectively.
187 &self, payer: &PublicKey, route_params: &RouteParameters,
188 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs
189 ) -> Result<Route, LightningError>;
191 /// Finds a [`Route`] for a payment between the given `payer` and a payee.
193 /// The `payee` and the payment's value are given in [`RouteParameters::payment_params`]
194 /// and [`RouteParameters::final_value_msat`], respectively.
196 /// Includes a [`PaymentHash`] and a [`PaymentId`] to be able to correlate the request with a specific
198 fn find_route_with_id(
199 &self, payer: &PublicKey, route_params: &RouteParameters,
200 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs,
201 _payment_hash: PaymentHash, _payment_id: PaymentId
202 ) -> Result<Route, LightningError> {
203 self.find_route(payer, route_params, first_hops, inflight_htlcs)
206 /// Creates [`BlindedPath`]s for payment to the `recipient` node. The channels in `first_hops`
207 /// are assumed to be with the `recipient`'s peers. The payment secret and any constraints are
209 fn create_blinded_payment_paths<
210 T: secp256k1::Signing + secp256k1::Verification
212 &self, recipient: PublicKey, first_hops: Vec<ChannelDetails>, tlvs: ReceiveTlvs,
213 amount_msats: u64, secp_ctx: &Secp256k1<T>
214 ) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()>;
217 /// [`ScoreLookUp`] implementation that factors in in-flight HTLC liquidity.
219 /// Useful for custom [`Router`] implementations to wrap their [`ScoreLookUp`] on-the-fly when calling
222 /// [`ScoreLookUp`]: crate::routing::scoring::ScoreLookUp
223 pub struct ScorerAccountingForInFlightHtlcs<'a, S: Deref> where S::Target: ScoreLookUp {
225 // Maps a channel's short channel id and its direction to the liquidity used up.
226 inflight_htlcs: &'a InFlightHtlcs,
228 impl<'a, S: Deref> ScorerAccountingForInFlightHtlcs<'a, S> where S::Target: ScoreLookUp {
229 /// Initialize a new `ScorerAccountingForInFlightHtlcs`.
230 pub fn new(scorer: S, inflight_htlcs: &'a InFlightHtlcs) -> Self {
231 ScorerAccountingForInFlightHtlcs {
238 impl<'a, S: Deref> ScoreLookUp for ScorerAccountingForInFlightHtlcs<'a, S> where S::Target: ScoreLookUp {
239 type ScoreParams = <S::Target as ScoreLookUp>::ScoreParams;
240 fn channel_penalty_msat(&self, candidate: &CandidateRouteHop, usage: ChannelUsage, score_params: &Self::ScoreParams) -> u64 {
241 let target = match candidate.target() {
242 Some(target) => target,
243 None => return self.scorer.channel_penalty_msat(candidate, usage, score_params),
245 let short_channel_id = match candidate.short_channel_id() {
246 Some(short_channel_id) => short_channel_id,
247 None => return self.scorer.channel_penalty_msat(candidate, usage, score_params),
249 let source = candidate.source();
250 if let Some(used_liquidity) = self.inflight_htlcs.used_liquidity_msat(
251 &source, &target, short_channel_id
253 let usage = ChannelUsage {
254 inflight_htlc_msat: usage.inflight_htlc_msat.saturating_add(used_liquidity),
258 self.scorer.channel_penalty_msat(candidate, usage, score_params)
260 self.scorer.channel_penalty_msat(candidate, usage, score_params)
265 /// A data structure for tracking in-flight HTLCs. May be used during pathfinding to account for
266 /// in-use channel liquidity.
268 pub struct InFlightHtlcs(
269 // A map with liquidity value (in msat) keyed by a short channel id and the direction the HTLC
270 // is traveling in. The direction boolean is determined by checking if the HTLC source's public
271 // key is less than its destination. See `InFlightHtlcs::used_liquidity_msat` for more
273 HashMap<(u64, bool), u64>
277 /// Constructs an empty `InFlightHtlcs`.
278 pub fn new() -> Self { InFlightHtlcs(new_hash_map()) }
280 /// Takes in a path with payer's node id and adds the path's details to `InFlightHtlcs`.
281 pub fn process_path(&mut self, path: &Path, payer_node_id: PublicKey) {
282 if path.hops.is_empty() { return };
284 let mut cumulative_msat = 0;
285 if let Some(tail) = &path.blinded_tail {
286 cumulative_msat += tail.final_value_msat;
289 // total_inflight_map needs to be direction-sensitive when keeping track of the HTLC value
290 // that is held up. However, the `hops` array, which is a path returned by `find_route` in
291 // the router excludes the payer node. In the following lines, the payer's information is
292 // hardcoded with an inflight value of 0 so that we can correctly represent the first hop
293 // in our sliding window of two.
294 let reversed_hops_with_payer = path.hops.iter().rev().skip(1)
295 .map(|hop| hop.pubkey)
296 .chain(core::iter::once(payer_node_id));
298 // Taking the reversed vector from above, we zip it with just the reversed hops list to
299 // work "backwards" of the given path, since the last hop's `fee_msat` actually represents
300 // the total amount sent.
301 for (next_hop, prev_hop) in path.hops.iter().rev().zip(reversed_hops_with_payer) {
302 cumulative_msat += next_hop.fee_msat;
304 .entry((next_hop.short_channel_id, NodeId::from_pubkey(&prev_hop) < NodeId::from_pubkey(&next_hop.pubkey)))
305 .and_modify(|used_liquidity_msat| *used_liquidity_msat += cumulative_msat)
306 .or_insert(cumulative_msat);
310 /// Adds a known HTLC given the public key of the HTLC source, target, and short channel
312 pub fn add_inflight_htlc(&mut self, source: &NodeId, target: &NodeId, channel_scid: u64, used_msat: u64){
314 .entry((channel_scid, source < target))
315 .and_modify(|used_liquidity_msat| *used_liquidity_msat += used_msat)
316 .or_insert(used_msat);
319 /// Returns liquidity in msat given the public key of the HTLC source, target, and short channel
321 pub fn used_liquidity_msat(&self, source: &NodeId, target: &NodeId, channel_scid: u64) -> Option<u64> {
322 self.0.get(&(channel_scid, source < target)).map(|v| *v)
326 impl Writeable for InFlightHtlcs {
327 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> { self.0.write(writer) }
330 impl Readable for InFlightHtlcs {
331 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
332 let infight_map: HashMap<(u64, bool), u64> = Readable::read(reader)?;
333 Ok(Self(infight_map))
337 /// A hop in a route, and additional metadata about it. "Hop" is defined as a node and the channel
338 /// that leads to it.
339 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
340 pub struct RouteHop {
341 /// The node_id of the node at this hop.
342 pub pubkey: PublicKey,
343 /// The node_announcement features of the node at this hop. For the last hop, these may be
344 /// amended to match the features present in the invoice this node generated.
345 pub node_features: NodeFeatures,
346 /// The channel that should be used from the previous hop to reach this node.
347 pub short_channel_id: u64,
348 /// The channel_announcement features of the channel that should be used from the previous hop
349 /// to reach this node.
350 pub channel_features: ChannelFeatures,
351 /// The fee taken on this hop (for paying for the use of the *next* channel in the path).
352 /// If this is the last hop in [`Path::hops`]:
353 /// * if we're sending to a [`BlindedPath`], this is the fee paid for use of the entire blinded path
354 /// * otherwise, this is the full value of this [`Path`]'s part of the payment
356 /// [`BlindedPath`]: crate::blinded_path::BlindedPath
358 /// The CLTV delta added for this hop.
359 /// If this is the last hop in [`Path::hops`]:
360 /// * if we're sending to a [`BlindedPath`], this is the CLTV delta for the entire blinded path
361 /// * otherwise, this is the CLTV delta expected at the destination
363 /// [`BlindedPath`]: crate::blinded_path::BlindedPath
364 pub cltv_expiry_delta: u32,
365 /// Indicates whether this hop is possibly announced in the public network graph.
367 /// Will be `true` if there is a possibility that the channel is publicly known, i.e., if we
368 /// either know for sure it's announced in the public graph, or if any public channels exist
369 /// for which the given `short_channel_id` could be an alias for. Will be `false` if we believe
370 /// the channel to be unannounced.
372 /// Will be `true` for objects serialized with LDK version 0.0.116 and before.
373 pub maybe_announced_channel: bool,
376 impl_writeable_tlv_based!(RouteHop, {
377 (0, pubkey, required),
378 (1, maybe_announced_channel, (default_value, true)),
379 (2, node_features, required),
380 (4, short_channel_id, required),
381 (6, channel_features, required),
382 (8, fee_msat, required),
383 (10, cltv_expiry_delta, required),
386 /// The blinded portion of a [`Path`], if we're routing to a recipient who provided blinded paths in
387 /// their [`Bolt12Invoice`].
389 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
390 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
391 pub struct BlindedTail {
392 /// The hops of the [`BlindedPath`] provided by the recipient.
394 /// [`BlindedPath`]: crate::blinded_path::BlindedPath
395 pub hops: Vec<BlindedHop>,
396 /// The blinding point of the [`BlindedPath`] provided by the recipient.
398 /// [`BlindedPath`]: crate::blinded_path::BlindedPath
399 pub blinding_point: PublicKey,
400 /// Excess CLTV delta added to the recipient's CLTV expiry to deter intermediate nodes from
401 /// inferring the destination. May be 0.
402 pub excess_final_cltv_expiry_delta: u32,
403 /// The total amount paid on this [`Path`], excluding the fees.
404 pub final_value_msat: u64,
407 impl_writeable_tlv_based!(BlindedTail, {
408 (0, hops, required_vec),
409 (2, blinding_point, required),
410 (4, excess_final_cltv_expiry_delta, required),
411 (6, final_value_msat, required),
414 /// A path in a [`Route`] to the payment recipient. Must always be at least length one.
415 /// If no [`Path::blinded_tail`] is present, then [`Path::hops`] length may be up to 19.
416 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
418 /// The list of unblinded hops in this [`Path`]. Must be at least length one.
419 pub hops: Vec<RouteHop>,
420 /// The blinded path at which this path terminates, if we're sending to one, and its metadata.
421 pub blinded_tail: Option<BlindedTail>,
425 /// Gets the fees for a given path, excluding any excess paid to the recipient.
426 pub fn fee_msat(&self) -> u64 {
427 match &self.blinded_tail {
428 Some(_) => self.hops.iter().map(|hop| hop.fee_msat).sum::<u64>(),
430 // Do not count last hop of each path since that's the full value of the payment
431 self.hops.split_last().map_or(0,
432 |(_, path_prefix)| path_prefix.iter().map(|hop| hop.fee_msat).sum())
437 /// Gets the total amount paid on this [`Path`], excluding the fees.
438 pub fn final_value_msat(&self) -> u64 {
439 match &self.blinded_tail {
440 Some(blinded_tail) => blinded_tail.final_value_msat,
441 None => self.hops.last().map_or(0, |hop| hop.fee_msat)
445 /// Gets the final hop's CLTV expiry delta.
446 pub fn final_cltv_expiry_delta(&self) -> Option<u32> {
447 match &self.blinded_tail {
449 None => self.hops.last().map(|hop| hop.cltv_expiry_delta)
454 /// A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
455 /// it can take multiple paths. Each path is composed of one or more hops through the network.
456 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
458 /// The list of [`Path`]s taken for a single (potentially-)multi-part payment. If no
459 /// [`BlindedTail`]s are present, then the pubkey of the last [`RouteHop`] in each path must be
461 pub paths: Vec<Path>,
462 /// The `route_params` parameter passed to [`find_route`].
464 /// This is used by `ChannelManager` to track information which may be required for retries.
466 /// Will be `None` for objects serialized with LDK versions prior to 0.0.117.
467 pub route_params: Option<RouteParameters>,
471 /// Returns the total amount of fees paid on this [`Route`].
473 /// For objects serialized with LDK 0.0.117 and after, this includes any extra payment made to
474 /// the recipient, which can happen in excess of the amount passed to [`find_route`] via
475 /// [`RouteParameters::final_value_msat`], if we had to reach the [`htlc_minimum_msat`] limits.
477 /// [`htlc_minimum_msat`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_update-message
478 pub fn get_total_fees(&self) -> u64 {
479 let overpaid_value_msat = self.route_params.as_ref()
480 .map_or(0, |p| self.get_total_amount().saturating_sub(p.final_value_msat));
481 overpaid_value_msat + self.paths.iter().map(|path| path.fee_msat()).sum::<u64>()
484 /// Returns the total amount paid on this [`Route`], excluding the fees.
486 /// Might be more than requested as part of the given [`RouteParameters::final_value_msat`] if
487 /// we had to reach the [`htlc_minimum_msat`] limits.
489 /// [`htlc_minimum_msat`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_update-message
490 pub fn get_total_amount(&self) -> u64 {
491 self.paths.iter().map(|path| path.final_value_msat()).sum()
495 impl fmt::Display for Route {
496 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
497 log_route!(self).fmt(f)
501 const SERIALIZATION_VERSION: u8 = 1;
502 const MIN_SERIALIZATION_VERSION: u8 = 1;
504 impl Writeable for Route {
505 fn write<W: crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
506 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
507 (self.paths.len() as u64).write(writer)?;
508 let mut blinded_tails = Vec::new();
509 for (idx, path) in self.paths.iter().enumerate() {
510 (path.hops.len() as u8).write(writer)?;
511 for hop in path.hops.iter() {
514 if let Some(blinded_tail) = &path.blinded_tail {
515 if blinded_tails.is_empty() {
516 blinded_tails = Vec::with_capacity(path.hops.len());
518 blinded_tails.push(None);
521 blinded_tails.push(Some(blinded_tail));
522 } else if !blinded_tails.is_empty() { blinded_tails.push(None); }
524 write_tlv_fields!(writer, {
525 // For compatibility with LDK versions prior to 0.0.117, we take the individual
526 // RouteParameters' fields and reconstruct them on read.
527 (1, self.route_params.as_ref().map(|p| &p.payment_params), option),
528 (2, blinded_tails, optional_vec),
529 (3, self.route_params.as_ref().map(|p| p.final_value_msat), option),
530 (5, self.route_params.as_ref().and_then(|p| p.max_total_routing_fee_msat), option),
536 impl Readable for Route {
537 fn read<R: io::Read>(reader: &mut R) -> Result<Route, DecodeError> {
538 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
539 let path_count: u64 = Readable::read(reader)?;
540 if path_count == 0 { return Err(DecodeError::InvalidValue); }
541 let mut paths = Vec::with_capacity(cmp::min(path_count, 128) as usize);
542 let mut min_final_cltv_expiry_delta = u32::max_value();
543 for _ in 0..path_count {
544 let hop_count: u8 = Readable::read(reader)?;
545 let mut hops: Vec<RouteHop> = Vec::with_capacity(hop_count as usize);
546 for _ in 0..hop_count {
547 hops.push(Readable::read(reader)?);
549 if hops.is_empty() { return Err(DecodeError::InvalidValue); }
550 min_final_cltv_expiry_delta =
551 cmp::min(min_final_cltv_expiry_delta, hops.last().unwrap().cltv_expiry_delta);
552 paths.push(Path { hops, blinded_tail: None });
554 _init_and_read_len_prefixed_tlv_fields!(reader, {
555 (1, payment_params, (option: ReadableArgs, min_final_cltv_expiry_delta)),
556 (2, blinded_tails, optional_vec),
557 (3, final_value_msat, option),
558 (5, max_total_routing_fee_msat, option)
560 let blinded_tails = blinded_tails.unwrap_or(Vec::new());
561 if blinded_tails.len() != 0 {
562 if blinded_tails.len() != paths.len() { return Err(DecodeError::InvalidValue) }
563 for (path, blinded_tail_opt) in paths.iter_mut().zip(blinded_tails.into_iter()) {
564 path.blinded_tail = blinded_tail_opt;
568 // If we previously wrote the corresponding fields, reconstruct RouteParameters.
569 let route_params = match (payment_params, final_value_msat) {
570 (Some(payment_params), Some(final_value_msat)) => {
571 Some(RouteParameters { payment_params, final_value_msat, max_total_routing_fee_msat })
576 Ok(Route { paths, route_params })
580 /// Parameters needed to find a [`Route`].
582 /// Passed to [`find_route`] and [`build_route_from_hops`].
583 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
584 pub struct RouteParameters {
585 /// The parameters of the failed payment path.
586 pub payment_params: PaymentParameters,
588 /// The amount in msats sent on the failed payment path.
589 pub final_value_msat: u64,
591 /// The maximum total fees, in millisatoshi, that may accrue during route finding.
593 /// This limit also applies to the total fees that may arise while retrying failed payment
596 /// Note that values below a few sats may result in some paths being spuriously ignored.
597 pub max_total_routing_fee_msat: Option<u64>,
600 impl RouteParameters {
601 /// Constructs [`RouteParameters`] from the given [`PaymentParameters`] and a payment amount.
603 /// [`Self::max_total_routing_fee_msat`] defaults to 1% of the payment amount + 50 sats
604 pub fn from_payment_params_and_value(payment_params: PaymentParameters, final_value_msat: u64) -> Self {
605 Self { payment_params, final_value_msat, max_total_routing_fee_msat: Some(final_value_msat / 100 + 50_000) }
608 /// Sets the maximum number of hops that can be included in a payment path, based on the provided
609 /// [`RecipientOnionFields`] and blinded paths.
610 pub fn set_max_path_length(
611 &mut self, recipient_onion: &RecipientOnionFields, is_keysend: bool, best_block_height: u32
612 ) -> Result<(), ()> {
613 let keysend_preimage_opt = is_keysend.then(|| PaymentPreimage([42; 32]));
614 onion_utils::set_max_path_length(
615 self, recipient_onion, keysend_preimage_opt, best_block_height
620 impl Writeable for RouteParameters {
621 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
622 write_tlv_fields!(writer, {
623 (0, self.payment_params, required),
624 (1, self.max_total_routing_fee_msat, option),
625 (2, self.final_value_msat, required),
626 // LDK versions prior to 0.0.114 had the `final_cltv_expiry_delta` parameter in
627 // `RouteParameters` directly. For compatibility, we write it here.
628 (4, self.payment_params.payee.final_cltv_expiry_delta(), option),
634 impl Readable for RouteParameters {
635 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
636 _init_and_read_len_prefixed_tlv_fields!(reader, {
637 (0, payment_params, (required: ReadableArgs, 0)),
638 (1, max_total_routing_fee_msat, option),
639 (2, final_value_msat, required),
640 (4, final_cltv_delta, option),
642 let mut payment_params: PaymentParameters = payment_params.0.unwrap();
643 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = payment_params.payee {
644 if final_cltv_expiry_delta == &0 {
645 *final_cltv_expiry_delta = final_cltv_delta.ok_or(DecodeError::InvalidValue)?;
650 final_value_msat: final_value_msat.0.unwrap(),
651 max_total_routing_fee_msat,
656 /// Maximum total CTLV difference we allow for a full payment path.
657 pub const DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA: u32 = 1008;
659 /// Maximum number of paths we allow an (MPP) payment to have.
660 // The default limit is currently set rather arbitrary - there aren't any real fundamental path-count
661 // limits, but for now more than 10 paths likely carries too much one-path failure.
662 pub const DEFAULT_MAX_PATH_COUNT: u8 = 10;
664 const DEFAULT_MAX_CHANNEL_SATURATION_POW_HALF: u8 = 2;
666 // The median hop CLTV expiry delta currently seen in the network.
667 const MEDIAN_HOP_CLTV_EXPIRY_DELTA: u32 = 40;
669 /// Estimated maximum number of hops that can be included in a payment path. May be inaccurate if
670 /// payment metadata, custom TLVs, or blinded paths are included in the payment.
671 // During routing, we only consider paths shorter than our maximum length estimate.
672 // In the TLV onion format, there is no fixed maximum length, but the `hop_payloads`
673 // field is always 1300 bytes. As the `tlv_payload` for each hop may vary in length, we have to
674 // estimate how many hops the route may have so that it actually fits the `hop_payloads` field.
676 // We estimate 3+32 (payload length and HMAC) + 2+8 (amt_to_forward) + 2+4 (outgoing_cltv_value) +
677 // 2+8 (short_channel_id) = 61 bytes for each intermediate hop and 3+32
678 // (payload length and HMAC) + 2+8 (amt_to_forward) + 2+4 (outgoing_cltv_value) + 2+32+8
679 // (payment_secret and total_msat) = 93 bytes for the final hop.
680 // Since the length of the potentially included `payment_metadata` is unknown to us, we round
681 // down from (1300-93) / 61 = 19.78... to arrive at a conservative estimate of 19.
682 pub const MAX_PATH_LENGTH_ESTIMATE: u8 = 19;
684 /// Information used to route a payment.
685 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
686 pub struct PaymentParameters {
687 /// Information about the payee, such as their features and route hints for their channels.
690 /// Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
691 pub expiry_time: Option<u64>,
693 /// The maximum total CLTV delta we accept for the route.
694 /// Defaults to [`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`].
695 pub max_total_cltv_expiry_delta: u32,
697 /// The maximum number of paths that may be used by (MPP) payments.
698 /// Defaults to [`DEFAULT_MAX_PATH_COUNT`].
699 pub max_path_count: u8,
701 /// The maximum number of [`Path::hops`] in any returned path.
702 /// Defaults to [`MAX_PATH_LENGTH_ESTIMATE`].
703 pub max_path_length: u8,
705 /// Selects the maximum share of a channel's total capacity which will be sent over a channel,
706 /// as a power of 1/2. A higher value prefers to send the payment using more MPP parts whereas
707 /// a lower value prefers to send larger MPP parts, potentially saturating channels and
708 /// increasing failure probability for those paths.
710 /// Note that this restriction will be relaxed during pathfinding after paths which meet this
711 /// restriction have been found. While paths which meet this criteria will be searched for, it
712 /// is ultimately up to the scorer to select them over other paths.
714 /// A value of 0 will allow payments up to and including a channel's total announced usable
715 /// capacity, a value of one will only use up to half its capacity, two 1/4, etc.
718 pub max_channel_saturation_power_of_half: u8,
720 /// A list of SCIDs which this payment was previously attempted over and which caused the
721 /// payment to fail. Future attempts for the same payment shouldn't be relayed through any of
723 pub previously_failed_channels: Vec<u64>,
725 /// A list of indices corresponding to blinded paths in [`Payee::Blinded::route_hints`] which this
726 /// payment was previously attempted over and which caused the payment to fail. Future attempts
727 /// for the same payment shouldn't be relayed through any of these blinded paths.
728 pub previously_failed_blinded_path_idxs: Vec<u64>,
731 impl Writeable for PaymentParameters {
732 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
733 let mut clear_hints = &vec![];
734 let mut blinded_hints = &vec![];
736 Payee::Clear { route_hints, .. } => clear_hints = route_hints,
737 Payee::Blinded { route_hints, .. } => blinded_hints = route_hints,
739 write_tlv_fields!(writer, {
740 (0, self.payee.node_id(), option),
741 (1, self.max_total_cltv_expiry_delta, required),
742 (2, self.payee.features(), option),
743 (3, self.max_path_count, required),
744 (4, *clear_hints, required_vec),
745 (5, self.max_channel_saturation_power_of_half, required),
746 (6, self.expiry_time, option),
747 (7, self.previously_failed_channels, required_vec),
748 (8, *blinded_hints, optional_vec),
749 (9, self.payee.final_cltv_expiry_delta(), option),
750 (11, self.previously_failed_blinded_path_idxs, required_vec),
751 (13, self.max_path_length, required),
757 impl ReadableArgs<u32> for PaymentParameters {
758 fn read<R: io::Read>(reader: &mut R, default_final_cltv_expiry_delta: u32) -> Result<Self, DecodeError> {
759 _init_and_read_len_prefixed_tlv_fields!(reader, {
760 (0, payee_pubkey, option),
761 (1, max_total_cltv_expiry_delta, (default_value, DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA)),
762 (2, features, (option: ReadableArgs, payee_pubkey.is_some())),
763 (3, max_path_count, (default_value, DEFAULT_MAX_PATH_COUNT)),
764 (4, clear_route_hints, required_vec),
765 (5, max_channel_saturation_power_of_half, (default_value, DEFAULT_MAX_CHANNEL_SATURATION_POW_HALF)),
766 (6, expiry_time, option),
767 (7, previously_failed_channels, optional_vec),
768 (8, blinded_route_hints, optional_vec),
769 (9, final_cltv_expiry_delta, (default_value, default_final_cltv_expiry_delta)),
770 (11, previously_failed_blinded_path_idxs, optional_vec),
771 (13, max_path_length, (default_value, MAX_PATH_LENGTH_ESTIMATE)),
773 let blinded_route_hints = blinded_route_hints.unwrap_or(vec![]);
774 let payee = if blinded_route_hints.len() != 0 {
775 if clear_route_hints.len() != 0 || payee_pubkey.is_some() { return Err(DecodeError::InvalidValue) }
777 route_hints: blinded_route_hints,
778 features: features.and_then(|f: Features| f.bolt12()),
782 route_hints: clear_route_hints,
783 node_id: payee_pubkey.ok_or(DecodeError::InvalidValue)?,
784 features: features.and_then(|f| f.bolt11()),
785 final_cltv_expiry_delta: final_cltv_expiry_delta.0.unwrap(),
789 max_total_cltv_expiry_delta: _init_tlv_based_struct_field!(max_total_cltv_expiry_delta, (default_value, unused)),
790 max_path_count: _init_tlv_based_struct_field!(max_path_count, (default_value, unused)),
792 max_channel_saturation_power_of_half: _init_tlv_based_struct_field!(max_channel_saturation_power_of_half, (default_value, unused)),
794 previously_failed_channels: previously_failed_channels.unwrap_or(Vec::new()),
795 previously_failed_blinded_path_idxs: previously_failed_blinded_path_idxs.unwrap_or(Vec::new()),
796 max_path_length: _init_tlv_based_struct_field!(max_path_length, (default_value, unused)),
802 impl PaymentParameters {
803 /// Creates a payee with the node id of the given `pubkey`.
805 /// The `final_cltv_expiry_delta` should match the expected final CLTV delta the recipient has
807 pub fn from_node_id(payee_pubkey: PublicKey, final_cltv_expiry_delta: u32) -> Self {
809 payee: Payee::Clear { node_id: payee_pubkey, route_hints: vec![], features: None, final_cltv_expiry_delta },
811 max_total_cltv_expiry_delta: DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA,
812 max_path_count: DEFAULT_MAX_PATH_COUNT,
813 max_path_length: MAX_PATH_LENGTH_ESTIMATE,
814 max_channel_saturation_power_of_half: DEFAULT_MAX_CHANNEL_SATURATION_POW_HALF,
815 previously_failed_channels: Vec::new(),
816 previously_failed_blinded_path_idxs: Vec::new(),
820 /// Creates a payee with the node id of the given `pubkey` to use for keysend payments.
822 /// The `final_cltv_expiry_delta` should match the expected final CLTV delta the recipient has
825 /// Note that MPP keysend is not widely supported yet. The `allow_mpp` lets you choose
826 /// whether your router will be allowed to find a multi-part route for this payment. If you
827 /// set `allow_mpp` to true, you should ensure a payment secret is set on send, likely via
828 /// [`RecipientOnionFields::secret_only`].
830 /// [`RecipientOnionFields::secret_only`]: crate::ln::channelmanager::RecipientOnionFields::secret_only
831 pub fn for_keysend(payee_pubkey: PublicKey, final_cltv_expiry_delta: u32, allow_mpp: bool) -> Self {
832 Self::from_node_id(payee_pubkey, final_cltv_expiry_delta)
833 .with_bolt11_features(Bolt11InvoiceFeatures::for_keysend(allow_mpp))
834 .expect("PaymentParameters::from_node_id should always initialize the payee as unblinded")
837 /// Creates parameters for paying to a blinded payee from the provided invoice. Sets
838 /// [`Payee::Blinded::route_hints`], [`Payee::Blinded::features`], and
839 /// [`PaymentParameters::expiry_time`].
840 pub fn from_bolt12_invoice(invoice: &Bolt12Invoice) -> Self {
841 Self::blinded(invoice.payment_paths().to_vec())
842 .with_bolt12_features(invoice.invoice_features().clone()).unwrap()
843 .with_expiry_time(invoice.created_at().as_secs().saturating_add(invoice.relative_expiry().as_secs()))
846 /// Creates parameters for paying to a blinded payee from the provided blinded route hints.
847 pub fn blinded(blinded_route_hints: Vec<(BlindedPayInfo, BlindedPath)>) -> Self {
849 payee: Payee::Blinded { route_hints: blinded_route_hints, features: None },
851 max_total_cltv_expiry_delta: DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA,
852 max_path_count: DEFAULT_MAX_PATH_COUNT,
853 max_path_length: MAX_PATH_LENGTH_ESTIMATE,
854 max_channel_saturation_power_of_half: DEFAULT_MAX_CHANNEL_SATURATION_POW_HALF,
855 previously_failed_channels: Vec::new(),
856 previously_failed_blinded_path_idxs: Vec::new(),
860 /// Includes the payee's features. Errors if the parameters were not initialized with
861 /// [`PaymentParameters::from_bolt12_invoice`].
863 /// This is not exported to bindings users since bindings don't support move semantics
864 pub fn with_bolt12_features(self, features: Bolt12InvoiceFeatures) -> Result<Self, ()> {
866 Payee::Clear { .. } => Err(()),
867 Payee::Blinded { route_hints, .. } =>
868 Ok(Self { payee: Payee::Blinded { route_hints, features: Some(features) }, ..self })
872 /// Includes the payee's features. Errors if the parameters were initialized with
873 /// [`PaymentParameters::from_bolt12_invoice`].
875 /// This is not exported to bindings users since bindings don't support move semantics
876 pub fn with_bolt11_features(self, features: Bolt11InvoiceFeatures) -> Result<Self, ()> {
878 Payee::Blinded { .. } => Err(()),
879 Payee::Clear { route_hints, node_id, final_cltv_expiry_delta, .. } =>
881 payee: Payee::Clear {
882 route_hints, node_id, features: Some(features), final_cltv_expiry_delta
888 /// Includes hints for routing to the payee. Errors if the parameters were initialized with
889 /// [`PaymentParameters::from_bolt12_invoice`].
891 /// This is not exported to bindings users since bindings don't support move semantics
892 pub fn with_route_hints(self, route_hints: Vec<RouteHint>) -> Result<Self, ()> {
894 Payee::Blinded { .. } => Err(()),
895 Payee::Clear { node_id, features, final_cltv_expiry_delta, .. } =>
897 payee: Payee::Clear {
898 route_hints, node_id, features, final_cltv_expiry_delta,
904 /// Includes a payment expiration in seconds relative to the UNIX epoch.
906 /// This is not exported to bindings users since bindings don't support move semantics
907 pub fn with_expiry_time(self, expiry_time: u64) -> Self {
908 Self { expiry_time: Some(expiry_time), ..self }
911 /// Includes a limit for the total CLTV expiry delta which is considered during routing
913 /// This is not exported to bindings users since bindings don't support move semantics
914 pub fn with_max_total_cltv_expiry_delta(self, max_total_cltv_expiry_delta: u32) -> Self {
915 Self { max_total_cltv_expiry_delta, ..self }
918 /// Includes a limit for the maximum number of payment paths that may be used.
920 /// This is not exported to bindings users since bindings don't support move semantics
921 pub fn with_max_path_count(self, max_path_count: u8) -> Self {
922 Self { max_path_count, ..self }
925 /// Includes a limit for the maximum share of a channel's total capacity that can be sent over, as
926 /// a power of 1/2. See [`PaymentParameters::max_channel_saturation_power_of_half`].
928 /// This is not exported to bindings users since bindings don't support move semantics
929 pub fn with_max_channel_saturation_power_of_half(self, max_channel_saturation_power_of_half: u8) -> Self {
930 Self { max_channel_saturation_power_of_half, ..self }
933 pub(crate) fn insert_previously_failed_blinded_path(&mut self, failed_blinded_tail: &BlindedTail) {
934 let mut found_blinded_tail = false;
935 for (idx, (_, path)) in self.payee.blinded_route_hints().iter().enumerate() {
936 if failed_blinded_tail.hops == path.blinded_hops &&
937 failed_blinded_tail.blinding_point == path.blinding_point
939 self.previously_failed_blinded_path_idxs.push(idx as u64);
940 found_blinded_tail = true;
943 debug_assert!(found_blinded_tail);
947 /// The recipient of a payment, differing based on whether they've hidden their identity with route
949 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
951 /// The recipient provided blinded paths and payinfo to reach them. The blinded paths themselves
952 /// will be included in the final [`Route`].
954 /// Aggregated routing info and blinded paths, for routing to the payee without knowing their
956 route_hints: Vec<(BlindedPayInfo, BlindedPath)>,
957 /// Features supported by the payee.
959 /// May be set from the payee's invoice. May be `None` if the invoice does not contain any
961 features: Option<Bolt12InvoiceFeatures>,
963 /// The recipient included these route hints in their BOLT11 invoice.
965 /// The node id of the payee.
967 /// Hints for routing to the payee, containing channels connecting the payee to public nodes.
968 route_hints: Vec<RouteHint>,
969 /// Features supported by the payee.
971 /// May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
972 /// does not contain any features.
974 /// [`for_keysend`]: PaymentParameters::for_keysend
975 features: Option<Bolt11InvoiceFeatures>,
976 /// The minimum CLTV delta at the end of the route. This value must not be zero.
977 final_cltv_expiry_delta: u32,
982 fn node_id(&self) -> Option<PublicKey> {
984 Self::Clear { node_id, .. } => Some(*node_id),
988 fn node_features(&self) -> Option<NodeFeatures> {
990 Self::Clear { features, .. } => features.as_ref().map(|f| f.to_context()),
991 Self::Blinded { features, .. } => features.as_ref().map(|f| f.to_context()),
994 fn supports_basic_mpp(&self) -> bool {
996 Self::Clear { features, .. } => features.as_ref().map_or(false, |f| f.supports_basic_mpp()),
997 Self::Blinded { features, .. } => features.as_ref().map_or(false, |f| f.supports_basic_mpp()),
1000 fn features(&self) -> Option<FeaturesRef> {
1002 Self::Clear { features, .. } => features.as_ref().map(|f| FeaturesRef::Bolt11(f)),
1003 Self::Blinded { features, .. } => features.as_ref().map(|f| FeaturesRef::Bolt12(f)),
1006 fn final_cltv_expiry_delta(&self) -> Option<u32> {
1008 Self::Clear { final_cltv_expiry_delta, .. } => Some(*final_cltv_expiry_delta),
1012 pub(crate) fn blinded_route_hints(&self) -> &[(BlindedPayInfo, BlindedPath)] {
1014 Self::Blinded { route_hints, .. } => &route_hints[..],
1015 Self::Clear { .. } => &[]
1019 fn unblinded_route_hints(&self) -> &[RouteHint] {
1021 Self::Blinded { .. } => &[],
1022 Self::Clear { route_hints, .. } => &route_hints[..]
1027 enum FeaturesRef<'a> {
1028 Bolt11(&'a Bolt11InvoiceFeatures),
1029 Bolt12(&'a Bolt12InvoiceFeatures),
1032 Bolt11(Bolt11InvoiceFeatures),
1033 Bolt12(Bolt12InvoiceFeatures),
1037 fn bolt12(self) -> Option<Bolt12InvoiceFeatures> {
1039 Self::Bolt12(f) => Some(f),
1043 fn bolt11(self) -> Option<Bolt11InvoiceFeatures> {
1045 Self::Bolt11(f) => Some(f),
1051 impl<'a> Writeable for FeaturesRef<'a> {
1052 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1054 Self::Bolt11(f) => Ok(f.write(w)?),
1055 Self::Bolt12(f) => Ok(f.write(w)?),
1060 impl ReadableArgs<bool> for Features {
1061 fn read<R: io::Read>(reader: &mut R, bolt11: bool) -> Result<Self, DecodeError> {
1062 if bolt11 { return Ok(Self::Bolt11(Readable::read(reader)?)) }
1063 Ok(Self::Bolt12(Readable::read(reader)?))
1067 /// A list of hops along a payment path terminating with a channel to the recipient.
1068 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
1069 pub struct RouteHint(pub Vec<RouteHintHop>);
1071 impl Writeable for RouteHint {
1072 fn write<W: crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1073 (self.0.len() as u64).write(writer)?;
1074 for hop in self.0.iter() {
1081 impl Readable for RouteHint {
1082 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
1083 let hop_count: u64 = Readable::read(reader)?;
1084 let mut hops = Vec::with_capacity(cmp::min(hop_count, 16) as usize);
1085 for _ in 0..hop_count {
1086 hops.push(Readable::read(reader)?);
1092 /// A channel descriptor for a hop along a payment path.
1094 /// While this generally comes from BOLT 11's `r` field, this struct includes more fields than are
1095 /// available in BOLT 11. Thus, encoding and decoding this via `lightning-invoice` is lossy, as
1096 /// fields not supported in BOLT 11 will be stripped.
1097 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
1098 pub struct RouteHintHop {
1099 /// The node_id of the non-target end of the route
1100 pub src_node_id: PublicKey,
1101 /// The short_channel_id of this channel
1102 pub short_channel_id: u64,
1103 /// The fees which must be paid to use this channel
1104 pub fees: RoutingFees,
1105 /// The difference in CLTV values between this node and the next node.
1106 pub cltv_expiry_delta: u16,
1107 /// The minimum value, in msat, which must be relayed to the next hop.
1108 pub htlc_minimum_msat: Option<u64>,
1109 /// The maximum value in msat available for routing with a single HTLC.
1110 pub htlc_maximum_msat: Option<u64>,
1113 impl_writeable_tlv_based!(RouteHintHop, {
1114 (0, src_node_id, required),
1115 (1, htlc_minimum_msat, option),
1116 (2, short_channel_id, required),
1117 (3, htlc_maximum_msat, option),
1118 (4, fees, required),
1119 (6, cltv_expiry_delta, required),
1122 #[derive(Eq, PartialEq)]
1123 #[repr(align(64))] // Force the size to 64 bytes
1124 struct RouteGraphNode {
1127 // The maximum value a yet-to-be-constructed payment path might flow through this node.
1128 // This value is upper-bounded by us by:
1129 // - how much is needed for a path being constructed
1130 // - how much value can channels following this node (up to the destination) can contribute,
1131 // considering their capacity and fees
1132 value_contribution_msat: u64,
1133 total_cltv_delta: u32,
1134 /// The number of hops walked up to this node.
1135 path_length_to_node: u8,
1138 impl cmp::Ord for RouteGraphNode {
1139 fn cmp(&self, other: &RouteGraphNode) -> cmp::Ordering {
1140 other.score.cmp(&self.score).then_with(|| other.node_id.cmp(&self.node_id))
1144 impl cmp::PartialOrd for RouteGraphNode {
1145 fn partial_cmp(&self, other: &RouteGraphNode) -> Option<cmp::Ordering> {
1146 Some(self.cmp(other))
1150 // While RouteGraphNode can be laid out with fewer bytes, performance appears to be improved
1151 // substantially when it is laid out at exactly 64 bytes.
1153 // Thus, we use `#[repr(C)]` on the struct to force a suboptimal layout and check that it stays 64
1155 #[cfg(any(ldk_bench, not(any(test, fuzzing))))]
1156 const _GRAPH_NODE_SMALL: usize = 64 - core::mem::size_of::<RouteGraphNode>();
1157 #[cfg(any(ldk_bench, not(any(test, fuzzing))))]
1158 const _GRAPH_NODE_FIXED_SIZE: usize = core::mem::size_of::<RouteGraphNode>() - 64;
1160 /// A [`CandidateRouteHop::FirstHop`] entry.
1161 #[derive(Clone, Debug)]
1162 pub struct FirstHopCandidate<'a> {
1163 /// Channel details of the first hop
1165 /// [`ChannelDetails::get_outbound_payment_scid`] MUST be `Some` (indicating the channel
1166 /// has been funded and is able to pay), and accessor methods may panic otherwise.
1168 /// [`find_route`] validates this prior to constructing a [`CandidateRouteHop`].
1170 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1171 pub details: &'a ChannelDetails,
1172 /// The node id of the payer, which is also the source side of this candidate route hop.
1174 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1175 pub payer_node_id: &'a NodeId,
1178 /// A [`CandidateRouteHop::PublicHop`] entry.
1179 #[derive(Clone, Debug)]
1180 pub struct PublicHopCandidate<'a> {
1181 /// Information about the channel, including potentially its capacity and
1182 /// direction-specific information.
1184 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1185 pub info: DirectedChannelInfo<'a>,
1186 /// The short channel ID of the channel, i.e. the identifier by which we refer to this
1188 pub short_channel_id: u64,
1191 /// A [`CandidateRouteHop::PrivateHop`] entry.
1192 #[derive(Clone, Debug)]
1193 pub struct PrivateHopCandidate<'a> {
1194 /// Information about the private hop communicated via BOLT 11.
1196 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1197 pub hint: &'a RouteHintHop,
1198 /// Node id of the next hop in BOLT 11 route hint.
1200 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1201 pub target_node_id: &'a NodeId
1204 /// A [`CandidateRouteHop::Blinded`] entry.
1205 #[derive(Clone, Debug)]
1206 pub struct BlindedPathCandidate<'a> {
1207 /// The node id of the introduction node, resolved from either the [`NetworkGraph`] or first
1210 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1211 pub source_node_id: &'a NodeId,
1212 /// Information about the blinded path including the fee, HTLC amount limits, and
1213 /// cryptographic material required to build an HTLC through the given path.
1215 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1216 pub hint: &'a (BlindedPayInfo, BlindedPath),
1217 /// Index of the hint in the original list of blinded hints.
1219 /// This is used to cheaply uniquely identify this blinded path, even though we don't have
1220 /// a short channel ID for this hop.
1224 /// A [`CandidateRouteHop::OneHopBlinded`] entry.
1225 #[derive(Clone, Debug)]
1226 pub struct OneHopBlindedPathCandidate<'a> {
1227 /// The node id of the introduction node, resolved from either the [`NetworkGraph`] or first
1230 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1231 pub source_node_id: &'a NodeId,
1232 /// Information about the blinded path including the fee, HTLC amount limits, and
1233 /// cryptographic material required to build an HTLC terminating with the given path.
1235 /// Note that the [`BlindedPayInfo`] is ignored here.
1237 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1238 pub hint: &'a (BlindedPayInfo, BlindedPath),
1239 /// Index of the hint in the original list of blinded hints.
1241 /// This is used to cheaply uniquely identify this blinded path, even though we don't have
1242 /// a short channel ID for this hop.
1246 /// A wrapper around the various hop representations.
1248 /// Can be used to examine the properties of a hop,
1249 /// potentially to decide whether to include it in a route.
1250 #[derive(Clone, Debug)]
1251 pub enum CandidateRouteHop<'a> {
1252 /// A hop from the payer, where the outbound liquidity is known.
1253 FirstHop(FirstHopCandidate<'a>),
1254 /// A hop found in the [`ReadOnlyNetworkGraph`].
1255 PublicHop(PublicHopCandidate<'a>),
1256 /// A private hop communicated by the payee, generally via a BOLT 11 invoice.
1258 /// Because BOLT 11 route hints can take multiple hops to get to the destination, this may not
1259 /// terminate at the payee.
1260 PrivateHop(PrivateHopCandidate<'a>),
1261 /// A blinded path which starts with an introduction point and ultimately terminates with the
1264 /// Because we don't know the payee's identity, [`CandidateRouteHop::target`] will return
1265 /// `None` in this state.
1267 /// Because blinded paths are "all or nothing", and we cannot use just one part of a blinded
1268 /// path, the full path is treated as a single [`CandidateRouteHop`].
1269 Blinded(BlindedPathCandidate<'a>),
1270 /// Similar to [`Self::Blinded`], but the path here only has one hop.
1272 /// While we treat this similarly to [`CandidateRouteHop::Blinded`] in many respects (e.g.
1273 /// returning `None` from [`CandidateRouteHop::target`]), in this case we do actually know the
1274 /// payee's identity - it's the introduction point!
1276 /// [`BlindedPayInfo`] provided for 1-hop blinded paths is ignored because it is meant to apply
1277 /// to the hops *between* the introduction node and the destination.
1279 /// This primarily exists to track that we need to included a blinded path at the end of our
1280 /// [`Route`], even though it doesn't actually add an additional hop in the payment.
1281 OneHopBlinded(OneHopBlindedPathCandidate<'a>),
1284 impl<'a> CandidateRouteHop<'a> {
1285 /// Returns the short channel ID for this hop, if one is known.
1287 /// This SCID could be an alias or a globally unique SCID, and thus is only expected to
1288 /// uniquely identify this channel in conjunction with the [`CandidateRouteHop::source`].
1290 /// Returns `Some` as long as the candidate is a [`CandidateRouteHop::PublicHop`], a
1291 /// [`CandidateRouteHop::PrivateHop`] from a BOLT 11 route hint, or a
1292 /// [`CandidateRouteHop::FirstHop`] with a known [`ChannelDetails::get_outbound_payment_scid`]
1293 /// (which is always true for channels which are funded and ready for use).
1295 /// In other words, this should always return `Some` as long as the candidate hop is not a
1296 /// [`CandidateRouteHop::Blinded`] or a [`CandidateRouteHop::OneHopBlinded`].
1298 /// Note that this is deliberately not public as it is somewhat of a footgun because it doesn't
1299 /// define a global namespace.
1301 fn short_channel_id(&self) -> Option<u64> {
1303 CandidateRouteHop::FirstHop(hop) => hop.details.get_outbound_payment_scid(),
1304 CandidateRouteHop::PublicHop(hop) => Some(hop.short_channel_id),
1305 CandidateRouteHop::PrivateHop(hop) => Some(hop.hint.short_channel_id),
1306 CandidateRouteHop::Blinded(_) => None,
1307 CandidateRouteHop::OneHopBlinded(_) => None,
1311 /// Returns the globally unique short channel ID for this hop, if one is known.
1313 /// This only returns `Some` if the channel is public (either our own, or one we've learned
1314 /// from the public network graph), and thus the short channel ID we have for this channel is
1315 /// globally unique and identifies this channel in a global namespace.
1317 pub fn globally_unique_short_channel_id(&self) -> Option<u64> {
1319 CandidateRouteHop::FirstHop(hop) => if hop.details.is_public { hop.details.short_channel_id } else { None },
1320 CandidateRouteHop::PublicHop(hop) => Some(hop.short_channel_id),
1321 CandidateRouteHop::PrivateHop(_) => None,
1322 CandidateRouteHop::Blinded(_) => None,
1323 CandidateRouteHop::OneHopBlinded(_) => None,
1327 // NOTE: This may alloc memory so avoid calling it in a hot code path.
1328 fn features(&self) -> ChannelFeatures {
1330 CandidateRouteHop::FirstHop(hop) => hop.details.counterparty.features.to_context(),
1331 CandidateRouteHop::PublicHop(hop) => hop.info.channel().features.clone(),
1332 CandidateRouteHop::PrivateHop(_) => ChannelFeatures::empty(),
1333 CandidateRouteHop::Blinded(_) => ChannelFeatures::empty(),
1334 CandidateRouteHop::OneHopBlinded(_) => ChannelFeatures::empty(),
1338 /// Returns the required difference in HTLC CLTV expiry between the [`Self::source`] and the
1339 /// next-hop for an HTLC taking this hop.
1341 /// This is the time that the node(s) in this hop have to claim the HTLC on-chain if the
1342 /// next-hop goes on chain with a payment preimage.
1344 pub fn cltv_expiry_delta(&self) -> u32 {
1346 CandidateRouteHop::FirstHop(_) => 0,
1347 CandidateRouteHop::PublicHop(hop) => hop.info.direction().cltv_expiry_delta as u32,
1348 CandidateRouteHop::PrivateHop(hop) => hop.hint.cltv_expiry_delta as u32,
1349 CandidateRouteHop::Blinded(hop) => hop.hint.0.cltv_expiry_delta as u32,
1350 CandidateRouteHop::OneHopBlinded(_) => 0,
1354 /// Returns the minimum amount that can be sent over this hop, in millisatoshis.
1356 pub fn htlc_minimum_msat(&self) -> u64 {
1358 CandidateRouteHop::FirstHop(hop) => hop.details.next_outbound_htlc_minimum_msat,
1359 CandidateRouteHop::PublicHop(hop) => hop.info.direction().htlc_minimum_msat,
1360 CandidateRouteHop::PrivateHop(hop) => hop.hint.htlc_minimum_msat.unwrap_or(0),
1361 CandidateRouteHop::Blinded(hop) => hop.hint.0.htlc_minimum_msat,
1362 CandidateRouteHop::OneHopBlinded { .. } => 0,
1366 /// Returns the fees that must be paid to route an HTLC over this channel.
1368 pub fn fees(&self) -> RoutingFees {
1370 CandidateRouteHop::FirstHop(_) => RoutingFees {
1371 base_msat: 0, proportional_millionths: 0,
1373 CandidateRouteHop::PublicHop(hop) => hop.info.direction().fees,
1374 CandidateRouteHop::PrivateHop(hop) => hop.hint.fees,
1375 CandidateRouteHop::Blinded(hop) => {
1377 base_msat: hop.hint.0.fee_base_msat,
1378 proportional_millionths: hop.hint.0.fee_proportional_millionths
1381 CandidateRouteHop::OneHopBlinded(_) =>
1382 RoutingFees { base_msat: 0, proportional_millionths: 0 },
1386 /// Fetch the effective capacity of this hop.
1388 /// Note that this may be somewhat expensive, so calls to this should be limited and results
1390 fn effective_capacity(&self) -> EffectiveCapacity {
1392 CandidateRouteHop::FirstHop(hop) => EffectiveCapacity::ExactLiquidity {
1393 liquidity_msat: hop.details.next_outbound_htlc_limit_msat,
1395 CandidateRouteHop::PublicHop(hop) => hop.info.effective_capacity(),
1396 CandidateRouteHop::PrivateHop(PrivateHopCandidate { hint: RouteHintHop { htlc_maximum_msat: Some(max), .. }, .. }) =>
1397 EffectiveCapacity::HintMaxHTLC { amount_msat: *max },
1398 CandidateRouteHop::PrivateHop(PrivateHopCandidate { hint: RouteHintHop { htlc_maximum_msat: None, .. }, .. }) =>
1399 EffectiveCapacity::Infinite,
1400 CandidateRouteHop::Blinded(hop) =>
1401 EffectiveCapacity::HintMaxHTLC { amount_msat: hop.hint.0.htlc_maximum_msat },
1402 CandidateRouteHop::OneHopBlinded(_) => EffectiveCapacity::Infinite,
1406 /// Returns an ID describing the given hop.
1408 /// See the docs on [`CandidateHopId`] for when this is, or is not, unique.
1410 fn id(&self) -> CandidateHopId {
1412 CandidateRouteHop::Blinded(hop) => CandidateHopId::Blinded(hop.hint_idx),
1413 CandidateRouteHop::OneHopBlinded(hop) => CandidateHopId::Blinded(hop.hint_idx),
1414 _ => CandidateHopId::Clear((self.short_channel_id().unwrap(), self.source() < self.target().unwrap())),
1417 fn blinded_path(&self) -> Option<&'a BlindedPath> {
1419 CandidateRouteHop::Blinded(BlindedPathCandidate { hint, .. }) | CandidateRouteHop::OneHopBlinded(OneHopBlindedPathCandidate { hint, .. }) => {
1425 fn blinded_hint_idx(&self) -> Option<usize> {
1427 Self::Blinded(BlindedPathCandidate { hint_idx, .. }) |
1428 Self::OneHopBlinded(OneHopBlindedPathCandidate { hint_idx, .. }) => {
1434 /// Returns the source node id of current hop.
1436 /// Source node id refers to the node forwarding the HTLC through this hop.
1438 /// For [`Self::FirstHop`] we return payer's node id.
1440 pub fn source(&self) -> NodeId {
1442 CandidateRouteHop::FirstHop(hop) => *hop.payer_node_id,
1443 CandidateRouteHop::PublicHop(hop) => *hop.info.source(),
1444 CandidateRouteHop::PrivateHop(hop) => hop.hint.src_node_id.into(),
1445 CandidateRouteHop::Blinded(hop) => *hop.source_node_id,
1446 CandidateRouteHop::OneHopBlinded(hop) => *hop.source_node_id,
1449 /// Returns the target node id of this hop, if known.
1451 /// Target node id refers to the node receiving the HTLC after this hop.
1453 /// For [`Self::Blinded`] we return `None` because the ultimate destination after the blinded
1454 /// path is unknown.
1456 /// For [`Self::OneHopBlinded`] we return `None` because the target is the same as the source,
1457 /// and such a return value would be somewhat nonsensical.
1459 pub fn target(&self) -> Option<NodeId> {
1461 CandidateRouteHop::FirstHop(hop) => Some(hop.details.counterparty.node_id.into()),
1462 CandidateRouteHop::PublicHop(hop) => Some(*hop.info.target()),
1463 CandidateRouteHop::PrivateHop(hop) => Some(*hop.target_node_id),
1464 CandidateRouteHop::Blinded(_) => None,
1465 CandidateRouteHop::OneHopBlinded(_) => None,
1470 /// A unique(ish) identifier for a specific [`CandidateRouteHop`].
1472 /// For blinded paths, this ID is unique only within a given [`find_route`] call.
1474 /// For other hops, because SCIDs between private channels and public channels can conflict, this
1475 /// isn't guaranteed to be unique at all.
1477 /// For our uses, this is generally fine, but it is not public as it is otherwise a rather
1478 /// difficult-to-use API.
1479 #[derive(Clone, Copy, Eq, Hash, Ord, PartialOrd, PartialEq)]
1480 enum CandidateHopId {
1481 /// Contains (scid, src_node_id < target_node_id)
1483 /// Index of the blinded route hint in [`Payee::Blinded::route_hints`].
1488 fn max_htlc_from_capacity(capacity: EffectiveCapacity, max_channel_saturation_power_of_half: u8) -> u64 {
1489 let saturation_shift: u32 = max_channel_saturation_power_of_half as u32;
1491 EffectiveCapacity::ExactLiquidity { liquidity_msat } => liquidity_msat,
1492 EffectiveCapacity::Infinite => u64::max_value(),
1493 EffectiveCapacity::Unknown => EffectiveCapacity::Unknown.as_msat(),
1494 EffectiveCapacity::AdvertisedMaxHTLC { amount_msat } =>
1495 amount_msat.checked_shr(saturation_shift).unwrap_or(0),
1496 // Treat htlc_maximum_msat from a route hint as an exact liquidity amount, since the invoice is
1497 // expected to have been generated from up-to-date capacity information.
1498 EffectiveCapacity::HintMaxHTLC { amount_msat } => amount_msat,
1499 EffectiveCapacity::Total { capacity_msat, htlc_maximum_msat } =>
1500 cmp::min(capacity_msat.checked_shr(saturation_shift).unwrap_or(0), htlc_maximum_msat),
1504 fn iter_equal<I1: Iterator, I2: Iterator>(mut iter_a: I1, mut iter_b: I2)
1505 -> bool where I1::Item: PartialEq<I2::Item> {
1507 let a = iter_a.next();
1508 let b = iter_b.next();
1509 if a.is_none() && b.is_none() { return true; }
1510 if a.is_none() || b.is_none() { return false; }
1511 if a.unwrap().ne(&b.unwrap()) { return false; }
1515 /// It's useful to keep track of the hops associated with the fees required to use them,
1516 /// so that we can choose cheaper paths (as per Dijkstra's algorithm).
1517 /// Fee values should be updated only in the context of the whole path, see update_value_and_recompute_fees.
1518 /// These fee values are useful to choose hops as we traverse the graph "payee-to-payer".
1520 #[repr(C)] // Force fields to appear in the order we define them.
1521 struct PathBuildingHop<'a> {
1522 candidate: CandidateRouteHop<'a>,
1523 /// If we've already processed a node as the best node, we shouldn't process it again. Normally
1524 /// we'd just ignore it if we did as all channels would have a higher new fee, but because we
1525 /// may decrease the amounts in use as we walk the graph, the actual calculated fee may
1526 /// decrease as well. Thus, we have to explicitly track which nodes have been processed and
1527 /// avoid processing them again.
1528 was_processed: bool,
1529 /// Used to compare channels when choosing the for routing.
1530 /// Includes paying for the use of a hop and the following hops, as well as
1531 /// an estimated cost of reaching this hop.
1532 /// Might get stale when fees are recomputed. Primarily for internal use.
1533 total_fee_msat: u64,
1534 /// A mirror of the same field in RouteGraphNode. Note that this is only used during the graph
1535 /// walk and may be invalid thereafter.
1536 path_htlc_minimum_msat: u64,
1537 /// All penalties incurred from this channel on the way to the destination, as calculated using
1538 /// channel scoring.
1539 path_penalty_msat: u64,
1541 // The last 16 bytes are on the next cache line by default in glibc's malloc. Thus, we should
1542 // only place fields which are not hot there. Luckily, the next three fields are only read if
1543 // we end up on the selected path, and only in the final path layout phase, so we don't care
1544 // too much if reading them is slow.
1548 /// All the fees paid *after* this channel on the way to the destination
1549 next_hops_fee_msat: u64,
1550 /// Fee paid for the use of the current channel (see candidate.fees()).
1551 /// The value will be actually deducted from the counterparty balance on the previous link.
1552 hop_use_fee_msat: u64,
1554 #[cfg(all(not(ldk_bench), any(test, fuzzing)))]
1555 // In tests, we apply further sanity checks on cases where we skip nodes we already processed
1556 // to ensure it is specifically in cases where the fee has gone down because of a decrease in
1557 // value_contribution_msat, which requires tracking it here. See comments below where it is
1558 // used for more info.
1559 value_contribution_msat: u64,
1562 // Checks that the entries in the `find_route` `dist` map fit in (exactly) two standard x86-64
1563 // cache lines. Sadly, they're not guaranteed to actually lie on a cache line (and in fact,
1564 // generally won't, because at least glibc's malloc will align to a nice, big, round
1565 // boundary...plus 16), but at least it will reduce the amount of data we'll need to load.
1567 // Note that these assertions only pass on somewhat recent rustc, and thus are gated on the
1570 const _NODE_MAP_SIZE_TWO_CACHE_LINES: usize = 128 - core::mem::size_of::<(NodeId, PathBuildingHop)>();
1572 const _NODE_MAP_SIZE_EXACTLY_CACHE_LINES: usize = core::mem::size_of::<(NodeId, PathBuildingHop)>() - 128;
1574 impl<'a> core::fmt::Debug for PathBuildingHop<'a> {
1575 fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
1576 let mut debug_struct = f.debug_struct("PathBuildingHop");
1578 .field("node_id", &self.candidate.target())
1579 .field("short_channel_id", &self.candidate.short_channel_id())
1580 .field("total_fee_msat", &self.total_fee_msat)
1581 .field("next_hops_fee_msat", &self.next_hops_fee_msat)
1582 .field("hop_use_fee_msat", &self.hop_use_fee_msat)
1583 .field("total_fee_msat - (next_hops_fee_msat + hop_use_fee_msat)", &(&self.total_fee_msat - (&self.next_hops_fee_msat + &self.hop_use_fee_msat)))
1584 .field("path_penalty_msat", &self.path_penalty_msat)
1585 .field("path_htlc_minimum_msat", &self.path_htlc_minimum_msat)
1586 .field("cltv_expiry_delta", &self.candidate.cltv_expiry_delta());
1587 #[cfg(all(not(ldk_bench), any(test, fuzzing)))]
1588 let debug_struct = debug_struct
1589 .field("value_contribution_msat", &self.value_contribution_msat);
1590 debug_struct.finish()
1594 // Instantiated with a list of hops with correct data in them collected during path finding,
1595 // an instance of this struct should be further modified only via given methods.
1597 struct PaymentPath<'a> {
1598 hops: Vec<(PathBuildingHop<'a>, NodeFeatures)>,
1601 impl<'a> PaymentPath<'a> {
1602 // TODO: Add a value_msat field to PaymentPath and use it instead of this function.
1603 fn get_value_msat(&self) -> u64 {
1604 self.hops.last().unwrap().0.fee_msat
1607 fn get_path_penalty_msat(&self) -> u64 {
1608 self.hops.first().map(|h| h.0.path_penalty_msat).unwrap_or(u64::max_value())
1611 fn get_total_fee_paid_msat(&self) -> u64 {
1612 if self.hops.len() < 1 {
1616 // Can't use next_hops_fee_msat because it gets outdated.
1617 for (i, (hop, _)) in self.hops.iter().enumerate() {
1618 if i != self.hops.len() - 1 {
1619 result += hop.fee_msat;
1625 fn get_cost_msat(&self) -> u64 {
1626 self.get_total_fee_paid_msat().saturating_add(self.get_path_penalty_msat())
1629 // If the amount transferred by the path is updated, the fees should be adjusted. Any other way
1630 // to change fees may result in an inconsistency.
1632 // Sometimes we call this function right after constructing a path which is inconsistent in
1633 // that it the value being transferred has decreased while we were doing path finding, leading
1634 // to the fees being paid not lining up with the actual limits.
1636 // Note that this function is not aware of the available_liquidity limit, and thus does not
1637 // support increasing the value being transferred beyond what was selected during the initial
1640 // Returns the amount that this path contributes to the total payment value, which may be greater
1641 // than `value_msat` if we had to overpay to meet the final node's `htlc_minimum_msat`.
1642 fn update_value_and_recompute_fees(&mut self, value_msat: u64) -> u64 {
1643 let mut extra_contribution_msat = 0;
1644 let mut total_fee_paid_msat = 0 as u64;
1645 for i in (0..self.hops.len()).rev() {
1646 let last_hop = i == self.hops.len() - 1;
1648 // For non-last-hop, this value will represent the fees paid on the current hop. It
1649 // will consist of the fees for the use of the next hop, and extra fees to match
1650 // htlc_minimum_msat of the current channel. Last hop is handled separately.
1651 let mut cur_hop_fees_msat = 0;
1653 cur_hop_fees_msat = self.hops.get(i + 1).unwrap().0.hop_use_fee_msat;
1656 let cur_hop = &mut self.hops.get_mut(i).unwrap().0;
1657 cur_hop.next_hops_fee_msat = total_fee_paid_msat;
1658 cur_hop.path_penalty_msat += extra_contribution_msat;
1659 // Overpay in fees if we can't save these funds due to htlc_minimum_msat.
1660 // We try to account for htlc_minimum_msat in scoring (add_entry!), so that nodes don't
1661 // set it too high just to maliciously take more fees by exploiting this
1662 // match htlc_minimum_msat logic.
1663 let mut cur_hop_transferred_amount_msat = total_fee_paid_msat + value_msat;
1664 if let Some(extra_fees_msat) = cur_hop.candidate.htlc_minimum_msat().checked_sub(cur_hop_transferred_amount_msat) {
1665 // Note that there is a risk that *previous hops* (those closer to us, as we go
1666 // payee->our_node here) would exceed their htlc_maximum_msat or available balance.
1668 // This might make us end up with a broken route, although this should be super-rare
1669 // in practice, both because of how healthy channels look like, and how we pick
1670 // channels in add_entry.
1671 // Also, this can't be exploited more heavily than *announce a free path and fail
1673 cur_hop_transferred_amount_msat += extra_fees_msat;
1675 // We remember and return the extra fees on the final hop to allow accounting for
1676 // them in the path's value contribution.
1678 extra_contribution_msat = extra_fees_msat;
1680 total_fee_paid_msat += extra_fees_msat;
1681 cur_hop_fees_msat += extra_fees_msat;
1686 // Final hop is a special case: it usually has just value_msat (by design), but also
1687 // it still could overpay for the htlc_minimum_msat.
1688 cur_hop.fee_msat = cur_hop_transferred_amount_msat;
1690 // Propagate updated fees for the use of the channels to one hop back, where they
1691 // will be actually paid (fee_msat). The last hop is handled above separately.
1692 cur_hop.fee_msat = cur_hop_fees_msat;
1695 // Fee for the use of the current hop which will be deducted on the previous hop.
1696 // Irrelevant for the first hop, as it doesn't have the previous hop, and the use of
1697 // this channel is free for us.
1699 if let Some(new_fee) = compute_fees(cur_hop_transferred_amount_msat, cur_hop.candidate.fees()) {
1700 cur_hop.hop_use_fee_msat = new_fee;
1701 total_fee_paid_msat += new_fee;
1703 // It should not be possible because this function is called only to reduce the
1704 // value. In that case, compute_fee was already called with the same fees for
1705 // larger amount and there was no overflow.
1710 value_msat + extra_contribution_msat
1715 /// Calculate the fees required to route the given amount over a channel with the given fees.
1716 fn compute_fees(amount_msat: u64, channel_fees: RoutingFees) -> Option<u64> {
1717 amount_msat.checked_mul(channel_fees.proportional_millionths as u64)
1718 .and_then(|part| (channel_fees.base_msat as u64).checked_add(part / 1_000_000))
1722 /// Calculate the fees required to route the given amount over a channel with the given fees,
1723 /// saturating to [`u64::max_value`].
1724 fn compute_fees_saturating(amount_msat: u64, channel_fees: RoutingFees) -> u64 {
1725 amount_msat.checked_mul(channel_fees.proportional_millionths as u64)
1726 .map(|prop| prop / 1_000_000).unwrap_or(u64::max_value())
1727 .saturating_add(channel_fees.base_msat as u64)
1730 /// The default `features` we assume for a node in a route, when no `features` are known about that
1733 /// Default features are:
1734 /// * variable_length_onion_optional
1735 fn default_node_features() -> NodeFeatures {
1736 let mut features = NodeFeatures::empty();
1737 features.set_variable_length_onion_optional();
1741 struct LoggedPayeePubkey(Option<PublicKey>);
1742 impl fmt::Display for LoggedPayeePubkey {
1743 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1746 "payee node id ".fmt(f)?;
1750 "blinded payee".fmt(f)
1756 struct LoggedCandidateHop<'a>(&'a CandidateRouteHop<'a>);
1757 impl<'a> fmt::Display for LoggedCandidateHop<'a> {
1758 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1760 CandidateRouteHop::Blinded(BlindedPathCandidate { hint, .. }) | CandidateRouteHop::OneHopBlinded(OneHopBlindedPathCandidate { hint, .. }) => {
1761 "blinded route hint with introduction node ".fmt(f)?;
1762 match &hint.1.introduction_node {
1763 IntroductionNode::NodeId(pubkey) => write!(f, "id {}", pubkey)?,
1764 IntroductionNode::DirectedShortChannelId(direction, scid) => {
1766 Direction::NodeOne => {
1767 write!(f, "one on channel with SCID {}", scid)?;
1769 Direction::NodeTwo => {
1770 write!(f, "two on channel with SCID {}", scid)?;
1775 " and blinding point ".fmt(f)?;
1776 hint.1.blinding_point.fmt(f)
1778 CandidateRouteHop::FirstHop(_) => {
1779 "first hop with SCID ".fmt(f)?;
1780 self.0.short_channel_id().unwrap().fmt(f)
1782 CandidateRouteHop::PrivateHop(_) => {
1783 "route hint with SCID ".fmt(f)?;
1784 self.0.short_channel_id().unwrap().fmt(f)
1788 self.0.short_channel_id().unwrap().fmt(f)
1795 fn sort_first_hop_channels(
1796 channels: &mut Vec<&ChannelDetails>, used_liquidities: &HashMap<CandidateHopId, u64>,
1797 recommended_value_msat: u64, our_node_pubkey: &PublicKey
1799 // Sort the first_hops channels to the same node(s) in priority order of which channel we'd
1800 // most like to use.
1802 // First, if channels are below `recommended_value_msat`, sort them in descending order,
1803 // preferring larger channels to avoid splitting the payment into more MPP parts than is
1806 // Second, because simply always sorting in descending order would always use our largest
1807 // available outbound capacity, needlessly fragmenting our available channel capacities,
1808 // sort channels above `recommended_value_msat` in ascending order, preferring channels
1809 // which have enough, but not too much, capacity for the payment.
1811 // Available outbound balances factor in liquidity already reserved for previously found paths.
1812 channels.sort_unstable_by(|chan_a, chan_b| {
1813 let chan_a_outbound_limit_msat = chan_a.next_outbound_htlc_limit_msat
1814 .saturating_sub(*used_liquidities.get(&CandidateHopId::Clear((chan_a.get_outbound_payment_scid().unwrap(),
1815 our_node_pubkey < &chan_a.counterparty.node_id))).unwrap_or(&0));
1816 let chan_b_outbound_limit_msat = chan_b.next_outbound_htlc_limit_msat
1817 .saturating_sub(*used_liquidities.get(&CandidateHopId::Clear((chan_b.get_outbound_payment_scid().unwrap(),
1818 our_node_pubkey < &chan_b.counterparty.node_id))).unwrap_or(&0));
1819 if chan_b_outbound_limit_msat < recommended_value_msat || chan_a_outbound_limit_msat < recommended_value_msat {
1820 // Sort in descending order
1821 chan_b_outbound_limit_msat.cmp(&chan_a_outbound_limit_msat)
1823 // Sort in ascending order
1824 chan_a_outbound_limit_msat.cmp(&chan_b_outbound_limit_msat)
1829 /// Finds a route from us (payer) to the given target node (payee).
1831 /// If the payee provided features in their invoice, they should be provided via the `payee` field
1832 /// in the given [`RouteParameters::payment_params`].
1833 /// Without this, MPP will only be used if the payee's features are available in the network graph.
1835 /// Private routing paths between a public node and the target may be included in the `payee` field
1836 /// of [`RouteParameters::payment_params`].
1838 /// If some channels aren't announced, it may be useful to fill in `first_hops` with the results
1839 /// from [`ChannelManager::list_usable_channels`]. If it is filled in, the view of these channels
1840 /// from `network_graph` will be ignored, and only those in `first_hops` will be used.
1842 /// The fees on channels from us to the next hop are ignored as they are assumed to all be equal.
1843 /// However, the enabled/disabled bit on such channels as well as the `htlc_minimum_msat` /
1844 /// `htlc_maximum_msat` *are* checked as they may change based on the receiving node.
1848 /// Panics if first_hops contains channels without `short_channel_id`s;
1849 /// [`ChannelManager::list_usable_channels`] will never include such channels.
1851 /// [`ChannelManager::list_usable_channels`]: crate::ln::channelmanager::ChannelManager::list_usable_channels
1852 /// [`Event::PaymentPathFailed`]: crate::events::Event::PaymentPathFailed
1853 /// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
1854 pub fn find_route<L: Deref, GL: Deref, S: ScoreLookUp>(
1855 our_node_pubkey: &PublicKey, route_params: &RouteParameters,
1856 network_graph: &NetworkGraph<GL>, first_hops: Option<&[&ChannelDetails]>, logger: L,
1857 scorer: &S, score_params: &S::ScoreParams, random_seed_bytes: &[u8; 32]
1858 ) -> Result<Route, LightningError>
1859 where L::Target: Logger, GL::Target: Logger {
1860 let graph_lock = network_graph.read_only();
1861 let mut route = get_route(our_node_pubkey, &route_params, &graph_lock, first_hops, logger,
1862 scorer, score_params, random_seed_bytes)?;
1863 add_random_cltv_offset(&mut route, &route_params.payment_params, &graph_lock, random_seed_bytes);
1867 pub(crate) fn get_route<L: Deref, S: ScoreLookUp>(
1868 our_node_pubkey: &PublicKey, route_params: &RouteParameters, network_graph: &ReadOnlyNetworkGraph,
1869 first_hops: Option<&[&ChannelDetails]>, logger: L, scorer: &S, score_params: &S::ScoreParams,
1870 _random_seed_bytes: &[u8; 32]
1871 ) -> Result<Route, LightningError>
1872 where L::Target: Logger {
1874 let payment_params = &route_params.payment_params;
1875 let max_path_length = core::cmp::min(payment_params.max_path_length, MAX_PATH_LENGTH_ESTIMATE);
1876 let final_value_msat = route_params.final_value_msat;
1877 // If we're routing to a blinded recipient, we won't have their node id. Therefore, keep the
1878 // unblinded payee id as an option. We also need a non-optional "payee id" for path construction,
1879 // so use a dummy id for this in the blinded case.
1880 let payee_node_id_opt = payment_params.payee.node_id().map(|pk| NodeId::from_pubkey(&pk));
1881 const DUMMY_BLINDED_PAYEE_ID: [u8; 33] = [2; 33];
1882 let maybe_dummy_payee_pk = payment_params.payee.node_id().unwrap_or_else(|| PublicKey::from_slice(&DUMMY_BLINDED_PAYEE_ID).unwrap());
1883 let maybe_dummy_payee_node_id = NodeId::from_pubkey(&maybe_dummy_payee_pk);
1884 let our_node_id = NodeId::from_pubkey(&our_node_pubkey);
1886 if payee_node_id_opt.map_or(false, |payee| payee == our_node_id) {
1887 return Err(LightningError{err: "Cannot generate a route to ourselves".to_owned(), action: ErrorAction::IgnoreError});
1889 if our_node_id == maybe_dummy_payee_node_id {
1890 return Err(LightningError{err: "Invalid origin node id provided, use a different one".to_owned(), action: ErrorAction::IgnoreError});
1893 if final_value_msat > MAX_VALUE_MSAT {
1894 return Err(LightningError{err: "Cannot generate a route of more value than all existing satoshis".to_owned(), action: ErrorAction::IgnoreError});
1897 if final_value_msat == 0 {
1898 return Err(LightningError{err: "Cannot send a payment of 0 msat".to_owned(), action: ErrorAction::IgnoreError});
1901 let introduction_node_id_cache = payment_params.payee.blinded_route_hints().iter()
1902 .map(|(_, path)| path.public_introduction_node_id(network_graph))
1903 .collect::<Vec<_>>();
1904 match &payment_params.payee {
1905 Payee::Clear { route_hints, node_id, .. } => {
1906 for route in route_hints.iter() {
1907 for hop in &route.0 {
1908 if hop.src_node_id == *node_id {
1909 return Err(LightningError{err: "Route hint cannot have the payee as the source.".to_owned(), action: ErrorAction::IgnoreError});
1914 Payee::Blinded { route_hints, .. } => {
1915 if introduction_node_id_cache.iter().all(|introduction_node_id| *introduction_node_id == Some(&our_node_id)) {
1916 return Err(LightningError{err: "Cannot generate a route to blinded paths if we are the introduction node to all of them".to_owned(), action: ErrorAction::IgnoreError});
1918 for ((_, blinded_path), introduction_node_id) in route_hints.iter().zip(introduction_node_id_cache.iter()) {
1919 if blinded_path.blinded_hops.len() == 0 {
1920 return Err(LightningError{err: "0-hop blinded path provided".to_owned(), action: ErrorAction::IgnoreError});
1921 } else if *introduction_node_id == Some(&our_node_id) {
1922 log_info!(logger, "Got blinded path with ourselves as the introduction node, ignoring");
1923 } else if blinded_path.blinded_hops.len() == 1 &&
1925 .iter().zip(introduction_node_id_cache.iter())
1926 .filter(|((_, p), _)| p.blinded_hops.len() == 1)
1927 .any(|(_, p_introduction_node_id)| p_introduction_node_id != introduction_node_id)
1929 return Err(LightningError{err: format!("1-hop blinded paths must all have matching introduction node ids"), action: ErrorAction::IgnoreError});
1934 let final_cltv_expiry_delta = payment_params.payee.final_cltv_expiry_delta().unwrap_or(0);
1935 if payment_params.max_total_cltv_expiry_delta <= final_cltv_expiry_delta {
1936 return Err(LightningError{err: "Can't find a route where the maximum total CLTV expiry delta is below the final CLTV expiry.".to_owned(), action: ErrorAction::IgnoreError});
1939 // The general routing idea is the following:
1940 // 1. Fill first/last hops communicated by the caller.
1941 // 2. Attempt to construct a path from payer to payee for transferring
1942 // any ~sufficient (described later) value.
1943 // If succeed, remember which channels were used and how much liquidity they have available,
1944 // so that future paths don't rely on the same liquidity.
1945 // 3. Proceed to the next step if:
1946 // - we hit the recommended target value;
1947 // - OR if we could not construct a new path. Any next attempt will fail too.
1948 // Otherwise, repeat step 2.
1949 // 4. See if we managed to collect paths which aggregately are able to transfer target value
1950 // (not recommended value).
1951 // 5. If yes, proceed. If not, fail routing.
1952 // 6. Select the paths which have the lowest cost (fee plus scorer penalty) per amount
1953 // transferred up to the transfer target value.
1954 // 7. Reduce the value of the last path until we are sending only the target value.
1955 // 8. If our maximum channel saturation limit caused us to pick two identical paths, combine
1956 // them so that we're not sending two HTLCs along the same path.
1958 // As for the actual search algorithm, we do a payee-to-payer Dijkstra's sorting by each node's
1959 // distance from the payee
1961 // We are not a faithful Dijkstra's implementation because we can change values which impact
1962 // earlier nodes while processing later nodes. Specifically, if we reach a channel with a lower
1963 // liquidity limit (via htlc_maximum_msat, on-chain capacity or assumed liquidity limits) than
1964 // the value we are currently attempting to send over a path, we simply reduce the value being
1965 // sent along the path for any hops after that channel. This may imply that later fees (which
1966 // we've already tabulated) are lower because a smaller value is passing through the channels
1967 // (and the proportional fee is thus lower). There isn't a trivial way to recalculate the
1968 // channels which were selected earlier (and which may still be used for other paths without a
1969 // lower liquidity limit), so we simply accept that some liquidity-limited paths may be
1972 // One potentially problematic case for this algorithm would be if there are many
1973 // liquidity-limited paths which are liquidity-limited near the destination (ie early in our
1974 // graph walking), we may never find a path which is not liquidity-limited and has lower
1975 // proportional fee (and only lower absolute fee when considering the ultimate value sent).
1976 // Because we only consider paths with at least 5% of the total value being sent, the damage
1977 // from such a case should be limited, however this could be further reduced in the future by
1978 // calculating fees on the amount we wish to route over a path, ie ignoring the liquidity
1979 // limits for the purposes of fee calculation.
1981 // Alternatively, we could store more detailed path information in the heap (targets, below)
1982 // and index the best-path map (dist, below) by node *and* HTLC limits, however that would blow
1983 // up the runtime significantly both algorithmically (as we'd traverse nodes multiple times)
1984 // and practically (as we would need to store dynamically-allocated path information in heap
1985 // objects, increasing malloc traffic and indirect memory access significantly). Further, the
1986 // results of such an algorithm would likely be biased towards lower-value paths.
1988 // Further, we could return to a faithful Dijkstra's algorithm by rejecting paths with limits
1989 // outside of our current search value, running a path search more times to gather candidate
1990 // paths at different values. While this may be acceptable, further path searches may increase
1991 // runtime for little gain. Specifically, the current algorithm rather efficiently explores the
1992 // graph for candidate paths, calculating the maximum value which can realistically be sent at
1993 // the same time, remaining generic across different payment values.
1995 let network_channels = network_graph.channels();
1996 let network_nodes = network_graph.nodes();
1998 if payment_params.max_path_count == 0 {
1999 return Err(LightningError{err: "Can't find a route with no paths allowed.".to_owned(), action: ErrorAction::IgnoreError});
2002 // Allow MPP only if we have a features set from somewhere that indicates the payee supports
2003 // it. If the payee supports it they're supposed to include it in the invoice, so that should
2005 let allow_mpp = if payment_params.max_path_count == 1 {
2007 } else if payment_params.payee.supports_basic_mpp() {
2009 } else if let Some(payee) = payee_node_id_opt {
2010 network_nodes.get(&payee).map_or(false, |node| node.announcement_info.as_ref().map_or(false,
2011 |info| info.features.supports_basic_mpp()))
2014 let max_total_routing_fee_msat = route_params.max_total_routing_fee_msat.unwrap_or(u64::max_value());
2016 log_trace!(logger, "Searching for a route from payer {} to {} {} MPP and {} first hops {}overriding the network graph of {} nodes and {} channels with a fee limit of {} msat",
2017 our_node_pubkey, LoggedPayeePubkey(payment_params.payee.node_id()),
2018 if allow_mpp { "with" } else { "without" },
2019 first_hops.map(|hops| hops.len()).unwrap_or(0), if first_hops.is_some() { "" } else { "not " },
2020 network_graph.nodes().len(), network_graph.channels().len(),
2021 max_total_routing_fee_msat);
2024 // Prepare the data we'll use for payee-to-payer search by
2025 // inserting first hops suggested by the caller as targets.
2026 // Our search will then attempt to reach them while traversing from the payee node.
2027 let mut first_hop_targets: HashMap<_, Vec<&ChannelDetails>> =
2028 hash_map_with_capacity(if first_hops.is_some() { first_hops.as_ref().unwrap().len() } else { 0 });
2029 if let Some(hops) = first_hops {
2031 if chan.get_outbound_payment_scid().is_none() {
2032 panic!("first_hops should be filled in with usable channels, not pending ones");
2034 if chan.counterparty.node_id == *our_node_pubkey {
2035 return Err(LightningError{err: "First hop cannot have our_node_pubkey as a destination.".to_owned(), action: ErrorAction::IgnoreError});
2038 .entry(NodeId::from_pubkey(&chan.counterparty.node_id))
2039 .or_insert(Vec::new())
2042 if first_hop_targets.is_empty() {
2043 return Err(LightningError{err: "Cannot route when there are no outbound routes away from us".to_owned(), action: ErrorAction::IgnoreError});
2047 let mut private_hop_key_cache = hash_map_with_capacity(
2048 payment_params.payee.unblinded_route_hints().iter().map(|path| path.0.len()).sum()
2051 // Because we store references to private hop node_ids in `dist`, below, we need them to exist
2052 // (as `NodeId`, not `PublicKey`) for the lifetime of `dist`. Thus, we calculate all the keys
2053 // we'll need here and simply fetch them when routing.
2054 private_hop_key_cache.insert(maybe_dummy_payee_pk, NodeId::from_pubkey(&maybe_dummy_payee_pk));
2055 for route in payment_params.payee.unblinded_route_hints().iter() {
2056 for hop in route.0.iter() {
2057 private_hop_key_cache.insert(hop.src_node_id, NodeId::from_pubkey(&hop.src_node_id));
2061 // The main heap containing all candidate next-hops sorted by their score (max(fee,
2062 // htlc_minimum)). Ideally this would be a heap which allowed cheap score reduction instead of
2063 // adding duplicate entries when we find a better path to a given node.
2064 let mut targets: BinaryHeap<RouteGraphNode> = BinaryHeap::new();
2066 // Map from node_id to information about the best current path to that node, including feerate
2068 let mut dist: HashMap<NodeId, PathBuildingHop> = hash_map_with_capacity(network_nodes.len());
2070 // During routing, if we ignore a path due to an htlc_minimum_msat limit, we set this,
2071 // indicating that we may wish to try again with a higher value, potentially paying to meet an
2072 // htlc_minimum with extra fees while still finding a cheaper path.
2073 let mut hit_minimum_limit;
2075 // When arranging a route, we select multiple paths so that we can make a multi-path payment.
2076 // We start with a path_value of the exact amount we want, and if that generates a route we may
2077 // return it immediately. Otherwise, we don't stop searching for paths until we have 3x the
2078 // amount we want in total across paths, selecting the best subset at the end.
2079 const ROUTE_CAPACITY_PROVISION_FACTOR: u64 = 3;
2080 let recommended_value_msat = final_value_msat * ROUTE_CAPACITY_PROVISION_FACTOR as u64;
2081 let mut path_value_msat = final_value_msat;
2083 // Routing Fragmentation Mitigation heuristic:
2085 // Routing fragmentation across many payment paths increases the overall routing
2086 // fees as you have irreducible routing fees per-link used (`fee_base_msat`).
2087 // Taking too many smaller paths also increases the chance of payment failure.
2088 // Thus to avoid this effect, we require from our collected links to provide
2089 // at least a minimal contribution to the recommended value yet-to-be-fulfilled.
2090 // This requirement is currently set to be 1/max_path_count of the payment
2091 // value to ensure we only ever return routes that do not violate this limit.
2092 let minimal_value_contribution_msat: u64 = if allow_mpp {
2093 (final_value_msat + (payment_params.max_path_count as u64 - 1)) / payment_params.max_path_count as u64
2098 // When we start collecting routes we enforce the max_channel_saturation_power_of_half
2099 // requirement strictly. After we've collected enough (or if we fail to find new routes) we
2100 // drop the requirement by setting this to 0.
2101 let mut channel_saturation_pow_half = payment_params.max_channel_saturation_power_of_half;
2103 // Keep track of how much liquidity has been used in selected channels or blinded paths. Used to
2104 // determine if the channel can be used by additional MPP paths or to inform path finding
2105 // decisions. It is aware of direction *only* to ensure that the correct htlc_maximum_msat value
2106 // is used. Hence, liquidity used in one direction will not offset any used in the opposite
2108 let mut used_liquidities: HashMap<CandidateHopId, u64> =
2109 hash_map_with_capacity(network_nodes.len());
2111 // Keeping track of how much value we already collected across other paths. Helps to decide
2112 // when we want to stop looking for new paths.
2113 let mut already_collected_value_msat = 0;
2115 for (_, channels) in first_hop_targets.iter_mut() {
2116 sort_first_hop_channels(channels, &used_liquidities, recommended_value_msat,
2120 log_trace!(logger, "Building path from {} to payer {} for value {} msat.",
2121 LoggedPayeePubkey(payment_params.payee.node_id()), our_node_pubkey, final_value_msat);
2123 // Remember how many candidates we ignored to allow for some logging afterwards.
2124 let mut num_ignored_value_contribution: u32 = 0;
2125 let mut num_ignored_path_length_limit: u32 = 0;
2126 let mut num_ignored_cltv_delta_limit: u32 = 0;
2127 let mut num_ignored_previously_failed: u32 = 0;
2128 let mut num_ignored_total_fee_limit: u32 = 0;
2129 let mut num_ignored_avoid_overpayment: u32 = 0;
2130 let mut num_ignored_htlc_minimum_msat_limit: u32 = 0;
2132 macro_rules! add_entry {
2133 // Adds entry which goes from $candidate.source() to $candidate.target() over the $candidate hop.
2134 // $next_hops_fee_msat represents the fees paid for using all the channels *after* this one,
2135 // since that value has to be transferred over this channel.
2136 // Returns the contribution amount of $candidate if the channel caused an update to `targets`.
2137 ( $candidate: expr, $next_hops_fee_msat: expr,
2138 $next_hops_value_contribution: expr, $next_hops_path_htlc_minimum_msat: expr,
2139 $next_hops_path_penalty_msat: expr, $next_hops_cltv_delta: expr, $next_hops_path_length: expr ) => { {
2140 // We "return" whether we updated the path at the end, and how much we can route via
2141 // this channel, via this:
2142 let mut hop_contribution_amt_msat = None;
2143 // Channels to self should not be used. This is more of belt-and-suspenders, because in
2144 // practice these cases should be caught earlier:
2145 // - for regular channels at channel announcement (TODO)
2146 // - for first and last hops early in get_route
2147 let src_node_id = $candidate.source();
2148 if Some(src_node_id) != $candidate.target() {
2149 let scid_opt = $candidate.short_channel_id();
2150 let effective_capacity = $candidate.effective_capacity();
2151 let htlc_maximum_msat = max_htlc_from_capacity(effective_capacity, channel_saturation_pow_half);
2153 // It is tricky to subtract $next_hops_fee_msat from available liquidity here.
2154 // It may be misleading because we might later choose to reduce the value transferred
2155 // over these channels, and the channel which was insufficient might become sufficient.
2156 // Worst case: we drop a good channel here because it can't cover the high following
2157 // fees caused by one expensive channel, but then this channel could have been used
2158 // if the amount being transferred over this path is lower.
2159 // We do this for now, but this is a subject for removal.
2160 if let Some(mut available_value_contribution_msat) = htlc_maximum_msat.checked_sub($next_hops_fee_msat) {
2161 let used_liquidity_msat = used_liquidities
2162 .get(&$candidate.id())
2163 .map_or(0, |used_liquidity_msat| {
2164 available_value_contribution_msat = available_value_contribution_msat
2165 .saturating_sub(*used_liquidity_msat);
2166 *used_liquidity_msat
2169 // Verify the liquidity offered by this channel complies to the minimal contribution.
2170 let contributes_sufficient_value = available_value_contribution_msat >= minimal_value_contribution_msat;
2171 // Do not consider candidate hops that would exceed the maximum path length.
2172 let path_length_to_node = $next_hops_path_length
2173 + if $candidate.blinded_hint_idx().is_some() { 0 } else { 1 };
2174 let exceeds_max_path_length = path_length_to_node > max_path_length;
2176 // Do not consider candidates that exceed the maximum total cltv expiry limit.
2177 // In order to already account for some of the privacy enhancing random CLTV
2178 // expiry delta offset we add on top later, we subtract a rough estimate
2179 // (2*MEDIAN_HOP_CLTV_EXPIRY_DELTA) here.
2180 let max_total_cltv_expiry_delta = (payment_params.max_total_cltv_expiry_delta - final_cltv_expiry_delta)
2181 .checked_sub(2*MEDIAN_HOP_CLTV_EXPIRY_DELTA)
2182 .unwrap_or(payment_params.max_total_cltv_expiry_delta - final_cltv_expiry_delta);
2183 let hop_total_cltv_delta = ($next_hops_cltv_delta as u32)
2184 .saturating_add($candidate.cltv_expiry_delta());
2185 let exceeds_cltv_delta_limit = hop_total_cltv_delta > max_total_cltv_expiry_delta;
2187 let value_contribution_msat = cmp::min(available_value_contribution_msat, $next_hops_value_contribution);
2188 // Includes paying fees for the use of the following channels.
2189 let amount_to_transfer_over_msat: u64 = match value_contribution_msat.checked_add($next_hops_fee_msat) {
2190 Some(result) => result,
2191 // Can't overflow due to how the values were computed right above.
2192 None => unreachable!(),
2194 #[allow(unused_comparisons)] // $next_hops_path_htlc_minimum_msat is 0 in some calls so rustc complains
2195 let over_path_minimum_msat = amount_to_transfer_over_msat >= $candidate.htlc_minimum_msat() &&
2196 amount_to_transfer_over_msat >= $next_hops_path_htlc_minimum_msat;
2198 #[allow(unused_comparisons)] // $next_hops_path_htlc_minimum_msat is 0 in some calls so rustc complains
2199 let may_overpay_to_meet_path_minimum_msat =
2200 ((amount_to_transfer_over_msat < $candidate.htlc_minimum_msat() &&
2201 recommended_value_msat >= $candidate.htlc_minimum_msat()) ||
2202 (amount_to_transfer_over_msat < $next_hops_path_htlc_minimum_msat &&
2203 recommended_value_msat >= $next_hops_path_htlc_minimum_msat));
2205 let payment_failed_on_this_channel = match scid_opt {
2206 Some(scid) => payment_params.previously_failed_channels.contains(&scid),
2207 None => match $candidate.blinded_hint_idx() {
2209 payment_params.previously_failed_blinded_path_idxs.contains(&(idx as u64))
2215 let (should_log_candidate, first_hop_details) = match $candidate {
2216 CandidateRouteHop::FirstHop(hop) => (true, Some(hop.details)),
2217 CandidateRouteHop::PrivateHop(_) => (true, None),
2218 CandidateRouteHop::Blinded(_) => (true, None),
2219 CandidateRouteHop::OneHopBlinded(_) => (true, None),
2223 // If HTLC minimum is larger than the amount we're going to transfer, we shouldn't
2224 // bother considering this channel. If retrying with recommended_value_msat may
2225 // allow us to hit the HTLC minimum limit, set htlc_minimum_limit so that we go
2226 // around again with a higher amount.
2227 if !contributes_sufficient_value {
2228 if should_log_candidate {
2229 log_trace!(logger, "Ignoring {} due to insufficient value contribution.", LoggedCandidateHop(&$candidate));
2231 if let Some(details) = first_hop_details {
2233 "First hop candidate next_outbound_htlc_limit_msat: {}",
2234 details.next_outbound_htlc_limit_msat,
2238 num_ignored_value_contribution += 1;
2239 } else if exceeds_max_path_length {
2240 if should_log_candidate {
2241 log_trace!(logger, "Ignoring {} due to exceeding maximum path length limit.", LoggedCandidateHop(&$candidate));
2243 num_ignored_path_length_limit += 1;
2244 } else if exceeds_cltv_delta_limit {
2245 if should_log_candidate {
2246 log_trace!(logger, "Ignoring {} due to exceeding CLTV delta limit.", LoggedCandidateHop(&$candidate));
2248 if let Some(_) = first_hop_details {
2250 "First hop candidate cltv_expiry_delta: {}. Limit: {}",
2251 hop_total_cltv_delta,
2252 max_total_cltv_expiry_delta,
2256 num_ignored_cltv_delta_limit += 1;
2257 } else if payment_failed_on_this_channel {
2258 if should_log_candidate {
2259 log_trace!(logger, "Ignoring {} due to a failed previous payment attempt.", LoggedCandidateHop(&$candidate));
2261 num_ignored_previously_failed += 1;
2262 } else if may_overpay_to_meet_path_minimum_msat {
2263 if should_log_candidate {
2265 "Ignoring {} to avoid overpaying to meet htlc_minimum_msat limit.",
2266 LoggedCandidateHop(&$candidate));
2268 if let Some(details) = first_hop_details {
2270 "First hop candidate next_outbound_htlc_minimum_msat: {}",
2271 details.next_outbound_htlc_minimum_msat,
2275 num_ignored_avoid_overpayment += 1;
2276 hit_minimum_limit = true;
2277 } else if over_path_minimum_msat {
2278 // Note that low contribution here (limited by available_liquidity_msat)
2279 // might violate htlc_minimum_msat on the hops which are next along the
2280 // payment path (upstream to the payee). To avoid that, we recompute
2281 // path fees knowing the final path contribution after constructing it.
2282 let curr_min = cmp::max(
2283 $next_hops_path_htlc_minimum_msat, $candidate.htlc_minimum_msat()
2285 let path_htlc_minimum_msat = compute_fees_saturating(curr_min, $candidate.fees())
2286 .saturating_add(curr_min);
2287 let hm_entry = dist.entry(src_node_id);
2288 let old_entry = hm_entry.or_insert_with(|| {
2289 // If there was previously no known way to access the source node
2290 // (recall it goes payee-to-payer) of short_channel_id, first add a
2291 // semi-dummy record just to compute the fees to reach the source node.
2292 // This will affect our decision on selecting short_channel_id
2293 // as a way to reach the $candidate.target() node.
2295 candidate: $candidate.clone(),
2297 next_hops_fee_msat: u64::max_value(),
2298 hop_use_fee_msat: u64::max_value(),
2299 total_fee_msat: u64::max_value(),
2300 path_htlc_minimum_msat,
2301 path_penalty_msat: u64::max_value(),
2302 was_processed: false,
2303 #[cfg(all(not(ldk_bench), any(test, fuzzing)))]
2304 value_contribution_msat,
2308 #[allow(unused_mut)] // We only use the mut in cfg(test)
2309 let mut should_process = !old_entry.was_processed;
2310 #[cfg(all(not(ldk_bench), any(test, fuzzing)))]
2312 // In test/fuzzing builds, we do extra checks to make sure the skipping
2313 // of already-seen nodes only happens in cases we expect (see below).
2314 if !should_process { should_process = true; }
2318 let mut hop_use_fee_msat = 0;
2319 let mut total_fee_msat: u64 = $next_hops_fee_msat;
2321 // Ignore hop_use_fee_msat for channel-from-us as we assume all channels-from-us
2322 // will have the same effective-fee
2323 if src_node_id != our_node_id {
2324 // Note that `u64::max_value` means we'll always fail the
2325 // `old_entry.total_fee_msat > total_fee_msat` check below
2326 hop_use_fee_msat = compute_fees_saturating(amount_to_transfer_over_msat, $candidate.fees());
2327 total_fee_msat = total_fee_msat.saturating_add(hop_use_fee_msat);
2330 // Ignore hops if augmenting the current path to them would put us over `max_total_routing_fee_msat`
2331 if total_fee_msat > max_total_routing_fee_msat {
2332 if should_log_candidate {
2333 log_trace!(logger, "Ignoring {} due to exceeding max total routing fee limit.", LoggedCandidateHop(&$candidate));
2335 if let Some(_) = first_hop_details {
2337 "First hop candidate routing fee: {}. Limit: {}",
2339 max_total_routing_fee_msat,
2343 num_ignored_total_fee_limit += 1;
2345 let channel_usage = ChannelUsage {
2346 amount_msat: amount_to_transfer_over_msat,
2347 inflight_htlc_msat: used_liquidity_msat,
2350 let channel_penalty_msat =
2351 scorer.channel_penalty_msat($candidate,
2354 let path_penalty_msat = $next_hops_path_penalty_msat
2355 .saturating_add(channel_penalty_msat);
2357 // Update the way of reaching $candidate.source()
2358 // with the given short_channel_id (from $candidate.target()),
2359 // if this way is cheaper than the already known
2360 // (considering the cost to "reach" this channel from the route destination,
2361 // the cost of using this channel,
2362 // and the cost of routing to the source node of this channel).
2363 // Also, consider that htlc_minimum_msat_difference, because we might end up
2364 // paying it. Consider the following exploit:
2365 // we use 2 paths to transfer 1.5 BTC. One of them is 0-fee normal 1 BTC path,
2366 // and for the other one we picked a 1sat-fee path with htlc_minimum_msat of
2367 // 1 BTC. Now, since the latter is more expensive, we gonna try to cut it
2368 // by 0.5 BTC, but then match htlc_minimum_msat by paying a fee of 0.5 BTC
2370 // Ideally the scoring could be smarter (e.g. 0.5*htlc_minimum_msat here),
2371 // but it may require additional tracking - we don't want to double-count
2372 // the fees included in $next_hops_path_htlc_minimum_msat, but also
2373 // can't use something that may decrease on future hops.
2374 let old_cost = cmp::max(old_entry.total_fee_msat, old_entry.path_htlc_minimum_msat)
2375 .saturating_add(old_entry.path_penalty_msat);
2376 let new_cost = cmp::max(total_fee_msat, path_htlc_minimum_msat)
2377 .saturating_add(path_penalty_msat);
2379 if !old_entry.was_processed && new_cost < old_cost {
2380 let new_graph_node = RouteGraphNode {
2381 node_id: src_node_id,
2382 score: cmp::max(total_fee_msat, path_htlc_minimum_msat).saturating_add(path_penalty_msat),
2383 total_cltv_delta: hop_total_cltv_delta,
2384 value_contribution_msat,
2385 path_length_to_node,
2387 targets.push(new_graph_node);
2388 old_entry.next_hops_fee_msat = $next_hops_fee_msat;
2389 old_entry.hop_use_fee_msat = hop_use_fee_msat;
2390 old_entry.total_fee_msat = total_fee_msat;
2391 old_entry.candidate = $candidate.clone();
2392 old_entry.fee_msat = 0; // This value will be later filled with hop_use_fee_msat of the following channel
2393 old_entry.path_htlc_minimum_msat = path_htlc_minimum_msat;
2394 old_entry.path_penalty_msat = path_penalty_msat;
2395 #[cfg(all(not(ldk_bench), any(test, fuzzing)))]
2397 old_entry.value_contribution_msat = value_contribution_msat;
2399 hop_contribution_amt_msat = Some(value_contribution_msat);
2400 } else if old_entry.was_processed && new_cost < old_cost {
2401 #[cfg(all(not(ldk_bench), any(test, fuzzing)))]
2403 // If we're skipping processing a node which was previously
2404 // processed even though we found another path to it with a
2405 // cheaper fee, check that it was because the second path we
2406 // found (which we are processing now) has a lower value
2407 // contribution due to an HTLC minimum limit.
2409 // e.g. take a graph with two paths from node 1 to node 2, one
2410 // through channel A, and one through channel B. Channel A and
2411 // B are both in the to-process heap, with their scores set by
2412 // a higher htlc_minimum than fee.
2413 // Channel A is processed first, and the channels onwards from
2414 // node 1 are added to the to-process heap. Thereafter, we pop
2415 // Channel B off of the heap, note that it has a much more
2416 // restrictive htlc_maximum_msat, and recalculate the fees for
2417 // all of node 1's channels using the new, reduced, amount.
2419 // This would be bogus - we'd be selecting a higher-fee path
2420 // with a lower htlc_maximum_msat instead of the one we'd
2421 // already decided to use.
2422 debug_assert!(path_htlc_minimum_msat < old_entry.path_htlc_minimum_msat);
2424 value_contribution_msat + path_penalty_msat <
2425 old_entry.value_contribution_msat + old_entry.path_penalty_msat
2432 if should_log_candidate {
2434 "Ignoring {} due to its htlc_minimum_msat limit.",
2435 LoggedCandidateHop(&$candidate));
2437 if let Some(details) = first_hop_details {
2439 "First hop candidate next_outbound_htlc_minimum_msat: {}",
2440 details.next_outbound_htlc_minimum_msat,
2444 num_ignored_htlc_minimum_msat_limit += 1;
2448 hop_contribution_amt_msat
2452 let default_node_features = default_node_features();
2454 // Find ways (channels with destination) to reach a given node and store them
2455 // in the corresponding data structures (routing graph etc).
2456 // $fee_to_target_msat represents how much it costs to reach to this node from the payee,
2457 // meaning how much will be paid in fees after this node (to the best of our knowledge).
2458 // This data can later be helpful to optimize routing (pay lower fees).
2459 macro_rules! add_entries_to_cheapest_to_target_node {
2460 ( $node: expr, $node_id: expr, $next_hops_value_contribution: expr,
2461 $next_hops_cltv_delta: expr, $next_hops_path_length: expr ) => {
2462 let fee_to_target_msat;
2463 let next_hops_path_htlc_minimum_msat;
2464 let next_hops_path_penalty_msat;
2465 let skip_node = if let Some(elem) = dist.get_mut(&$node_id) {
2466 let was_processed = elem.was_processed;
2467 elem.was_processed = true;
2468 fee_to_target_msat = elem.total_fee_msat;
2469 next_hops_path_htlc_minimum_msat = elem.path_htlc_minimum_msat;
2470 next_hops_path_penalty_msat = elem.path_penalty_msat;
2473 // Entries are added to dist in add_entry!() when there is a channel from a node.
2474 // Because there are no channels from payee, it will not have a dist entry at this point.
2475 // If we're processing any other node, it is always be the result of a channel from it.
2476 debug_assert_eq!($node_id, maybe_dummy_payee_node_id);
2477 fee_to_target_msat = 0;
2478 next_hops_path_htlc_minimum_msat = 0;
2479 next_hops_path_penalty_msat = 0;
2484 if let Some(first_channels) = first_hop_targets.get(&$node_id) {
2485 for details in first_channels {
2486 let candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
2487 details, payer_node_id: &our_node_id,
2489 add_entry!(&candidate, fee_to_target_msat,
2490 $next_hops_value_contribution,
2491 next_hops_path_htlc_minimum_msat, next_hops_path_penalty_msat,
2492 $next_hops_cltv_delta, $next_hops_path_length);
2496 let features = if let Some(node_info) = $node.announcement_info.as_ref() {
2499 &default_node_features
2502 if !features.requires_unknown_bits() {
2503 for chan_id in $node.channels.iter() {
2504 let chan = network_channels.get(chan_id).unwrap();
2505 if !chan.features.requires_unknown_bits() {
2506 if let Some((directed_channel, source)) = chan.as_directed_to(&$node_id) {
2507 if first_hops.is_none() || *source != our_node_id {
2508 if directed_channel.direction().enabled {
2509 let candidate = CandidateRouteHop::PublicHop(PublicHopCandidate {
2510 info: directed_channel,
2511 short_channel_id: *chan_id,
2513 add_entry!(&candidate,
2515 $next_hops_value_contribution,
2516 next_hops_path_htlc_minimum_msat,
2517 next_hops_path_penalty_msat,
2518 $next_hops_cltv_delta, $next_hops_path_length);
2529 let mut payment_paths = Vec::<PaymentPath>::new();
2531 // TODO: diversify by nodes (so that all paths aren't doomed if one node is offline).
2532 'paths_collection: loop {
2533 // For every new path, start from scratch, except for used_liquidities, which
2534 // helps to avoid reusing previously selected paths in future iterations.
2537 hit_minimum_limit = false;
2539 // If first hop is a private channel and the only way to reach the payee, this is the only
2540 // place where it could be added.
2541 payee_node_id_opt.map(|payee| first_hop_targets.get(&payee).map(|first_channels| {
2542 for details in first_channels {
2543 let candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
2544 details, payer_node_id: &our_node_id,
2546 let added = add_entry!(&candidate, 0, path_value_msat,
2547 0, 0u64, 0, 0).is_some();
2548 log_trace!(logger, "{} direct route to payee via {}",
2549 if added { "Added" } else { "Skipped" }, LoggedCandidateHop(&candidate));
2553 // Add the payee as a target, so that the payee-to-payer
2554 // search algorithm knows what to start with.
2555 payee_node_id_opt.map(|payee| match network_nodes.get(&payee) {
2556 // The payee is not in our network graph, so nothing to add here.
2557 // There is still a chance of reaching them via last_hops though,
2558 // so don't yet fail the payment here.
2559 // If not, targets.pop() will not even let us enter the loop in step 2.
2562 add_entries_to_cheapest_to_target_node!(node, payee, path_value_msat, 0, 0);
2567 // If a caller provided us with last hops, add them to routing targets. Since this happens
2568 // earlier than general path finding, they will be somewhat prioritized, although currently
2569 // it matters only if the fees are exactly the same.
2570 for (hint_idx, hint) in payment_params.payee.blinded_route_hints().iter().enumerate() {
2571 // Only add the hops in this route to our candidate set if either
2572 // we have a direct channel to the first hop or the first hop is
2573 // in the regular network graph.
2574 let source_node_id = match introduction_node_id_cache[hint_idx] {
2575 Some(node_id) => node_id,
2576 None => match &hint.1.introduction_node {
2577 IntroductionNode::NodeId(pubkey) => {
2578 let node_id = NodeId::from_pubkey(&pubkey);
2579 match first_hop_targets.get_key_value(&node_id).map(|(key, _)| key) {
2580 Some(node_id) => node_id,
2584 IntroductionNode::DirectedShortChannelId(direction, scid) => {
2585 let first_hop = first_hop_targets.iter().find(|(_, channels)|
2588 .any(|details| Some(*scid) == details.get_outbound_payment_scid())
2591 Some((counterparty_node_id, _)) => {
2592 direction.select_node_id(&our_node_id, counterparty_node_id)
2599 if our_node_id == *source_node_id { continue }
2600 let candidate = if hint.1.blinded_hops.len() == 1 {
2601 CandidateRouteHop::OneHopBlinded(
2602 OneHopBlindedPathCandidate { source_node_id, hint, hint_idx }
2605 CandidateRouteHop::Blinded(BlindedPathCandidate { source_node_id, hint, hint_idx })
2607 let mut path_contribution_msat = path_value_msat;
2608 if let Some(hop_used_msat) = add_entry!(&candidate,
2609 0, path_contribution_msat, 0, 0_u64, 0, 0)
2611 path_contribution_msat = hop_used_msat;
2613 if let Some(first_channels) = first_hop_targets.get(source_node_id) {
2614 let mut first_channels = first_channels.clone();
2615 sort_first_hop_channels(
2616 &mut first_channels, &used_liquidities, recommended_value_msat, our_node_pubkey
2618 for details in first_channels {
2619 let first_hop_candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
2620 details, payer_node_id: &our_node_id,
2622 let blinded_path_fee = match compute_fees(path_contribution_msat, candidate.fees()) {
2626 let path_min = candidate.htlc_minimum_msat().saturating_add(
2627 compute_fees_saturating(candidate.htlc_minimum_msat(), candidate.fees()));
2628 add_entry!(&first_hop_candidate, blinded_path_fee, path_contribution_msat, path_min,
2629 0_u64, candidate.cltv_expiry_delta(), 0);
2633 for route in payment_params.payee.unblinded_route_hints().iter()
2634 .filter(|route| !route.0.is_empty())
2636 let first_hop_src_id = NodeId::from_pubkey(&route.0.first().unwrap().src_node_id);
2637 let first_hop_src_is_reachable =
2638 // Only add the hops in this route to our candidate set if either we are part of
2639 // the first hop, we have a direct channel to the first hop, or the first hop is in
2640 // the regular network graph.
2641 our_node_id == first_hop_src_id ||
2642 first_hop_targets.get(&first_hop_src_id).is_some() ||
2643 network_nodes.get(&first_hop_src_id).is_some();
2644 if first_hop_src_is_reachable {
2645 // We start building the path from reverse, i.e., from payee
2646 // to the first RouteHintHop in the path.
2647 let hop_iter = route.0.iter().rev();
2648 let prev_hop_iter = core::iter::once(&maybe_dummy_payee_pk).chain(
2649 route.0.iter().skip(1).rev().map(|hop| &hop.src_node_id));
2650 let mut hop_used = true;
2651 let mut aggregate_next_hops_fee_msat: u64 = 0;
2652 let mut aggregate_next_hops_path_htlc_minimum_msat: u64 = 0;
2653 let mut aggregate_next_hops_path_penalty_msat: u64 = 0;
2654 let mut aggregate_next_hops_cltv_delta: u32 = 0;
2655 let mut aggregate_next_hops_path_length: u8 = 0;
2656 let mut aggregate_path_contribution_msat = path_value_msat;
2658 for (idx, (hop, prev_hop_id)) in hop_iter.zip(prev_hop_iter).enumerate() {
2659 let target = private_hop_key_cache.get(prev_hop_id).unwrap();
2661 if let Some(first_channels) = first_hop_targets.get(target) {
2662 if first_channels.iter().any(|d| d.outbound_scid_alias == Some(hop.short_channel_id)) {
2663 log_trace!(logger, "Ignoring route hint with SCID {} (and any previous) due to it being a direct channel of ours.",
2664 hop.short_channel_id);
2669 let candidate = network_channels
2670 .get(&hop.short_channel_id)
2671 .and_then(|channel| channel.as_directed_to(target))
2672 .map(|(info, _)| CandidateRouteHop::PublicHop(PublicHopCandidate {
2674 short_channel_id: hop.short_channel_id,
2676 .unwrap_or_else(|| CandidateRouteHop::PrivateHop(PrivateHopCandidate { hint: hop, target_node_id: target }));
2678 if let Some(hop_used_msat) = add_entry!(&candidate,
2679 aggregate_next_hops_fee_msat, aggregate_path_contribution_msat,
2680 aggregate_next_hops_path_htlc_minimum_msat, aggregate_next_hops_path_penalty_msat,
2681 aggregate_next_hops_cltv_delta, aggregate_next_hops_path_length)
2683 aggregate_path_contribution_msat = hop_used_msat;
2685 // If this hop was not used then there is no use checking the preceding
2686 // hops in the RouteHint. We can break by just searching for a direct
2687 // channel between last checked hop and first_hop_targets.
2691 let used_liquidity_msat = used_liquidities
2692 .get(&candidate.id()).copied()
2694 let channel_usage = ChannelUsage {
2695 amount_msat: final_value_msat + aggregate_next_hops_fee_msat,
2696 inflight_htlc_msat: used_liquidity_msat,
2697 effective_capacity: candidate.effective_capacity(),
2699 let channel_penalty_msat = scorer.channel_penalty_msat(
2700 &candidate, channel_usage, score_params
2702 aggregate_next_hops_path_penalty_msat = aggregate_next_hops_path_penalty_msat
2703 .saturating_add(channel_penalty_msat);
2705 aggregate_next_hops_cltv_delta = aggregate_next_hops_cltv_delta
2706 .saturating_add(hop.cltv_expiry_delta as u32);
2708 aggregate_next_hops_path_length = aggregate_next_hops_path_length
2711 // Searching for a direct channel between last checked hop and first_hop_targets
2712 if let Some(first_channels) = first_hop_targets.get(target) {
2713 let mut first_channels = first_channels.clone();
2714 sort_first_hop_channels(
2715 &mut first_channels, &used_liquidities, recommended_value_msat, our_node_pubkey
2717 for details in first_channels {
2718 let first_hop_candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
2719 details, payer_node_id: &our_node_id,
2721 add_entry!(&first_hop_candidate,
2722 aggregate_next_hops_fee_msat, aggregate_path_contribution_msat,
2723 aggregate_next_hops_path_htlc_minimum_msat, aggregate_next_hops_path_penalty_msat,
2724 aggregate_next_hops_cltv_delta, aggregate_next_hops_path_length);
2732 // In the next values of the iterator, the aggregate fees already reflects
2733 // the sum of value sent from payer (final_value_msat) and routing fees
2734 // for the last node in the RouteHint. We need to just add the fees to
2735 // route through the current node so that the preceding node (next iteration)
2737 let hops_fee = compute_fees(aggregate_next_hops_fee_msat + final_value_msat, hop.fees)
2738 .map_or(None, |inc| inc.checked_add(aggregate_next_hops_fee_msat));
2739 aggregate_next_hops_fee_msat = if let Some(val) = hops_fee { val } else { break; };
2741 // The next channel will need to relay this channel's min_htlc *plus* the fees taken by
2742 // this route hint's source node to forward said min over this channel.
2743 aggregate_next_hops_path_htlc_minimum_msat = {
2744 let curr_htlc_min = cmp::max(
2745 candidate.htlc_minimum_msat(), aggregate_next_hops_path_htlc_minimum_msat
2747 let curr_htlc_min_fee = if let Some(val) = compute_fees(curr_htlc_min, hop.fees) { val } else { break };
2748 if let Some(min) = curr_htlc_min.checked_add(curr_htlc_min_fee) { min } else { break }
2751 if idx == route.0.len() - 1 {
2752 // The last hop in this iterator is the first hop in
2753 // overall RouteHint.
2754 // If this hop connects to a node with which we have a direct channel,
2755 // ignore the network graph and, if the last hop was added, add our
2756 // direct channel to the candidate set.
2758 // Note that we *must* check if the last hop was added as `add_entry`
2759 // always assumes that the third argument is a node to which we have a
2761 if let Some(first_channels) = first_hop_targets.get(&NodeId::from_pubkey(&hop.src_node_id)) {
2762 let mut first_channels = first_channels.clone();
2763 sort_first_hop_channels(
2764 &mut first_channels, &used_liquidities, recommended_value_msat, our_node_pubkey
2766 for details in first_channels {
2767 let first_hop_candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
2768 details, payer_node_id: &our_node_id,
2770 add_entry!(&first_hop_candidate,
2771 aggregate_next_hops_fee_msat,
2772 aggregate_path_contribution_msat,
2773 aggregate_next_hops_path_htlc_minimum_msat,
2774 aggregate_next_hops_path_penalty_msat,
2775 aggregate_next_hops_cltv_delta,
2776 aggregate_next_hops_path_length);
2784 log_trace!(logger, "Starting main path collection loop with {} nodes pre-filled from first/last hops.", targets.len());
2786 // At this point, targets are filled with the data from first and
2787 // last hops communicated by the caller, and the payment receiver.
2788 let mut found_new_path = false;
2791 // If this loop terminates due the exhaustion of targets, two situations are possible:
2792 // - not enough outgoing liquidity:
2793 // 0 < already_collected_value_msat < final_value_msat
2794 // - enough outgoing liquidity:
2795 // final_value_msat <= already_collected_value_msat < recommended_value_msat
2796 // Both these cases (and other cases except reaching recommended_value_msat) mean that
2797 // paths_collection will be stopped because found_new_path==false.
2798 // This is not necessarily a routing failure.
2799 'path_construction: while let Some(RouteGraphNode { node_id, total_cltv_delta, mut value_contribution_msat, path_length_to_node, .. }) = targets.pop() {
2801 // Since we're going payee-to-payer, hitting our node as a target means we should stop
2802 // traversing the graph and arrange the path out of what we found.
2803 if node_id == our_node_id {
2804 let mut new_entry = dist.remove(&our_node_id).unwrap();
2805 let mut ordered_hops: Vec<(PathBuildingHop, NodeFeatures)> = vec!((new_entry.clone(), default_node_features.clone()));
2808 let mut features_set = false;
2809 let target = ordered_hops.last().unwrap().0.candidate.target().unwrap_or(maybe_dummy_payee_node_id);
2810 if let Some(first_channels) = first_hop_targets.get(&target) {
2811 for details in first_channels {
2812 if let CandidateRouteHop::FirstHop(FirstHopCandidate { details: last_hop_details, .. })
2813 = ordered_hops.last().unwrap().0.candidate
2815 if details.get_outbound_payment_scid() == last_hop_details.get_outbound_payment_scid() {
2816 ordered_hops.last_mut().unwrap().1 = details.counterparty.features.to_context();
2817 features_set = true;
2824 if let Some(node) = network_nodes.get(&target) {
2825 if let Some(node_info) = node.announcement_info.as_ref() {
2826 ordered_hops.last_mut().unwrap().1 = node_info.features.clone();
2828 ordered_hops.last_mut().unwrap().1 = default_node_features.clone();
2831 // We can fill in features for everything except hops which were
2832 // provided via the invoice we're paying. We could guess based on the
2833 // recipient's features but for now we simply avoid guessing at all.
2837 // Means we successfully traversed from the payer to the payee, now
2838 // save this path for the payment route. Also, update the liquidity
2839 // remaining on the used hops, so that we take them into account
2840 // while looking for more paths.
2841 if target == maybe_dummy_payee_node_id {
2845 new_entry = match dist.remove(&target) {
2846 Some(payment_hop) => payment_hop,
2847 // We can't arrive at None because, if we ever add an entry to targets,
2848 // we also fill in the entry in dist (see add_entry!).
2849 None => unreachable!(),
2851 // We "propagate" the fees one hop backward (topologically) here,
2852 // so that fees paid for a HTLC forwarding on the current channel are
2853 // associated with the previous channel (where they will be subtracted).
2854 ordered_hops.last_mut().unwrap().0.fee_msat = new_entry.hop_use_fee_msat;
2855 ordered_hops.push((new_entry.clone(), default_node_features.clone()));
2857 ordered_hops.last_mut().unwrap().0.fee_msat = value_contribution_msat;
2858 ordered_hops.last_mut().unwrap().0.hop_use_fee_msat = 0;
2860 log_trace!(logger, "Found a path back to us from the target with {} hops contributing up to {} msat: \n {:#?}",
2861 ordered_hops.len(), value_contribution_msat, ordered_hops.iter().map(|h| &(h.0)).collect::<Vec<&PathBuildingHop>>());
2863 let mut payment_path = PaymentPath {hops: ordered_hops};
2865 // We could have possibly constructed a slightly inconsistent path: since we reduce
2866 // value being transferred along the way, we could have violated htlc_minimum_msat
2867 // on some channels we already passed (assuming dest->source direction). Here, we
2868 // recompute the fees again, so that if that's the case, we match the currently
2869 // underpaid htlc_minimum_msat with fees.
2870 debug_assert_eq!(payment_path.get_value_msat(), value_contribution_msat);
2871 let desired_value_contribution = cmp::min(value_contribution_msat, final_value_msat);
2872 value_contribution_msat = payment_path.update_value_and_recompute_fees(desired_value_contribution);
2874 // Since a path allows to transfer as much value as
2875 // the smallest channel it has ("bottleneck"), we should recompute
2876 // the fees so sender HTLC don't overpay fees when traversing
2877 // larger channels than the bottleneck. This may happen because
2878 // when we were selecting those channels we were not aware how much value
2879 // this path will transfer, and the relative fee for them
2880 // might have been computed considering a larger value.
2881 // Remember that we used these channels so that we don't rely
2882 // on the same liquidity in future paths.
2883 let mut prevented_redundant_path_selection = false;
2884 for (hop, _) in payment_path.hops.iter() {
2885 let spent_on_hop_msat = value_contribution_msat + hop.next_hops_fee_msat;
2886 let used_liquidity_msat = used_liquidities
2887 .entry(hop.candidate.id())
2888 .and_modify(|used_liquidity_msat| *used_liquidity_msat += spent_on_hop_msat)
2889 .or_insert(spent_on_hop_msat);
2890 let hop_capacity = hop.candidate.effective_capacity();
2891 let hop_max_msat = max_htlc_from_capacity(hop_capacity, channel_saturation_pow_half);
2892 if *used_liquidity_msat == hop_max_msat {
2893 // If this path used all of this channel's available liquidity, we know
2894 // this path will not be selected again in the next loop iteration.
2895 prevented_redundant_path_selection = true;
2897 debug_assert!(*used_liquidity_msat <= hop_max_msat);
2899 if !prevented_redundant_path_selection {
2900 // If we weren't capped by hitting a liquidity limit on a channel in the path,
2901 // we'll probably end up picking the same path again on the next iteration.
2902 // Decrease the available liquidity of a hop in the middle of the path.
2903 let victim_candidate = &payment_path.hops[(payment_path.hops.len()) / 2].0.candidate;
2904 let exhausted = u64::max_value();
2906 "Disabling route candidate {} for future path building iterations to avoid duplicates.",
2907 LoggedCandidateHop(victim_candidate));
2908 if let Some(scid) = victim_candidate.short_channel_id() {
2909 *used_liquidities.entry(CandidateHopId::Clear((scid, false))).or_default() = exhausted;
2910 *used_liquidities.entry(CandidateHopId::Clear((scid, true))).or_default() = exhausted;
2914 // Track the total amount all our collected paths allow to send so that we know
2915 // when to stop looking for more paths
2916 already_collected_value_msat += value_contribution_msat;
2918 payment_paths.push(payment_path);
2919 found_new_path = true;
2920 break 'path_construction;
2923 // If we found a path back to the payee, we shouldn't try to process it again. This is
2924 // the equivalent of the `elem.was_processed` check in
2925 // add_entries_to_cheapest_to_target_node!() (see comment there for more info).
2926 if node_id == maybe_dummy_payee_node_id { continue 'path_construction; }
2928 // Otherwise, since the current target node is not us,
2929 // keep "unrolling" the payment graph from payee to payer by
2930 // finding a way to reach the current target from the payer side.
2931 match network_nodes.get(&node_id) {
2934 add_entries_to_cheapest_to_target_node!(node, node_id,
2935 value_contribution_msat,
2936 total_cltv_delta, path_length_to_node);
2942 if !found_new_path && channel_saturation_pow_half != 0 {
2943 channel_saturation_pow_half = 0;
2944 continue 'paths_collection;
2946 // If we don't support MPP, no use trying to gather more value ever.
2947 break 'paths_collection;
2951 // Stop either when the recommended value is reached or if no new path was found in this
2953 // In the latter case, making another path finding attempt won't help,
2954 // because we deterministically terminated the search due to low liquidity.
2955 if !found_new_path && channel_saturation_pow_half != 0 {
2956 channel_saturation_pow_half = 0;
2957 } else if !found_new_path && hit_minimum_limit && already_collected_value_msat < final_value_msat && path_value_msat != recommended_value_msat {
2958 log_trace!(logger, "Failed to collect enough value, but running again to collect extra paths with a potentially higher limit.");
2959 path_value_msat = recommended_value_msat;
2960 } else if already_collected_value_msat >= recommended_value_msat || !found_new_path {
2961 log_trace!(logger, "Have now collected {} msat (seeking {} msat) in paths. Last path loop {} a new path.",
2962 already_collected_value_msat, recommended_value_msat, if found_new_path { "found" } else { "did not find" });
2963 break 'paths_collection;
2964 } else if found_new_path && already_collected_value_msat == final_value_msat && payment_paths.len() == 1 {
2965 // Further, if this was our first walk of the graph, and we weren't limited by an
2966 // htlc_minimum_msat, return immediately because this path should suffice. If we were
2967 // limited by an htlc_minimum_msat value, find another path with a higher value,
2968 // potentially allowing us to pay fees to meet the htlc_minimum on the new path while
2969 // still keeping a lower total fee than this path.
2970 if !hit_minimum_limit {
2971 log_trace!(logger, "Collected exactly our payment amount on the first pass, without hitting an htlc_minimum_msat limit, exiting.");
2972 break 'paths_collection;
2974 log_trace!(logger, "Collected our payment amount on the first pass, but running again to collect extra paths with a potentially higher value to meet htlc_minimum_msat limit.");
2975 path_value_msat = recommended_value_msat;
2979 let num_ignored_total = num_ignored_value_contribution + num_ignored_path_length_limit +
2980 num_ignored_cltv_delta_limit + num_ignored_previously_failed +
2981 num_ignored_avoid_overpayment + num_ignored_htlc_minimum_msat_limit +
2982 num_ignored_total_fee_limit;
2983 if num_ignored_total > 0 {
2985 "Ignored {} candidate hops due to insufficient value contribution, {} due to path length limit, {} due to CLTV delta limit, {} due to previous payment failure, {} due to htlc_minimum_msat limit, {} to avoid overpaying, {} due to maximum total fee limit. Total: {} ignored candidates.",
2986 num_ignored_value_contribution, num_ignored_path_length_limit,
2987 num_ignored_cltv_delta_limit, num_ignored_previously_failed,
2988 num_ignored_htlc_minimum_msat_limit, num_ignored_avoid_overpayment,
2989 num_ignored_total_fee_limit, num_ignored_total);
2993 if payment_paths.len() == 0 {
2994 return Err(LightningError{err: "Failed to find a path to the given destination".to_owned(), action: ErrorAction::IgnoreError});
2997 if already_collected_value_msat < final_value_msat {
2998 return Err(LightningError{err: "Failed to find a sufficient route to the given destination".to_owned(), action: ErrorAction::IgnoreError});
3002 let mut selected_route = payment_paths;
3004 debug_assert_eq!(selected_route.iter().map(|p| p.get_value_msat()).sum::<u64>(), already_collected_value_msat);
3005 let mut overpaid_value_msat = already_collected_value_msat - final_value_msat;
3007 // First, sort by the cost-per-value of the path, dropping the paths that cost the most for
3008 // the value they contribute towards the payment amount.
3009 // We sort in descending order as we will remove from the front in `retain`, next.
3010 selected_route.sort_unstable_by(|a, b|
3011 (((b.get_cost_msat() as u128) << 64) / (b.get_value_msat() as u128))
3012 .cmp(&(((a.get_cost_msat() as u128) << 64) / (a.get_value_msat() as u128)))
3015 // We should make sure that at least 1 path left.
3016 let mut paths_left = selected_route.len();
3017 selected_route.retain(|path| {
3018 if paths_left == 1 {
3021 let path_value_msat = path.get_value_msat();
3022 if path_value_msat <= overpaid_value_msat {
3023 overpaid_value_msat -= path_value_msat;
3029 debug_assert!(selected_route.len() > 0);
3031 if overpaid_value_msat != 0 {
3033 // Now, subtract the remaining overpaid value from the most-expensive path.
3034 // TODO: this could also be optimized by also sorting by feerate_per_sat_routed,
3035 // so that the sender pays less fees overall. And also htlc_minimum_msat.
3036 selected_route.sort_unstable_by(|a, b| {
3037 let a_f = a.hops.iter().map(|hop| hop.0.candidate.fees().proportional_millionths as u64).sum::<u64>();
3038 let b_f = b.hops.iter().map(|hop| hop.0.candidate.fees().proportional_millionths as u64).sum::<u64>();
3039 a_f.cmp(&b_f).then_with(|| b.get_cost_msat().cmp(&a.get_cost_msat()))
3041 let expensive_payment_path = selected_route.first_mut().unwrap();
3043 // We already dropped all the paths with value below `overpaid_value_msat` above, thus this
3044 // can't go negative.
3045 let expensive_path_new_value_msat = expensive_payment_path.get_value_msat() - overpaid_value_msat;
3046 expensive_payment_path.update_value_and_recompute_fees(expensive_path_new_value_msat);
3050 // Sort by the path itself and combine redundant paths.
3051 // Note that we sort by SCIDs alone as its simpler but when combining we have to ensure we
3052 // compare both SCIDs and NodeIds as individual nodes may use random aliases causing collisions
3054 selected_route.sort_unstable_by_key(|path| {
3055 let mut key = [CandidateHopId::Clear((42, true)) ; MAX_PATH_LENGTH_ESTIMATE as usize];
3056 debug_assert!(path.hops.len() <= key.len());
3057 for (scid, key) in path.hops.iter() .map(|h| h.0.candidate.id()).zip(key.iter_mut()) {
3062 for idx in 0..(selected_route.len() - 1) {
3063 if idx + 1 >= selected_route.len() { break; }
3064 if iter_equal(selected_route[idx ].hops.iter().map(|h| (h.0.candidate.id(), h.0.candidate.target())),
3065 selected_route[idx + 1].hops.iter().map(|h| (h.0.candidate.id(), h.0.candidate.target()))) {
3066 let new_value = selected_route[idx].get_value_msat() + selected_route[idx + 1].get_value_msat();
3067 selected_route[idx].update_value_and_recompute_fees(new_value);
3068 selected_route.remove(idx + 1);
3072 let mut paths = Vec::new();
3073 for payment_path in selected_route {
3074 let mut hops = Vec::with_capacity(payment_path.hops.len());
3075 for (hop, node_features) in payment_path.hops.iter()
3076 .filter(|(h, _)| h.candidate.short_channel_id().is_some())
3078 let target = hop.candidate.target().expect("target is defined when short_channel_id is defined");
3079 let maybe_announced_channel = if let CandidateRouteHop::PublicHop(_) = hop.candidate {
3080 // If we sourced the hop from the graph we're sure the target node is announced.
3082 } else if let CandidateRouteHop::FirstHop(first_hop) = &hop.candidate {
3083 // If this is a first hop we also know if it's announced.
3084 first_hop.details.is_public
3086 // If we sourced it any other way, we double-check the network graph to see if
3087 // there are announced channels between the endpoints. If so, the hop might be
3088 // referring to any of the announced channels, as its `short_channel_id` might be
3089 // an alias, in which case we don't take any chances here.
3090 network_graph.node(&target).map_or(false, |hop_node|
3091 hop_node.channels.iter().any(|scid| network_graph.channel(*scid)
3092 .map_or(false, |c| c.as_directed_from(&hop.candidate.source()).is_some()))
3096 hops.push(RouteHop {
3097 pubkey: PublicKey::from_slice(target.as_slice()).map_err(|_| LightningError{err: format!("Public key {:?} is invalid", &target), action: ErrorAction::IgnoreAndLog(Level::Trace)})?,
3098 node_features: node_features.clone(),
3099 short_channel_id: hop.candidate.short_channel_id().unwrap(),
3100 channel_features: hop.candidate.features(),
3101 fee_msat: hop.fee_msat,
3102 cltv_expiry_delta: hop.candidate.cltv_expiry_delta(),
3103 maybe_announced_channel,
3106 let mut final_cltv_delta = final_cltv_expiry_delta;
3107 let blinded_tail = payment_path.hops.last().and_then(|(h, _)| {
3108 if let Some(blinded_path) = h.candidate.blinded_path() {
3109 final_cltv_delta = h.candidate.cltv_expiry_delta();
3111 hops: blinded_path.blinded_hops.clone(),
3112 blinding_point: blinded_path.blinding_point,
3113 excess_final_cltv_expiry_delta: 0,
3114 final_value_msat: h.fee_msat,
3118 // Propagate the cltv_expiry_delta one hop backwards since the delta from the current hop is
3119 // applicable for the previous hop.
3120 hops.iter_mut().rev().fold(final_cltv_delta, |prev_cltv_expiry_delta, hop| {
3121 core::mem::replace(&mut hop.cltv_expiry_delta, prev_cltv_expiry_delta)
3124 paths.push(Path { hops, blinded_tail });
3126 // Make sure we would never create a route with more paths than we allow.
3127 debug_assert!(paths.len() <= payment_params.max_path_count.into());
3129 if let Some(node_features) = payment_params.payee.node_features() {
3130 for path in paths.iter_mut() {
3131 path.hops.last_mut().unwrap().node_features = node_features.clone();
3135 let route = Route { paths, route_params: Some(route_params.clone()) };
3137 // Make sure we would never create a route whose total fees exceed max_total_routing_fee_msat.
3138 if let Some(max_total_routing_fee_msat) = route_params.max_total_routing_fee_msat {
3139 if route.get_total_fees() > max_total_routing_fee_msat {
3140 return Err(LightningError{err: format!("Failed to find route that adheres to the maximum total fee limit of {}msat",
3141 max_total_routing_fee_msat), action: ErrorAction::IgnoreError});
3145 log_info!(logger, "Got route: {}", log_route!(route));
3149 // When an adversarial intermediary node observes a payment, it may be able to infer its
3150 // destination, if the remaining CLTV expiry delta exactly matches a feasible path in the network
3151 // graph. In order to improve privacy, this method obfuscates the CLTV expiry deltas along the
3152 // payment path by adding a randomized 'shadow route' offset to the final hop.
3153 fn add_random_cltv_offset(route: &mut Route, payment_params: &PaymentParameters,
3154 network_graph: &ReadOnlyNetworkGraph, random_seed_bytes: &[u8; 32]
3156 let network_channels = network_graph.channels();
3157 let network_nodes = network_graph.nodes();
3159 for path in route.paths.iter_mut() {
3160 let mut shadow_ctlv_expiry_delta_offset: u32 = 0;
3162 // Remember the last three nodes of the random walk and avoid looping back on them.
3163 // Init with the last three nodes from the actual path, if possible.
3164 let mut nodes_to_avoid: [NodeId; 3] = [NodeId::from_pubkey(&path.hops.last().unwrap().pubkey),
3165 NodeId::from_pubkey(&path.hops.get(path.hops.len().saturating_sub(2)).unwrap().pubkey),
3166 NodeId::from_pubkey(&path.hops.get(path.hops.len().saturating_sub(3)).unwrap().pubkey)];
3168 // Choose the last publicly known node as the starting point for the random walk.
3169 let mut cur_hop: Option<NodeId> = None;
3170 let mut path_nonce = [0u8; 12];
3171 if let Some(starting_hop) = path.hops.iter().rev()
3172 .find(|h| network_nodes.contains_key(&NodeId::from_pubkey(&h.pubkey))) {
3173 cur_hop = Some(NodeId::from_pubkey(&starting_hop.pubkey));
3174 path_nonce.copy_from_slice(&cur_hop.unwrap().as_slice()[..12]);
3177 // Init PRNG with the path-dependant nonce, which is static for private paths.
3178 let mut prng = ChaCha20::new(random_seed_bytes, &path_nonce);
3179 let mut random_path_bytes = [0u8; ::core::mem::size_of::<usize>()];
3181 // Pick a random path length in [1 .. 3]
3182 prng.process_in_place(&mut random_path_bytes);
3183 let random_walk_length = usize::from_be_bytes(random_path_bytes).wrapping_rem(3).wrapping_add(1);
3185 for random_hop in 0..random_walk_length {
3186 // If we don't find a suitable offset in the public network graph, we default to
3187 // MEDIAN_HOP_CLTV_EXPIRY_DELTA.
3188 let mut random_hop_offset = MEDIAN_HOP_CLTV_EXPIRY_DELTA;
3190 if let Some(cur_node_id) = cur_hop {
3191 if let Some(cur_node) = network_nodes.get(&cur_node_id) {
3192 // Randomly choose the next unvisited hop.
3193 prng.process_in_place(&mut random_path_bytes);
3194 if let Some(random_channel) = usize::from_be_bytes(random_path_bytes)
3195 .checked_rem(cur_node.channels.len())
3196 .and_then(|index| cur_node.channels.get(index))
3197 .and_then(|id| network_channels.get(id)) {
3198 random_channel.as_directed_from(&cur_node_id).map(|(dir_info, next_id)| {
3199 if !nodes_to_avoid.iter().any(|x| x == next_id) {
3200 nodes_to_avoid[random_hop] = *next_id;
3201 random_hop_offset = dir_info.direction().cltv_expiry_delta.into();
3202 cur_hop = Some(*next_id);
3209 shadow_ctlv_expiry_delta_offset = shadow_ctlv_expiry_delta_offset
3210 .checked_add(random_hop_offset)
3211 .unwrap_or(shadow_ctlv_expiry_delta_offset);
3214 // Limit the total offset to reduce the worst-case locked liquidity timevalue
3215 const MAX_SHADOW_CLTV_EXPIRY_DELTA_OFFSET: u32 = 3*144;
3216 shadow_ctlv_expiry_delta_offset = cmp::min(shadow_ctlv_expiry_delta_offset, MAX_SHADOW_CLTV_EXPIRY_DELTA_OFFSET);
3218 // Limit the offset so we never exceed the max_total_cltv_expiry_delta. To improve plausibility,
3219 // we choose the limit to be the largest possible multiple of MEDIAN_HOP_CLTV_EXPIRY_DELTA.
3220 let path_total_cltv_expiry_delta: u32 = path.hops.iter().map(|h| h.cltv_expiry_delta).sum();
3221 let mut max_path_offset = payment_params.max_total_cltv_expiry_delta - path_total_cltv_expiry_delta;
3222 max_path_offset = cmp::max(
3223 max_path_offset - (max_path_offset % MEDIAN_HOP_CLTV_EXPIRY_DELTA),
3224 max_path_offset % MEDIAN_HOP_CLTV_EXPIRY_DELTA);
3225 shadow_ctlv_expiry_delta_offset = cmp::min(shadow_ctlv_expiry_delta_offset, max_path_offset);
3227 // Add 'shadow' CLTV offset to the final hop
3228 if let Some(tail) = path.blinded_tail.as_mut() {
3229 tail.excess_final_cltv_expiry_delta = tail.excess_final_cltv_expiry_delta
3230 .checked_add(shadow_ctlv_expiry_delta_offset).unwrap_or(tail.excess_final_cltv_expiry_delta);
3232 if let Some(last_hop) = path.hops.last_mut() {
3233 last_hop.cltv_expiry_delta = last_hop.cltv_expiry_delta
3234 .checked_add(shadow_ctlv_expiry_delta_offset).unwrap_or(last_hop.cltv_expiry_delta);
3239 /// Construct a route from us (payer) to the target node (payee) via the given hops (which should
3240 /// exclude the payer, but include the payee). This may be useful, e.g., for probing the chosen path.
3242 /// Re-uses logic from `find_route`, so the restrictions described there also apply here.
3243 pub fn build_route_from_hops<L: Deref, GL: Deref>(
3244 our_node_pubkey: &PublicKey, hops: &[PublicKey], route_params: &RouteParameters,
3245 network_graph: &NetworkGraph<GL>, logger: L, random_seed_bytes: &[u8; 32]
3246 ) -> Result<Route, LightningError>
3247 where L::Target: Logger, GL::Target: Logger {
3248 let graph_lock = network_graph.read_only();
3249 let mut route = build_route_from_hops_internal(our_node_pubkey, hops, &route_params,
3250 &graph_lock, logger, random_seed_bytes)?;
3251 add_random_cltv_offset(&mut route, &route_params.payment_params, &graph_lock, random_seed_bytes);
3255 fn build_route_from_hops_internal<L: Deref>(
3256 our_node_pubkey: &PublicKey, hops: &[PublicKey], route_params: &RouteParameters,
3257 network_graph: &ReadOnlyNetworkGraph, logger: L, random_seed_bytes: &[u8; 32],
3258 ) -> Result<Route, LightningError> where L::Target: Logger {
3261 our_node_id: NodeId,
3262 hop_ids: [Option<NodeId>; MAX_PATH_LENGTH_ESTIMATE as usize],
3265 impl ScoreLookUp for HopScorer {
3266 type ScoreParams = ();
3267 fn channel_penalty_msat(&self, candidate: &CandidateRouteHop,
3268 _usage: ChannelUsage, _score_params: &Self::ScoreParams) -> u64
3270 let mut cur_id = self.our_node_id;
3271 for i in 0..self.hop_ids.len() {
3272 if let Some(next_id) = self.hop_ids[i] {
3273 if cur_id == candidate.source() && Some(next_id) == candidate.target() {
3285 impl<'a> Writeable for HopScorer {
3287 fn write<W: Writer>(&self, _w: &mut W) -> Result<(), io::Error> {
3292 if hops.len() > MAX_PATH_LENGTH_ESTIMATE.into() {
3293 return Err(LightningError{err: "Cannot build a route exceeding the maximum path length.".to_owned(), action: ErrorAction::IgnoreError});
3296 let our_node_id = NodeId::from_pubkey(our_node_pubkey);
3297 let mut hop_ids = [None; MAX_PATH_LENGTH_ESTIMATE as usize];
3298 for i in 0..hops.len() {
3299 hop_ids[i] = Some(NodeId::from_pubkey(&hops[i]));
3302 let scorer = HopScorer { our_node_id, hop_ids };
3304 get_route(our_node_pubkey, route_params, network_graph, None, logger, &scorer, &Default::default(), random_seed_bytes)
3309 use crate::blinded_path::{BlindedHop, BlindedPath, IntroductionNode};
3310 use crate::routing::gossip::{NetworkGraph, P2PGossipSync, NodeId, EffectiveCapacity};
3311 use crate::routing::utxo::UtxoResult;
3312 use crate::routing::router::{get_route, build_route_from_hops_internal, add_random_cltv_offset, default_node_features,
3313 BlindedTail, InFlightHtlcs, Path, PaymentParameters, Route, RouteHint, RouteHintHop, RouteHop, RoutingFees,
3314 DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA, MAX_PATH_LENGTH_ESTIMATE, RouteParameters, CandidateRouteHop, PublicHopCandidate};
3315 use crate::routing::scoring::{ChannelUsage, FixedPenaltyScorer, ScoreLookUp, ProbabilisticScorer, ProbabilisticScoringFeeParameters, ProbabilisticScoringDecayParameters};
3316 use crate::routing::test_utils::{add_channel, add_or_update_node, build_graph, build_line_graph, id_to_feature_flags, get_nodes, update_channel};
3317 use crate::chain::transaction::OutPoint;
3318 use crate::sign::EntropySource;
3319 use crate::ln::types::ChannelId;
3320 use crate::ln::features::{BlindedHopFeatures, ChannelFeatures, InitFeatures, NodeFeatures};
3321 use crate::ln::msgs::{ErrorAction, LightningError, UnsignedChannelUpdate, MAX_VALUE_MSAT};
3322 use crate::ln::channelmanager;
3323 use crate::offers::invoice::BlindedPayInfo;
3324 use crate::util::config::UserConfig;
3325 use crate::util::test_utils as ln_test_utils;
3326 use crate::crypto::chacha20::ChaCha20;
3327 use crate::util::ser::{Readable, Writeable};
3329 use crate::util::ser::Writer;
3331 use bitcoin::hashes::Hash;
3332 use bitcoin::network::constants::Network;
3333 use bitcoin::blockdata::constants::ChainHash;
3334 use bitcoin::blockdata::script::Builder;
3335 use bitcoin::blockdata::opcodes;
3336 use bitcoin::blockdata::transaction::TxOut;
3337 use bitcoin::hashes::hex::FromHex;
3338 use bitcoin::secp256k1::{PublicKey,SecretKey};
3339 use bitcoin::secp256k1::Secp256k1;
3341 use crate::io::Cursor;
3342 use crate::prelude::*;
3343 use crate::sync::Arc;
3345 fn get_channel_details(short_channel_id: Option<u64>, node_id: PublicKey,
3346 features: InitFeatures, outbound_capacity_msat: u64) -> channelmanager::ChannelDetails {
3347 channelmanager::ChannelDetails {
3348 channel_id: ChannelId::new_zero(),
3349 counterparty: channelmanager::ChannelCounterparty {
3352 unspendable_punishment_reserve: 0,
3353 forwarding_info: None,
3354 outbound_htlc_minimum_msat: None,
3355 outbound_htlc_maximum_msat: None,
3357 funding_txo: Some(OutPoint { txid: bitcoin::Txid::from_slice(&[0; 32]).unwrap(), index: 0 }),
3360 outbound_scid_alias: None,
3361 inbound_scid_alias: None,
3362 channel_value_satoshis: 0,
3365 outbound_capacity_msat,
3366 next_outbound_htlc_limit_msat: outbound_capacity_msat,
3367 next_outbound_htlc_minimum_msat: 0,
3368 inbound_capacity_msat: 42,
3369 unspendable_punishment_reserve: None,
3370 confirmations_required: None,
3371 confirmations: None,
3372 force_close_spend_delay: None,
3373 is_outbound: true, is_channel_ready: true,
3374 is_usable: true, is_public: true,
3375 inbound_htlc_minimum_msat: None,
3376 inbound_htlc_maximum_msat: None,
3378 feerate_sat_per_1000_weight: None,
3379 channel_shutdown_state: Some(channelmanager::ChannelShutdownState::NotShuttingDown),
3380 pending_inbound_htlcs: Vec::new(),
3381 pending_outbound_htlcs: Vec::new(),
3386 fn simple_route_test() {
3387 let (secp_ctx, network_graph, _, _, logger) = build_graph();
3388 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
3389 let mut payment_params = PaymentParameters::from_node_id(nodes[2], 42);
3390 let scorer = ln_test_utils::TestScorer::new();
3391 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3392 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3394 // Simple route to 2 via 1
3396 let route_params = RouteParameters::from_payment_params_and_value(
3397 payment_params.clone(), 0);
3398 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
3399 &route_params, &network_graph.read_only(), None, Arc::clone(&logger), &scorer,
3400 &Default::default(), &random_seed_bytes) {
3401 assert_eq!(err, "Cannot send a payment of 0 msat");
3402 } else { panic!(); }
3404 payment_params.max_path_length = 2;
3405 let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
3406 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3407 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3408 assert_eq!(route.paths[0].hops.len(), 2);
3410 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
3411 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
3412 assert_eq!(route.paths[0].hops[0].fee_msat, 100);
3413 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
3414 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
3415 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
3417 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
3418 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
3419 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
3420 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
3421 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
3422 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
3424 route_params.payment_params.max_path_length = 1;
3425 get_route(&our_id, &route_params, &network_graph.read_only(), None,
3426 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap_err();
3430 fn invalid_first_hop_test() {
3431 let (secp_ctx, network_graph, _, _, logger) = build_graph();
3432 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
3433 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
3434 let scorer = ln_test_utils::TestScorer::new();
3435 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3436 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3438 // Simple route to 2 via 1
3440 let our_chans = vec![get_channel_details(Some(2), our_id, InitFeatures::from_le_bytes(vec![0b11]), 100000)];
3442 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
3443 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
3444 &route_params, &network_graph.read_only(), Some(&our_chans.iter().collect::<Vec<_>>()),
3445 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes) {
3446 assert_eq!(err, "First hop cannot have our_node_pubkey as a destination.");
3447 } else { panic!(); }
3449 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3450 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3451 assert_eq!(route.paths[0].hops.len(), 2);
3455 fn htlc_minimum_test() {
3456 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
3457 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3458 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
3459 let scorer = ln_test_utils::TestScorer::new();
3460 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3461 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3463 // Simple route to 2 via 1
3465 // Disable other paths
3466 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3467 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3468 short_channel_id: 12,
3470 flags: 2, // to disable
3471 cltv_expiry_delta: 0,
3472 htlc_minimum_msat: 0,
3473 htlc_maximum_msat: MAX_VALUE_MSAT,
3475 fee_proportional_millionths: 0,
3476 excess_data: Vec::new()
3478 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
3479 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3480 short_channel_id: 3,
3482 flags: 2, // to disable
3483 cltv_expiry_delta: 0,
3484 htlc_minimum_msat: 0,
3485 htlc_maximum_msat: MAX_VALUE_MSAT,
3487 fee_proportional_millionths: 0,
3488 excess_data: Vec::new()
3490 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
3491 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3492 short_channel_id: 13,
3494 flags: 2, // to disable
3495 cltv_expiry_delta: 0,
3496 htlc_minimum_msat: 0,
3497 htlc_maximum_msat: MAX_VALUE_MSAT,
3499 fee_proportional_millionths: 0,
3500 excess_data: Vec::new()
3502 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3503 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3504 short_channel_id: 6,
3506 flags: 2, // to disable
3507 cltv_expiry_delta: 0,
3508 htlc_minimum_msat: 0,
3509 htlc_maximum_msat: MAX_VALUE_MSAT,
3511 fee_proportional_millionths: 0,
3512 excess_data: Vec::new()
3514 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3515 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3516 short_channel_id: 7,
3518 flags: 2, // to disable
3519 cltv_expiry_delta: 0,
3520 htlc_minimum_msat: 0,
3521 htlc_maximum_msat: MAX_VALUE_MSAT,
3523 fee_proportional_millionths: 0,
3524 excess_data: Vec::new()
3527 // Check against amount_to_transfer_over_msat.
3528 // Set minimal HTLC of 200_000_000 msat.
3529 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3530 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3531 short_channel_id: 2,
3534 cltv_expiry_delta: 0,
3535 htlc_minimum_msat: 200_000_000,
3536 htlc_maximum_msat: MAX_VALUE_MSAT,
3538 fee_proportional_millionths: 0,
3539 excess_data: Vec::new()
3542 // Second hop only allows to forward 199_999_999 at most, thus not allowing the first hop to
3544 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
3545 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3546 short_channel_id: 4,
3549 cltv_expiry_delta: 0,
3550 htlc_minimum_msat: 0,
3551 htlc_maximum_msat: 199_999_999,
3553 fee_proportional_millionths: 0,
3554 excess_data: Vec::new()
3557 // Not possible to send 199_999_999, because the minimum on channel=2 is 200_000_000.
3558 let route_params = RouteParameters::from_payment_params_and_value(
3559 payment_params, 199_999_999);
3560 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
3561 &route_params, &network_graph.read_only(), None, Arc::clone(&logger), &scorer,
3562 &Default::default(), &random_seed_bytes) {
3563 assert_eq!(err, "Failed to find a path to the given destination");
3564 } else { panic!(); }
3566 // Lift the restriction on the first hop.
3567 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3568 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3569 short_channel_id: 2,
3572 cltv_expiry_delta: 0,
3573 htlc_minimum_msat: 0,
3574 htlc_maximum_msat: MAX_VALUE_MSAT,
3576 fee_proportional_millionths: 0,
3577 excess_data: Vec::new()
3580 // A payment above the minimum should pass
3581 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3582 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3583 assert_eq!(route.paths[0].hops.len(), 2);
3587 fn htlc_minimum_overpay_test() {
3588 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
3589 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3590 let config = UserConfig::default();
3591 let payment_params = PaymentParameters::from_node_id(nodes[2], 42)
3592 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
3594 let scorer = ln_test_utils::TestScorer::new();
3595 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3596 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3598 // A route to node#2 via two paths.
3599 // One path allows transferring 35-40 sats, another one also allows 35-40 sats.
3600 // Thus, they can't send 60 without overpaying.
3601 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3602 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3603 short_channel_id: 2,
3606 cltv_expiry_delta: 0,
3607 htlc_minimum_msat: 35_000,
3608 htlc_maximum_msat: 40_000,
3610 fee_proportional_millionths: 0,
3611 excess_data: Vec::new()
3613 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3614 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3615 short_channel_id: 12,
3618 cltv_expiry_delta: 0,
3619 htlc_minimum_msat: 35_000,
3620 htlc_maximum_msat: 40_000,
3622 fee_proportional_millionths: 0,
3623 excess_data: Vec::new()
3627 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
3628 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3629 short_channel_id: 13,
3632 cltv_expiry_delta: 0,
3633 htlc_minimum_msat: 0,
3634 htlc_maximum_msat: MAX_VALUE_MSAT,
3636 fee_proportional_millionths: 0,
3637 excess_data: Vec::new()
3639 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
3640 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3641 short_channel_id: 4,
3644 cltv_expiry_delta: 0,
3645 htlc_minimum_msat: 0,
3646 htlc_maximum_msat: MAX_VALUE_MSAT,
3648 fee_proportional_millionths: 0,
3649 excess_data: Vec::new()
3652 // Disable other paths
3653 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3654 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3655 short_channel_id: 1,
3657 flags: 2, // to disable
3658 cltv_expiry_delta: 0,
3659 htlc_minimum_msat: 0,
3660 htlc_maximum_msat: MAX_VALUE_MSAT,
3662 fee_proportional_millionths: 0,
3663 excess_data: Vec::new()
3666 let mut route_params = RouteParameters::from_payment_params_and_value(
3667 payment_params.clone(), 60_000);
3668 route_params.max_total_routing_fee_msat = Some(15_000);
3669 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3670 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3671 // Overpay fees to hit htlc_minimum_msat.
3672 let overpaid_fees = route.paths[0].hops[0].fee_msat + route.paths[1].hops[0].fee_msat;
3673 // TODO: this could be better balanced to overpay 10k and not 15k.
3674 assert_eq!(overpaid_fees, 15_000);
3676 // Now, test that if there are 2 paths, a "cheaper" by fee path wouldn't be prioritized
3677 // while taking even more fee to match htlc_minimum_msat.
3678 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3679 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3680 short_channel_id: 12,
3683 cltv_expiry_delta: 0,
3684 htlc_minimum_msat: 65_000,
3685 htlc_maximum_msat: 80_000,
3687 fee_proportional_millionths: 0,
3688 excess_data: Vec::new()
3690 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3691 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3692 short_channel_id: 2,
3695 cltv_expiry_delta: 0,
3696 htlc_minimum_msat: 0,
3697 htlc_maximum_msat: MAX_VALUE_MSAT,
3699 fee_proportional_millionths: 0,
3700 excess_data: Vec::new()
3702 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
3703 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3704 short_channel_id: 4,
3707 cltv_expiry_delta: 0,
3708 htlc_minimum_msat: 0,
3709 htlc_maximum_msat: MAX_VALUE_MSAT,
3711 fee_proportional_millionths: 100_000,
3712 excess_data: Vec::new()
3715 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3716 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3717 // Fine to overpay for htlc_minimum_msat if it allows us to save fee.
3718 assert_eq!(route.paths.len(), 1);
3719 assert_eq!(route.paths[0].hops[0].short_channel_id, 12);
3720 let fees = route.paths[0].hops[0].fee_msat;
3721 assert_eq!(fees, 5_000);
3723 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 50_000);
3724 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3725 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3726 // Not fine to overpay for htlc_minimum_msat if it requires paying more than fee on
3727 // the other channel.
3728 assert_eq!(route.paths.len(), 1);
3729 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
3730 let fees = route.paths[0].hops[0].fee_msat;
3731 assert_eq!(fees, 5_000);
3735 fn htlc_minimum_recipient_overpay_test() {
3736 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
3737 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3738 let config = UserConfig::default();
3739 let payment_params = PaymentParameters::from_node_id(nodes[2], 42).with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config)).unwrap();
3740 let scorer = ln_test_utils::TestScorer::new();
3741 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3742 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3744 // Route to node2 over a single path which requires overpaying the recipient themselves.
3746 // First disable all paths except the us -> node1 -> node2 path
3747 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3748 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3749 short_channel_id: 13,
3752 cltv_expiry_delta: 0,
3753 htlc_minimum_msat: 0,
3754 htlc_maximum_msat: 0,
3756 fee_proportional_millionths: 0,
3757 excess_data: Vec::new()
3760 // Set channel 4 to free but with a high htlc_minimum_msat
3761 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
3762 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3763 short_channel_id: 4,
3766 cltv_expiry_delta: 0,
3767 htlc_minimum_msat: 15_000,
3768 htlc_maximum_msat: MAX_VALUE_MSAT,
3770 fee_proportional_millionths: 0,
3771 excess_data: Vec::new()
3774 // Now check that we'll fail to find a path if we fail to find a path if the htlc_minimum
3775 // is overrun. Note that the fees are actually calculated on 3*payment amount as that's
3776 // what we try to find a route for, so this test only just happens to work out to exactly
3778 let mut route_params = RouteParameters::from_payment_params_and_value(
3779 payment_params.clone(), 5_000);
3780 route_params.max_total_routing_fee_msat = Some(9_999);
3781 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
3782 &route_params, &network_graph.read_only(), None, Arc::clone(&logger), &scorer,
3783 &Default::default(), &random_seed_bytes) {
3784 assert_eq!(err, "Failed to find route that adheres to the maximum total fee limit of 9999msat");
3785 } else { panic!(); }
3787 let mut route_params = RouteParameters::from_payment_params_and_value(
3788 payment_params.clone(), 5_000);
3789 route_params.max_total_routing_fee_msat = Some(10_000);
3790 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3791 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3792 assert_eq!(route.get_total_fees(), 10_000);
3796 fn disable_channels_test() {
3797 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
3798 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3799 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
3800 let scorer = ln_test_utils::TestScorer::new();
3801 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3802 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3804 // // Disable channels 4 and 12 by flags=2
3805 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
3806 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3807 short_channel_id: 4,
3809 flags: 2, // to disable
3810 cltv_expiry_delta: 0,
3811 htlc_minimum_msat: 0,
3812 htlc_maximum_msat: MAX_VALUE_MSAT,
3814 fee_proportional_millionths: 0,
3815 excess_data: Vec::new()
3817 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3818 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3819 short_channel_id: 12,
3821 flags: 2, // to disable
3822 cltv_expiry_delta: 0,
3823 htlc_minimum_msat: 0,
3824 htlc_maximum_msat: MAX_VALUE_MSAT,
3826 fee_proportional_millionths: 0,
3827 excess_data: Vec::new()
3830 // If all the channels require some features we don't understand, route should fail
3831 let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
3832 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
3833 &route_params, &network_graph.read_only(), None, Arc::clone(&logger), &scorer,
3834 &Default::default(), &random_seed_bytes) {
3835 assert_eq!(err, "Failed to find a path to the given destination");
3836 } else { panic!(); }
3838 // If we specify a channel to node7, that overrides our local channel view and that gets used
3839 let our_chans = vec![get_channel_details(Some(42), nodes[7].clone(),
3840 InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)];
3841 route_params.payment_params.max_path_length = 2;
3842 let route = get_route(&our_id, &route_params, &network_graph.read_only(),
3843 Some(&our_chans.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
3844 &Default::default(), &random_seed_bytes).unwrap();
3845 assert_eq!(route.paths[0].hops.len(), 2);
3847 assert_eq!(route.paths[0].hops[0].pubkey, nodes[7]);
3848 assert_eq!(route.paths[0].hops[0].short_channel_id, 42);
3849 assert_eq!(route.paths[0].hops[0].fee_msat, 200);
3850 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (13 << 4) | 1);
3851 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
3852 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
3854 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
3855 assert_eq!(route.paths[0].hops[1].short_channel_id, 13);
3856 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
3857 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
3858 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
3859 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(13));
3863 fn disable_node_test() {
3864 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
3865 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3866 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
3867 let scorer = ln_test_utils::TestScorer::new();
3868 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3869 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3871 // Disable nodes 1, 2, and 8 by requiring unknown feature bits
3872 let mut unknown_features = NodeFeatures::empty();
3873 unknown_features.set_unknown_feature_required();
3874 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[0], unknown_features.clone(), 1);
3875 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[1], unknown_features.clone(), 1);
3876 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[7], unknown_features.clone(), 1);
3878 // If all nodes require some features we don't understand, route should fail
3879 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
3880 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
3881 &route_params, &network_graph.read_only(), None, Arc::clone(&logger), &scorer,
3882 &Default::default(), &random_seed_bytes) {
3883 assert_eq!(err, "Failed to find a path to the given destination");
3884 } else { panic!(); }
3886 // If we specify a channel to node7, that overrides our local channel view and that gets used
3887 let our_chans = vec![get_channel_details(Some(42), nodes[7].clone(),
3888 InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)];
3889 let route = get_route(&our_id, &route_params, &network_graph.read_only(),
3890 Some(&our_chans.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
3891 &Default::default(), &random_seed_bytes).unwrap();
3892 assert_eq!(route.paths[0].hops.len(), 2);
3894 assert_eq!(route.paths[0].hops[0].pubkey, nodes[7]);
3895 assert_eq!(route.paths[0].hops[0].short_channel_id, 42);
3896 assert_eq!(route.paths[0].hops[0].fee_msat, 200);
3897 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (13 << 4) | 1);
3898 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
3899 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
3901 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
3902 assert_eq!(route.paths[0].hops[1].short_channel_id, 13);
3903 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
3904 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
3905 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
3906 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(13));
3908 // Note that we don't test disabling node 3 and failing to route to it, as we (somewhat
3909 // naively) assume that the user checked the feature bits on the invoice, which override
3910 // the node_announcement.
3914 fn our_chans_test() {
3915 let (secp_ctx, network_graph, _, _, logger) = build_graph();
3916 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
3917 let scorer = ln_test_utils::TestScorer::new();
3918 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3919 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3921 // Route to 1 via 2 and 3 because our channel to 1 is disabled
3922 let payment_params = PaymentParameters::from_node_id(nodes[0], 42);
3923 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
3924 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3925 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3926 assert_eq!(route.paths[0].hops.len(), 3);
3928 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
3929 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
3930 assert_eq!(route.paths[0].hops[0].fee_msat, 200);
3931 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
3932 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
3933 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
3935 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
3936 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
3937 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
3938 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (3 << 4) | 2);
3939 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
3940 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
3942 assert_eq!(route.paths[0].hops[2].pubkey, nodes[0]);
3943 assert_eq!(route.paths[0].hops[2].short_channel_id, 3);
3944 assert_eq!(route.paths[0].hops[2].fee_msat, 100);
3945 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, 42);
3946 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(1));
3947 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(3));
3949 // If we specify a channel to node7, that overrides our local channel view and that gets used
3950 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
3951 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
3952 let our_chans = vec![get_channel_details(Some(42), nodes[7].clone(),
3953 InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)];
3954 let route = get_route(&our_id, &route_params, &network_graph.read_only(),
3955 Some(&our_chans.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
3956 &Default::default(), &random_seed_bytes).unwrap();
3957 assert_eq!(route.paths[0].hops.len(), 2);
3959 assert_eq!(route.paths[0].hops[0].pubkey, nodes[7]);
3960 assert_eq!(route.paths[0].hops[0].short_channel_id, 42);
3961 assert_eq!(route.paths[0].hops[0].fee_msat, 200);
3962 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (13 << 4) | 1);
3963 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &vec![0b11]);
3964 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
3966 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
3967 assert_eq!(route.paths[0].hops[1].short_channel_id, 13);
3968 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
3969 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
3970 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
3971 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(13));
3974 fn last_hops(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
3975 let zero_fees = RoutingFees {
3977 proportional_millionths: 0,
3979 vec![RouteHint(vec![RouteHintHop {
3980 src_node_id: nodes[3],
3981 short_channel_id: 8,
3983 cltv_expiry_delta: (8 << 4) | 1,
3984 htlc_minimum_msat: None,
3985 htlc_maximum_msat: None,
3987 ]), RouteHint(vec![RouteHintHop {
3988 src_node_id: nodes[4],
3989 short_channel_id: 9,
3992 proportional_millionths: 0,
3994 cltv_expiry_delta: (9 << 4) | 1,
3995 htlc_minimum_msat: None,
3996 htlc_maximum_msat: None,
3997 }]), RouteHint(vec![RouteHintHop {
3998 src_node_id: nodes[5],
3999 short_channel_id: 10,
4001 cltv_expiry_delta: (10 << 4) | 1,
4002 htlc_minimum_msat: None,
4003 htlc_maximum_msat: None,
4007 fn last_hops_multi_private_channels(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
4008 let zero_fees = RoutingFees {
4010 proportional_millionths: 0,
4012 vec![RouteHint(vec![RouteHintHop {
4013 src_node_id: nodes[2],
4014 short_channel_id: 5,
4017 proportional_millionths: 0,
4019 cltv_expiry_delta: (5 << 4) | 1,
4020 htlc_minimum_msat: None,
4021 htlc_maximum_msat: None,
4023 src_node_id: nodes[3],
4024 short_channel_id: 8,
4026 cltv_expiry_delta: (8 << 4) | 1,
4027 htlc_minimum_msat: None,
4028 htlc_maximum_msat: None,
4030 ]), RouteHint(vec![RouteHintHop {
4031 src_node_id: nodes[4],
4032 short_channel_id: 9,
4035 proportional_millionths: 0,
4037 cltv_expiry_delta: (9 << 4) | 1,
4038 htlc_minimum_msat: None,
4039 htlc_maximum_msat: None,
4040 }]), RouteHint(vec![RouteHintHop {
4041 src_node_id: nodes[5],
4042 short_channel_id: 10,
4044 cltv_expiry_delta: (10 << 4) | 1,
4045 htlc_minimum_msat: None,
4046 htlc_maximum_msat: None,
4051 fn partial_route_hint_test() {
4052 let (secp_ctx, network_graph, _, _, logger) = build_graph();
4053 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
4054 let scorer = ln_test_utils::TestScorer::new();
4055 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4056 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4058 // Simple test across 2, 3, 5, and 4 via a last_hop channel
4059 // Tests the behaviour when the RouteHint contains a suboptimal hop.
4060 // RouteHint may be partially used by the algo to build the best path.
4062 // First check that last hop can't have its source as the payee.
4063 let invalid_last_hop = RouteHint(vec![RouteHintHop {
4064 src_node_id: nodes[6],
4065 short_channel_id: 8,
4068 proportional_millionths: 0,
4070 cltv_expiry_delta: (8 << 4) | 1,
4071 htlc_minimum_msat: None,
4072 htlc_maximum_msat: None,
4075 let mut invalid_last_hops = last_hops_multi_private_channels(&nodes);
4076 invalid_last_hops.push(invalid_last_hop);
4078 let payment_params = PaymentParameters::from_node_id(nodes[6], 42)
4079 .with_route_hints(invalid_last_hops).unwrap();
4080 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4081 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
4082 &route_params, &network_graph.read_only(), None, Arc::clone(&logger), &scorer,
4083 &Default::default(), &random_seed_bytes) {
4084 assert_eq!(err, "Route hint cannot have the payee as the source.");
4085 } else { panic!(); }
4088 let mut payment_params = PaymentParameters::from_node_id(nodes[6], 42)
4089 .with_route_hints(last_hops_multi_private_channels(&nodes)).unwrap();
4090 payment_params.max_path_length = 5;
4091 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4092 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4093 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4094 assert_eq!(route.paths[0].hops.len(), 5);
4096 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4097 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4098 assert_eq!(route.paths[0].hops[0].fee_msat, 100);
4099 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
4100 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4101 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4103 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4104 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4105 assert_eq!(route.paths[0].hops[1].fee_msat, 0);
4106 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (6 << 4) | 1);
4107 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4108 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4110 assert_eq!(route.paths[0].hops[2].pubkey, nodes[4]);
4111 assert_eq!(route.paths[0].hops[2].short_channel_id, 6);
4112 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4113 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, (11 << 4) | 1);
4114 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(5));
4115 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(6));
4117 assert_eq!(route.paths[0].hops[3].pubkey, nodes[3]);
4118 assert_eq!(route.paths[0].hops[3].short_channel_id, 11);
4119 assert_eq!(route.paths[0].hops[3].fee_msat, 0);
4120 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, (8 << 4) | 1);
4121 // If we have a peer in the node map, we'll use their features here since we don't have
4122 // a way of figuring out their features from the invoice:
4123 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), &id_to_feature_flags(4));
4124 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &id_to_feature_flags(11));
4126 assert_eq!(route.paths[0].hops[4].pubkey, nodes[6]);
4127 assert_eq!(route.paths[0].hops[4].short_channel_id, 8);
4128 assert_eq!(route.paths[0].hops[4].fee_msat, 100);
4129 assert_eq!(route.paths[0].hops[4].cltv_expiry_delta, 42);
4130 assert_eq!(route.paths[0].hops[4].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4131 assert_eq!(route.paths[0].hops[4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4134 fn empty_last_hop(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
4135 let zero_fees = RoutingFees {
4137 proportional_millionths: 0,
4139 vec![RouteHint(vec![RouteHintHop {
4140 src_node_id: nodes[3],
4141 short_channel_id: 8,
4143 cltv_expiry_delta: (8 << 4) | 1,
4144 htlc_minimum_msat: None,
4145 htlc_maximum_msat: None,
4146 }]), RouteHint(vec![
4148 ]), RouteHint(vec![RouteHintHop {
4149 src_node_id: nodes[5],
4150 short_channel_id: 10,
4152 cltv_expiry_delta: (10 << 4) | 1,
4153 htlc_minimum_msat: None,
4154 htlc_maximum_msat: None,
4159 fn ignores_empty_last_hops_test() {
4160 let (secp_ctx, network_graph, _, _, logger) = build_graph();
4161 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
4162 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(empty_last_hop(&nodes)).unwrap();
4163 let scorer = ln_test_utils::TestScorer::new();
4164 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4165 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4167 // Test handling of an empty RouteHint passed in Invoice.
4168 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4169 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4170 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4171 assert_eq!(route.paths[0].hops.len(), 5);
4173 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4174 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4175 assert_eq!(route.paths[0].hops[0].fee_msat, 100);
4176 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
4177 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4178 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4180 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4181 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4182 assert_eq!(route.paths[0].hops[1].fee_msat, 0);
4183 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (6 << 4) | 1);
4184 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4185 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4187 assert_eq!(route.paths[0].hops[2].pubkey, nodes[4]);
4188 assert_eq!(route.paths[0].hops[2].short_channel_id, 6);
4189 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4190 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, (11 << 4) | 1);
4191 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(5));
4192 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(6));
4194 assert_eq!(route.paths[0].hops[3].pubkey, nodes[3]);
4195 assert_eq!(route.paths[0].hops[3].short_channel_id, 11);
4196 assert_eq!(route.paths[0].hops[3].fee_msat, 0);
4197 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, (8 << 4) | 1);
4198 // If we have a peer in the node map, we'll use their features here since we don't have
4199 // a way of figuring out their features from the invoice:
4200 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), &id_to_feature_flags(4));
4201 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &id_to_feature_flags(11));
4203 assert_eq!(route.paths[0].hops[4].pubkey, nodes[6]);
4204 assert_eq!(route.paths[0].hops[4].short_channel_id, 8);
4205 assert_eq!(route.paths[0].hops[4].fee_msat, 100);
4206 assert_eq!(route.paths[0].hops[4].cltv_expiry_delta, 42);
4207 assert_eq!(route.paths[0].hops[4].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4208 assert_eq!(route.paths[0].hops[4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4211 /// Builds a trivial last-hop hint that passes through the two nodes given, with channel 0xff00
4213 fn multi_hop_last_hops_hint(hint_hops: [PublicKey; 2]) -> Vec<RouteHint> {
4214 let zero_fees = RoutingFees {
4216 proportional_millionths: 0,
4218 vec![RouteHint(vec![RouteHintHop {
4219 src_node_id: hint_hops[0],
4220 short_channel_id: 0xff00,
4223 proportional_millionths: 0,
4225 cltv_expiry_delta: (5 << 4) | 1,
4226 htlc_minimum_msat: None,
4227 htlc_maximum_msat: None,
4229 src_node_id: hint_hops[1],
4230 short_channel_id: 0xff01,
4232 cltv_expiry_delta: (8 << 4) | 1,
4233 htlc_minimum_msat: None,
4234 htlc_maximum_msat: None,
4239 fn multi_hint_last_hops_test() {
4240 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
4241 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4242 let last_hops = multi_hop_last_hops_hint([nodes[2], nodes[3]]);
4243 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(last_hops.clone()).unwrap();
4244 let scorer = ln_test_utils::TestScorer::new();
4245 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4246 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4247 // Test through channels 2, 3, 0xff00, 0xff01.
4248 // Test shows that multi-hop route hints are considered and factored correctly into the
4251 // Disabling channels 6 & 7 by flags=2
4252 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4253 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4254 short_channel_id: 6,
4256 flags: 2, // to disable
4257 cltv_expiry_delta: 0,
4258 htlc_minimum_msat: 0,
4259 htlc_maximum_msat: MAX_VALUE_MSAT,
4261 fee_proportional_millionths: 0,
4262 excess_data: Vec::new()
4264 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4265 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4266 short_channel_id: 7,
4268 flags: 2, // to disable
4269 cltv_expiry_delta: 0,
4270 htlc_minimum_msat: 0,
4271 htlc_maximum_msat: MAX_VALUE_MSAT,
4273 fee_proportional_millionths: 0,
4274 excess_data: Vec::new()
4277 let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4278 route_params.payment_params.max_path_length = 4;
4279 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4280 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4281 assert_eq!(route.paths[0].hops.len(), 4);
4283 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4284 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4285 assert_eq!(route.paths[0].hops[0].fee_msat, 200);
4286 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, 65);
4287 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4288 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4290 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4291 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4292 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
4293 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 81);
4294 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4295 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4297 assert_eq!(route.paths[0].hops[2].pubkey, nodes[3]);
4298 assert_eq!(route.paths[0].hops[2].short_channel_id, last_hops[0].0[0].short_channel_id);
4299 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4300 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, 129);
4301 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(4));
4302 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4304 assert_eq!(route.paths[0].hops[3].pubkey, nodes[6]);
4305 assert_eq!(route.paths[0].hops[3].short_channel_id, last_hops[0].0[1].short_channel_id);
4306 assert_eq!(route.paths[0].hops[3].fee_msat, 100);
4307 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, 42);
4308 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4309 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4310 route_params.payment_params.max_path_length = 3;
4311 get_route(&our_id, &route_params, &network_graph.read_only(), None,
4312 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap_err();
4316 fn private_multi_hint_last_hops_test() {
4317 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
4318 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4320 let non_announced_privkey = SecretKey::from_slice(&<Vec<u8>>::from_hex(&format!("{:02x}", 0xf0).repeat(32)).unwrap()[..]).unwrap();
4321 let non_announced_pubkey = PublicKey::from_secret_key(&secp_ctx, &non_announced_privkey);
4323 let last_hops = multi_hop_last_hops_hint([nodes[2], non_announced_pubkey]);
4324 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(last_hops.clone()).unwrap();
4325 let scorer = ln_test_utils::TestScorer::new();
4326 // Test through channels 2, 3, 0xff00, 0xff01.
4327 // Test shows that multiple hop hints are considered.
4329 // Disabling channels 6 & 7 by flags=2
4330 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4331 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4332 short_channel_id: 6,
4334 flags: 2, // to disable
4335 cltv_expiry_delta: 0,
4336 htlc_minimum_msat: 0,
4337 htlc_maximum_msat: MAX_VALUE_MSAT,
4339 fee_proportional_millionths: 0,
4340 excess_data: Vec::new()
4342 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4343 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4344 short_channel_id: 7,
4346 flags: 2, // to disable
4347 cltv_expiry_delta: 0,
4348 htlc_minimum_msat: 0,
4349 htlc_maximum_msat: MAX_VALUE_MSAT,
4351 fee_proportional_millionths: 0,
4352 excess_data: Vec::new()
4355 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4356 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4357 Arc::clone(&logger), &scorer, &Default::default(), &[42u8; 32]).unwrap();
4358 assert_eq!(route.paths[0].hops.len(), 4);
4360 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4361 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4362 assert_eq!(route.paths[0].hops[0].fee_msat, 200);
4363 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, 65);
4364 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4365 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4367 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4368 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4369 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
4370 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 81);
4371 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4372 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4374 assert_eq!(route.paths[0].hops[2].pubkey, non_announced_pubkey);
4375 assert_eq!(route.paths[0].hops[2].short_channel_id, last_hops[0].0[0].short_channel_id);
4376 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4377 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, 129);
4378 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4379 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4381 assert_eq!(route.paths[0].hops[3].pubkey, nodes[6]);
4382 assert_eq!(route.paths[0].hops[3].short_channel_id, last_hops[0].0[1].short_channel_id);
4383 assert_eq!(route.paths[0].hops[3].fee_msat, 100);
4384 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, 42);
4385 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4386 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4389 fn last_hops_with_public_channel(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
4390 let zero_fees = RoutingFees {
4392 proportional_millionths: 0,
4394 vec![RouteHint(vec![RouteHintHop {
4395 src_node_id: nodes[4],
4396 short_channel_id: 11,
4398 cltv_expiry_delta: (11 << 4) | 1,
4399 htlc_minimum_msat: None,
4400 htlc_maximum_msat: None,
4402 src_node_id: nodes[3],
4403 short_channel_id: 8,
4405 cltv_expiry_delta: (8 << 4) | 1,
4406 htlc_minimum_msat: None,
4407 htlc_maximum_msat: None,
4408 }]), RouteHint(vec![RouteHintHop {
4409 src_node_id: nodes[4],
4410 short_channel_id: 9,
4413 proportional_millionths: 0,
4415 cltv_expiry_delta: (9 << 4) | 1,
4416 htlc_minimum_msat: None,
4417 htlc_maximum_msat: None,
4418 }]), RouteHint(vec![RouteHintHop {
4419 src_node_id: nodes[5],
4420 short_channel_id: 10,
4422 cltv_expiry_delta: (10 << 4) | 1,
4423 htlc_minimum_msat: None,
4424 htlc_maximum_msat: None,
4429 fn last_hops_with_public_channel_test() {
4430 let (secp_ctx, network_graph, _, _, logger) = build_graph();
4431 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
4432 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(last_hops_with_public_channel(&nodes)).unwrap();
4433 let scorer = ln_test_utils::TestScorer::new();
4434 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4435 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4436 // This test shows that public routes can be present in the invoice
4437 // which would be handled in the same manner.
4439 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4440 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4441 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4442 assert_eq!(route.paths[0].hops.len(), 5);
4444 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4445 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4446 assert_eq!(route.paths[0].hops[0].fee_msat, 100);
4447 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
4448 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4449 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4451 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4452 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4453 assert_eq!(route.paths[0].hops[1].fee_msat, 0);
4454 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (6 << 4) | 1);
4455 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4456 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4458 assert_eq!(route.paths[0].hops[2].pubkey, nodes[4]);
4459 assert_eq!(route.paths[0].hops[2].short_channel_id, 6);
4460 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4461 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, (11 << 4) | 1);
4462 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(5));
4463 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(6));
4465 assert_eq!(route.paths[0].hops[3].pubkey, nodes[3]);
4466 assert_eq!(route.paths[0].hops[3].short_channel_id, 11);
4467 assert_eq!(route.paths[0].hops[3].fee_msat, 0);
4468 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, (8 << 4) | 1);
4469 // If we have a peer in the node map, we'll use their features here since we don't have
4470 // a way of figuring out their features from the invoice:
4471 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), &id_to_feature_flags(4));
4472 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &id_to_feature_flags(11));
4474 assert_eq!(route.paths[0].hops[4].pubkey, nodes[6]);
4475 assert_eq!(route.paths[0].hops[4].short_channel_id, 8);
4476 assert_eq!(route.paths[0].hops[4].fee_msat, 100);
4477 assert_eq!(route.paths[0].hops[4].cltv_expiry_delta, 42);
4478 assert_eq!(route.paths[0].hops[4].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4479 assert_eq!(route.paths[0].hops[4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4483 fn our_chans_last_hop_connect_test() {
4484 let (secp_ctx, network_graph, _, _, logger) = build_graph();
4485 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
4486 let scorer = ln_test_utils::TestScorer::new();
4487 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4488 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4490 // Simple test with outbound channel to 4 to test that last_hops and first_hops connect
4491 let our_chans = vec![get_channel_details(Some(42), nodes[3].clone(), InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)];
4492 let mut last_hops = last_hops(&nodes);
4493 let payment_params = PaymentParameters::from_node_id(nodes[6], 42)
4494 .with_route_hints(last_hops.clone()).unwrap();
4495 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4496 let route = get_route(&our_id, &route_params, &network_graph.read_only(),
4497 Some(&our_chans.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
4498 &Default::default(), &random_seed_bytes).unwrap();
4499 assert_eq!(route.paths[0].hops.len(), 2);
4501 assert_eq!(route.paths[0].hops[0].pubkey, nodes[3]);
4502 assert_eq!(route.paths[0].hops[0].short_channel_id, 42);
4503 assert_eq!(route.paths[0].hops[0].fee_msat, 0);
4504 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (8 << 4) | 1);
4505 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &vec![0b11]);
4506 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
4508 assert_eq!(route.paths[0].hops[1].pubkey, nodes[6]);
4509 assert_eq!(route.paths[0].hops[1].short_channel_id, 8);
4510 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
4511 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
4512 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4513 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4515 last_hops[0].0[0].fees.base_msat = 1000;
4517 // Revert to via 6 as the fee on 8 goes up
4518 let payment_params = PaymentParameters::from_node_id(nodes[6], 42)
4519 .with_route_hints(last_hops).unwrap();
4520 let route_params = RouteParameters::from_payment_params_and_value(
4521 payment_params.clone(), 100);
4522 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4523 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4524 assert_eq!(route.paths[0].hops.len(), 4);
4526 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4527 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4528 assert_eq!(route.paths[0].hops[0].fee_msat, 200); // fee increased as its % of value transferred across node
4529 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
4530 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4531 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4533 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4534 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4535 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
4536 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (7 << 4) | 1);
4537 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4538 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4540 assert_eq!(route.paths[0].hops[2].pubkey, nodes[5]);
4541 assert_eq!(route.paths[0].hops[2].short_channel_id, 7);
4542 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4543 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, (10 << 4) | 1);
4544 // If we have a peer in the node map, we'll use their features here since we don't have
4545 // a way of figuring out their features from the invoice:
4546 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(6));
4547 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(7));
4549 assert_eq!(route.paths[0].hops[3].pubkey, nodes[6]);
4550 assert_eq!(route.paths[0].hops[3].short_channel_id, 10);
4551 assert_eq!(route.paths[0].hops[3].fee_msat, 100);
4552 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, 42);
4553 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4554 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4556 // ...but still use 8 for larger payments as 6 has a variable feerate
4557 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 2000);
4558 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4559 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4560 assert_eq!(route.paths[0].hops.len(), 5);
4562 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4563 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4564 assert_eq!(route.paths[0].hops[0].fee_msat, 3000);
4565 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
4566 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4567 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4569 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4570 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4571 assert_eq!(route.paths[0].hops[1].fee_msat, 0);
4572 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (6 << 4) | 1);
4573 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4574 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4576 assert_eq!(route.paths[0].hops[2].pubkey, nodes[4]);
4577 assert_eq!(route.paths[0].hops[2].short_channel_id, 6);
4578 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4579 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, (11 << 4) | 1);
4580 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(5));
4581 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(6));
4583 assert_eq!(route.paths[0].hops[3].pubkey, nodes[3]);
4584 assert_eq!(route.paths[0].hops[3].short_channel_id, 11);
4585 assert_eq!(route.paths[0].hops[3].fee_msat, 1000);
4586 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, (8 << 4) | 1);
4587 // If we have a peer in the node map, we'll use their features here since we don't have
4588 // a way of figuring out their features from the invoice:
4589 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), &id_to_feature_flags(4));
4590 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &id_to_feature_flags(11));
4592 assert_eq!(route.paths[0].hops[4].pubkey, nodes[6]);
4593 assert_eq!(route.paths[0].hops[4].short_channel_id, 8);
4594 assert_eq!(route.paths[0].hops[4].fee_msat, 2000);
4595 assert_eq!(route.paths[0].hops[4].cltv_expiry_delta, 42);
4596 assert_eq!(route.paths[0].hops[4].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4597 assert_eq!(route.paths[0].hops[4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4600 fn do_unannounced_path_test(last_hop_htlc_max: Option<u64>, last_hop_fee_prop: u32, outbound_capacity_msat: u64, route_val: u64) -> Result<Route, LightningError> {
4601 let source_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&<Vec<u8>>::from_hex(&format!("{:02}", 41).repeat(32)).unwrap()[..]).unwrap());
4602 let middle_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&<Vec<u8>>::from_hex(&format!("{:02}", 42).repeat(32)).unwrap()[..]).unwrap());
4603 let target_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&<Vec<u8>>::from_hex(&format!("{:02}", 43).repeat(32)).unwrap()[..]).unwrap());
4605 // If we specify a channel to a middle hop, that overrides our local channel view and that gets used
4606 let last_hops = RouteHint(vec![RouteHintHop {
4607 src_node_id: middle_node_id,
4608 short_channel_id: 8,
4611 proportional_millionths: last_hop_fee_prop,
4613 cltv_expiry_delta: (8 << 4) | 1,
4614 htlc_minimum_msat: None,
4615 htlc_maximum_msat: last_hop_htlc_max,
4617 let payment_params = PaymentParameters::from_node_id(target_node_id, 42).with_route_hints(vec![last_hops]).unwrap();
4618 let our_chans = vec![get_channel_details(Some(42), middle_node_id, InitFeatures::from_le_bytes(vec![0b11]), outbound_capacity_msat)];
4619 let scorer = ln_test_utils::TestScorer::new();
4620 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4621 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4622 let logger = ln_test_utils::TestLogger::new();
4623 let network_graph = NetworkGraph::new(Network::Testnet, &logger);
4624 let route_params = RouteParameters::from_payment_params_and_value(payment_params, route_val);
4625 let route = get_route(&source_node_id, &route_params, &network_graph.read_only(),
4626 Some(&our_chans.iter().collect::<Vec<_>>()), &logger, &scorer, &Default::default(),
4627 &random_seed_bytes);
4632 fn unannounced_path_test() {
4633 // We should be able to send a payment to a destination without any help of a routing graph
4634 // if we have a channel with a common counterparty that appears in the first and last hop
4636 let route = do_unannounced_path_test(None, 1, 2000000, 1000000).unwrap();
4638 let middle_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&<Vec<u8>>::from_hex(&format!("{:02}", 42).repeat(32)).unwrap()[..]).unwrap());
4639 let target_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&<Vec<u8>>::from_hex(&format!("{:02}", 43).repeat(32)).unwrap()[..]).unwrap());
4640 assert_eq!(route.paths[0].hops.len(), 2);
4642 assert_eq!(route.paths[0].hops[0].pubkey, middle_node_id);
4643 assert_eq!(route.paths[0].hops[0].short_channel_id, 42);
4644 assert_eq!(route.paths[0].hops[0].fee_msat, 1001);
4645 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (8 << 4) | 1);
4646 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &[0b11]);
4647 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &[0; 0]); // We can't learn any flags from invoices, sadly
4649 assert_eq!(route.paths[0].hops[1].pubkey, target_node_id);
4650 assert_eq!(route.paths[0].hops[1].short_channel_id, 8);
4651 assert_eq!(route.paths[0].hops[1].fee_msat, 1000000);
4652 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
4653 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4654 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &[0; 0]); // We can't learn any flags from invoices, sadly
4658 fn overflow_unannounced_path_test_liquidity_underflow() {
4659 // Previously, when we had a last-hop hint connected directly to a first-hop channel, where
4660 // the last-hop had a fee which overflowed a u64, we'd panic.
4661 // This was due to us adding the first-hop from us unconditionally, causing us to think
4662 // we'd built a path (as our node is in the "best candidate" set), when we had not.
4663 // In this test, we previously hit a subtraction underflow due to having less available
4664 // liquidity at the last hop than 0.
4665 assert!(do_unannounced_path_test(Some(21_000_000_0000_0000_000), 0, 21_000_000_0000_0000_000, 21_000_000_0000_0000_000).is_err());
4669 fn overflow_unannounced_path_test_feerate_overflow() {
4670 // This tests for the same case as above, except instead of hitting a subtraction
4671 // underflow, we hit a case where the fee charged at a hop overflowed.
4672 assert!(do_unannounced_path_test(Some(21_000_000_0000_0000_000), 50000, 21_000_000_0000_0000_000, 21_000_000_0000_0000_000).is_err());
4676 fn available_amount_while_routing_test() {
4677 // Tests whether we choose the correct available channel amount while routing.
4679 let (secp_ctx, network_graph, gossip_sync, chain_monitor, logger) = build_graph();
4680 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4681 let scorer = ln_test_utils::TestScorer::new();
4682 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4683 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4684 let config = UserConfig::default();
4685 let payment_params = PaymentParameters::from_node_id(nodes[2], 42)
4686 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
4689 // We will use a simple single-path route from
4690 // our node to node2 via node0: channels {1, 3}.
4692 // First disable all other paths.
4693 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4694 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4695 short_channel_id: 2,
4698 cltv_expiry_delta: 0,
4699 htlc_minimum_msat: 0,
4700 htlc_maximum_msat: 100_000,
4702 fee_proportional_millionths: 0,
4703 excess_data: Vec::new()
4705 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4706 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4707 short_channel_id: 12,
4710 cltv_expiry_delta: 0,
4711 htlc_minimum_msat: 0,
4712 htlc_maximum_msat: 100_000,
4714 fee_proportional_millionths: 0,
4715 excess_data: Vec::new()
4718 // Make the first channel (#1) very permissive,
4719 // and we will be testing all limits on the second channel.
4720 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4721 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4722 short_channel_id: 1,
4725 cltv_expiry_delta: 0,
4726 htlc_minimum_msat: 0,
4727 htlc_maximum_msat: 1_000_000_000,
4729 fee_proportional_millionths: 0,
4730 excess_data: Vec::new()
4733 // First, let's see if routing works if we have absolutely no idea about the available amount.
4734 // In this case, it should be set to 250_000 sats.
4735 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4736 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4737 short_channel_id: 3,
4740 cltv_expiry_delta: 0,
4741 htlc_minimum_msat: 0,
4742 htlc_maximum_msat: 250_000_000,
4744 fee_proportional_millionths: 0,
4745 excess_data: Vec::new()
4749 // Attempt to route more than available results in a failure.
4750 let route_params = RouteParameters::from_payment_params_and_value(
4751 payment_params.clone(), 250_000_001);
4752 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4753 &our_id, &route_params, &network_graph.read_only(), None,
4754 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes) {
4755 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4756 } else { panic!(); }
4760 // Now, attempt to route an exact amount we have should be fine.
4761 let route_params = RouteParameters::from_payment_params_and_value(
4762 payment_params.clone(), 250_000_000);
4763 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4764 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4765 assert_eq!(route.paths.len(), 1);
4766 let path = route.paths.last().unwrap();
4767 assert_eq!(path.hops.len(), 2);
4768 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
4769 assert_eq!(path.final_value_msat(), 250_000_000);
4772 // Check that setting next_outbound_htlc_limit_msat in first_hops limits the channels.
4773 // Disable channel #1 and use another first hop.
4774 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4775 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4776 short_channel_id: 1,
4779 cltv_expiry_delta: 0,
4780 htlc_minimum_msat: 0,
4781 htlc_maximum_msat: 1_000_000_000,
4783 fee_proportional_millionths: 0,
4784 excess_data: Vec::new()
4787 // Now, limit the first_hop by the next_outbound_htlc_limit_msat of 200_000 sats.
4788 let our_chans = vec![get_channel_details(Some(42), nodes[0].clone(), InitFeatures::from_le_bytes(vec![0b11]), 200_000_000)];
4791 // Attempt to route more than available results in a failure.
4792 let route_params = RouteParameters::from_payment_params_and_value(
4793 payment_params.clone(), 200_000_001);
4794 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4795 &our_id, &route_params, &network_graph.read_only(),
4796 Some(&our_chans.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
4797 &Default::default(), &random_seed_bytes) {
4798 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4799 } else { panic!(); }
4803 // Now, attempt to route an exact amount we have should be fine.
4804 let route_params = RouteParameters::from_payment_params_and_value(
4805 payment_params.clone(), 200_000_000);
4806 let route = get_route(&our_id, &route_params, &network_graph.read_only(),
4807 Some(&our_chans.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
4808 &Default::default(), &random_seed_bytes).unwrap();
4809 assert_eq!(route.paths.len(), 1);
4810 let path = route.paths.last().unwrap();
4811 assert_eq!(path.hops.len(), 2);
4812 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
4813 assert_eq!(path.final_value_msat(), 200_000_000);
4816 // Enable channel #1 back.
4817 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4818 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4819 short_channel_id: 1,
4822 cltv_expiry_delta: 0,
4823 htlc_minimum_msat: 0,
4824 htlc_maximum_msat: 1_000_000_000,
4826 fee_proportional_millionths: 0,
4827 excess_data: Vec::new()
4831 // Now let's see if routing works if we know only htlc_maximum_msat.
4832 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4833 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4834 short_channel_id: 3,
4837 cltv_expiry_delta: 0,
4838 htlc_minimum_msat: 0,
4839 htlc_maximum_msat: 15_000,
4841 fee_proportional_millionths: 0,
4842 excess_data: Vec::new()
4846 // Attempt to route more than available results in a failure.
4847 let route_params = RouteParameters::from_payment_params_and_value(
4848 payment_params.clone(), 15_001);
4849 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4850 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
4851 &scorer, &Default::default(), &random_seed_bytes) {
4852 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4853 } else { panic!(); }
4857 // Now, attempt to route an exact amount we have should be fine.
4858 let route_params = RouteParameters::from_payment_params_and_value(
4859 payment_params.clone(), 15_000);
4860 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4861 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4862 assert_eq!(route.paths.len(), 1);
4863 let path = route.paths.last().unwrap();
4864 assert_eq!(path.hops.len(), 2);
4865 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
4866 assert_eq!(path.final_value_msat(), 15_000);
4869 // Now let's see if routing works if we know only capacity from the UTXO.
4871 // We can't change UTXO capacity on the fly, so we'll disable
4872 // the existing channel and add another one with the capacity we need.
4873 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4874 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4875 short_channel_id: 3,
4878 cltv_expiry_delta: 0,
4879 htlc_minimum_msat: 0,
4880 htlc_maximum_msat: MAX_VALUE_MSAT,
4882 fee_proportional_millionths: 0,
4883 excess_data: Vec::new()
4886 let good_script = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2)
4887 .push_slice(&PublicKey::from_secret_key(&secp_ctx, &privkeys[0]).serialize())
4888 .push_slice(&PublicKey::from_secret_key(&secp_ctx, &privkeys[2]).serialize())
4889 .push_opcode(opcodes::all::OP_PUSHNUM_2)
4890 .push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script().to_v0_p2wsh();
4892 *chain_monitor.utxo_ret.lock().unwrap() =
4893 UtxoResult::Sync(Ok(TxOut { value: 15, script_pubkey: good_script.clone() }));
4894 gossip_sync.add_utxo_lookup(Some(chain_monitor));
4896 add_channel(&gossip_sync, &secp_ctx, &privkeys[0], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(3)), 333);
4897 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4898 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4899 short_channel_id: 333,
4902 cltv_expiry_delta: (3 << 4) | 1,
4903 htlc_minimum_msat: 0,
4904 htlc_maximum_msat: 15_000,
4906 fee_proportional_millionths: 0,
4907 excess_data: Vec::new()
4909 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4910 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4911 short_channel_id: 333,
4914 cltv_expiry_delta: (3 << 4) | 2,
4915 htlc_minimum_msat: 0,
4916 htlc_maximum_msat: 15_000,
4918 fee_proportional_millionths: 0,
4919 excess_data: Vec::new()
4923 // Attempt to route more than available results in a failure.
4924 let route_params = RouteParameters::from_payment_params_and_value(
4925 payment_params.clone(), 15_001);
4926 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4927 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
4928 &scorer, &Default::default(), &random_seed_bytes) {
4929 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4930 } else { panic!(); }
4934 // Now, attempt to route an exact amount we have should be fine.
4935 let route_params = RouteParameters::from_payment_params_and_value(
4936 payment_params.clone(), 15_000);
4937 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4938 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4939 assert_eq!(route.paths.len(), 1);
4940 let path = route.paths.last().unwrap();
4941 assert_eq!(path.hops.len(), 2);
4942 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
4943 assert_eq!(path.final_value_msat(), 15_000);
4946 // Now let's see if routing chooses htlc_maximum_msat over UTXO capacity.
4947 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4948 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4949 short_channel_id: 333,
4952 cltv_expiry_delta: 0,
4953 htlc_minimum_msat: 0,
4954 htlc_maximum_msat: 10_000,
4956 fee_proportional_millionths: 0,
4957 excess_data: Vec::new()
4961 // Attempt to route more than available results in a failure.
4962 let route_params = RouteParameters::from_payment_params_and_value(
4963 payment_params.clone(), 10_001);
4964 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4965 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
4966 &scorer, &Default::default(), &random_seed_bytes) {
4967 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4968 } else { panic!(); }
4972 // Now, attempt to route an exact amount we have should be fine.
4973 let route_params = RouteParameters::from_payment_params_and_value(
4974 payment_params.clone(), 10_000);
4975 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4976 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4977 assert_eq!(route.paths.len(), 1);
4978 let path = route.paths.last().unwrap();
4979 assert_eq!(path.hops.len(), 2);
4980 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
4981 assert_eq!(path.final_value_msat(), 10_000);
4986 fn available_liquidity_last_hop_test() {
4987 // Check that available liquidity properly limits the path even when only
4988 // one of the latter hops is limited.
4989 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
4990 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4991 let scorer = ln_test_utils::TestScorer::new();
4992 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4993 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4994 let config = UserConfig::default();
4995 let payment_params = PaymentParameters::from_node_id(nodes[3], 42)
4996 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
4999 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
5000 // {12, 13, 11} have the capacities of 100, {6} has a capacity of 50.
5001 // Total capacity: 50 sats.
5003 // Disable other potential paths.
5004 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5005 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5006 short_channel_id: 2,
5009 cltv_expiry_delta: 0,
5010 htlc_minimum_msat: 0,
5011 htlc_maximum_msat: 100_000,
5013 fee_proportional_millionths: 0,
5014 excess_data: Vec::new()
5016 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5017 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5018 short_channel_id: 7,
5021 cltv_expiry_delta: 0,
5022 htlc_minimum_msat: 0,
5023 htlc_maximum_msat: 100_000,
5025 fee_proportional_millionths: 0,
5026 excess_data: Vec::new()
5031 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5032 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5033 short_channel_id: 12,
5036 cltv_expiry_delta: 0,
5037 htlc_minimum_msat: 0,
5038 htlc_maximum_msat: 100_000,
5040 fee_proportional_millionths: 0,
5041 excess_data: Vec::new()
5043 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
5044 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5045 short_channel_id: 13,
5048 cltv_expiry_delta: 0,
5049 htlc_minimum_msat: 0,
5050 htlc_maximum_msat: 100_000,
5052 fee_proportional_millionths: 0,
5053 excess_data: Vec::new()
5056 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5057 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5058 short_channel_id: 6,
5061 cltv_expiry_delta: 0,
5062 htlc_minimum_msat: 0,
5063 htlc_maximum_msat: 50_000,
5065 fee_proportional_millionths: 0,
5066 excess_data: Vec::new()
5068 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
5069 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5070 short_channel_id: 11,
5073 cltv_expiry_delta: 0,
5074 htlc_minimum_msat: 0,
5075 htlc_maximum_msat: 100_000,
5077 fee_proportional_millionths: 0,
5078 excess_data: Vec::new()
5081 // Attempt to route more than available results in a failure.
5082 let route_params = RouteParameters::from_payment_params_and_value(
5083 payment_params.clone(), 60_000);
5084 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5085 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
5086 &scorer, &Default::default(), &random_seed_bytes) {
5087 assert_eq!(err, "Failed to find a sufficient route to the given destination");
5088 } else { panic!(); }
5092 // Now, attempt to route 49 sats (just a bit below the capacity).
5093 let route_params = RouteParameters::from_payment_params_and_value(
5094 payment_params.clone(), 49_000);
5095 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5096 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5097 assert_eq!(route.paths.len(), 1);
5098 let mut total_amount_paid_msat = 0;
5099 for path in &route.paths {
5100 assert_eq!(path.hops.len(), 4);
5101 assert_eq!(path.hops.last().unwrap().pubkey, nodes[3]);
5102 total_amount_paid_msat += path.final_value_msat();
5104 assert_eq!(total_amount_paid_msat, 49_000);
5108 // Attempt to route an exact amount is also fine
5109 let route_params = RouteParameters::from_payment_params_and_value(
5110 payment_params, 50_000);
5111 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5112 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5113 assert_eq!(route.paths.len(), 1);
5114 let mut total_amount_paid_msat = 0;
5115 for path in &route.paths {
5116 assert_eq!(path.hops.len(), 4);
5117 assert_eq!(path.hops.last().unwrap().pubkey, nodes[3]);
5118 total_amount_paid_msat += path.final_value_msat();
5120 assert_eq!(total_amount_paid_msat, 50_000);
5125 fn ignore_fee_first_hop_test() {
5126 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5127 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5128 let scorer = ln_test_utils::TestScorer::new();
5129 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5130 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5131 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
5133 // Path via node0 is channels {1, 3}. Limit them to 100 and 50 sats (total limit 50).
5134 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5135 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5136 short_channel_id: 1,
5139 cltv_expiry_delta: 0,
5140 htlc_minimum_msat: 0,
5141 htlc_maximum_msat: 100_000,
5142 fee_base_msat: 1_000_000,
5143 fee_proportional_millionths: 0,
5144 excess_data: Vec::new()
5146 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
5147 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5148 short_channel_id: 3,
5151 cltv_expiry_delta: 0,
5152 htlc_minimum_msat: 0,
5153 htlc_maximum_msat: 50_000,
5155 fee_proportional_millionths: 0,
5156 excess_data: Vec::new()
5160 let route_params = RouteParameters::from_payment_params_and_value(
5161 payment_params, 50_000);
5162 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5163 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5164 assert_eq!(route.paths.len(), 1);
5165 let mut total_amount_paid_msat = 0;
5166 for path in &route.paths {
5167 assert_eq!(path.hops.len(), 2);
5168 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
5169 total_amount_paid_msat += path.final_value_msat();
5171 assert_eq!(total_amount_paid_msat, 50_000);
5176 fn simple_mpp_route_test() {
5177 let (secp_ctx, _, _, _, _) = build_graph();
5178 let (_, _, _, nodes) = get_nodes(&secp_ctx);
5179 let config = UserConfig::default();
5180 let clear_payment_params = PaymentParameters::from_node_id(nodes[2], 42)
5181 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
5183 do_simple_mpp_route_test(clear_payment_params);
5185 // MPP to a 1-hop blinded path for nodes[2]
5186 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
5187 let blinded_path = BlindedPath {
5188 introduction_node: IntroductionNode::NodeId(nodes[2]),
5189 blinding_point: ln_test_utils::pubkey(42),
5190 blinded_hops: vec![BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }],
5192 let blinded_payinfo = BlindedPayInfo { // These fields are ignored for 1-hop blinded paths
5194 fee_proportional_millionths: 0,
5195 htlc_minimum_msat: 0,
5196 htlc_maximum_msat: 0,
5197 cltv_expiry_delta: 0,
5198 features: BlindedHopFeatures::empty(),
5200 let one_hop_blinded_payment_params = PaymentParameters::blinded(vec![(blinded_payinfo.clone(), blinded_path.clone())])
5201 .with_bolt12_features(bolt12_features.clone()).unwrap();
5202 do_simple_mpp_route_test(one_hop_blinded_payment_params.clone());
5204 // MPP to 3 2-hop blinded paths
5205 let mut blinded_path_node_0 = blinded_path.clone();
5206 blinded_path_node_0.introduction_node = IntroductionNode::NodeId(nodes[0]);
5207 blinded_path_node_0.blinded_hops.push(blinded_path.blinded_hops[0].clone());
5208 let mut node_0_payinfo = blinded_payinfo.clone();
5209 node_0_payinfo.htlc_maximum_msat = 50_000;
5211 let mut blinded_path_node_7 = blinded_path_node_0.clone();
5212 blinded_path_node_7.introduction_node = IntroductionNode::NodeId(nodes[7]);
5213 let mut node_7_payinfo = blinded_payinfo.clone();
5214 node_7_payinfo.htlc_maximum_msat = 60_000;
5216 let mut blinded_path_node_1 = blinded_path_node_0.clone();
5217 blinded_path_node_1.introduction_node = IntroductionNode::NodeId(nodes[1]);
5218 let mut node_1_payinfo = blinded_payinfo.clone();
5219 node_1_payinfo.htlc_maximum_msat = 180_000;
5221 let two_hop_blinded_payment_params = PaymentParameters::blinded(
5223 (node_0_payinfo, blinded_path_node_0),
5224 (node_7_payinfo, blinded_path_node_7),
5225 (node_1_payinfo, blinded_path_node_1)
5227 .with_bolt12_features(bolt12_features).unwrap();
5228 do_simple_mpp_route_test(two_hop_blinded_payment_params);
5232 fn do_simple_mpp_route_test(payment_params: PaymentParameters) {
5233 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5234 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5235 let scorer = ln_test_utils::TestScorer::new();
5236 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5237 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5239 // We need a route consisting of 3 paths:
5240 // From our node to node2 via node0, node7, node1 (three paths one hop each).
5241 // To achieve this, the amount being transferred should be around
5242 // the total capacity of these 3 paths.
5244 // First, we set limits on these (previously unlimited) channels.
5245 // Their aggregate capacity will be 50 + 60 + 180 = 290 sats.
5247 // Path via node0 is channels {1, 3}. Limit them to 100 and 50 sats (total limit 50).
5248 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5249 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5250 short_channel_id: 1,
5253 cltv_expiry_delta: 0,
5254 htlc_minimum_msat: 0,
5255 htlc_maximum_msat: 100_000,
5257 fee_proportional_millionths: 0,
5258 excess_data: Vec::new()
5260 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
5261 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5262 short_channel_id: 3,
5265 cltv_expiry_delta: 0,
5266 htlc_minimum_msat: 0,
5267 htlc_maximum_msat: 50_000,
5269 fee_proportional_millionths: 0,
5270 excess_data: Vec::new()
5273 // Path via node7 is channels {12, 13}. Limit them to 60 and 60 sats
5274 // (total limit 60).
5275 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5276 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5277 short_channel_id: 12,
5280 cltv_expiry_delta: 0,
5281 htlc_minimum_msat: 0,
5282 htlc_maximum_msat: 60_000,
5284 fee_proportional_millionths: 0,
5285 excess_data: Vec::new()
5287 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
5288 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5289 short_channel_id: 13,
5292 cltv_expiry_delta: 0,
5293 htlc_minimum_msat: 0,
5294 htlc_maximum_msat: 60_000,
5296 fee_proportional_millionths: 0,
5297 excess_data: Vec::new()
5300 // Path via node1 is channels {2, 4}. Limit them to 200 and 180 sats
5301 // (total capacity 180 sats).
5302 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5303 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5304 short_channel_id: 2,
5307 cltv_expiry_delta: 0,
5308 htlc_minimum_msat: 0,
5309 htlc_maximum_msat: 200_000,
5311 fee_proportional_millionths: 0,
5312 excess_data: Vec::new()
5314 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
5315 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5316 short_channel_id: 4,
5319 cltv_expiry_delta: 0,
5320 htlc_minimum_msat: 0,
5321 htlc_maximum_msat: 180_000,
5323 fee_proportional_millionths: 0,
5324 excess_data: Vec::new()
5328 // Attempt to route more than available results in a failure.
5329 let route_params = RouteParameters::from_payment_params_and_value(
5330 payment_params.clone(), 300_000);
5331 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5332 &our_id, &route_params, &network_graph.read_only(), None,
5333 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes) {
5334 assert_eq!(err, "Failed to find a sufficient route to the given destination");
5335 } else { panic!(); }
5339 // Attempt to route while setting max_path_count to 0 results in a failure.
5340 let zero_payment_params = payment_params.clone().with_max_path_count(0);
5341 let route_params = RouteParameters::from_payment_params_and_value(
5342 zero_payment_params, 100);
5343 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5344 &our_id, &route_params, &network_graph.read_only(), None,
5345 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes) {
5346 assert_eq!(err, "Can't find a route with no paths allowed.");
5347 } else { panic!(); }
5351 // Attempt to route while setting max_path_count to 3 results in a failure.
5352 // This is the case because the minimal_value_contribution_msat would require each path
5353 // to account for 1/3 of the total value, which is violated by 2 out of 3 paths.
5354 let fail_payment_params = payment_params.clone().with_max_path_count(3);
5355 let route_params = RouteParameters::from_payment_params_and_value(
5356 fail_payment_params, 250_000);
5357 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5358 &our_id, &route_params, &network_graph.read_only(), None,
5359 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes) {
5360 assert_eq!(err, "Failed to find a sufficient route to the given destination");
5361 } else { panic!(); }
5365 // Now, attempt to route 250 sats (just a bit below the capacity).
5366 // Our algorithm should provide us with these 3 paths.
5367 let route_params = RouteParameters::from_payment_params_and_value(
5368 payment_params.clone(), 250_000);
5369 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5370 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5371 assert_eq!(route.paths.len(), 3);
5372 let mut total_amount_paid_msat = 0;
5373 for path in &route.paths {
5374 if let Some(bt) = &path.blinded_tail {
5375 assert_eq!(path.hops.len() + if bt.hops.len() == 1 { 0 } else { 1 }, 2);
5377 assert_eq!(path.hops.len(), 2);
5378 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
5380 total_amount_paid_msat += path.final_value_msat();
5382 assert_eq!(total_amount_paid_msat, 250_000);
5386 // Attempt to route an exact amount is also fine
5387 let route_params = RouteParameters::from_payment_params_and_value(
5388 payment_params.clone(), 290_000);
5389 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5390 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5391 assert_eq!(route.paths.len(), 3);
5392 let mut total_amount_paid_msat = 0;
5393 for path in &route.paths {
5394 if payment_params.payee.blinded_route_hints().len() != 0 {
5395 assert!(path.blinded_tail.is_some()) } else { assert!(path.blinded_tail.is_none()) }
5396 if let Some(bt) = &path.blinded_tail {
5397 assert_eq!(path.hops.len() + if bt.hops.len() == 1 { 0 } else { 1 }, 2);
5398 if bt.hops.len() > 1 {
5399 let network_graph = network_graph.read_only();
5401 NodeId::from_pubkey(&path.hops.last().unwrap().pubkey),
5402 payment_params.payee.blinded_route_hints().iter()
5403 .find(|(p, _)| p.htlc_maximum_msat == path.final_value_msat())
5404 .and_then(|(_, p)| p.public_introduction_node_id(&network_graph))
5409 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
5412 assert_eq!(path.hops.len(), 2);
5413 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
5415 total_amount_paid_msat += path.final_value_msat();
5417 assert_eq!(total_amount_paid_msat, 290_000);
5422 fn long_mpp_route_test() {
5423 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5424 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5425 let scorer = ln_test_utils::TestScorer::new();
5426 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5427 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5428 let config = UserConfig::default();
5429 let payment_params = PaymentParameters::from_node_id(nodes[3], 42)
5430 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
5433 // We need a route consisting of 3 paths:
5434 // From our node to node3 via {node0, node2}, {node7, node2, node4} and {node7, node2}.
5435 // Note that these paths overlap (channels 5, 12, 13).
5436 // We will route 300 sats.
5437 // Each path will have 100 sats capacity, those channels which
5438 // are used twice will have 200 sats capacity.
5440 // Disable other potential paths.
5441 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5442 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5443 short_channel_id: 2,
5446 cltv_expiry_delta: 0,
5447 htlc_minimum_msat: 0,
5448 htlc_maximum_msat: 100_000,
5450 fee_proportional_millionths: 0,
5451 excess_data: Vec::new()
5453 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5454 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5455 short_channel_id: 7,
5458 cltv_expiry_delta: 0,
5459 htlc_minimum_msat: 0,
5460 htlc_maximum_msat: 100_000,
5462 fee_proportional_millionths: 0,
5463 excess_data: Vec::new()
5466 // Path via {node0, node2} is channels {1, 3, 5}.
5467 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5468 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5469 short_channel_id: 1,
5472 cltv_expiry_delta: 0,
5473 htlc_minimum_msat: 0,
5474 htlc_maximum_msat: 100_000,
5476 fee_proportional_millionths: 0,
5477 excess_data: Vec::new()
5479 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
5480 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5481 short_channel_id: 3,
5484 cltv_expiry_delta: 0,
5485 htlc_minimum_msat: 0,
5486 htlc_maximum_msat: 100_000,
5488 fee_proportional_millionths: 0,
5489 excess_data: Vec::new()
5492 // Capacity of 200 sats because this channel will be used by 3rd path as well.
5493 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
5494 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5495 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5496 short_channel_id: 5,
5499 cltv_expiry_delta: 0,
5500 htlc_minimum_msat: 0,
5501 htlc_maximum_msat: 200_000,
5503 fee_proportional_millionths: 0,
5504 excess_data: Vec::new()
5507 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
5508 // Add 100 sats to the capacities of {12, 13}, because these channels
5509 // are also used for 3rd path. 100 sats for the rest. Total capacity: 100 sats.
5510 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5511 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5512 short_channel_id: 12,
5515 cltv_expiry_delta: 0,
5516 htlc_minimum_msat: 0,
5517 htlc_maximum_msat: 200_000,
5519 fee_proportional_millionths: 0,
5520 excess_data: Vec::new()
5522 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
5523 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5524 short_channel_id: 13,
5527 cltv_expiry_delta: 0,
5528 htlc_minimum_msat: 0,
5529 htlc_maximum_msat: 200_000,
5531 fee_proportional_millionths: 0,
5532 excess_data: Vec::new()
5535 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5536 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5537 short_channel_id: 6,
5540 cltv_expiry_delta: 0,
5541 htlc_minimum_msat: 0,
5542 htlc_maximum_msat: 100_000,
5544 fee_proportional_millionths: 0,
5545 excess_data: Vec::new()
5547 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
5548 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5549 short_channel_id: 11,
5552 cltv_expiry_delta: 0,
5553 htlc_minimum_msat: 0,
5554 htlc_maximum_msat: 100_000,
5556 fee_proportional_millionths: 0,
5557 excess_data: Vec::new()
5560 // Path via {node7, node2} is channels {12, 13, 5}.
5561 // We already limited them to 200 sats (they are used twice for 100 sats).
5562 // Nothing to do here.
5565 // Attempt to route more than available results in a failure.
5566 let route_params = RouteParameters::from_payment_params_and_value(
5567 payment_params.clone(), 350_000);
5568 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5569 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
5570 &scorer, &Default::default(), &random_seed_bytes) {
5571 assert_eq!(err, "Failed to find a sufficient route to the given destination");
5572 } else { panic!(); }
5576 // Now, attempt to route 300 sats (exact amount we can route).
5577 // Our algorithm should provide us with these 3 paths, 100 sats each.
5578 let route_params = RouteParameters::from_payment_params_and_value(
5579 payment_params, 300_000);
5580 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5581 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5582 assert_eq!(route.paths.len(), 3);
5584 let mut total_amount_paid_msat = 0;
5585 for path in &route.paths {
5586 assert_eq!(path.hops.last().unwrap().pubkey, nodes[3]);
5587 total_amount_paid_msat += path.final_value_msat();
5589 assert_eq!(total_amount_paid_msat, 300_000);
5595 fn mpp_cheaper_route_test() {
5596 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5597 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5598 let scorer = ln_test_utils::TestScorer::new();
5599 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5600 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5601 let config = UserConfig::default();
5602 let payment_params = PaymentParameters::from_node_id(nodes[3], 42)
5603 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
5606 // This test checks that if we have two cheaper paths and one more expensive path,
5607 // so that liquidity-wise any 2 of 3 combination is sufficient,
5608 // two cheaper paths will be taken.
5609 // These paths have equal available liquidity.
5611 // We need a combination of 3 paths:
5612 // From our node to node3 via {node0, node2}, {node7, node2, node4} and {node7, node2}.
5613 // Note that these paths overlap (channels 5, 12, 13).
5614 // Each path will have 100 sats capacity, those channels which
5615 // are used twice will have 200 sats capacity.
5617 // Disable other potential paths.
5618 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5619 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5620 short_channel_id: 2,
5623 cltv_expiry_delta: 0,
5624 htlc_minimum_msat: 0,
5625 htlc_maximum_msat: 100_000,
5627 fee_proportional_millionths: 0,
5628 excess_data: Vec::new()
5630 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5631 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5632 short_channel_id: 7,
5635 cltv_expiry_delta: 0,
5636 htlc_minimum_msat: 0,
5637 htlc_maximum_msat: 100_000,
5639 fee_proportional_millionths: 0,
5640 excess_data: Vec::new()
5643 // Path via {node0, node2} is channels {1, 3, 5}.
5644 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5645 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5646 short_channel_id: 1,
5649 cltv_expiry_delta: 0,
5650 htlc_minimum_msat: 0,
5651 htlc_maximum_msat: 100_000,
5653 fee_proportional_millionths: 0,
5654 excess_data: Vec::new()
5656 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
5657 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5658 short_channel_id: 3,
5661 cltv_expiry_delta: 0,
5662 htlc_minimum_msat: 0,
5663 htlc_maximum_msat: 100_000,
5665 fee_proportional_millionths: 0,
5666 excess_data: Vec::new()
5669 // Capacity of 200 sats because this channel will be used by 3rd path as well.
5670 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
5671 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5672 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5673 short_channel_id: 5,
5676 cltv_expiry_delta: 0,
5677 htlc_minimum_msat: 0,
5678 htlc_maximum_msat: 200_000,
5680 fee_proportional_millionths: 0,
5681 excess_data: Vec::new()
5684 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
5685 // Add 100 sats to the capacities of {12, 13}, because these channels
5686 // are also used for 3rd path. 100 sats for the rest. Total capacity: 100 sats.
5687 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5688 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5689 short_channel_id: 12,
5692 cltv_expiry_delta: 0,
5693 htlc_minimum_msat: 0,
5694 htlc_maximum_msat: 200_000,
5696 fee_proportional_millionths: 0,
5697 excess_data: Vec::new()
5699 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
5700 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5701 short_channel_id: 13,
5704 cltv_expiry_delta: 0,
5705 htlc_minimum_msat: 0,
5706 htlc_maximum_msat: 200_000,
5708 fee_proportional_millionths: 0,
5709 excess_data: Vec::new()
5712 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5713 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5714 short_channel_id: 6,
5717 cltv_expiry_delta: 0,
5718 htlc_minimum_msat: 0,
5719 htlc_maximum_msat: 100_000,
5720 fee_base_msat: 1_000,
5721 fee_proportional_millionths: 0,
5722 excess_data: Vec::new()
5724 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
5725 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5726 short_channel_id: 11,
5729 cltv_expiry_delta: 0,
5730 htlc_minimum_msat: 0,
5731 htlc_maximum_msat: 100_000,
5733 fee_proportional_millionths: 0,
5734 excess_data: Vec::new()
5737 // Path via {node7, node2} is channels {12, 13, 5}.
5738 // We already limited them to 200 sats (they are used twice for 100 sats).
5739 // Nothing to do here.
5742 // Now, attempt to route 180 sats.
5743 // Our algorithm should provide us with these 2 paths.
5744 let route_params = RouteParameters::from_payment_params_and_value(
5745 payment_params, 180_000);
5746 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5747 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5748 assert_eq!(route.paths.len(), 2);
5750 let mut total_value_transferred_msat = 0;
5751 let mut total_paid_msat = 0;
5752 for path in &route.paths {
5753 assert_eq!(path.hops.last().unwrap().pubkey, nodes[3]);
5754 total_value_transferred_msat += path.final_value_msat();
5755 for hop in &path.hops {
5756 total_paid_msat += hop.fee_msat;
5759 // If we paid fee, this would be higher.
5760 assert_eq!(total_value_transferred_msat, 180_000);
5761 let total_fees_paid = total_paid_msat - total_value_transferred_msat;
5762 assert_eq!(total_fees_paid, 0);
5767 fn fees_on_mpp_route_test() {
5768 // This test makes sure that MPP algorithm properly takes into account
5769 // fees charged on the channels, by making the fees impactful:
5770 // if the fee is not properly accounted for, the behavior is different.
5771 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5772 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5773 let scorer = ln_test_utils::TestScorer::new();
5774 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5775 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5776 let config = UserConfig::default();
5777 let payment_params = PaymentParameters::from_node_id(nodes[3], 42)
5778 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
5781 // We need a route consisting of 2 paths:
5782 // From our node to node3 via {node0, node2} and {node7, node2, node4}.
5783 // We will route 200 sats, Each path will have 100 sats capacity.
5785 // This test is not particularly stable: e.g.,
5786 // there's a way to route via {node0, node2, node4}.
5787 // It works while pathfinding is deterministic, but can be broken otherwise.
5788 // It's fine to ignore this concern for now.
5790 // Disable other potential paths.
5791 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5792 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5793 short_channel_id: 2,
5796 cltv_expiry_delta: 0,
5797 htlc_minimum_msat: 0,
5798 htlc_maximum_msat: 100_000,
5800 fee_proportional_millionths: 0,
5801 excess_data: Vec::new()
5804 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5805 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5806 short_channel_id: 7,
5809 cltv_expiry_delta: 0,
5810 htlc_minimum_msat: 0,
5811 htlc_maximum_msat: 100_000,
5813 fee_proportional_millionths: 0,
5814 excess_data: Vec::new()
5817 // Path via {node0, node2} is channels {1, 3, 5}.
5818 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5819 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5820 short_channel_id: 1,
5823 cltv_expiry_delta: 0,
5824 htlc_minimum_msat: 0,
5825 htlc_maximum_msat: 100_000,
5827 fee_proportional_millionths: 0,
5828 excess_data: Vec::new()
5830 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
5831 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5832 short_channel_id: 3,
5835 cltv_expiry_delta: 0,
5836 htlc_minimum_msat: 0,
5837 htlc_maximum_msat: 100_000,
5839 fee_proportional_millionths: 0,
5840 excess_data: Vec::new()
5843 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
5844 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5845 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5846 short_channel_id: 5,
5849 cltv_expiry_delta: 0,
5850 htlc_minimum_msat: 0,
5851 htlc_maximum_msat: 100_000,
5853 fee_proportional_millionths: 0,
5854 excess_data: Vec::new()
5857 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
5858 // All channels should be 100 sats capacity. But for the fee experiment,
5859 // we'll add absolute fee of 150 sats paid for the use channel 6 (paid to node2 on channel 13).
5860 // Since channel 12 allows to deliver only 250 sats to channel 13, channel 13 can transfer only
5861 // 100 sats (and pay 150 sats in fees for the use of channel 6),
5862 // so no matter how large are other channels,
5863 // the whole path will be limited by 100 sats with just these 2 conditions:
5864 // - channel 12 capacity is 250 sats
5865 // - fee for channel 6 is 150 sats
5866 // Let's test this by enforcing these 2 conditions and removing other limits.
5867 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5868 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5869 short_channel_id: 12,
5872 cltv_expiry_delta: 0,
5873 htlc_minimum_msat: 0,
5874 htlc_maximum_msat: 250_000,
5876 fee_proportional_millionths: 0,
5877 excess_data: Vec::new()
5879 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
5880 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5881 short_channel_id: 13,
5884 cltv_expiry_delta: 0,
5885 htlc_minimum_msat: 0,
5886 htlc_maximum_msat: MAX_VALUE_MSAT,
5888 fee_proportional_millionths: 0,
5889 excess_data: Vec::new()
5892 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5893 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5894 short_channel_id: 6,
5897 cltv_expiry_delta: 0,
5898 htlc_minimum_msat: 0,
5899 htlc_maximum_msat: MAX_VALUE_MSAT,
5900 fee_base_msat: 150_000,
5901 fee_proportional_millionths: 0,
5902 excess_data: Vec::new()
5904 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
5905 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5906 short_channel_id: 11,
5909 cltv_expiry_delta: 0,
5910 htlc_minimum_msat: 0,
5911 htlc_maximum_msat: MAX_VALUE_MSAT,
5913 fee_proportional_millionths: 0,
5914 excess_data: Vec::new()
5918 // Attempt to route more than available results in a failure.
5919 let route_params = RouteParameters::from_payment_params_and_value(
5920 payment_params.clone(), 210_000);
5921 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5922 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
5923 &scorer, &Default::default(), &random_seed_bytes) {
5924 assert_eq!(err, "Failed to find a sufficient route to the given destination");
5925 } else { panic!(); }
5929 // Attempt to route while setting max_total_routing_fee_msat to 149_999 results in a failure.
5930 let route_params = RouteParameters { payment_params: payment_params.clone(), final_value_msat: 200_000,
5931 max_total_routing_fee_msat: Some(149_999) };
5932 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5933 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
5934 &scorer, &Default::default(), &random_seed_bytes) {
5935 assert_eq!(err, "Failed to find a sufficient route to the given destination");
5936 } else { panic!(); }
5940 // Now, attempt to route 200 sats (exact amount we can route).
5941 let route_params = RouteParameters { payment_params: payment_params.clone(), final_value_msat: 200_000,
5942 max_total_routing_fee_msat: Some(150_000) };
5943 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5944 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5945 assert_eq!(route.paths.len(), 2);
5947 let mut total_amount_paid_msat = 0;
5948 for path in &route.paths {
5949 assert_eq!(path.hops.last().unwrap().pubkey, nodes[3]);
5950 total_amount_paid_msat += path.final_value_msat();
5952 assert_eq!(total_amount_paid_msat, 200_000);
5953 assert_eq!(route.get_total_fees(), 150_000);
5958 fn mpp_with_last_hops() {
5959 // Previously, if we tried to send an MPP payment to a destination which was only reachable
5960 // via a single last-hop route hint, we'd fail to route if we first collected routes
5961 // totaling close but not quite enough to fund the full payment.
5963 // This was because we considered last-hop hints to have exactly the sought payment amount
5964 // instead of the amount we were trying to collect, needlessly limiting our path searching
5965 // at the very first hop.
5967 // Specifically, this interacted with our "all paths must fund at least 5% of total target"
5968 // criterion to cause us to refuse all routes at the last hop hint which would be considered
5969 // to only have the remaining to-collect amount in available liquidity.
5971 // This bug appeared in production in some specific channel configurations.
5972 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5973 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5974 let scorer = ln_test_utils::TestScorer::new();
5975 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5976 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5977 let config = UserConfig::default();
5978 let payment_params = PaymentParameters::from_node_id(PublicKey::from_slice(&[02; 33]).unwrap(), 42)
5979 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config)).unwrap()
5980 .with_route_hints(vec![RouteHint(vec![RouteHintHop {
5981 src_node_id: nodes[2],
5982 short_channel_id: 42,
5983 fees: RoutingFees { base_msat: 0, proportional_millionths: 0 },
5984 cltv_expiry_delta: 42,
5985 htlc_minimum_msat: None,
5986 htlc_maximum_msat: None,
5987 }])]).unwrap().with_max_channel_saturation_power_of_half(0);
5989 // Keep only two paths from us to nodes[2], both with a 99sat HTLC maximum, with one with
5990 // no fee and one with a 1msat fee. Previously, trying to route 100 sats to nodes[2] here
5991 // would first use the no-fee route and then fail to find a path along the second route as
5992 // we think we can only send up to 1 additional sat over the last-hop but refuse to as its
5993 // under 5% of our payment amount.
5994 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5995 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5996 short_channel_id: 1,
5999 cltv_expiry_delta: (5 << 4) | 5,
6000 htlc_minimum_msat: 0,
6001 htlc_maximum_msat: 99_000,
6002 fee_base_msat: u32::max_value(),
6003 fee_proportional_millionths: u32::max_value(),
6004 excess_data: Vec::new()
6006 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6007 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6008 short_channel_id: 2,
6011 cltv_expiry_delta: (5 << 4) | 3,
6012 htlc_minimum_msat: 0,
6013 htlc_maximum_msat: 99_000,
6014 fee_base_msat: u32::max_value(),
6015 fee_proportional_millionths: u32::max_value(),
6016 excess_data: Vec::new()
6018 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
6019 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6020 short_channel_id: 4,
6023 cltv_expiry_delta: (4 << 4) | 1,
6024 htlc_minimum_msat: 0,
6025 htlc_maximum_msat: MAX_VALUE_MSAT,
6027 fee_proportional_millionths: 0,
6028 excess_data: Vec::new()
6030 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
6031 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6032 short_channel_id: 13,
6034 flags: 0|2, // Channel disabled
6035 cltv_expiry_delta: (13 << 4) | 1,
6036 htlc_minimum_msat: 0,
6037 htlc_maximum_msat: MAX_VALUE_MSAT,
6039 fee_proportional_millionths: 2000000,
6040 excess_data: Vec::new()
6043 // Get a route for 100 sats and check that we found the MPP route no problem and didn't
6045 let route_params = RouteParameters::from_payment_params_and_value(
6046 payment_params, 100_000);
6047 let mut route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
6048 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6049 assert_eq!(route.paths.len(), 2);
6050 route.paths.sort_by_key(|path| path.hops[0].short_channel_id);
6051 // Paths are manually ordered ordered by SCID, so:
6052 // * the first is channel 1 (0 fee, but 99 sat maximum) -> channel 3 -> channel 42
6053 // * the second is channel 2 (1 msat fee) -> channel 4 -> channel 42
6054 assert_eq!(route.paths[0].hops[0].short_channel_id, 1);
6055 assert_eq!(route.paths[0].hops[0].fee_msat, 0);
6056 assert_eq!(route.paths[0].hops[2].fee_msat, 99_000);
6057 assert_eq!(route.paths[1].hops[0].short_channel_id, 2);
6058 assert_eq!(route.paths[1].hops[0].fee_msat, 1);
6059 assert_eq!(route.paths[1].hops[2].fee_msat, 1_000);
6060 assert_eq!(route.get_total_fees(), 1);
6061 assert_eq!(route.get_total_amount(), 100_000);
6065 fn drop_lowest_channel_mpp_route_test() {
6066 // This test checks that low-capacity channel is dropped when after
6067 // path finding we realize that we found more capacity than we need.
6068 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
6069 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
6070 let scorer = ln_test_utils::TestScorer::new();
6071 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6072 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6073 let config = UserConfig::default();
6074 let payment_params = PaymentParameters::from_node_id(nodes[2], 42)
6075 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
6077 .with_max_channel_saturation_power_of_half(0);
6079 // We need a route consisting of 3 paths:
6080 // From our node to node2 via node0, node7, node1 (three paths one hop each).
6082 // The first and the second paths should be sufficient, but the third should be
6083 // cheaper, so that we select it but drop later.
6085 // First, we set limits on these (previously unlimited) channels.
6086 // Their aggregate capacity will be 50 + 60 + 20 = 130 sats.
6088 // Path via node0 is channels {1, 3}. Limit them to 100 and 50 sats (total limit 50);
6089 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6090 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6091 short_channel_id: 1,
6094 cltv_expiry_delta: 0,
6095 htlc_minimum_msat: 0,
6096 htlc_maximum_msat: 100_000,
6098 fee_proportional_millionths: 0,
6099 excess_data: Vec::new()
6101 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
6102 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6103 short_channel_id: 3,
6106 cltv_expiry_delta: 0,
6107 htlc_minimum_msat: 0,
6108 htlc_maximum_msat: 50_000,
6110 fee_proportional_millionths: 0,
6111 excess_data: Vec::new()
6114 // Path via node7 is channels {12, 13}. Limit them to 60 and 60 sats (total limit 60);
6115 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6116 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6117 short_channel_id: 12,
6120 cltv_expiry_delta: 0,
6121 htlc_minimum_msat: 0,
6122 htlc_maximum_msat: 60_000,
6124 fee_proportional_millionths: 0,
6125 excess_data: Vec::new()
6127 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
6128 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6129 short_channel_id: 13,
6132 cltv_expiry_delta: 0,
6133 htlc_minimum_msat: 0,
6134 htlc_maximum_msat: 60_000,
6136 fee_proportional_millionths: 0,
6137 excess_data: Vec::new()
6140 // Path via node1 is channels {2, 4}. Limit them to 20 and 20 sats (total capacity 20 sats).
6141 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6142 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6143 short_channel_id: 2,
6146 cltv_expiry_delta: 0,
6147 htlc_minimum_msat: 0,
6148 htlc_maximum_msat: 20_000,
6150 fee_proportional_millionths: 0,
6151 excess_data: Vec::new()
6153 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
6154 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6155 short_channel_id: 4,
6158 cltv_expiry_delta: 0,
6159 htlc_minimum_msat: 0,
6160 htlc_maximum_msat: 20_000,
6162 fee_proportional_millionths: 0,
6163 excess_data: Vec::new()
6167 // Attempt to route more than available results in a failure.
6168 let route_params = RouteParameters::from_payment_params_and_value(
6169 payment_params.clone(), 150_000);
6170 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
6171 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
6172 &scorer, &Default::default(), &random_seed_bytes) {
6173 assert_eq!(err, "Failed to find a sufficient route to the given destination");
6174 } else { panic!(); }
6178 // Now, attempt to route 125 sats (just a bit below the capacity of 3 channels).
6179 // Our algorithm should provide us with these 3 paths.
6180 let route_params = RouteParameters::from_payment_params_and_value(
6181 payment_params.clone(), 125_000);
6182 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
6183 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6184 assert_eq!(route.paths.len(), 3);
6185 let mut total_amount_paid_msat = 0;
6186 for path in &route.paths {
6187 assert_eq!(path.hops.len(), 2);
6188 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
6189 total_amount_paid_msat += path.final_value_msat();
6191 assert_eq!(total_amount_paid_msat, 125_000);
6195 // Attempt to route without the last small cheap channel
6196 let route_params = RouteParameters::from_payment_params_and_value(
6197 payment_params, 90_000);
6198 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
6199 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6200 assert_eq!(route.paths.len(), 2);
6201 let mut total_amount_paid_msat = 0;
6202 for path in &route.paths {
6203 assert_eq!(path.hops.len(), 2);
6204 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
6205 total_amount_paid_msat += path.final_value_msat();
6207 assert_eq!(total_amount_paid_msat, 90_000);
6212 fn min_criteria_consistency() {
6213 // Test that we don't use an inconsistent metric between updating and walking nodes during
6214 // our Dijkstra's pass. In the initial version of MPP, the "best source" for a given node
6215 // was updated with a different criterion from the heap sorting, resulting in loops in
6216 // calculated paths. We test for that specific case here.
6218 // We construct a network that looks like this:
6220 // node2 -1(3)2- node3
6224 // node1 -1(5)2- node4 -1(1)2- node6
6230 // We create a loop on the side of our real path - our destination is node 6, with a
6231 // previous hop of node 4. From 4, the cheapest previous path is channel 2 from node 2,
6232 // followed by node 3 over channel 3. Thereafter, the cheapest next-hop is back to node 4
6233 // (this time over channel 4). Channel 4 has 0 htlc_minimum_msat whereas channel 1 (the
6234 // other channel with a previous-hop of node 4) has a high (but irrelevant to the overall
6235 // payment) htlc_minimum_msat. In the original algorithm, this resulted in node4's
6236 // "previous hop" being set to node 3, creating a loop in the path.
6237 let secp_ctx = Secp256k1::new();
6238 let logger = Arc::new(ln_test_utils::TestLogger::new());
6239 let network = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
6240 let gossip_sync = P2PGossipSync::new(Arc::clone(&network), None, Arc::clone(&logger));
6241 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
6242 let scorer = ln_test_utils::TestScorer::new();
6243 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6244 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6245 let payment_params = PaymentParameters::from_node_id(nodes[6], 42);
6247 add_channel(&gossip_sync, &secp_ctx, &our_privkey, &privkeys[1], ChannelFeatures::from_le_bytes(id_to_feature_flags(6)), 6);
6248 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6249 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6250 short_channel_id: 6,
6253 cltv_expiry_delta: (6 << 4) | 0,
6254 htlc_minimum_msat: 0,
6255 htlc_maximum_msat: MAX_VALUE_MSAT,
6257 fee_proportional_millionths: 0,
6258 excess_data: Vec::new()
6260 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[1], NodeFeatures::from_le_bytes(id_to_feature_flags(1)), 0);
6262 add_channel(&gossip_sync, &secp_ctx, &privkeys[1], &privkeys[4], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
6263 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
6264 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6265 short_channel_id: 5,
6268 cltv_expiry_delta: (5 << 4) | 0,
6269 htlc_minimum_msat: 0,
6270 htlc_maximum_msat: MAX_VALUE_MSAT,
6272 fee_proportional_millionths: 0,
6273 excess_data: Vec::new()
6275 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[4], NodeFeatures::from_le_bytes(id_to_feature_flags(4)), 0);
6277 add_channel(&gossip_sync, &secp_ctx, &privkeys[4], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(4)), 4);
6278 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
6279 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6280 short_channel_id: 4,
6283 cltv_expiry_delta: (4 << 4) | 0,
6284 htlc_minimum_msat: 0,
6285 htlc_maximum_msat: MAX_VALUE_MSAT,
6287 fee_proportional_millionths: 0,
6288 excess_data: Vec::new()
6290 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[3], NodeFeatures::from_le_bytes(id_to_feature_flags(3)), 0);
6292 add_channel(&gossip_sync, &secp_ctx, &privkeys[3], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(3)), 3);
6293 update_channel(&gossip_sync, &secp_ctx, &privkeys[3], UnsignedChannelUpdate {
6294 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6295 short_channel_id: 3,
6298 cltv_expiry_delta: (3 << 4) | 0,
6299 htlc_minimum_msat: 0,
6300 htlc_maximum_msat: MAX_VALUE_MSAT,
6302 fee_proportional_millionths: 0,
6303 excess_data: Vec::new()
6305 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[2], NodeFeatures::from_le_bytes(id_to_feature_flags(2)), 0);
6307 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[4], ChannelFeatures::from_le_bytes(id_to_feature_flags(2)), 2);
6308 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
6309 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6310 short_channel_id: 2,
6313 cltv_expiry_delta: (2 << 4) | 0,
6314 htlc_minimum_msat: 0,
6315 htlc_maximum_msat: MAX_VALUE_MSAT,
6317 fee_proportional_millionths: 0,
6318 excess_data: Vec::new()
6321 add_channel(&gossip_sync, &secp_ctx, &privkeys[4], &privkeys[6], ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 1);
6322 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
6323 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6324 short_channel_id: 1,
6327 cltv_expiry_delta: (1 << 4) | 0,
6328 htlc_minimum_msat: 100,
6329 htlc_maximum_msat: MAX_VALUE_MSAT,
6331 fee_proportional_millionths: 0,
6332 excess_data: Vec::new()
6334 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[6], NodeFeatures::from_le_bytes(id_to_feature_flags(6)), 0);
6337 // Now ensure the route flows simply over nodes 1 and 4 to 6.
6338 let route_params = RouteParameters::from_payment_params_and_value(
6339 payment_params, 10_000);
6340 let route = get_route(&our_id, &route_params, &network.read_only(), None,
6341 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6342 assert_eq!(route.paths.len(), 1);
6343 assert_eq!(route.paths[0].hops.len(), 3);
6345 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
6346 assert_eq!(route.paths[0].hops[0].short_channel_id, 6);
6347 assert_eq!(route.paths[0].hops[0].fee_msat, 100);
6348 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (5 << 4) | 0);
6349 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(1));
6350 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(6));
6352 assert_eq!(route.paths[0].hops[1].pubkey, nodes[4]);
6353 assert_eq!(route.paths[0].hops[1].short_channel_id, 5);
6354 assert_eq!(route.paths[0].hops[1].fee_msat, 0);
6355 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (1 << 4) | 0);
6356 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(4));
6357 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(5));
6359 assert_eq!(route.paths[0].hops[2].pubkey, nodes[6]);
6360 assert_eq!(route.paths[0].hops[2].short_channel_id, 1);
6361 assert_eq!(route.paths[0].hops[2].fee_msat, 10_000);
6362 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, 42);
6363 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(6));
6364 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(1));
6370 fn exact_fee_liquidity_limit() {
6371 // Test that if, while walking the graph, we find a hop that has exactly enough liquidity
6372 // for us, including later hop fees, we take it. In the first version of our MPP algorithm
6373 // we calculated fees on a higher value, resulting in us ignoring such paths.
6374 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
6375 let (our_privkey, our_id, _, nodes) = get_nodes(&secp_ctx);
6376 let scorer = ln_test_utils::TestScorer::new();
6377 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6378 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6379 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
6381 // We modify the graph to set the htlc_maximum of channel 2 to below the value we wish to
6383 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6384 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6385 short_channel_id: 2,
6388 cltv_expiry_delta: 0,
6389 htlc_minimum_msat: 0,
6390 htlc_maximum_msat: 85_000,
6392 fee_proportional_millionths: 0,
6393 excess_data: Vec::new()
6396 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6397 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6398 short_channel_id: 12,
6401 cltv_expiry_delta: (4 << 4) | 1,
6402 htlc_minimum_msat: 0,
6403 htlc_maximum_msat: 270_000,
6405 fee_proportional_millionths: 1000000,
6406 excess_data: Vec::new()
6410 // Now, attempt to route 90 sats, which is exactly 90 sats at the last hop, plus the
6411 // 200% fee charged channel 13 in the 1-to-2 direction.
6412 let mut route_params = RouteParameters::from_payment_params_and_value(
6413 payment_params, 90_000);
6414 route_params.max_total_routing_fee_msat = Some(90_000*2);
6415 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
6416 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6417 assert_eq!(route.paths.len(), 1);
6418 assert_eq!(route.paths[0].hops.len(), 2);
6420 assert_eq!(route.paths[0].hops[0].pubkey, nodes[7]);
6421 assert_eq!(route.paths[0].hops[0].short_channel_id, 12);
6422 assert_eq!(route.paths[0].hops[0].fee_msat, 90_000*2);
6423 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (13 << 4) | 1);
6424 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(8));
6425 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(12));
6427 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
6428 assert_eq!(route.paths[0].hops[1].short_channel_id, 13);
6429 assert_eq!(route.paths[0].hops[1].fee_msat, 90_000);
6430 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
6431 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
6432 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(13));
6437 fn htlc_max_reduction_below_min() {
6438 // Test that if, while walking the graph, we reduce the value being sent to meet an
6439 // htlc_maximum_msat, we don't end up undershooting a later htlc_minimum_msat. In the
6440 // initial version of MPP we'd accept such routes but reject them while recalculating fees,
6441 // resulting in us thinking there is no possible path, even if other paths exist.
6442 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
6443 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
6444 let scorer = ln_test_utils::TestScorer::new();
6445 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6446 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6447 let config = UserConfig::default();
6448 let payment_params = PaymentParameters::from_node_id(nodes[2], 42)
6449 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
6452 // We modify the graph to set the htlc_minimum of channel 2 and 4 as needed - channel 2
6453 // gets an htlc_maximum_msat of 80_000 and channel 4 an htlc_minimum_msat of 90_000. We
6454 // then try to send 90_000.
6455 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6456 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6457 short_channel_id: 2,
6460 cltv_expiry_delta: 0,
6461 htlc_minimum_msat: 0,
6462 htlc_maximum_msat: 80_000,
6464 fee_proportional_millionths: 0,
6465 excess_data: Vec::new()
6467 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
6468 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6469 short_channel_id: 4,
6472 cltv_expiry_delta: (4 << 4) | 1,
6473 htlc_minimum_msat: 90_000,
6474 htlc_maximum_msat: MAX_VALUE_MSAT,
6476 fee_proportional_millionths: 0,
6477 excess_data: Vec::new()
6481 // Now, attempt to route 90 sats, hitting the htlc_minimum on channel 4, but
6482 // overshooting the htlc_maximum on channel 2. Thus, we should pick the (absurdly
6483 // expensive) channels 12-13 path.
6484 let mut route_params = RouteParameters::from_payment_params_and_value(
6485 payment_params, 90_000);
6486 route_params.max_total_routing_fee_msat = Some(90_000*2);
6487 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
6488 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6489 assert_eq!(route.paths.len(), 1);
6490 assert_eq!(route.paths[0].hops.len(), 2);
6492 assert_eq!(route.paths[0].hops[0].pubkey, nodes[7]);
6493 assert_eq!(route.paths[0].hops[0].short_channel_id, 12);
6494 assert_eq!(route.paths[0].hops[0].fee_msat, 90_000*2);
6495 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (13 << 4) | 1);
6496 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(8));
6497 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(12));
6499 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
6500 assert_eq!(route.paths[0].hops[1].short_channel_id, 13);
6501 assert_eq!(route.paths[0].hops[1].fee_msat, 90_000);
6502 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
6503 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), channelmanager::provided_bolt11_invoice_features(&config).le_flags());
6504 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(13));
6509 fn multiple_direct_first_hops() {
6510 // Previously we'd only ever considered one first hop path per counterparty.
6511 // However, as we don't restrict users to one channel per peer, we really need to support
6512 // looking at all first hop paths.
6513 // Here we test that we do not ignore all-but-the-last first hop paths per counterparty (as
6514 // we used to do by overwriting the `first_hop_targets` hashmap entry) and that we can MPP
6515 // route over multiple channels with the same first hop.
6516 let secp_ctx = Secp256k1::new();
6517 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6518 let logger = Arc::new(ln_test_utils::TestLogger::new());
6519 let network_graph = NetworkGraph::new(Network::Testnet, Arc::clone(&logger));
6520 let scorer = ln_test_utils::TestScorer::new();
6521 let config = UserConfig::default();
6522 let payment_params = PaymentParameters::from_node_id(nodes[0], 42)
6523 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
6525 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6526 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6529 let route_params = RouteParameters::from_payment_params_and_value(
6530 payment_params.clone(), 100_000);
6531 let route = get_route(&our_id, &route_params, &network_graph.read_only(), Some(&[
6532 &get_channel_details(Some(3), nodes[0], channelmanager::provided_init_features(&config), 200_000),
6533 &get_channel_details(Some(2), nodes[0], channelmanager::provided_init_features(&config), 10_000),
6534 ]), Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6535 assert_eq!(route.paths.len(), 1);
6536 assert_eq!(route.paths[0].hops.len(), 1);
6538 assert_eq!(route.paths[0].hops[0].pubkey, nodes[0]);
6539 assert_eq!(route.paths[0].hops[0].short_channel_id, 3);
6540 assert_eq!(route.paths[0].hops[0].fee_msat, 100_000);
6543 let route_params = RouteParameters::from_payment_params_and_value(
6544 payment_params.clone(), 100_000);
6545 let route = get_route(&our_id, &route_params, &network_graph.read_only(), Some(&[
6546 &get_channel_details(Some(3), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6547 &get_channel_details(Some(2), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6548 ]), Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6549 assert_eq!(route.paths.len(), 2);
6550 assert_eq!(route.paths[0].hops.len(), 1);
6551 assert_eq!(route.paths[1].hops.len(), 1);
6553 assert!((route.paths[0].hops[0].short_channel_id == 3 && route.paths[1].hops[0].short_channel_id == 2) ||
6554 (route.paths[0].hops[0].short_channel_id == 2 && route.paths[1].hops[0].short_channel_id == 3));
6556 assert_eq!(route.paths[0].hops[0].pubkey, nodes[0]);
6557 assert_eq!(route.paths[0].hops[0].fee_msat, 50_000);
6559 assert_eq!(route.paths[1].hops[0].pubkey, nodes[0]);
6560 assert_eq!(route.paths[1].hops[0].fee_msat, 50_000);
6564 // If we have a bunch of outbound channels to the same node, where most are not
6565 // sufficient to pay the full payment, but one is, we should default to just using the
6566 // one single channel that has sufficient balance, avoiding MPP.
6568 // If we have several options above the 3xpayment value threshold, we should pick the
6569 // smallest of them, avoiding further fragmenting our available outbound balance to
6571 let route_params = RouteParameters::from_payment_params_and_value(
6572 payment_params, 100_000);
6573 let route = get_route(&our_id, &route_params, &network_graph.read_only(), Some(&[
6574 &get_channel_details(Some(2), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6575 &get_channel_details(Some(3), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6576 &get_channel_details(Some(5), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6577 &get_channel_details(Some(6), nodes[0], channelmanager::provided_init_features(&config), 300_000),
6578 &get_channel_details(Some(7), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6579 &get_channel_details(Some(8), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6580 &get_channel_details(Some(9), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6581 &get_channel_details(Some(4), nodes[0], channelmanager::provided_init_features(&config), 1_000_000),
6582 ]), Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6583 assert_eq!(route.paths.len(), 1);
6584 assert_eq!(route.paths[0].hops.len(), 1);
6586 assert_eq!(route.paths[0].hops[0].pubkey, nodes[0]);
6587 assert_eq!(route.paths[0].hops[0].short_channel_id, 6);
6588 assert_eq!(route.paths[0].hops[0].fee_msat, 100_000);
6593 fn prefers_shorter_route_with_higher_fees() {
6594 let (secp_ctx, network_graph, _, _, logger) = build_graph();
6595 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6596 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(last_hops(&nodes)).unwrap();
6598 // Without penalizing each hop 100 msats, a longer path with lower fees is chosen.
6599 let scorer = ln_test_utils::TestScorer::new();
6600 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6601 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6602 let route_params = RouteParameters::from_payment_params_and_value(
6603 payment_params.clone(), 100);
6604 let route = get_route( &our_id, &route_params, &network_graph.read_only(), None,
6605 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6606 let path = route.paths[0].hops.iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
6608 assert_eq!(route.get_total_fees(), 100);
6609 assert_eq!(route.get_total_amount(), 100);
6610 assert_eq!(path, vec![2, 4, 6, 11, 8]);
6612 // Applying a 100 msat penalty to each hop results in taking channels 7 and 10 to nodes[6]
6613 // from nodes[2] rather than channel 6, 11, and 8, even though the longer path is cheaper.
6614 let scorer = FixedPenaltyScorer::with_penalty(100);
6615 let route_params = RouteParameters::from_payment_params_and_value(
6616 payment_params, 100);
6617 let route = get_route( &our_id, &route_params, &network_graph.read_only(), None,
6618 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6619 let path = route.paths[0].hops.iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
6621 assert_eq!(route.get_total_fees(), 300);
6622 assert_eq!(route.get_total_amount(), 100);
6623 assert_eq!(path, vec![2, 4, 7, 10]);
6626 struct BadChannelScorer {
6627 short_channel_id: u64,
6631 impl Writeable for BadChannelScorer {
6632 fn write<W: Writer>(&self, _w: &mut W) -> Result<(), crate::io::Error> { unimplemented!() }
6634 impl ScoreLookUp for BadChannelScorer {
6635 type ScoreParams = ();
6636 fn channel_penalty_msat(&self, candidate: &CandidateRouteHop, _: ChannelUsage, _score_params:&Self::ScoreParams) -> u64 {
6637 if candidate.short_channel_id() == Some(self.short_channel_id) { u64::max_value() } else { 0 }
6641 struct BadNodeScorer {
6646 impl Writeable for BadNodeScorer {
6647 fn write<W: Writer>(&self, _w: &mut W) -> Result<(), crate::io::Error> { unimplemented!() }
6650 impl ScoreLookUp for BadNodeScorer {
6651 type ScoreParams = ();
6652 fn channel_penalty_msat(&self, candidate: &CandidateRouteHop, _: ChannelUsage, _score_params:&Self::ScoreParams) -> u64 {
6653 if candidate.target() == Some(self.node_id) { u64::max_value() } else { 0 }
6658 fn avoids_routing_through_bad_channels_and_nodes() {
6659 let (secp_ctx, network, _, _, logger) = build_graph();
6660 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6661 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(last_hops(&nodes)).unwrap();
6662 let network_graph = network.read_only();
6664 // A path to nodes[6] exists when no penalties are applied to any channel.
6665 let scorer = ln_test_utils::TestScorer::new();
6666 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6667 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6668 let route_params = RouteParameters::from_payment_params_and_value(
6669 payment_params, 100);
6670 let route = get_route( &our_id, &route_params, &network_graph, None, Arc::clone(&logger),
6671 &scorer, &Default::default(), &random_seed_bytes).unwrap();
6672 let path = route.paths[0].hops.iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
6674 assert_eq!(route.get_total_fees(), 100);
6675 assert_eq!(route.get_total_amount(), 100);
6676 assert_eq!(path, vec![2, 4, 6, 11, 8]);
6678 // A different path to nodes[6] exists if channel 6 cannot be routed over.
6679 let scorer = BadChannelScorer { short_channel_id: 6 };
6680 let route = get_route( &our_id, &route_params, &network_graph, None, Arc::clone(&logger),
6681 &scorer, &Default::default(), &random_seed_bytes).unwrap();
6682 let path = route.paths[0].hops.iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
6684 assert_eq!(route.get_total_fees(), 300);
6685 assert_eq!(route.get_total_amount(), 100);
6686 assert_eq!(path, vec![2, 4, 7, 10]);
6688 // A path to nodes[6] does not exist if nodes[2] cannot be routed through.
6689 let scorer = BadNodeScorer { node_id: NodeId::from_pubkey(&nodes[2]) };
6690 match get_route( &our_id, &route_params, &network_graph, None, Arc::clone(&logger),
6691 &scorer, &Default::default(), &random_seed_bytes) {
6692 Err(LightningError { err, .. } ) => {
6693 assert_eq!(err, "Failed to find a path to the given destination");
6695 Ok(_) => panic!("Expected error"),
6700 fn total_fees_single_path() {
6702 paths: vec![Path { hops: vec![
6704 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
6705 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6706 short_channel_id: 0, fee_msat: 100, cltv_expiry_delta: 0, maybe_announced_channel: true,
6709 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
6710 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6711 short_channel_id: 0, fee_msat: 150, cltv_expiry_delta: 0, maybe_announced_channel: true,
6714 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
6715 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6716 short_channel_id: 0, fee_msat: 225, cltv_expiry_delta: 0, maybe_announced_channel: true,
6718 ], blinded_tail: None }],
6722 assert_eq!(route.get_total_fees(), 250);
6723 assert_eq!(route.get_total_amount(), 225);
6727 fn total_fees_multi_path() {
6729 paths: vec![Path { hops: vec![
6731 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
6732 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6733 short_channel_id: 0, fee_msat: 100, cltv_expiry_delta: 0, maybe_announced_channel: true,
6736 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
6737 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6738 short_channel_id: 0, fee_msat: 150, cltv_expiry_delta: 0, maybe_announced_channel: true,
6740 ], blinded_tail: None }, Path { hops: vec![
6742 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
6743 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6744 short_channel_id: 0, fee_msat: 100, cltv_expiry_delta: 0, maybe_announced_channel: true,
6747 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
6748 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6749 short_channel_id: 0, fee_msat: 150, cltv_expiry_delta: 0, maybe_announced_channel: true,
6751 ], blinded_tail: None }],
6755 assert_eq!(route.get_total_fees(), 200);
6756 assert_eq!(route.get_total_amount(), 300);
6760 fn total_empty_route_no_panic() {
6761 // In an earlier version of `Route::get_total_fees` and `Route::get_total_amount`, they
6762 // would both panic if the route was completely empty. We test to ensure they return 0
6763 // here, even though its somewhat nonsensical as a route.
6764 let route = Route { paths: Vec::new(), route_params: None };
6766 assert_eq!(route.get_total_fees(), 0);
6767 assert_eq!(route.get_total_amount(), 0);
6771 fn limits_total_cltv_delta() {
6772 let (secp_ctx, network, _, _, logger) = build_graph();
6773 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6774 let network_graph = network.read_only();
6776 let scorer = ln_test_utils::TestScorer::new();
6778 // Make sure that generally there is at least one route available
6779 let feasible_max_total_cltv_delta = 1008;
6780 let feasible_payment_params = PaymentParameters::from_node_id(nodes[6], 0).with_route_hints(last_hops(&nodes)).unwrap()
6781 .with_max_total_cltv_expiry_delta(feasible_max_total_cltv_delta);
6782 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6783 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6784 let route_params = RouteParameters::from_payment_params_and_value(
6785 feasible_payment_params, 100);
6786 let route = get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger),
6787 &scorer, &Default::default(), &random_seed_bytes).unwrap();
6788 let path = route.paths[0].hops.iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
6789 assert_ne!(path.len(), 0);
6791 // But not if we exclude all paths on the basis of their accumulated CLTV delta
6792 let fail_max_total_cltv_delta = 23;
6793 let fail_payment_params = PaymentParameters::from_node_id(nodes[6], 0).with_route_hints(last_hops(&nodes)).unwrap()
6794 .with_max_total_cltv_expiry_delta(fail_max_total_cltv_delta);
6795 let route_params = RouteParameters::from_payment_params_and_value(
6796 fail_payment_params, 100);
6797 match get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger), &scorer,
6798 &Default::default(), &random_seed_bytes)
6800 Err(LightningError { err, .. } ) => {
6801 assert_eq!(err, "Failed to find a path to the given destination");
6803 Ok(_) => panic!("Expected error"),
6808 fn avoids_recently_failed_paths() {
6809 // Ensure that the router always avoids all of the `previously_failed_channels` channels by
6810 // randomly inserting channels into it until we can't find a route anymore.
6811 let (secp_ctx, network, _, _, logger) = build_graph();
6812 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6813 let network_graph = network.read_only();
6815 let scorer = ln_test_utils::TestScorer::new();
6816 let mut payment_params = PaymentParameters::from_node_id(nodes[6], 0).with_route_hints(last_hops(&nodes)).unwrap()
6817 .with_max_path_count(1);
6818 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6819 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6821 // We should be able to find a route initially, and then after we fail a few random
6822 // channels eventually we won't be able to any longer.
6823 let route_params = RouteParameters::from_payment_params_and_value(
6824 payment_params.clone(), 100);
6825 assert!(get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger),
6826 &scorer, &Default::default(), &random_seed_bytes).is_ok());
6828 let route_params = RouteParameters::from_payment_params_and_value(
6829 payment_params.clone(), 100);
6830 if let Ok(route) = get_route(&our_id, &route_params, &network_graph, None,
6831 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes)
6833 for chan in route.paths[0].hops.iter() {
6834 assert!(!payment_params.previously_failed_channels.contains(&chan.short_channel_id));
6836 let victim = (u64::from_ne_bytes(random_seed_bytes[0..8].try_into().unwrap()) as usize)
6837 % route.paths[0].hops.len();
6838 payment_params.previously_failed_channels.push(route.paths[0].hops[victim].short_channel_id);
6844 fn limits_path_length() {
6845 let (secp_ctx, network, _, _, logger) = build_line_graph();
6846 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6847 let network_graph = network.read_only();
6849 let scorer = ln_test_utils::TestScorer::new();
6850 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6851 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6853 // First check we can actually create a long route on this graph.
6854 let feasible_payment_params = PaymentParameters::from_node_id(nodes[18], 0);
6855 let route_params = RouteParameters::from_payment_params_and_value(
6856 feasible_payment_params, 100);
6857 let route = get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger),
6858 &scorer, &Default::default(), &random_seed_bytes).unwrap();
6859 let path = route.paths[0].hops.iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
6860 assert!(path.len() == MAX_PATH_LENGTH_ESTIMATE.into());
6862 // But we can't create a path surpassing the MAX_PATH_LENGTH_ESTIMATE limit.
6863 let fail_payment_params = PaymentParameters::from_node_id(nodes[19], 0);
6864 let route_params = RouteParameters::from_payment_params_and_value(
6865 fail_payment_params, 100);
6866 match get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger), &scorer,
6867 &Default::default(), &random_seed_bytes)
6869 Err(LightningError { err, .. } ) => {
6870 assert_eq!(err, "Failed to find a path to the given destination");
6872 Ok(_) => panic!("Expected error"),
6877 fn adds_and_limits_cltv_offset() {
6878 let (secp_ctx, network_graph, _, _, logger) = build_graph();
6879 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6881 let scorer = ln_test_utils::TestScorer::new();
6883 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(last_hops(&nodes)).unwrap();
6884 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6885 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6886 let route_params = RouteParameters::from_payment_params_and_value(
6887 payment_params.clone(), 100);
6888 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
6889 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6890 assert_eq!(route.paths.len(), 1);
6892 let cltv_expiry_deltas_before = route.paths[0].hops.iter().map(|h| h.cltv_expiry_delta).collect::<Vec<u32>>();
6894 // Check whether the offset added to the last hop by default is in [1 .. DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA]
6895 let mut route_default = route.clone();
6896 add_random_cltv_offset(&mut route_default, &payment_params, &network_graph.read_only(), &random_seed_bytes);
6897 let cltv_expiry_deltas_default = route_default.paths[0].hops.iter().map(|h| h.cltv_expiry_delta).collect::<Vec<u32>>();
6898 assert_eq!(cltv_expiry_deltas_before.split_last().unwrap().1, cltv_expiry_deltas_default.split_last().unwrap().1);
6899 assert!(cltv_expiry_deltas_default.last() > cltv_expiry_deltas_before.last());
6900 assert!(cltv_expiry_deltas_default.last().unwrap() <= &DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA);
6902 // Check that no offset is added when we restrict the max_total_cltv_expiry_delta
6903 let mut route_limited = route.clone();
6904 let limited_max_total_cltv_expiry_delta = cltv_expiry_deltas_before.iter().sum();
6905 let limited_payment_params = payment_params.with_max_total_cltv_expiry_delta(limited_max_total_cltv_expiry_delta);
6906 add_random_cltv_offset(&mut route_limited, &limited_payment_params, &network_graph.read_only(), &random_seed_bytes);
6907 let cltv_expiry_deltas_limited = route_limited.paths[0].hops.iter().map(|h| h.cltv_expiry_delta).collect::<Vec<u32>>();
6908 assert_eq!(cltv_expiry_deltas_before, cltv_expiry_deltas_limited);
6912 fn adds_plausible_cltv_offset() {
6913 let (secp_ctx, network, _, _, logger) = build_graph();
6914 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6915 let network_graph = network.read_only();
6916 let network_nodes = network_graph.nodes();
6917 let network_channels = network_graph.channels();
6918 let scorer = ln_test_utils::TestScorer::new();
6919 let payment_params = PaymentParameters::from_node_id(nodes[3], 0);
6920 let keys_manager = ln_test_utils::TestKeysInterface::new(&[4u8; 32], Network::Testnet);
6921 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6923 let route_params = RouteParameters::from_payment_params_and_value(
6924 payment_params.clone(), 100);
6925 let mut route = get_route(&our_id, &route_params, &network_graph, None,
6926 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6927 add_random_cltv_offset(&mut route, &payment_params, &network_graph, &random_seed_bytes);
6929 let mut path_plausibility = vec![];
6931 for p in route.paths {
6932 // 1. Select random observation point
6933 let mut prng = ChaCha20::new(&random_seed_bytes, &[0u8; 12]);
6934 let mut random_bytes = [0u8; ::core::mem::size_of::<usize>()];
6936 prng.process_in_place(&mut random_bytes);
6937 let random_path_index = usize::from_be_bytes(random_bytes).wrapping_rem(p.hops.len());
6938 let observation_point = NodeId::from_pubkey(&p.hops.get(random_path_index).unwrap().pubkey);
6940 // 2. Calculate what CLTV expiry delta we would observe there
6941 let observed_cltv_expiry_delta: u32 = p.hops[random_path_index..].iter().map(|h| h.cltv_expiry_delta).sum();
6943 // 3. Starting from the observation point, find candidate paths
6944 let mut candidates: VecDeque<(NodeId, Vec<u32>)> = VecDeque::new();
6945 candidates.push_back((observation_point, vec![]));
6947 let mut found_plausible_candidate = false;
6949 'candidate_loop: while let Some((cur_node_id, cur_path_cltv_deltas)) = candidates.pop_front() {
6950 if let Some(remaining) = observed_cltv_expiry_delta.checked_sub(cur_path_cltv_deltas.iter().sum::<u32>()) {
6951 if remaining == 0 || remaining.wrapping_rem(40) == 0 || remaining.wrapping_rem(144) == 0 {
6952 found_plausible_candidate = true;
6953 break 'candidate_loop;
6957 if let Some(cur_node) = network_nodes.get(&cur_node_id) {
6958 for channel_id in &cur_node.channels {
6959 if let Some(channel_info) = network_channels.get(&channel_id) {
6960 if let Some((dir_info, next_id)) = channel_info.as_directed_from(&cur_node_id) {
6961 let next_cltv_expiry_delta = dir_info.direction().cltv_expiry_delta as u32;
6962 if cur_path_cltv_deltas.iter().sum::<u32>()
6963 .saturating_add(next_cltv_expiry_delta) <= observed_cltv_expiry_delta {
6964 let mut new_path_cltv_deltas = cur_path_cltv_deltas.clone();
6965 new_path_cltv_deltas.push(next_cltv_expiry_delta);
6966 candidates.push_back((*next_id, new_path_cltv_deltas));
6974 path_plausibility.push(found_plausible_candidate);
6976 assert!(path_plausibility.iter().all(|x| *x));
6980 fn builds_correct_path_from_hops() {
6981 let (secp_ctx, network, _, _, logger) = build_graph();
6982 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6983 let network_graph = network.read_only();
6985 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6986 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6988 let payment_params = PaymentParameters::from_node_id(nodes[3], 0);
6989 let hops = [nodes[1], nodes[2], nodes[4], nodes[3]];
6990 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
6991 let route = build_route_from_hops_internal(&our_id, &hops, &route_params, &network_graph,
6992 Arc::clone(&logger), &random_seed_bytes).unwrap();
6993 let route_hop_pubkeys = route.paths[0].hops.iter().map(|hop| hop.pubkey).collect::<Vec<_>>();
6994 assert_eq!(hops.len(), route.paths[0].hops.len());
6995 for (idx, hop_pubkey) in hops.iter().enumerate() {
6996 assert!(*hop_pubkey == route_hop_pubkeys[idx]);
7001 fn avoids_saturating_channels() {
7002 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
7003 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
7004 let decay_params = ProbabilisticScoringDecayParameters::default();
7005 let scorer = ProbabilisticScorer::new(decay_params, &*network_graph, Arc::clone(&logger));
7007 // Set the fee on channel 13 to 100% to match channel 4 giving us two equivalent paths (us
7008 // -> node 7 -> node2 and us -> node 1 -> node 2) which we should balance over.
7009 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
7010 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
7011 short_channel_id: 4,
7014 cltv_expiry_delta: (4 << 4) | 1,
7015 htlc_minimum_msat: 0,
7016 htlc_maximum_msat: 250_000_000,
7018 fee_proportional_millionths: 0,
7019 excess_data: Vec::new()
7021 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
7022 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
7023 short_channel_id: 13,
7026 cltv_expiry_delta: (13 << 4) | 1,
7027 htlc_minimum_msat: 0,
7028 htlc_maximum_msat: 250_000_000,
7030 fee_proportional_millionths: 0,
7031 excess_data: Vec::new()
7034 let config = UserConfig::default();
7035 let payment_params = PaymentParameters::from_node_id(nodes[2], 42)
7036 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
7038 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7039 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7040 // 100,000 sats is less than the available liquidity on each channel, set above.
7041 let route_params = RouteParameters::from_payment_params_and_value(
7042 payment_params, 100_000_000);
7043 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
7044 Arc::clone(&logger), &scorer, &ProbabilisticScoringFeeParameters::default(), &random_seed_bytes).unwrap();
7045 assert_eq!(route.paths.len(), 2);
7046 assert!((route.paths[0].hops[1].short_channel_id == 4 && route.paths[1].hops[1].short_channel_id == 13) ||
7047 (route.paths[1].hops[1].short_channel_id == 4 && route.paths[0].hops[1].short_channel_id == 13));
7050 #[cfg(feature = "std")]
7051 pub(super) fn random_init_seed() -> u64 {
7052 // Because the default HashMap in std pulls OS randomness, we can use it as a (bad) RNG.
7053 use core::hash::{BuildHasher, Hasher};
7054 let seed = std::collections::hash_map::RandomState::new().build_hasher().finish();
7055 println!("Using seed of {}", seed);
7060 #[cfg(feature = "std")]
7061 fn generate_routes() {
7062 use crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters};
7064 let logger = ln_test_utils::TestLogger::new();
7065 let graph = match super::bench_utils::read_network_graph(&logger) {
7073 let params = ProbabilisticScoringFeeParameters::default();
7074 let mut scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), &graph, &logger);
7075 let features = super::Bolt11InvoiceFeatures::empty();
7077 super::bench_utils::generate_test_routes(&graph, &mut scorer, ¶ms, features, random_init_seed(), 0, 2);
7081 #[cfg(feature = "std")]
7082 fn generate_routes_mpp() {
7083 use crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters};
7085 let logger = ln_test_utils::TestLogger::new();
7086 let graph = match super::bench_utils::read_network_graph(&logger) {
7094 let params = ProbabilisticScoringFeeParameters::default();
7095 let mut scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), &graph, &logger);
7096 let features = channelmanager::provided_bolt11_invoice_features(&UserConfig::default());
7098 super::bench_utils::generate_test_routes(&graph, &mut scorer, ¶ms, features, random_init_seed(), 0, 2);
7102 #[cfg(feature = "std")]
7103 fn generate_large_mpp_routes() {
7104 use crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters};
7106 let logger = ln_test_utils::TestLogger::new();
7107 let graph = match super::bench_utils::read_network_graph(&logger) {
7115 let params = ProbabilisticScoringFeeParameters::default();
7116 let mut scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), &graph, &logger);
7117 let features = channelmanager::provided_bolt11_invoice_features(&UserConfig::default());
7119 super::bench_utils::generate_test_routes(&graph, &mut scorer, ¶ms, features, random_init_seed(), 1_000_000, 2);
7123 fn honors_manual_penalties() {
7124 let (secp_ctx, network_graph, _, _, logger) = build_line_graph();
7125 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7127 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7128 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7130 let mut scorer_params = ProbabilisticScoringFeeParameters::default();
7131 let scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), Arc::clone(&network_graph), Arc::clone(&logger));
7133 // First check set manual penalties are returned by the scorer.
7134 let usage = ChannelUsage {
7136 inflight_htlc_msat: 0,
7137 effective_capacity: EffectiveCapacity::Total { capacity_msat: 1_024_000, htlc_maximum_msat: 1_000 },
7139 scorer_params.set_manual_penalty(&NodeId::from_pubkey(&nodes[3]), 123);
7140 scorer_params.set_manual_penalty(&NodeId::from_pubkey(&nodes[4]), 456);
7141 let network_graph = network_graph.read_only();
7142 let channels = network_graph.channels();
7143 let channel = channels.get(&5).unwrap();
7144 let info = channel.as_directed_from(&NodeId::from_pubkey(&nodes[3])).unwrap();
7145 let candidate: CandidateRouteHop = CandidateRouteHop::PublicHop(PublicHopCandidate {
7147 short_channel_id: 5,
7149 assert_eq!(scorer.channel_penalty_msat(&candidate, usage, &scorer_params), 456);
7151 // Then check we can get a normal route
7152 let payment_params = PaymentParameters::from_node_id(nodes[10], 42);
7153 let route_params = RouteParameters::from_payment_params_and_value(
7154 payment_params, 100);
7155 let route = get_route(&our_id, &route_params, &network_graph, None,
7156 Arc::clone(&logger), &scorer, &scorer_params, &random_seed_bytes);
7157 assert!(route.is_ok());
7159 // Then check that we can't get a route if we ban an intermediate node.
7160 scorer_params.add_banned(&NodeId::from_pubkey(&nodes[3]));
7161 let route = get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger), &scorer, &scorer_params,&random_seed_bytes);
7162 assert!(route.is_err());
7164 // Finally make sure we can route again, when we remove the ban.
7165 scorer_params.remove_banned(&NodeId::from_pubkey(&nodes[3]));
7166 let route = get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger), &scorer, &scorer_params,&random_seed_bytes);
7167 assert!(route.is_ok());
7171 fn abide_by_route_hint_max_htlc() {
7172 // Check that we abide by any htlc_maximum_msat provided in the route hints of the payment
7173 // params in the final route.
7174 let (secp_ctx, network_graph, _, _, logger) = build_graph();
7175 let netgraph = network_graph.read_only();
7176 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7177 let scorer = ln_test_utils::TestScorer::new();
7178 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7179 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7180 let config = UserConfig::default();
7182 let max_htlc_msat = 50_000;
7183 let route_hint_1 = RouteHint(vec![RouteHintHop {
7184 src_node_id: nodes[2],
7185 short_channel_id: 42,
7188 proportional_millionths: 0,
7190 cltv_expiry_delta: 10,
7191 htlc_minimum_msat: None,
7192 htlc_maximum_msat: Some(max_htlc_msat),
7194 let dest_node_id = ln_test_utils::pubkey(42);
7195 let payment_params = PaymentParameters::from_node_id(dest_node_id, 42)
7196 .with_route_hints(vec![route_hint_1.clone()]).unwrap()
7197 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
7200 // Make sure we'll error if our route hints don't have enough liquidity according to their
7201 // htlc_maximum_msat.
7202 let mut route_params = RouteParameters::from_payment_params_and_value(
7203 payment_params, max_htlc_msat + 1);
7204 route_params.max_total_routing_fee_msat = None;
7205 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
7206 &route_params, &netgraph, None, Arc::clone(&logger), &scorer, &Default::default(),
7209 assert_eq!(err, "Failed to find a sufficient route to the given destination");
7210 } else { panic!(); }
7212 // Make sure we'll split an MPP payment across route hints if their htlc_maximum_msat warrants.
7213 let mut route_hint_2 = route_hint_1.clone();
7214 route_hint_2.0[0].short_channel_id = 43;
7215 let payment_params = PaymentParameters::from_node_id(dest_node_id, 42)
7216 .with_route_hints(vec![route_hint_1, route_hint_2]).unwrap()
7217 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
7219 let mut route_params = RouteParameters::from_payment_params_and_value(
7220 payment_params, max_htlc_msat + 1);
7221 route_params.max_total_routing_fee_msat = Some(max_htlc_msat * 2);
7222 let route = get_route(&our_id, &route_params, &netgraph, None, Arc::clone(&logger),
7223 &scorer, &Default::default(), &random_seed_bytes).unwrap();
7224 assert_eq!(route.paths.len(), 2);
7225 assert!(route.paths[0].hops.last().unwrap().fee_msat <= max_htlc_msat);
7226 assert!(route.paths[1].hops.last().unwrap().fee_msat <= max_htlc_msat);
7230 fn direct_channel_to_hints_with_max_htlc() {
7231 // Check that if we have a first hop channel peer that's connected to multiple provided route
7232 // hints, that we properly split the payment between the route hints if needed.
7233 let logger = Arc::new(ln_test_utils::TestLogger::new());
7234 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
7235 let scorer = ln_test_utils::TestScorer::new();
7236 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7237 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7238 let config = UserConfig::default();
7240 let our_node_id = ln_test_utils::pubkey(42);
7241 let intermed_node_id = ln_test_utils::pubkey(43);
7242 let first_hop = vec![get_channel_details(Some(42), intermed_node_id, InitFeatures::from_le_bytes(vec![0b11]), 10_000_000)];
7244 let amt_msat = 900_000;
7245 let max_htlc_msat = 500_000;
7246 let route_hint_1 = RouteHint(vec![RouteHintHop {
7247 src_node_id: intermed_node_id,
7248 short_channel_id: 44,
7251 proportional_millionths: 0,
7253 cltv_expiry_delta: 10,
7254 htlc_minimum_msat: None,
7255 htlc_maximum_msat: Some(max_htlc_msat),
7257 src_node_id: intermed_node_id,
7258 short_channel_id: 45,
7261 proportional_millionths: 0,
7263 cltv_expiry_delta: 10,
7264 htlc_minimum_msat: None,
7265 // Check that later route hint max htlcs don't override earlier ones
7266 htlc_maximum_msat: Some(max_htlc_msat - 50),
7268 let mut route_hint_2 = route_hint_1.clone();
7269 route_hint_2.0[0].short_channel_id = 46;
7270 route_hint_2.0[1].short_channel_id = 47;
7271 let dest_node_id = ln_test_utils::pubkey(44);
7272 let payment_params = PaymentParameters::from_node_id(dest_node_id, 42)
7273 .with_route_hints(vec![route_hint_1, route_hint_2]).unwrap()
7274 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
7277 let route_params = RouteParameters::from_payment_params_and_value(
7278 payment_params, amt_msat);
7279 let route = get_route(&our_node_id, &route_params, &network_graph.read_only(),
7280 Some(&first_hop.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
7281 &Default::default(), &random_seed_bytes).unwrap();
7282 assert_eq!(route.paths.len(), 2);
7283 assert!(route.paths[0].hops.last().unwrap().fee_msat <= max_htlc_msat);
7284 assert!(route.paths[1].hops.last().unwrap().fee_msat <= max_htlc_msat);
7285 assert_eq!(route.get_total_amount(), amt_msat);
7287 // Re-run but with two first hop channels connected to the same route hint peers that must be
7289 let first_hops = vec![
7290 get_channel_details(Some(42), intermed_node_id, InitFeatures::from_le_bytes(vec![0b11]), amt_msat - 10),
7291 get_channel_details(Some(43), intermed_node_id, InitFeatures::from_le_bytes(vec![0b11]), amt_msat - 10),
7293 let route = get_route(&our_node_id, &route_params, &network_graph.read_only(),
7294 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
7295 &Default::default(), &random_seed_bytes).unwrap();
7296 assert_eq!(route.paths.len(), 2);
7297 assert!(route.paths[0].hops.last().unwrap().fee_msat <= max_htlc_msat);
7298 assert!(route.paths[1].hops.last().unwrap().fee_msat <= max_htlc_msat);
7299 assert_eq!(route.get_total_amount(), amt_msat);
7301 // Make sure this works for blinded route hints.
7302 let blinded_path = BlindedPath {
7303 introduction_node: IntroductionNode::NodeId(intermed_node_id),
7304 blinding_point: ln_test_utils::pubkey(42),
7306 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42), encrypted_payload: vec![] },
7307 BlindedHop { blinded_node_id: ln_test_utils::pubkey(43), encrypted_payload: vec![] },
7310 let blinded_payinfo = BlindedPayInfo {
7312 fee_proportional_millionths: 0,
7313 htlc_minimum_msat: 1,
7314 htlc_maximum_msat: max_htlc_msat,
7315 cltv_expiry_delta: 10,
7316 features: BlindedHopFeatures::empty(),
7318 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
7319 let payment_params = PaymentParameters::blinded(vec![
7320 (blinded_payinfo.clone(), blinded_path.clone()),
7321 (blinded_payinfo.clone(), blinded_path.clone())])
7322 .with_bolt12_features(bolt12_features).unwrap();
7323 let route_params = RouteParameters::from_payment_params_and_value(
7324 payment_params, amt_msat);
7325 let route = get_route(&our_node_id, &route_params, &network_graph.read_only(),
7326 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
7327 &Default::default(), &random_seed_bytes).unwrap();
7328 assert_eq!(route.paths.len(), 2);
7329 assert!(route.paths[0].hops.last().unwrap().fee_msat <= max_htlc_msat);
7330 assert!(route.paths[1].hops.last().unwrap().fee_msat <= max_htlc_msat);
7331 assert_eq!(route.get_total_amount(), amt_msat);
7335 fn blinded_route_ser() {
7336 let blinded_path_1 = BlindedPath {
7337 introduction_node: IntroductionNode::NodeId(ln_test_utils::pubkey(42)),
7338 blinding_point: ln_test_utils::pubkey(43),
7340 BlindedHop { blinded_node_id: ln_test_utils::pubkey(44), encrypted_payload: Vec::new() },
7341 BlindedHop { blinded_node_id: ln_test_utils::pubkey(45), encrypted_payload: Vec::new() }
7344 let blinded_path_2 = BlindedPath {
7345 introduction_node: IntroductionNode::NodeId(ln_test_utils::pubkey(46)),
7346 blinding_point: ln_test_utils::pubkey(47),
7348 BlindedHop { blinded_node_id: ln_test_utils::pubkey(48), encrypted_payload: Vec::new() },
7349 BlindedHop { blinded_node_id: ln_test_utils::pubkey(49), encrypted_payload: Vec::new() }
7352 // (De)serialize a Route with 1 blinded path out of two total paths.
7353 let mut route = Route { paths: vec![Path {
7354 hops: vec![RouteHop {
7355 pubkey: ln_test_utils::pubkey(50),
7356 node_features: NodeFeatures::empty(),
7357 short_channel_id: 42,
7358 channel_features: ChannelFeatures::empty(),
7360 cltv_expiry_delta: 0,
7361 maybe_announced_channel: true,
7363 blinded_tail: Some(BlindedTail {
7364 hops: blinded_path_1.blinded_hops,
7365 blinding_point: blinded_path_1.blinding_point,
7366 excess_final_cltv_expiry_delta: 40,
7367 final_value_msat: 100,
7369 hops: vec![RouteHop {
7370 pubkey: ln_test_utils::pubkey(51),
7371 node_features: NodeFeatures::empty(),
7372 short_channel_id: 43,
7373 channel_features: ChannelFeatures::empty(),
7375 cltv_expiry_delta: 0,
7376 maybe_announced_channel: true,
7377 }], blinded_tail: None }],
7380 let encoded_route = route.encode();
7381 let decoded_route: Route = Readable::read(&mut Cursor::new(&encoded_route[..])).unwrap();
7382 assert_eq!(decoded_route.paths[0].blinded_tail, route.paths[0].blinded_tail);
7383 assert_eq!(decoded_route.paths[1].blinded_tail, route.paths[1].blinded_tail);
7385 // (De)serialize a Route with two paths, each containing a blinded tail.
7386 route.paths[1].blinded_tail = Some(BlindedTail {
7387 hops: blinded_path_2.blinded_hops,
7388 blinding_point: blinded_path_2.blinding_point,
7389 excess_final_cltv_expiry_delta: 41,
7390 final_value_msat: 101,
7392 let encoded_route = route.encode();
7393 let decoded_route: Route = Readable::read(&mut Cursor::new(&encoded_route[..])).unwrap();
7394 assert_eq!(decoded_route.paths[0].blinded_tail, route.paths[0].blinded_tail);
7395 assert_eq!(decoded_route.paths[1].blinded_tail, route.paths[1].blinded_tail);
7399 fn blinded_path_inflight_processing() {
7400 // Ensure we'll score the channel that's inbound to a blinded path's introduction node, and
7401 // account for the blinded tail's final amount_msat.
7402 let mut inflight_htlcs = InFlightHtlcs::new();
7403 let blinded_path = BlindedPath {
7404 introduction_node: IntroductionNode::NodeId(ln_test_utils::pubkey(43)),
7405 blinding_point: ln_test_utils::pubkey(48),
7406 blinded_hops: vec![BlindedHop { blinded_node_id: ln_test_utils::pubkey(49), encrypted_payload: Vec::new() }],
7409 hops: vec![RouteHop {
7410 pubkey: ln_test_utils::pubkey(42),
7411 node_features: NodeFeatures::empty(),
7412 short_channel_id: 42,
7413 channel_features: ChannelFeatures::empty(),
7415 cltv_expiry_delta: 0,
7416 maybe_announced_channel: false,
7419 pubkey: ln_test_utils::pubkey(43),
7420 node_features: NodeFeatures::empty(),
7421 short_channel_id: 43,
7422 channel_features: ChannelFeatures::empty(),
7424 cltv_expiry_delta: 0,
7425 maybe_announced_channel: false,
7427 blinded_tail: Some(BlindedTail {
7428 hops: blinded_path.blinded_hops,
7429 blinding_point: blinded_path.blinding_point,
7430 excess_final_cltv_expiry_delta: 0,
7431 final_value_msat: 200,
7434 inflight_htlcs.process_path(&path, ln_test_utils::pubkey(44));
7435 assert_eq!(*inflight_htlcs.0.get(&(42, true)).unwrap(), 301);
7436 assert_eq!(*inflight_htlcs.0.get(&(43, false)).unwrap(), 201);
7440 fn blinded_path_cltv_shadow_offset() {
7441 // Make sure we add a shadow offset when sending to blinded paths.
7442 let blinded_path = BlindedPath {
7443 introduction_node: IntroductionNode::NodeId(ln_test_utils::pubkey(43)),
7444 blinding_point: ln_test_utils::pubkey(44),
7446 BlindedHop { blinded_node_id: ln_test_utils::pubkey(45), encrypted_payload: Vec::new() },
7447 BlindedHop { blinded_node_id: ln_test_utils::pubkey(46), encrypted_payload: Vec::new() }
7450 let mut route = Route { paths: vec![Path {
7451 hops: vec![RouteHop {
7452 pubkey: ln_test_utils::pubkey(42),
7453 node_features: NodeFeatures::empty(),
7454 short_channel_id: 42,
7455 channel_features: ChannelFeatures::empty(),
7457 cltv_expiry_delta: 0,
7458 maybe_announced_channel: false,
7461 pubkey: ln_test_utils::pubkey(43),
7462 node_features: NodeFeatures::empty(),
7463 short_channel_id: 43,
7464 channel_features: ChannelFeatures::empty(),
7466 cltv_expiry_delta: 0,
7467 maybe_announced_channel: false,
7470 blinded_tail: Some(BlindedTail {
7471 hops: blinded_path.blinded_hops,
7472 blinding_point: blinded_path.blinding_point,
7473 excess_final_cltv_expiry_delta: 0,
7474 final_value_msat: 200,
7476 }], route_params: None};
7478 let payment_params = PaymentParameters::from_node_id(ln_test_utils::pubkey(47), 18);
7479 let (_, network_graph, _, _, _) = build_line_graph();
7480 add_random_cltv_offset(&mut route, &payment_params, &network_graph.read_only(), &[0; 32]);
7481 assert_eq!(route.paths[0].blinded_tail.as_ref().unwrap().excess_final_cltv_expiry_delta, 40);
7482 assert_eq!(route.paths[0].hops.last().unwrap().cltv_expiry_delta, 40);
7486 fn simple_blinded_route_hints() {
7487 do_simple_blinded_route_hints(1);
7488 do_simple_blinded_route_hints(2);
7489 do_simple_blinded_route_hints(3);
7492 fn do_simple_blinded_route_hints(num_blinded_hops: usize) {
7493 // Check that we can generate a route to a blinded path with the expected hops.
7494 let (secp_ctx, network, _, _, logger) = build_graph();
7495 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7496 let network_graph = network.read_only();
7498 let scorer = ln_test_utils::TestScorer::new();
7499 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7500 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7502 let mut blinded_path = BlindedPath {
7503 introduction_node: IntroductionNode::NodeId(nodes[2]),
7504 blinding_point: ln_test_utils::pubkey(42),
7505 blinded_hops: Vec::with_capacity(num_blinded_hops),
7507 for i in 0..num_blinded_hops {
7508 blinded_path.blinded_hops.push(
7509 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 + i as u8), encrypted_payload: Vec::new() },
7512 let blinded_payinfo = BlindedPayInfo {
7514 fee_proportional_millionths: 500,
7515 htlc_minimum_msat: 1000,
7516 htlc_maximum_msat: 100_000_000,
7517 cltv_expiry_delta: 15,
7518 features: BlindedHopFeatures::empty(),
7521 let payment_params = PaymentParameters::blinded(vec![(blinded_payinfo.clone(), blinded_path.clone())]);
7522 let route_params = RouteParameters::from_payment_params_and_value(
7523 payment_params, 1001);
7524 let route = get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger),
7525 &scorer, &Default::default(), &random_seed_bytes).unwrap();
7526 assert_eq!(route.paths.len(), 1);
7527 assert_eq!(route.paths[0].hops.len(), 2);
7529 let tail = route.paths[0].blinded_tail.as_ref().unwrap();
7530 assert_eq!(tail.hops, blinded_path.blinded_hops);
7531 assert_eq!(tail.excess_final_cltv_expiry_delta, 0);
7532 assert_eq!(tail.final_value_msat, 1001);
7534 let final_hop = route.paths[0].hops.last().unwrap();
7536 NodeId::from_pubkey(&final_hop.pubkey),
7537 *blinded_path.public_introduction_node_id(&network_graph).unwrap()
7539 if tail.hops.len() > 1 {
7540 assert_eq!(final_hop.fee_msat,
7541 blinded_payinfo.fee_base_msat as u64 + blinded_payinfo.fee_proportional_millionths as u64 * tail.final_value_msat / 1000000);
7542 assert_eq!(final_hop.cltv_expiry_delta, blinded_payinfo.cltv_expiry_delta as u32);
7544 assert_eq!(final_hop.fee_msat, 0);
7545 assert_eq!(final_hop.cltv_expiry_delta, 0);
7550 fn blinded_path_routing_errors() {
7551 // Check that we can generate a route to a blinded path with the expected hops.
7552 let (secp_ctx, network, _, _, logger) = build_graph();
7553 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7554 let network_graph = network.read_only();
7556 let scorer = ln_test_utils::TestScorer::new();
7557 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7558 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7560 let mut invalid_blinded_path = BlindedPath {
7561 introduction_node: IntroductionNode::NodeId(nodes[2]),
7562 blinding_point: ln_test_utils::pubkey(42),
7564 BlindedHop { blinded_node_id: ln_test_utils::pubkey(43), encrypted_payload: vec![0; 43] },
7567 let blinded_payinfo = BlindedPayInfo {
7569 fee_proportional_millionths: 500,
7570 htlc_minimum_msat: 1000,
7571 htlc_maximum_msat: 100_000_000,
7572 cltv_expiry_delta: 15,
7573 features: BlindedHopFeatures::empty(),
7576 let mut invalid_blinded_path_2 = invalid_blinded_path.clone();
7577 invalid_blinded_path_2.introduction_node = IntroductionNode::NodeId(ln_test_utils::pubkey(45));
7578 let payment_params = PaymentParameters::blinded(vec![
7579 (blinded_payinfo.clone(), invalid_blinded_path.clone()),
7580 (blinded_payinfo.clone(), invalid_blinded_path_2)]);
7581 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 1001);
7582 match get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger),
7583 &scorer, &Default::default(), &random_seed_bytes)
7585 Err(LightningError { err, .. }) => {
7586 assert_eq!(err, "1-hop blinded paths must all have matching introduction node ids");
7588 _ => panic!("Expected error")
7591 invalid_blinded_path.introduction_node = IntroductionNode::NodeId(our_id);
7592 let payment_params = PaymentParameters::blinded(vec![(blinded_payinfo.clone(), invalid_blinded_path.clone())]);
7593 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 1001);
7594 match get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger), &scorer,
7595 &Default::default(), &random_seed_bytes)
7597 Err(LightningError { err, .. }) => {
7598 assert_eq!(err, "Cannot generate a route to blinded paths if we are the introduction node to all of them");
7600 _ => panic!("Expected error")
7603 invalid_blinded_path.introduction_node = IntroductionNode::NodeId(ln_test_utils::pubkey(46));
7604 invalid_blinded_path.blinded_hops.clear();
7605 let payment_params = PaymentParameters::blinded(vec![(blinded_payinfo, invalid_blinded_path)]);
7606 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 1001);
7607 match get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger), &scorer,
7608 &Default::default(), &random_seed_bytes)
7610 Err(LightningError { err, .. }) => {
7611 assert_eq!(err, "0-hop blinded path provided");
7613 _ => panic!("Expected error")
7618 fn matching_intro_node_paths_provided() {
7619 // Check that if multiple blinded paths with the same intro node are provided in payment
7620 // parameters, we'll return the correct paths in the resulting MPP route.
7621 let (secp_ctx, network, _, _, logger) = build_graph();
7622 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7623 let network_graph = network.read_only();
7625 let scorer = ln_test_utils::TestScorer::new();
7626 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7627 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7628 let config = UserConfig::default();
7630 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
7631 let blinded_path_1 = BlindedPath {
7632 introduction_node: IntroductionNode::NodeId(nodes[2]),
7633 blinding_point: ln_test_utils::pubkey(42),
7635 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
7636 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
7639 let blinded_payinfo_1 = BlindedPayInfo {
7641 fee_proportional_millionths: 0,
7642 htlc_minimum_msat: 0,
7643 htlc_maximum_msat: 30_000,
7644 cltv_expiry_delta: 0,
7645 features: BlindedHopFeatures::empty(),
7648 let mut blinded_path_2 = blinded_path_1.clone();
7649 blinded_path_2.blinding_point = ln_test_utils::pubkey(43);
7650 let mut blinded_payinfo_2 = blinded_payinfo_1.clone();
7651 blinded_payinfo_2.htlc_maximum_msat = 70_000;
7653 let blinded_hints = vec![
7654 (blinded_payinfo_1.clone(), blinded_path_1.clone()),
7655 (blinded_payinfo_2.clone(), blinded_path_2.clone()),
7657 let payment_params = PaymentParameters::blinded(blinded_hints.clone())
7658 .with_bolt12_features(bolt12_features).unwrap();
7660 let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, 100_000);
7661 route_params.max_total_routing_fee_msat = Some(100_000);
7662 let route = get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger),
7663 &scorer, &Default::default(), &random_seed_bytes).unwrap();
7664 assert_eq!(route.paths.len(), 2);
7665 let mut total_amount_paid_msat = 0;
7666 for path in route.paths.into_iter() {
7667 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
7668 if let Some(bt) = &path.blinded_tail {
7669 assert_eq!(bt.blinding_point,
7670 blinded_hints.iter().find(|(p, _)| p.htlc_maximum_msat == path.final_value_msat())
7671 .map(|(_, bp)| bp.blinding_point).unwrap());
7672 } else { panic!(); }
7673 total_amount_paid_msat += path.final_value_msat();
7675 assert_eq!(total_amount_paid_msat, 100_000);
7679 fn direct_to_intro_node() {
7680 // This previously caused a debug panic in the router when asserting
7681 // `used_liquidity_msat <= hop_max_msat`, because when adding first_hop<>blinded_route_hint
7682 // direct channels we failed to account for the fee charged for use of the blinded path.
7685 // node0 -1(1)2 - node1
7686 // such that there isn't enough liquidity to reach node1, but the router thinks there is if it
7687 // doesn't account for the blinded path fee.
7689 let secp_ctx = Secp256k1::new();
7690 let logger = Arc::new(ln_test_utils::TestLogger::new());
7691 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
7692 let gossip_sync = P2PGossipSync::new(Arc::clone(&network_graph), None, Arc::clone(&logger));
7693 let scorer = ln_test_utils::TestScorer::new();
7694 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7695 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7697 let amt_msat = 10_000_000;
7698 let (_, _, privkeys, nodes) = get_nodes(&secp_ctx);
7699 add_channel(&gossip_sync, &secp_ctx, &privkeys[0], &privkeys[1],
7700 ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 1);
7701 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
7702 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
7703 short_channel_id: 1,
7706 cltv_expiry_delta: 42,
7707 htlc_minimum_msat: 1_000,
7708 htlc_maximum_msat: 10_000_000,
7710 fee_proportional_millionths: 0,
7711 excess_data: Vec::new()
7713 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
7714 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
7715 short_channel_id: 1,
7718 cltv_expiry_delta: 42,
7719 htlc_minimum_msat: 1_000,
7720 htlc_maximum_msat: 10_000_000,
7722 fee_proportional_millionths: 0,
7723 excess_data: Vec::new()
7725 let first_hops = vec![
7726 get_channel_details(Some(1), nodes[1], InitFeatures::from_le_bytes(vec![0b11]), 10_000_000)];
7728 let blinded_path = BlindedPath {
7729 introduction_node: IntroductionNode::NodeId(nodes[1]),
7730 blinding_point: ln_test_utils::pubkey(42),
7732 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
7733 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
7736 let blinded_payinfo = BlindedPayInfo {
7737 fee_base_msat: 1000,
7738 fee_proportional_millionths: 0,
7739 htlc_minimum_msat: 1000,
7740 htlc_maximum_msat: MAX_VALUE_MSAT,
7741 cltv_expiry_delta: 0,
7742 features: BlindedHopFeatures::empty(),
7744 let blinded_hints = vec![(blinded_payinfo.clone(), blinded_path)];
7746 let payment_params = PaymentParameters::blinded(blinded_hints.clone());
7748 let netgraph = network_graph.read_only();
7749 let route_params = RouteParameters::from_payment_params_and_value(
7750 payment_params.clone(), amt_msat);
7751 if let Err(LightningError { err, .. }) = get_route(&nodes[0], &route_params, &netgraph,
7752 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
7753 &Default::default(), &random_seed_bytes) {
7754 assert_eq!(err, "Failed to find a path to the given destination");
7755 } else { panic!("Expected error") }
7757 // Sending an exact amount accounting for the blinded path fee works.
7758 let amt_minus_blinded_path_fee = amt_msat - blinded_payinfo.fee_base_msat as u64;
7759 let route_params = RouteParameters::from_payment_params_and_value(
7760 payment_params, amt_minus_blinded_path_fee);
7761 let route = get_route(&nodes[0], &route_params, &netgraph,
7762 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
7763 &Default::default(), &random_seed_bytes).unwrap();
7764 assert_eq!(route.get_total_fees(), blinded_payinfo.fee_base_msat as u64);
7765 assert_eq!(route.get_total_amount(), amt_minus_blinded_path_fee);
7769 fn direct_to_matching_intro_nodes() {
7770 // This previously caused us to enter `unreachable` code in the following situation:
7771 // 1. We add a route candidate for intro_node contributing a high amount
7772 // 2. We add a first_hop<>intro_node route candidate for the same high amount
7773 // 3. We see a cheaper blinded route hint for the same intro node but a much lower contribution
7774 // amount, and update our route candidate for intro_node for the lower amount
7775 // 4. We then attempt to update the aforementioned first_hop<>intro_node route candidate for the
7776 // lower contribution amount, but fail (this was previously caused by failure to account for
7777 // blinded path fees when adding first_hop<>intro_node candidates)
7778 // 5. We go to construct the path from these route candidates and our first_hop<>intro_node
7779 // candidate still thinks its path is contributing the original higher amount. This caused us
7780 // to hit an `unreachable` overflow when calculating the cheaper intro_node fees over the
7782 let secp_ctx = Secp256k1::new();
7783 let logger = Arc::new(ln_test_utils::TestLogger::new());
7784 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
7785 let scorer = ln_test_utils::TestScorer::new();
7786 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7787 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7788 let config = UserConfig::default();
7790 // Values are taken from the fuzz input that uncovered this panic.
7791 let amt_msat = 21_7020_5185_1403_2640;
7792 let (_, _, _, nodes) = get_nodes(&secp_ctx);
7793 let first_hops = vec![
7794 get_channel_details(Some(1), nodes[1], channelmanager::provided_init_features(&config),
7795 18446744073709551615)];
7797 let blinded_path = BlindedPath {
7798 introduction_node: IntroductionNode::NodeId(nodes[1]),
7799 blinding_point: ln_test_utils::pubkey(42),
7801 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
7802 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
7805 let blinded_payinfo = BlindedPayInfo {
7806 fee_base_msat: 5046_2720,
7807 fee_proportional_millionths: 0,
7808 htlc_minimum_msat: 4503_5996_2737_0496,
7809 htlc_maximum_msat: 45_0359_9627_3704_9600,
7810 cltv_expiry_delta: 0,
7811 features: BlindedHopFeatures::empty(),
7813 let mut blinded_hints = vec![
7814 (blinded_payinfo.clone(), blinded_path.clone()),
7815 (blinded_payinfo.clone(), blinded_path.clone()),
7817 blinded_hints[1].0.fee_base_msat = 419_4304;
7818 blinded_hints[1].0.fee_proportional_millionths = 257;
7819 blinded_hints[1].0.htlc_minimum_msat = 280_8908_6115_8400;
7820 blinded_hints[1].0.htlc_maximum_msat = 2_8089_0861_1584_0000;
7821 blinded_hints[1].0.cltv_expiry_delta = 0;
7823 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
7824 let payment_params = PaymentParameters::blinded(blinded_hints.clone())
7825 .with_bolt12_features(bolt12_features).unwrap();
7827 let netgraph = network_graph.read_only();
7828 let route_params = RouteParameters::from_payment_params_and_value(
7829 payment_params, amt_msat);
7830 let route = get_route(&nodes[0], &route_params, &netgraph,
7831 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
7832 &Default::default(), &random_seed_bytes).unwrap();
7833 assert_eq!(route.get_total_fees(), blinded_payinfo.fee_base_msat as u64);
7834 assert_eq!(route.get_total_amount(), amt_msat);
7838 fn we_are_intro_node_candidate_hops() {
7839 // This previously led to a panic in the router because we'd generate a Path with only a
7840 // BlindedTail and 0 unblinded hops, due to the only candidate hops being blinded route hints
7841 // where the origin node is the intro node. We now fully disallow considering candidate hops
7842 // where the origin node is the intro node.
7843 let (secp_ctx, network_graph, _, _, logger) = build_graph();
7844 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7845 let scorer = ln_test_utils::TestScorer::new();
7846 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7847 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7848 let config = UserConfig::default();
7850 // Values are taken from the fuzz input that uncovered this panic.
7851 let amt_msat = 21_7020_5185_1423_0019;
7853 let blinded_path = BlindedPath {
7854 introduction_node: IntroductionNode::NodeId(our_id),
7855 blinding_point: ln_test_utils::pubkey(42),
7857 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
7858 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
7861 let blinded_payinfo = BlindedPayInfo {
7862 fee_base_msat: 5052_9027,
7863 fee_proportional_millionths: 0,
7864 htlc_minimum_msat: 21_7020_5185_1423_0019,
7865 htlc_maximum_msat: 1844_6744_0737_0955_1615,
7866 cltv_expiry_delta: 0,
7867 features: BlindedHopFeatures::empty(),
7869 let mut blinded_hints = vec![
7870 (blinded_payinfo.clone(), blinded_path.clone()),
7871 (blinded_payinfo.clone(), blinded_path.clone()),
7873 blinded_hints[1].1.introduction_node = IntroductionNode::NodeId(nodes[6]);
7875 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
7876 let payment_params = PaymentParameters::blinded(blinded_hints.clone())
7877 .with_bolt12_features(bolt12_features.clone()).unwrap();
7879 let netgraph = network_graph.read_only();
7880 let route_params = RouteParameters::from_payment_params_and_value(
7881 payment_params, amt_msat);
7882 if let Err(LightningError { err, .. }) = get_route(
7883 &our_id, &route_params, &netgraph, None, Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes
7885 assert_eq!(err, "Failed to find a path to the given destination");
7890 fn we_are_intro_node_bp_in_final_path_fee_calc() {
7891 // This previously led to a debug panic in the router because we'd find an invalid Path with
7892 // 0 unblinded hops and a blinded tail, leading to the generation of a final
7893 // PaymentPathHop::fee_msat that included both the blinded path fees and the final value of
7894 // the payment, when it was intended to only include the final value of the payment.
7895 let (secp_ctx, network_graph, _, _, logger) = build_graph();
7896 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7897 let scorer = ln_test_utils::TestScorer::new();
7898 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7899 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7900 let config = UserConfig::default();
7902 // Values are taken from the fuzz input that uncovered this panic.
7903 let amt_msat = 21_7020_5185_1423_0019;
7905 let blinded_path = BlindedPath {
7906 introduction_node: IntroductionNode::NodeId(our_id),
7907 blinding_point: ln_test_utils::pubkey(42),
7909 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
7910 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
7913 let blinded_payinfo = BlindedPayInfo {
7914 fee_base_msat: 10_4425_1395,
7915 fee_proportional_millionths: 0,
7916 htlc_minimum_msat: 21_7301_9934_9094_0931,
7917 htlc_maximum_msat: 1844_6744_0737_0955_1615,
7918 cltv_expiry_delta: 0,
7919 features: BlindedHopFeatures::empty(),
7921 let mut blinded_hints = vec![
7922 (blinded_payinfo.clone(), blinded_path.clone()),
7923 (blinded_payinfo.clone(), blinded_path.clone()),
7924 (blinded_payinfo.clone(), blinded_path.clone()),
7926 blinded_hints[1].0.fee_base_msat = 5052_9027;
7927 blinded_hints[1].0.htlc_minimum_msat = 21_7020_5185_1423_0019;
7928 blinded_hints[1].0.htlc_maximum_msat = 1844_6744_0737_0955_1615;
7930 blinded_hints[2].1.introduction_node = IntroductionNode::NodeId(nodes[6]);
7932 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
7933 let payment_params = PaymentParameters::blinded(blinded_hints.clone())
7934 .with_bolt12_features(bolt12_features.clone()).unwrap();
7936 let netgraph = network_graph.read_only();
7937 let route_params = RouteParameters::from_payment_params_and_value(
7938 payment_params, amt_msat);
7939 if let Err(LightningError { err, .. }) = get_route(
7940 &our_id, &route_params, &netgraph, None, Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes
7942 assert_eq!(err, "Failed to find a path to the given destination");
7947 fn min_htlc_overpay_violates_max_htlc() {
7948 do_min_htlc_overpay_violates_max_htlc(true);
7949 do_min_htlc_overpay_violates_max_htlc(false);
7951 fn do_min_htlc_overpay_violates_max_htlc(blinded_payee: bool) {
7952 // Test that if overpaying to meet a later hop's min_htlc and causes us to violate an earlier
7953 // hop's max_htlc, we don't consider that candidate hop valid. Previously we would add this hop
7954 // to `targets` and build an invalid path with it, and subsequently hit a debug panic asserting
7955 // that the used liquidity for a hop was less than its available liquidity limit.
7956 let secp_ctx = Secp256k1::new();
7957 let logger = Arc::new(ln_test_utils::TestLogger::new());
7958 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
7959 let scorer = ln_test_utils::TestScorer::new();
7960 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7961 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7962 let config = UserConfig::default();
7964 // Values are taken from the fuzz input that uncovered this panic.
7965 let amt_msat = 7_4009_8048;
7966 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7967 let first_hop_outbound_capacity = 2_7345_2000;
7968 let first_hops = vec![get_channel_details(
7969 Some(200), nodes[0], channelmanager::provided_init_features(&config),
7970 first_hop_outbound_capacity
7973 let base_fee = 1_6778_3453;
7974 let htlc_min = 2_5165_8240;
7975 let payment_params = if blinded_payee {
7976 let blinded_path = BlindedPath {
7977 introduction_node: IntroductionNode::NodeId(nodes[0]),
7978 blinding_point: ln_test_utils::pubkey(42),
7980 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
7981 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
7984 let blinded_payinfo = BlindedPayInfo {
7985 fee_base_msat: base_fee,
7986 fee_proportional_millionths: 0,
7987 htlc_minimum_msat: htlc_min,
7988 htlc_maximum_msat: htlc_min * 1000,
7989 cltv_expiry_delta: 0,
7990 features: BlindedHopFeatures::empty(),
7992 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
7993 PaymentParameters::blinded(vec![(blinded_payinfo, blinded_path)])
7994 .with_bolt12_features(bolt12_features.clone()).unwrap()
7996 let route_hint = RouteHint(vec![RouteHintHop {
7997 src_node_id: nodes[0],
7998 short_channel_id: 42,
8000 base_msat: base_fee,
8001 proportional_millionths: 0,
8003 cltv_expiry_delta: 10,
8004 htlc_minimum_msat: Some(htlc_min),
8005 htlc_maximum_msat: None,
8008 PaymentParameters::from_node_id(nodes[1], 42)
8009 .with_route_hints(vec![route_hint]).unwrap()
8010 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config)).unwrap()
8013 let netgraph = network_graph.read_only();
8014 let route_params = RouteParameters::from_payment_params_and_value(
8015 payment_params, amt_msat);
8016 if let Err(LightningError { err, .. }) = get_route(
8017 &our_id, &route_params, &netgraph, Some(&first_hops.iter().collect::<Vec<_>>()),
8018 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes
8020 assert_eq!(err, "Failed to find a path to the given destination");
8025 fn previously_used_liquidity_violates_max_htlc() {
8026 do_previously_used_liquidity_violates_max_htlc(true);
8027 do_previously_used_liquidity_violates_max_htlc(false);
8030 fn do_previously_used_liquidity_violates_max_htlc(blinded_payee: bool) {
8031 // Test that if a candidate first_hop<>route_hint_src_node channel does not have enough
8032 // contribution amount to cover the next hop's min_htlc plus fees, we will not consider that
8033 // candidate. In this case, the candidate does not have enough due to a previous path taking up
8034 // some of its liquidity. Previously we would construct an invalid path and hit a debug panic
8035 // asserting that the used liquidity for a hop was less than its available liquidity limit.
8036 let secp_ctx = Secp256k1::new();
8037 let logger = Arc::new(ln_test_utils::TestLogger::new());
8038 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
8039 let scorer = ln_test_utils::TestScorer::new();
8040 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
8041 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8042 let config = UserConfig::default();
8044 // Values are taken from the fuzz input that uncovered this panic.
8045 let amt_msat = 52_4288;
8046 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
8047 let first_hops = vec![get_channel_details(
8048 Some(161), nodes[0], channelmanager::provided_init_features(&config), 486_4000
8049 ), get_channel_details(
8050 Some(122), nodes[0], channelmanager::provided_init_features(&config), 179_5000
8053 let base_fees = [0, 425_9840, 0, 0];
8054 let htlc_mins = [1_4392, 19_7401, 1027, 6_5535];
8055 let payment_params = if blinded_payee {
8056 let blinded_path = BlindedPath {
8057 introduction_node: IntroductionNode::NodeId(nodes[0]),
8058 blinding_point: ln_test_utils::pubkey(42),
8060 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
8061 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
8064 let mut blinded_hints = Vec::new();
8065 for (base_fee, htlc_min) in base_fees.iter().zip(htlc_mins.iter()) {
8066 blinded_hints.push((BlindedPayInfo {
8067 fee_base_msat: *base_fee,
8068 fee_proportional_millionths: 0,
8069 htlc_minimum_msat: *htlc_min,
8070 htlc_maximum_msat: htlc_min * 100,
8071 cltv_expiry_delta: 10,
8072 features: BlindedHopFeatures::empty(),
8073 }, blinded_path.clone()));
8075 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
8076 PaymentParameters::blinded(blinded_hints.clone())
8077 .with_bolt12_features(bolt12_features.clone()).unwrap()
8079 let mut route_hints = Vec::new();
8080 for (idx, (base_fee, htlc_min)) in base_fees.iter().zip(htlc_mins.iter()).enumerate() {
8081 route_hints.push(RouteHint(vec![RouteHintHop {
8082 src_node_id: nodes[0],
8083 short_channel_id: 42 + idx as u64,
8085 base_msat: *base_fee,
8086 proportional_millionths: 0,
8088 cltv_expiry_delta: 10,
8089 htlc_minimum_msat: Some(*htlc_min),
8090 htlc_maximum_msat: Some(htlc_min * 100),
8093 PaymentParameters::from_node_id(nodes[1], 42)
8094 .with_route_hints(route_hints).unwrap()
8095 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config)).unwrap()
8098 let netgraph = network_graph.read_only();
8099 let route_params = RouteParameters::from_payment_params_and_value(
8100 payment_params, amt_msat);
8102 let route = get_route(
8103 &our_id, &route_params, &netgraph, Some(&first_hops.iter().collect::<Vec<_>>()),
8104 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes
8106 assert_eq!(route.paths.len(), 1);
8107 assert_eq!(route.get_total_amount(), amt_msat);
8111 fn candidate_path_min() {
8112 // Test that if a candidate first_hop<>network_node channel does not have enough contribution
8113 // amount to cover the next channel's min htlc plus fees, we will not consider that candidate.
8114 // Previously, we were storing RouteGraphNodes with a path_min that did not include fees, and
8115 // would add a connecting first_hop node that did not have enough contribution amount, leading
8116 // to a debug panic upon invalid path construction.
8117 let secp_ctx = Secp256k1::new();
8118 let logger = Arc::new(ln_test_utils::TestLogger::new());
8119 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
8120 let gossip_sync = P2PGossipSync::new(network_graph.clone(), None, logger.clone());
8121 let scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), network_graph.clone(), logger.clone());
8122 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
8123 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8124 let config = UserConfig::default();
8126 // Values are taken from the fuzz input that uncovered this panic.
8127 let amt_msat = 7_4009_8048;
8128 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
8129 let first_hops = vec![get_channel_details(
8130 Some(200), nodes[0], channelmanager::provided_init_features(&config), 2_7345_2000
8133 add_channel(&gossip_sync, &secp_ctx, &privkeys[0], &privkeys[6], ChannelFeatures::from_le_bytes(id_to_feature_flags(6)), 6);
8134 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
8135 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
8136 short_channel_id: 6,
8139 cltv_expiry_delta: (6 << 4) | 0,
8140 htlc_minimum_msat: 0,
8141 htlc_maximum_msat: MAX_VALUE_MSAT,
8143 fee_proportional_millionths: 0,
8144 excess_data: Vec::new()
8146 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[0], NodeFeatures::from_le_bytes(id_to_feature_flags(1)), 0);
8148 let htlc_min = 2_5165_8240;
8149 let blinded_hints = vec![
8151 fee_base_msat: 1_6778_3453,
8152 fee_proportional_millionths: 0,
8153 htlc_minimum_msat: htlc_min,
8154 htlc_maximum_msat: htlc_min * 100,
8155 cltv_expiry_delta: 10,
8156 features: BlindedHopFeatures::empty(),
8158 introduction_node: IntroductionNode::NodeId(nodes[0]),
8159 blinding_point: ln_test_utils::pubkey(42),
8161 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
8162 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
8166 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
8167 let payment_params = PaymentParameters::blinded(blinded_hints.clone())
8168 .with_bolt12_features(bolt12_features.clone()).unwrap();
8169 let route_params = RouteParameters::from_payment_params_and_value(
8170 payment_params, amt_msat);
8171 let netgraph = network_graph.read_only();
8173 if let Err(LightningError { err, .. }) = get_route(
8174 &our_id, &route_params, &netgraph, Some(&first_hops.iter().collect::<Vec<_>>()),
8175 Arc::clone(&logger), &scorer, &ProbabilisticScoringFeeParameters::default(),
8178 assert_eq!(err, "Failed to find a path to the given destination");
8183 fn path_contribution_includes_min_htlc_overpay() {
8184 // Previously, the fuzzer hit a debug panic because we wouldn't include the amount overpaid to
8185 // meet a last hop's min_htlc in the total collected paths value. We now include this value and
8186 // also penalize hops along the overpaying path to ensure that it gets deprioritized in path
8187 // selection, both tested here.
8188 let secp_ctx = Secp256k1::new();
8189 let logger = Arc::new(ln_test_utils::TestLogger::new());
8190 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
8191 let scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), network_graph.clone(), logger.clone());
8192 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
8193 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8194 let config = UserConfig::default();
8196 // Values are taken from the fuzz input that uncovered this panic.
8197 let amt_msat = 562_0000;
8198 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
8199 let first_hops = vec![
8200 get_channel_details(
8201 Some(83), nodes[0], channelmanager::provided_init_features(&config), 2199_0000,
8205 let htlc_mins = [49_0000, 1125_0000];
8206 let payment_params = {
8207 let blinded_path = BlindedPath {
8208 introduction_node: IntroductionNode::NodeId(nodes[0]),
8209 blinding_point: ln_test_utils::pubkey(42),
8211 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
8212 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
8215 let mut blinded_hints = Vec::new();
8216 for htlc_min in htlc_mins.iter() {
8217 blinded_hints.push((BlindedPayInfo {
8219 fee_proportional_millionths: 0,
8220 htlc_minimum_msat: *htlc_min,
8221 htlc_maximum_msat: *htlc_min * 100,
8222 cltv_expiry_delta: 10,
8223 features: BlindedHopFeatures::empty(),
8224 }, blinded_path.clone()));
8226 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
8227 PaymentParameters::blinded(blinded_hints.clone())
8228 .with_bolt12_features(bolt12_features.clone()).unwrap()
8231 let netgraph = network_graph.read_only();
8232 let route_params = RouteParameters::from_payment_params_and_value(
8233 payment_params, amt_msat);
8234 let route = get_route(
8235 &our_id, &route_params, &netgraph, Some(&first_hops.iter().collect::<Vec<_>>()),
8236 Arc::clone(&logger), &scorer, &ProbabilisticScoringFeeParameters::default(),
8239 assert_eq!(route.paths.len(), 1);
8240 assert_eq!(route.get_total_amount(), amt_msat);
8244 fn first_hop_preferred_over_hint() {
8245 // Check that if we have a first hop to a peer we'd always prefer that over a route hint
8246 // they gave us, but we'd still consider all subsequent hints if they are more attractive.
8247 let secp_ctx = Secp256k1::new();
8248 let logger = Arc::new(ln_test_utils::TestLogger::new());
8249 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
8250 let gossip_sync = P2PGossipSync::new(Arc::clone(&network_graph), None, Arc::clone(&logger));
8251 let scorer = ln_test_utils::TestScorer::new();
8252 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
8253 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8254 let config = UserConfig::default();
8256 let amt_msat = 1_000_000;
8257 let (our_privkey, our_node_id, privkeys, nodes) = get_nodes(&secp_ctx);
8259 add_channel(&gossip_sync, &secp_ctx, &our_privkey, &privkeys[0],
8260 ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 1);
8261 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
8262 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
8263 short_channel_id: 1,
8266 cltv_expiry_delta: 42,
8267 htlc_minimum_msat: 1_000,
8268 htlc_maximum_msat: 10_000_000,
8270 fee_proportional_millionths: 0,
8271 excess_data: Vec::new()
8273 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
8274 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
8275 short_channel_id: 1,
8278 cltv_expiry_delta: 42,
8279 htlc_minimum_msat: 1_000,
8280 htlc_maximum_msat: 10_000_000,
8282 fee_proportional_millionths: 0,
8283 excess_data: Vec::new()
8286 add_channel(&gossip_sync, &secp_ctx, &privkeys[0], &privkeys[1],
8287 ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 2);
8288 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
8289 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
8290 short_channel_id: 2,
8293 cltv_expiry_delta: 42,
8294 htlc_minimum_msat: 1_000,
8295 htlc_maximum_msat: 10_000_000,
8297 fee_proportional_millionths: 0,
8298 excess_data: Vec::new()
8300 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
8301 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
8302 short_channel_id: 2,
8305 cltv_expiry_delta: 42,
8306 htlc_minimum_msat: 1_000,
8307 htlc_maximum_msat: 10_000_000,
8309 fee_proportional_millionths: 0,
8310 excess_data: Vec::new()
8313 let dest_node_id = nodes[2];
8315 let route_hint = RouteHint(vec![RouteHintHop {
8316 src_node_id: our_node_id,
8317 short_channel_id: 44,
8320 proportional_millionths: 0,
8322 cltv_expiry_delta: 10,
8323 htlc_minimum_msat: None,
8324 htlc_maximum_msat: Some(5_000_000),
8327 src_node_id: nodes[0],
8328 short_channel_id: 45,
8331 proportional_millionths: 0,
8333 cltv_expiry_delta: 10,
8334 htlc_minimum_msat: None,
8335 htlc_maximum_msat: None,
8338 let payment_params = PaymentParameters::from_node_id(dest_node_id, 42)
8339 .with_route_hints(vec![route_hint]).unwrap()
8340 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config)).unwrap();
8341 let route_params = RouteParameters::from_payment_params_and_value(
8342 payment_params, amt_msat);
8344 // First create an insufficient first hop for channel with SCID 1 and check we'd use the
8346 let first_hop = get_channel_details(Some(1), nodes[0],
8347 channelmanager::provided_init_features(&config), 999_999);
8348 let first_hops = vec![first_hop];
8350 let route = get_route(&our_node_id, &route_params.clone(), &network_graph.read_only(),
8351 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
8352 &Default::default(), &random_seed_bytes).unwrap();
8353 assert_eq!(route.paths.len(), 1);
8354 assert_eq!(route.get_total_amount(), amt_msat);
8355 assert_eq!(route.paths[0].hops.len(), 2);
8356 assert_eq!(route.paths[0].hops[0].short_channel_id, 44);
8357 assert_eq!(route.paths[0].hops[1].short_channel_id, 45);
8358 assert_eq!(route.get_total_fees(), 123);
8360 // Now check we would trust our first hop info, i.e., fail if we detect the route hint is
8361 // for a first hop channel.
8362 let mut first_hop = get_channel_details(Some(1), nodes[0], channelmanager::provided_init_features(&config), 999_999);
8363 first_hop.outbound_scid_alias = Some(44);
8364 let first_hops = vec![first_hop];
8366 let route_res = get_route(&our_node_id, &route_params.clone(), &network_graph.read_only(),
8367 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
8368 &Default::default(), &random_seed_bytes);
8369 assert!(route_res.is_err());
8371 // Finally check we'd use the first hop if has sufficient outbound capacity. But we'd stil
8372 // use the cheaper second hop of the route hint.
8373 let mut first_hop = get_channel_details(Some(1), nodes[0],
8374 channelmanager::provided_init_features(&config), 10_000_000);
8375 first_hop.outbound_scid_alias = Some(44);
8376 let first_hops = vec![first_hop];
8378 let route = get_route(&our_node_id, &route_params.clone(), &network_graph.read_only(),
8379 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
8380 &Default::default(), &random_seed_bytes).unwrap();
8381 assert_eq!(route.paths.len(), 1);
8382 assert_eq!(route.get_total_amount(), amt_msat);
8383 assert_eq!(route.paths[0].hops.len(), 2);
8384 assert_eq!(route.paths[0].hops[0].short_channel_id, 1);
8385 assert_eq!(route.paths[0].hops[1].short_channel_id, 45);
8386 assert_eq!(route.get_total_fees(), 123);
8390 fn allow_us_being_first_hint() {
8391 // Check that we consider a route hint even if we are the src of the first hop.
8392 let secp_ctx = Secp256k1::new();
8393 let logger = Arc::new(ln_test_utils::TestLogger::new());
8394 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
8395 let scorer = ln_test_utils::TestScorer::new();
8396 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
8397 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8398 let config = UserConfig::default();
8400 let (_, our_node_id, _, nodes) = get_nodes(&secp_ctx);
8402 let amt_msat = 1_000_000;
8403 let dest_node_id = nodes[1];
8405 let first_hop = get_channel_details(Some(1), nodes[0], channelmanager::provided_init_features(&config), 10_000_000);
8406 let first_hops = vec![first_hop];
8408 let route_hint = RouteHint(vec![RouteHintHop {
8409 src_node_id: our_node_id,
8410 short_channel_id: 44,
8413 proportional_millionths: 0,
8415 cltv_expiry_delta: 10,
8416 htlc_minimum_msat: None,
8417 htlc_maximum_msat: None,
8420 let payment_params = PaymentParameters::from_node_id(dest_node_id, 42)
8421 .with_route_hints(vec![route_hint]).unwrap()
8422 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config)).unwrap();
8424 let route_params = RouteParameters::from_payment_params_and_value(
8425 payment_params, amt_msat);
8428 let route = get_route(&our_node_id, &route_params, &network_graph.read_only(),
8429 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
8430 &Default::default(), &random_seed_bytes).unwrap();
8432 assert_eq!(route.paths.len(), 1);
8433 assert_eq!(route.get_total_amount(), amt_msat);
8434 assert_eq!(route.get_total_fees(), 0);
8435 assert_eq!(route.paths[0].hops.len(), 1);
8437 assert_eq!(route.paths[0].hops[0].short_channel_id, 44);
8441 #[cfg(all(any(test, ldk_bench), feature = "std"))]
8442 pub(crate) mod bench_utils {
8445 use std::time::Duration;
8447 use bitcoin::hashes::Hash;
8448 use bitcoin::secp256k1::SecretKey;
8450 use crate::chain::transaction::OutPoint;
8451 use crate::routing::scoring::ScoreUpdate;
8452 use crate::sign::KeysManager;
8453 use crate::ln::types::ChannelId;
8454 use crate::ln::channelmanager::{self, ChannelCounterparty};
8455 use crate::util::config::UserConfig;
8456 use crate::util::test_utils::TestLogger;
8458 /// Tries to open a network graph file, or panics with a URL to fetch it.
8459 pub(crate) fn get_route_file() -> Result<std::fs::File, &'static str> {
8460 let res = File::open("net_graph-2023-01-18.bin") // By default we're run in RL/lightning
8461 .or_else(|_| File::open("lightning/net_graph-2023-01-18.bin")) // We may be run manually in RL/
8462 .or_else(|_| { // Fall back to guessing based on the binary location
8463 // path is likely something like .../rust-lightning/target/debug/deps/lightning-...
8464 let mut path = std::env::current_exe().unwrap();
8465 path.pop(); // lightning-...
8467 path.pop(); // debug
8468 path.pop(); // target
8469 path.push("lightning");
8470 path.push("net_graph-2023-01-18.bin");
8473 .or_else(|_| { // Fall back to guessing based on the binary location for a subcrate
8474 // path is likely something like .../rust-lightning/bench/target/debug/deps/bench..
8475 let mut path = std::env::current_exe().unwrap();
8476 path.pop(); // bench...
8478 path.pop(); // debug
8479 path.pop(); // target
8480 path.pop(); // bench
8481 path.push("lightning");
8482 path.push("net_graph-2023-01-18.bin");
8485 .map_err(|_| "Please fetch https://bitcoin.ninja/ldk-net_graph-v0.0.113-2023-01-18.bin and place it at lightning/net_graph-2023-01-18.bin");
8486 #[cfg(require_route_graph_test)]
8487 return Ok(res.unwrap());
8488 #[cfg(not(require_route_graph_test))]
8492 pub(crate) fn read_network_graph(logger: &TestLogger) -> Result<NetworkGraph<&TestLogger>, &'static str> {
8493 get_route_file().map(|mut f| NetworkGraph::read(&mut f, logger).unwrap())
8496 pub(crate) fn payer_pubkey() -> PublicKey {
8497 let secp_ctx = Secp256k1::new();
8498 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap())
8502 pub(crate) fn first_hop(node_id: PublicKey) -> ChannelDetails {
8504 channel_id: ChannelId::new_zero(),
8505 counterparty: ChannelCounterparty {
8506 features: channelmanager::provided_init_features(&UserConfig::default()),
8508 unspendable_punishment_reserve: 0,
8509 forwarding_info: None,
8510 outbound_htlc_minimum_msat: None,
8511 outbound_htlc_maximum_msat: None,
8513 funding_txo: Some(OutPoint {
8514 txid: bitcoin::Txid::from_slice(&[0; 32]).unwrap(), index: 0
8517 short_channel_id: Some(1),
8518 inbound_scid_alias: None,
8519 outbound_scid_alias: None,
8520 channel_value_satoshis: 10_000_000_000,
8522 balance_msat: 10_000_000_000,
8523 outbound_capacity_msat: 10_000_000_000,
8524 next_outbound_htlc_minimum_msat: 0,
8525 next_outbound_htlc_limit_msat: 10_000_000_000,
8526 inbound_capacity_msat: 0,
8527 unspendable_punishment_reserve: None,
8528 confirmations_required: None,
8529 confirmations: None,
8530 force_close_spend_delay: None,
8532 is_channel_ready: true,
8535 inbound_htlc_minimum_msat: None,
8536 inbound_htlc_maximum_msat: None,
8538 feerate_sat_per_1000_weight: None,
8539 channel_shutdown_state: Some(channelmanager::ChannelShutdownState::NotShuttingDown),
8540 pending_inbound_htlcs: Vec::new(),
8541 pending_outbound_htlcs: Vec::new(),
8545 pub(crate) fn generate_test_routes<S: ScoreLookUp + ScoreUpdate>(graph: &NetworkGraph<&TestLogger>, scorer: &mut S,
8546 score_params: &S::ScoreParams, features: Bolt11InvoiceFeatures, mut seed: u64,
8547 starting_amount: u64, route_count: usize,
8548 ) -> Vec<(ChannelDetails, PaymentParameters, u64)> {
8549 let payer = payer_pubkey();
8550 let keys_manager = KeysManager::new(&[0u8; 32], 42, 42);
8551 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8553 let nodes = graph.read_only().nodes().clone();
8554 let mut route_endpoints = Vec::new();
8555 // Fetch 1.5x more routes than we need as after we do some scorer updates we may end up
8556 // with some routes we picked being un-routable.
8557 for _ in 0..route_count * 3 / 2 {
8559 seed = seed.overflowing_mul(6364136223846793005).0.overflowing_add(1).0;
8560 let src = PublicKey::from_slice(nodes.unordered_keys()
8561 .skip((seed as usize) % nodes.len()).next().unwrap().as_slice()).unwrap();
8562 seed = seed.overflowing_mul(6364136223846793005).0.overflowing_add(1).0;
8563 let dst = PublicKey::from_slice(nodes.unordered_keys()
8564 .skip((seed as usize) % nodes.len()).next().unwrap().as_slice()).unwrap();
8565 let params = PaymentParameters::from_node_id(dst, 42)
8566 .with_bolt11_features(features.clone()).unwrap();
8567 let first_hop = first_hop(src);
8568 let amt_msat = starting_amount + seed % 1_000_000;
8569 let route_params = RouteParameters::from_payment_params_and_value(
8570 params.clone(), amt_msat);
8572 get_route(&payer, &route_params, &graph.read_only(), Some(&[&first_hop]),
8573 &TestLogger::new(), scorer, score_params, &random_seed_bytes).is_ok();
8575 // ...and seed the scorer with success and failure data...
8576 seed = seed.overflowing_mul(6364136223846793005).0.overflowing_add(1).0;
8577 let mut score_amt = seed % 1_000_000_000;
8579 // Generate fail/success paths for a wider range of potential amounts with
8580 // MPP enabled to give us a chance to apply penalties for more potential
8582 let mpp_features = channelmanager::provided_bolt11_invoice_features(&UserConfig::default());
8583 let params = PaymentParameters::from_node_id(dst, 42)
8584 .with_bolt11_features(mpp_features).unwrap();
8585 let route_params = RouteParameters::from_payment_params_and_value(
8586 params.clone(), score_amt);
8587 let route_res = get_route(&payer, &route_params, &graph.read_only(),
8588 Some(&[&first_hop]), &TestLogger::new(), scorer, score_params,
8589 &random_seed_bytes);
8590 if let Ok(route) = route_res {
8591 for path in route.paths {
8592 if seed & 0x80 == 0 {
8593 scorer.payment_path_successful(&path, Duration::ZERO);
8595 let short_channel_id = path.hops[path.hops.len() / 2].short_channel_id;
8596 scorer.payment_path_failed(&path, short_channel_id, Duration::ZERO);
8598 seed = seed.overflowing_mul(6364136223846793005).0.overflowing_add(1).0;
8602 // If we couldn't find a path with a higher amount, reduce and try again.
8606 route_endpoints.push((first_hop, params, amt_msat));
8612 // Because we've changed channel scores, it's possible we'll take different routes to the
8613 // selected destinations, possibly causing us to fail because, eg, the newly-selected path
8614 // requires a too-high CLTV delta.
8615 route_endpoints.retain(|(first_hop, params, amt_msat)| {
8616 let route_params = RouteParameters::from_payment_params_and_value(
8617 params.clone(), *amt_msat);
8618 get_route(&payer, &route_params, &graph.read_only(), Some(&[first_hop]),
8619 &TestLogger::new(), scorer, score_params, &random_seed_bytes).is_ok()
8621 route_endpoints.truncate(route_count);
8622 assert_eq!(route_endpoints.len(), route_count);
8630 use crate::routing::scoring::{ScoreUpdate, ScoreLookUp};
8631 use crate::sign::{EntropySource, KeysManager};
8632 use crate::ln::channelmanager;
8633 use crate::ln::features::Bolt11InvoiceFeatures;
8634 use crate::routing::gossip::NetworkGraph;
8635 use crate::routing::scoring::{FixedPenaltyScorer, ProbabilisticScorer, ProbabilisticScoringFeeParameters, ProbabilisticScoringDecayParameters};
8636 use crate::util::config::UserConfig;
8637 use crate::util::logger::{Logger, Record};
8638 use crate::util::test_utils::TestLogger;
8640 use criterion::Criterion;
8642 struct DummyLogger {}
8643 impl Logger for DummyLogger {
8644 fn log(&self, _record: Record) {}
8647 pub fn generate_routes_with_zero_penalty_scorer(bench: &mut Criterion) {
8648 let logger = TestLogger::new();
8649 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8650 let scorer = FixedPenaltyScorer::with_penalty(0);
8651 generate_routes(bench, &network_graph, scorer, &Default::default(),
8652 Bolt11InvoiceFeatures::empty(), 0, "generate_routes_with_zero_penalty_scorer");
8655 pub fn generate_mpp_routes_with_zero_penalty_scorer(bench: &mut Criterion) {
8656 let logger = TestLogger::new();
8657 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8658 let scorer = FixedPenaltyScorer::with_penalty(0);
8659 generate_routes(bench, &network_graph, scorer, &Default::default(),
8660 channelmanager::provided_bolt11_invoice_features(&UserConfig::default()), 0,
8661 "generate_mpp_routes_with_zero_penalty_scorer");
8664 pub fn generate_routes_with_probabilistic_scorer(bench: &mut Criterion) {
8665 let logger = TestLogger::new();
8666 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8667 let params = ProbabilisticScoringFeeParameters::default();
8668 let scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), &network_graph, &logger);
8669 generate_routes(bench, &network_graph, scorer, ¶ms, Bolt11InvoiceFeatures::empty(), 0,
8670 "generate_routes_with_probabilistic_scorer");
8673 pub fn generate_mpp_routes_with_probabilistic_scorer(bench: &mut Criterion) {
8674 let logger = TestLogger::new();
8675 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8676 let params = ProbabilisticScoringFeeParameters::default();
8677 let scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), &network_graph, &logger);
8678 generate_routes(bench, &network_graph, scorer, ¶ms,
8679 channelmanager::provided_bolt11_invoice_features(&UserConfig::default()), 0,
8680 "generate_mpp_routes_with_probabilistic_scorer");
8683 pub fn generate_large_mpp_routes_with_probabilistic_scorer(bench: &mut Criterion) {
8684 let logger = TestLogger::new();
8685 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8686 let params = ProbabilisticScoringFeeParameters::default();
8687 let scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), &network_graph, &logger);
8688 generate_routes(bench, &network_graph, scorer, ¶ms,
8689 channelmanager::provided_bolt11_invoice_features(&UserConfig::default()), 100_000_000,
8690 "generate_large_mpp_routes_with_probabilistic_scorer");
8693 pub fn generate_routes_with_nonlinear_probabilistic_scorer(bench: &mut Criterion) {
8694 let logger = TestLogger::new();
8695 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8696 let mut params = ProbabilisticScoringFeeParameters::default();
8697 params.linear_success_probability = false;
8698 let scorer = ProbabilisticScorer::new(
8699 ProbabilisticScoringDecayParameters::default(), &network_graph, &logger);
8700 generate_routes(bench, &network_graph, scorer, ¶ms,
8701 channelmanager::provided_bolt11_invoice_features(&UserConfig::default()), 0,
8702 "generate_routes_with_nonlinear_probabilistic_scorer");
8705 pub fn generate_mpp_routes_with_nonlinear_probabilistic_scorer(bench: &mut Criterion) {
8706 let logger = TestLogger::new();
8707 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8708 let mut params = ProbabilisticScoringFeeParameters::default();
8709 params.linear_success_probability = false;
8710 let scorer = ProbabilisticScorer::new(
8711 ProbabilisticScoringDecayParameters::default(), &network_graph, &logger);
8712 generate_routes(bench, &network_graph, scorer, ¶ms,
8713 channelmanager::provided_bolt11_invoice_features(&UserConfig::default()), 0,
8714 "generate_mpp_routes_with_nonlinear_probabilistic_scorer");
8717 pub fn generate_large_mpp_routes_with_nonlinear_probabilistic_scorer(bench: &mut Criterion) {
8718 let logger = TestLogger::new();
8719 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8720 let mut params = ProbabilisticScoringFeeParameters::default();
8721 params.linear_success_probability = false;
8722 let scorer = ProbabilisticScorer::new(
8723 ProbabilisticScoringDecayParameters::default(), &network_graph, &logger);
8724 generate_routes(bench, &network_graph, scorer, ¶ms,
8725 channelmanager::provided_bolt11_invoice_features(&UserConfig::default()), 100_000_000,
8726 "generate_large_mpp_routes_with_nonlinear_probabilistic_scorer");
8729 fn generate_routes<S: ScoreLookUp + ScoreUpdate>(
8730 bench: &mut Criterion, graph: &NetworkGraph<&TestLogger>, mut scorer: S,
8731 score_params: &S::ScoreParams, features: Bolt11InvoiceFeatures, starting_amount: u64,
8732 bench_name: &'static str,
8734 let payer = bench_utils::payer_pubkey();
8735 let keys_manager = KeysManager::new(&[0u8; 32], 42, 42);
8736 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8738 // First, get 100 (source, destination) pairs for which route-getting actually succeeds...
8739 let route_endpoints = bench_utils::generate_test_routes(graph, &mut scorer, score_params, features, 0xdeadbeef, starting_amount, 50);
8741 // ...then benchmark finding paths between the nodes we learned.
8743 bench.bench_function(bench_name, |b| b.iter(|| {
8744 let (first_hop, params, amt) = &route_endpoints[idx % route_endpoints.len()];
8745 let route_params = RouteParameters::from_payment_params_and_value(params.clone(), *amt);
8746 assert!(get_route(&payer, &route_params, &graph.read_only(), Some(&[first_hop]),
8747 &DummyLogger{}, &scorer, score_params, &random_seed_bytes).is_ok());