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::message;
16 use crate::blinded_path::payment::{ForwardTlvs, PaymentConstraints, PaymentRelay, ReceiveTlvs, self};
17 use crate::ln::{PaymentHash, PaymentPreimage};
18 use crate::ln::channelmanager::{ChannelDetails, PaymentId, MIN_FINAL_CLTV_EXPIRY_DELTA, RecipientOnionFields};
19 use crate::ln::features::{BlindedHopFeatures, Bolt11InvoiceFeatures, Bolt12InvoiceFeatures, ChannelFeatures, NodeFeatures};
20 use crate::ln::msgs::{DecodeError, ErrorAction, LightningError, MAX_VALUE_MSAT};
21 use crate::ln::onion_utils;
22 use crate::offers::invoice::{BlindedPayInfo, Bolt12Invoice};
23 use crate::onion_message::messenger::{DefaultMessageRouter, Destination, MessageRouter, OnionMessagePath};
24 use crate::routing::gossip::{DirectedChannelInfo, EffectiveCapacity, ReadOnlyNetworkGraph, NetworkGraph, NodeId, RoutingFees};
25 use crate::routing::scoring::{ChannelUsage, LockableScore, ScoreLookUp};
26 use crate::sign::EntropySource;
27 use crate::util::ser::{Writeable, Readable, ReadableArgs, Writer};
28 use crate::util::logger::{Level, Logger};
29 use crate::crypto::chacha20::ChaCha20;
32 use crate::prelude::*;
33 use alloc::collections::BinaryHeap;
37 /// A [`Router`] implemented using [`find_route`].
38 pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>> + Clone, L: Deref, ES: Deref, S: Deref, SP: Sized, Sc: ScoreLookUp<ScoreParams = SP>> where
40 S::Target: for <'a> LockableScore<'a, ScoreLookUp = Sc>,
41 ES::Target: EntropySource,
48 message_router: DefaultMessageRouter<G, L, ES>,
51 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
53 S::Target: for <'a> LockableScore<'a, ScoreLookUp = Sc>,
54 ES::Target: EntropySource,
56 /// Creates a new router.
57 pub fn new(network_graph: G, logger: L, entropy_source: ES, scorer: S, score_params: SP) -> Self {
58 let message_router = DefaultMessageRouter::new(network_graph.clone(), entropy_source.clone());
59 Self { network_graph, logger, entropy_source, scorer, score_params, message_router }
63 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
65 S::Target: for <'a> LockableScore<'a, ScoreLookUp = Sc>,
66 ES::Target: EntropySource,
71 params: &RouteParameters,
72 first_hops: Option<&[&ChannelDetails]>,
73 inflight_htlcs: InFlightHtlcs
74 ) -> Result<Route, LightningError> {
75 let random_seed_bytes = self.entropy_source.get_secure_random_bytes();
77 payer, params, &self.network_graph, first_hops, &*self.logger,
78 &ScorerAccountingForInFlightHtlcs::new(self.scorer.read_lock(), &inflight_htlcs),
84 fn create_blinded_payment_paths<
85 T: secp256k1::Signing + secp256k1::Verification
87 &self, recipient: PublicKey, first_hops: Vec<ChannelDetails>, tlvs: ReceiveTlvs,
88 amount_msats: u64, secp_ctx: &Secp256k1<T>
89 ) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()> {
90 // Limit the number of blinded paths that are computed.
91 const MAX_PAYMENT_PATHS: usize = 3;
93 // Ensure peers have at least three channels so that it is more difficult to infer the
94 // recipient's node_id.
95 const MIN_PEER_CHANNELS: usize = 3;
97 let network_graph = self.network_graph.deref().read_only();
98 let paths = first_hops.into_iter()
99 .filter(|details| details.counterparty.features.supports_route_blinding())
100 .filter(|details| amount_msats <= details.inbound_capacity_msat)
101 .filter(|details| amount_msats >= details.inbound_htlc_minimum_msat.unwrap_or(0))
102 .filter(|details| amount_msats <= details.inbound_htlc_maximum_msat.unwrap_or(u64::MAX))
103 .filter(|details| network_graph
104 .node(&NodeId::from_pubkey(&details.counterparty.node_id))
105 .map(|node_info| node_info.channels.len() >= MIN_PEER_CHANNELS)
108 .filter_map(|details| {
109 let short_channel_id = match details.get_inbound_payment_scid() {
110 Some(short_channel_id) => short_channel_id,
113 let payment_relay: PaymentRelay = match details.counterparty.forwarding_info {
114 Some(forwarding_info) => match forwarding_info.try_into() {
115 Ok(payment_relay) => payment_relay,
116 Err(()) => return None,
121 let cltv_expiry_delta = payment_relay.cltv_expiry_delta as u32;
122 let payment_constraints = PaymentConstraints {
123 max_cltv_expiry: tlvs.payment_constraints.max_cltv_expiry + cltv_expiry_delta,
124 htlc_minimum_msat: details.inbound_htlc_minimum_msat.unwrap_or(0),
126 Some(payment::ForwardNode {
131 features: BlindedHopFeatures::empty(),
133 node_id: details.counterparty.node_id,
134 htlc_maximum_msat: details.inbound_htlc_maximum_msat.unwrap_or(u64::MAX),
137 .map(|forward_node| {
138 BlindedPath::new_for_payment(
139 &[forward_node], recipient, tlvs.clone(), u64::MAX, MIN_FINAL_CLTV_EXPIRY_DELTA,
140 &*self.entropy_source, secp_ctx
143 .take(MAX_PAYMENT_PATHS)
144 .collect::<Result<Vec<_>, _>>();
147 Ok(paths) if !paths.is_empty() => Ok(paths),
149 if network_graph.nodes().contains_key(&NodeId::from_pubkey(&recipient)) {
150 BlindedPath::one_hop_for_payment(
151 recipient, tlvs, MIN_FINAL_CLTV_EXPIRY_DELTA, &*self.entropy_source, secp_ctx
152 ).map(|path| vec![path])
161 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
163 S::Target: for <'a> LockableScore<'a, ScoreLookUp = Sc>,
164 ES::Target: EntropySource,
167 &self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
168 ) -> Result<OnionMessagePath, ()> {
169 self.message_router.find_path(sender, peers, destination)
172 fn create_blinded_paths<
173 T: secp256k1::Signing + secp256k1::Verification
175 &self, recipient: PublicKey, peers: Vec<message::ForwardNode>, secp_ctx: &Secp256k1<T>,
176 ) -> Result<Vec<BlindedPath>, ()> {
177 self.message_router.create_blinded_paths(recipient, peers, secp_ctx)
181 /// A trait defining behavior for routing a payment.
182 pub trait Router: MessageRouter {
183 /// Finds a [`Route`] for a payment between the given `payer` and a payee.
185 /// The `payee` and the payment's value are given in [`RouteParameters::payment_params`]
186 /// and [`RouteParameters::final_value_msat`], respectively.
188 &self, payer: &PublicKey, route_params: &RouteParameters,
189 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs
190 ) -> Result<Route, LightningError>;
192 /// Finds a [`Route`] for a payment between the given `payer` and a payee.
194 /// The `payee` and the payment's value are given in [`RouteParameters::payment_params`]
195 /// and [`RouteParameters::final_value_msat`], respectively.
197 /// Includes a [`PaymentHash`] and a [`PaymentId`] to be able to correlate the request with a specific
199 fn find_route_with_id(
200 &self, payer: &PublicKey, route_params: &RouteParameters,
201 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs,
202 _payment_hash: PaymentHash, _payment_id: PaymentId
203 ) -> Result<Route, LightningError> {
204 self.find_route(payer, route_params, first_hops, inflight_htlcs)
207 /// Creates [`BlindedPath`]s for payment to the `recipient` node. The channels in `first_hops`
208 /// are assumed to be with the `recipient`'s peers. The payment secret and any constraints are
210 fn create_blinded_payment_paths<
211 T: secp256k1::Signing + secp256k1::Verification
213 &self, recipient: PublicKey, first_hops: Vec<ChannelDetails>, tlvs: ReceiveTlvs,
214 amount_msats: u64, secp_ctx: &Secp256k1<T>
215 ) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()>;
218 /// [`ScoreLookUp`] implementation that factors in in-flight HTLC liquidity.
220 /// Useful for custom [`Router`] implementations to wrap their [`ScoreLookUp`] on-the-fly when calling
223 /// [`ScoreLookUp`]: crate::routing::scoring::ScoreLookUp
224 pub struct ScorerAccountingForInFlightHtlcs<'a, S: Deref> where S::Target: ScoreLookUp {
226 // Maps a channel's short channel id and its direction to the liquidity used up.
227 inflight_htlcs: &'a InFlightHtlcs,
229 impl<'a, S: Deref> ScorerAccountingForInFlightHtlcs<'a, S> where S::Target: ScoreLookUp {
230 /// Initialize a new `ScorerAccountingForInFlightHtlcs`.
231 pub fn new(scorer: S, inflight_htlcs: &'a InFlightHtlcs) -> Self {
232 ScorerAccountingForInFlightHtlcs {
239 impl<'a, S: Deref> ScoreLookUp for ScorerAccountingForInFlightHtlcs<'a, S> where S::Target: ScoreLookUp {
240 type ScoreParams = <S::Target as ScoreLookUp>::ScoreParams;
241 fn channel_penalty_msat(&self, candidate: &CandidateRouteHop, usage: ChannelUsage, score_params: &Self::ScoreParams) -> u64 {
242 let target = match candidate.target() {
243 Some(target) => target,
244 None => return self.scorer.channel_penalty_msat(candidate, usage, score_params),
246 let short_channel_id = match candidate.short_channel_id() {
247 Some(short_channel_id) => short_channel_id,
248 None => return self.scorer.channel_penalty_msat(candidate, usage, score_params),
250 let source = candidate.source();
251 if let Some(used_liquidity) = self.inflight_htlcs.used_liquidity_msat(
252 &source, &target, short_channel_id
254 let usage = ChannelUsage {
255 inflight_htlc_msat: usage.inflight_htlc_msat.saturating_add(used_liquidity),
259 self.scorer.channel_penalty_msat(candidate, usage, score_params)
261 self.scorer.channel_penalty_msat(candidate, usage, score_params)
266 /// A data structure for tracking in-flight HTLCs. May be used during pathfinding to account for
267 /// in-use channel liquidity.
269 pub struct InFlightHtlcs(
270 // A map with liquidity value (in msat) keyed by a short channel id and the direction the HTLC
271 // is traveling in. The direction boolean is determined by checking if the HTLC source's public
272 // key is less than its destination. See `InFlightHtlcs::used_liquidity_msat` for more
274 HashMap<(u64, bool), u64>
278 /// Constructs an empty `InFlightHtlcs`.
279 pub fn new() -> Self { InFlightHtlcs(new_hash_map()) }
281 /// Takes in a path with payer's node id and adds the path's details to `InFlightHtlcs`.
282 pub fn process_path(&mut self, path: &Path, payer_node_id: PublicKey) {
283 if path.hops.is_empty() { return };
285 let mut cumulative_msat = 0;
286 if let Some(tail) = &path.blinded_tail {
287 cumulative_msat += tail.final_value_msat;
290 // total_inflight_map needs to be direction-sensitive when keeping track of the HTLC value
291 // that is held up. However, the `hops` array, which is a path returned by `find_route` in
292 // the router excludes the payer node. In the following lines, the payer's information is
293 // hardcoded with an inflight value of 0 so that we can correctly represent the first hop
294 // in our sliding window of two.
295 let reversed_hops_with_payer = path.hops.iter().rev().skip(1)
296 .map(|hop| hop.pubkey)
297 .chain(core::iter::once(payer_node_id));
299 // Taking the reversed vector from above, we zip it with just the reversed hops list to
300 // work "backwards" of the given path, since the last hop's `fee_msat` actually represents
301 // the total amount sent.
302 for (next_hop, prev_hop) in path.hops.iter().rev().zip(reversed_hops_with_payer) {
303 cumulative_msat += next_hop.fee_msat;
305 .entry((next_hop.short_channel_id, NodeId::from_pubkey(&prev_hop) < NodeId::from_pubkey(&next_hop.pubkey)))
306 .and_modify(|used_liquidity_msat| *used_liquidity_msat += cumulative_msat)
307 .or_insert(cumulative_msat);
311 /// Adds a known HTLC given the public key of the HTLC source, target, and short channel
313 pub fn add_inflight_htlc(&mut self, source: &NodeId, target: &NodeId, channel_scid: u64, used_msat: u64){
315 .entry((channel_scid, source < target))
316 .and_modify(|used_liquidity_msat| *used_liquidity_msat += used_msat)
317 .or_insert(used_msat);
320 /// Returns liquidity in msat given the public key of the HTLC source, target, and short channel
322 pub fn used_liquidity_msat(&self, source: &NodeId, target: &NodeId, channel_scid: u64) -> Option<u64> {
323 self.0.get(&(channel_scid, source < target)).map(|v| *v)
327 impl Writeable for InFlightHtlcs {
328 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> { self.0.write(writer) }
331 impl Readable for InFlightHtlcs {
332 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
333 let infight_map: HashMap<(u64, bool), u64> = Readable::read(reader)?;
334 Ok(Self(infight_map))
338 /// A hop in a route, and additional metadata about it. "Hop" is defined as a node and the channel
339 /// that leads to it.
340 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
341 pub struct RouteHop {
342 /// The node_id of the node at this hop.
343 pub pubkey: PublicKey,
344 /// The node_announcement features of the node at this hop. For the last hop, these may be
345 /// amended to match the features present in the invoice this node generated.
346 pub node_features: NodeFeatures,
347 /// The channel that should be used from the previous hop to reach this node.
348 pub short_channel_id: u64,
349 /// The channel_announcement features of the channel that should be used from the previous hop
350 /// to reach this node.
351 pub channel_features: ChannelFeatures,
352 /// The fee taken on this hop (for paying for the use of the *next* channel in the path).
353 /// If this is the last hop in [`Path::hops`]:
354 /// * if we're sending to a [`BlindedPath`], this is the fee paid for use of the entire blinded path
355 /// * otherwise, this is the full value of this [`Path`]'s part of the payment
357 /// [`BlindedPath`]: crate::blinded_path::BlindedPath
359 /// The CLTV delta added for this hop.
360 /// If this is the last hop in [`Path::hops`]:
361 /// * if we're sending to a [`BlindedPath`], this is the CLTV delta for the entire blinded path
362 /// * otherwise, this is the CLTV delta expected at the destination
364 /// [`BlindedPath`]: crate::blinded_path::BlindedPath
365 pub cltv_expiry_delta: u32,
366 /// Indicates whether this hop is possibly announced in the public network graph.
368 /// Will be `true` if there is a possibility that the channel is publicly known, i.e., if we
369 /// either know for sure it's announced in the public graph, or if any public channels exist
370 /// for which the given `short_channel_id` could be an alias for. Will be `false` if we believe
371 /// the channel to be unannounced.
373 /// Will be `true` for objects serialized with LDK version 0.0.116 and before.
374 pub maybe_announced_channel: bool,
377 impl_writeable_tlv_based!(RouteHop, {
378 (0, pubkey, required),
379 (1, maybe_announced_channel, (default_value, true)),
380 (2, node_features, required),
381 (4, short_channel_id, required),
382 (6, channel_features, required),
383 (8, fee_msat, required),
384 (10, cltv_expiry_delta, required),
387 /// The blinded portion of a [`Path`], if we're routing to a recipient who provided blinded paths in
388 /// their [`Bolt12Invoice`].
390 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
391 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
392 pub struct BlindedTail {
393 /// The hops of the [`BlindedPath`] provided by the recipient.
395 /// [`BlindedPath`]: crate::blinded_path::BlindedPath
396 pub hops: Vec<BlindedHop>,
397 /// The blinding point of the [`BlindedPath`] provided by the recipient.
399 /// [`BlindedPath`]: crate::blinded_path::BlindedPath
400 pub blinding_point: PublicKey,
401 /// Excess CLTV delta added to the recipient's CLTV expiry to deter intermediate nodes from
402 /// inferring the destination. May be 0.
403 pub excess_final_cltv_expiry_delta: u32,
404 /// The total amount paid on this [`Path`], excluding the fees.
405 pub final_value_msat: u64,
408 impl_writeable_tlv_based!(BlindedTail, {
409 (0, hops, required_vec),
410 (2, blinding_point, required),
411 (4, excess_final_cltv_expiry_delta, required),
412 (6, final_value_msat, required),
415 /// A path in a [`Route`] to the payment recipient. Must always be at least length one.
416 /// If no [`Path::blinded_tail`] is present, then [`Path::hops`] length may be up to 19.
417 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
419 /// The list of unblinded hops in this [`Path`]. Must be at least length one.
420 pub hops: Vec<RouteHop>,
421 /// The blinded path at which this path terminates, if we're sending to one, and its metadata.
422 pub blinded_tail: Option<BlindedTail>,
426 /// Gets the fees for a given path, excluding any excess paid to the recipient.
427 pub fn fee_msat(&self) -> u64 {
428 match &self.blinded_tail {
429 Some(_) => self.hops.iter().map(|hop| hop.fee_msat).sum::<u64>(),
431 // Do not count last hop of each path since that's the full value of the payment
432 self.hops.split_last().map_or(0,
433 |(_, path_prefix)| path_prefix.iter().map(|hop| hop.fee_msat).sum())
438 /// Gets the total amount paid on this [`Path`], excluding the fees.
439 pub fn final_value_msat(&self) -> u64 {
440 match &self.blinded_tail {
441 Some(blinded_tail) => blinded_tail.final_value_msat,
442 None => self.hops.last().map_or(0, |hop| hop.fee_msat)
446 /// Gets the final hop's CLTV expiry delta.
447 pub fn final_cltv_expiry_delta(&self) -> Option<u32> {
448 match &self.blinded_tail {
450 None => self.hops.last().map(|hop| hop.cltv_expiry_delta)
455 /// A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
456 /// it can take multiple paths. Each path is composed of one or more hops through the network.
457 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
459 /// The list of [`Path`]s taken for a single (potentially-)multi-part payment. If no
460 /// [`BlindedTail`]s are present, then the pubkey of the last [`RouteHop`] in each path must be
462 pub paths: Vec<Path>,
463 /// The `route_params` parameter passed to [`find_route`].
465 /// This is used by `ChannelManager` to track information which may be required for retries.
467 /// Will be `None` for objects serialized with LDK versions prior to 0.0.117.
468 pub route_params: Option<RouteParameters>,
472 /// Returns the total amount of fees paid on this [`Route`].
474 /// For objects serialized with LDK 0.0.117 and after, this includes any extra payment made to
475 /// the recipient, which can happen in excess of the amount passed to [`find_route`] via
476 /// [`RouteParameters::final_value_msat`], if we had to reach the [`htlc_minimum_msat`] limits.
478 /// [`htlc_minimum_msat`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_update-message
479 pub fn get_total_fees(&self) -> u64 {
480 let overpaid_value_msat = self.route_params.as_ref()
481 .map_or(0, |p| self.get_total_amount().saturating_sub(p.final_value_msat));
482 overpaid_value_msat + self.paths.iter().map(|path| path.fee_msat()).sum::<u64>()
485 /// Returns the total amount paid on this [`Route`], excluding the fees.
487 /// Might be more than requested as part of the given [`RouteParameters::final_value_msat`] if
488 /// we had to reach the [`htlc_minimum_msat`] limits.
490 /// [`htlc_minimum_msat`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_update-message
491 pub fn get_total_amount(&self) -> u64 {
492 self.paths.iter().map(|path| path.final_value_msat()).sum()
496 impl fmt::Display for Route {
497 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
498 log_route!(self).fmt(f)
502 const SERIALIZATION_VERSION: u8 = 1;
503 const MIN_SERIALIZATION_VERSION: u8 = 1;
505 impl Writeable for Route {
506 fn write<W: crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
507 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
508 (self.paths.len() as u64).write(writer)?;
509 let mut blinded_tails = Vec::new();
510 for (idx, path) in self.paths.iter().enumerate() {
511 (path.hops.len() as u8).write(writer)?;
512 for hop in path.hops.iter() {
515 if let Some(blinded_tail) = &path.blinded_tail {
516 if blinded_tails.is_empty() {
517 blinded_tails = Vec::with_capacity(path.hops.len());
519 blinded_tails.push(None);
522 blinded_tails.push(Some(blinded_tail));
523 } else if !blinded_tails.is_empty() { blinded_tails.push(None); }
525 write_tlv_fields!(writer, {
526 // For compatibility with LDK versions prior to 0.0.117, we take the individual
527 // RouteParameters' fields and reconstruct them on read.
528 (1, self.route_params.as_ref().map(|p| &p.payment_params), option),
529 (2, blinded_tails, optional_vec),
530 (3, self.route_params.as_ref().map(|p| p.final_value_msat), option),
531 (5, self.route_params.as_ref().and_then(|p| p.max_total_routing_fee_msat), option),
537 impl Readable for Route {
538 fn read<R: io::Read>(reader: &mut R) -> Result<Route, DecodeError> {
539 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
540 let path_count: u64 = Readable::read(reader)?;
541 if path_count == 0 { return Err(DecodeError::InvalidValue); }
542 let mut paths = Vec::with_capacity(cmp::min(path_count, 128) as usize);
543 let mut min_final_cltv_expiry_delta = u32::max_value();
544 for _ in 0..path_count {
545 let hop_count: u8 = Readable::read(reader)?;
546 let mut hops: Vec<RouteHop> = Vec::with_capacity(hop_count as usize);
547 for _ in 0..hop_count {
548 hops.push(Readable::read(reader)?);
550 if hops.is_empty() { return Err(DecodeError::InvalidValue); }
551 min_final_cltv_expiry_delta =
552 cmp::min(min_final_cltv_expiry_delta, hops.last().unwrap().cltv_expiry_delta);
553 paths.push(Path { hops, blinded_tail: None });
555 _init_and_read_len_prefixed_tlv_fields!(reader, {
556 (1, payment_params, (option: ReadableArgs, min_final_cltv_expiry_delta)),
557 (2, blinded_tails, optional_vec),
558 (3, final_value_msat, option),
559 (5, max_total_routing_fee_msat, option)
561 let blinded_tails = blinded_tails.unwrap_or(Vec::new());
562 if blinded_tails.len() != 0 {
563 if blinded_tails.len() != paths.len() { return Err(DecodeError::InvalidValue) }
564 for (path, blinded_tail_opt) in paths.iter_mut().zip(blinded_tails.into_iter()) {
565 path.blinded_tail = blinded_tail_opt;
569 // If we previously wrote the corresponding fields, reconstruct RouteParameters.
570 let route_params = match (payment_params, final_value_msat) {
571 (Some(payment_params), Some(final_value_msat)) => {
572 Some(RouteParameters { payment_params, final_value_msat, max_total_routing_fee_msat })
577 Ok(Route { paths, route_params })
581 /// Parameters needed to find a [`Route`].
583 /// Passed to [`find_route`] and [`build_route_from_hops`].
584 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
585 pub struct RouteParameters {
586 /// The parameters of the failed payment path.
587 pub payment_params: PaymentParameters,
589 /// The amount in msats sent on the failed payment path.
590 pub final_value_msat: u64,
592 /// The maximum total fees, in millisatoshi, that may accrue during route finding.
594 /// This limit also applies to the total fees that may arise while retrying failed payment
597 /// Note that values below a few sats may result in some paths being spuriously ignored.
598 pub max_total_routing_fee_msat: Option<u64>,
601 impl RouteParameters {
602 /// Constructs [`RouteParameters`] from the given [`PaymentParameters`] and a payment amount.
604 /// [`Self::max_total_routing_fee_msat`] defaults to 1% of the payment amount + 50 sats
605 pub fn from_payment_params_and_value(payment_params: PaymentParameters, final_value_msat: u64) -> Self {
606 Self { payment_params, final_value_msat, max_total_routing_fee_msat: Some(final_value_msat / 100 + 50_000) }
609 /// Sets the maximum number of hops that can be included in a payment path, based on the provided
610 /// [`RecipientOnionFields`] and blinded paths.
611 pub fn set_max_path_length(
612 &mut self, recipient_onion: &RecipientOnionFields, is_keysend: bool, best_block_height: u32
613 ) -> Result<(), ()> {
614 let keysend_preimage_opt = is_keysend.then(|| PaymentPreimage([42; 32]));
615 onion_utils::set_max_path_length(
616 self, recipient_onion, keysend_preimage_opt, best_block_height
621 impl Writeable for RouteParameters {
622 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
623 write_tlv_fields!(writer, {
624 (0, self.payment_params, required),
625 (1, self.max_total_routing_fee_msat, option),
626 (2, self.final_value_msat, required),
627 // LDK versions prior to 0.0.114 had the `final_cltv_expiry_delta` parameter in
628 // `RouteParameters` directly. For compatibility, we write it here.
629 (4, self.payment_params.payee.final_cltv_expiry_delta(), option),
635 impl Readable for RouteParameters {
636 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
637 _init_and_read_len_prefixed_tlv_fields!(reader, {
638 (0, payment_params, (required: ReadableArgs, 0)),
639 (1, max_total_routing_fee_msat, option),
640 (2, final_value_msat, required),
641 (4, final_cltv_delta, option),
643 let mut payment_params: PaymentParameters = payment_params.0.unwrap();
644 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = payment_params.payee {
645 if final_cltv_expiry_delta == &0 {
646 *final_cltv_expiry_delta = final_cltv_delta.ok_or(DecodeError::InvalidValue)?;
651 final_value_msat: final_value_msat.0.unwrap(),
652 max_total_routing_fee_msat,
657 /// Maximum total CTLV difference we allow for a full payment path.
658 pub const DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA: u32 = 1008;
660 /// Maximum number of paths we allow an (MPP) payment to have.
661 // The default limit is currently set rather arbitrary - there aren't any real fundamental path-count
662 // limits, but for now more than 10 paths likely carries too much one-path failure.
663 pub const DEFAULT_MAX_PATH_COUNT: u8 = 10;
665 const DEFAULT_MAX_CHANNEL_SATURATION_POW_HALF: u8 = 2;
667 // The median hop CLTV expiry delta currently seen in the network.
668 const MEDIAN_HOP_CLTV_EXPIRY_DELTA: u32 = 40;
670 /// Estimated maximum number of hops that can be included in a payment path. May be inaccurate if
671 /// payment metadata, custom TLVs, or blinded paths are included in the payment.
672 // During routing, we only consider paths shorter than our maximum length estimate.
673 // In the TLV onion format, there is no fixed maximum length, but the `hop_payloads`
674 // field is always 1300 bytes. As the `tlv_payload` for each hop may vary in length, we have to
675 // estimate how many hops the route may have so that it actually fits the `hop_payloads` field.
677 // We estimate 3+32 (payload length and HMAC) + 2+8 (amt_to_forward) + 2+4 (outgoing_cltv_value) +
678 // 2+8 (short_channel_id) = 61 bytes for each intermediate hop and 3+32
679 // (payload length and HMAC) + 2+8 (amt_to_forward) + 2+4 (outgoing_cltv_value) + 2+32+8
680 // (payment_secret and total_msat) = 93 bytes for the final hop.
681 // Since the length of the potentially included `payment_metadata` is unknown to us, we round
682 // down from (1300-93) / 61 = 19.78... to arrive at a conservative estimate of 19.
683 pub const MAX_PATH_LENGTH_ESTIMATE: u8 = 19;
685 /// Information used to route a payment.
686 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
687 pub struct PaymentParameters {
688 /// Information about the payee, such as their features and route hints for their channels.
691 /// Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
692 pub expiry_time: Option<u64>,
694 /// The maximum total CLTV delta we accept for the route.
695 /// Defaults to [`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`].
696 pub max_total_cltv_expiry_delta: u32,
698 /// The maximum number of paths that may be used by (MPP) payments.
699 /// Defaults to [`DEFAULT_MAX_PATH_COUNT`].
700 pub max_path_count: u8,
702 /// The maximum number of [`Path::hops`] in any returned path.
703 /// Defaults to [`MAX_PATH_LENGTH_ESTIMATE`].
704 pub max_path_length: u8,
706 /// Selects the maximum share of a channel's total capacity which will be sent over a channel,
707 /// as a power of 1/2. A higher value prefers to send the payment using more MPP parts whereas
708 /// a lower value prefers to send larger MPP parts, potentially saturating channels and
709 /// increasing failure probability for those paths.
711 /// Note that this restriction will be relaxed during pathfinding after paths which meet this
712 /// restriction have been found. While paths which meet this criteria will be searched for, it
713 /// is ultimately up to the scorer to select them over other paths.
715 /// A value of 0 will allow payments up to and including a channel's total announced usable
716 /// capacity, a value of one will only use up to half its capacity, two 1/4, etc.
719 pub max_channel_saturation_power_of_half: u8,
721 /// A list of SCIDs which this payment was previously attempted over and which caused the
722 /// payment to fail. Future attempts for the same payment shouldn't be relayed through any of
724 pub previously_failed_channels: Vec<u64>,
726 /// A list of indices corresponding to blinded paths in [`Payee::Blinded::route_hints`] which this
727 /// payment was previously attempted over and which caused the payment to fail. Future attempts
728 /// for the same payment shouldn't be relayed through any of these blinded paths.
729 pub previously_failed_blinded_path_idxs: Vec<u64>,
732 impl Writeable for PaymentParameters {
733 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
734 let mut clear_hints = &vec![];
735 let mut blinded_hints = &vec![];
737 Payee::Clear { route_hints, .. } => clear_hints = route_hints,
738 Payee::Blinded { route_hints, .. } => blinded_hints = route_hints,
740 write_tlv_fields!(writer, {
741 (0, self.payee.node_id(), option),
742 (1, self.max_total_cltv_expiry_delta, required),
743 (2, self.payee.features(), option),
744 (3, self.max_path_count, required),
745 (4, *clear_hints, required_vec),
746 (5, self.max_channel_saturation_power_of_half, required),
747 (6, self.expiry_time, option),
748 (7, self.previously_failed_channels, required_vec),
749 (8, *blinded_hints, optional_vec),
750 (9, self.payee.final_cltv_expiry_delta(), option),
751 (11, self.previously_failed_blinded_path_idxs, required_vec),
752 (13, self.max_path_length, required),
758 impl ReadableArgs<u32> for PaymentParameters {
759 fn read<R: io::Read>(reader: &mut R, default_final_cltv_expiry_delta: u32) -> Result<Self, DecodeError> {
760 _init_and_read_len_prefixed_tlv_fields!(reader, {
761 (0, payee_pubkey, option),
762 (1, max_total_cltv_expiry_delta, (default_value, DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA)),
763 (2, features, (option: ReadableArgs, payee_pubkey.is_some())),
764 (3, max_path_count, (default_value, DEFAULT_MAX_PATH_COUNT)),
765 (4, clear_route_hints, required_vec),
766 (5, max_channel_saturation_power_of_half, (default_value, DEFAULT_MAX_CHANNEL_SATURATION_POW_HALF)),
767 (6, expiry_time, option),
768 (7, previously_failed_channels, optional_vec),
769 (8, blinded_route_hints, optional_vec),
770 (9, final_cltv_expiry_delta, (default_value, default_final_cltv_expiry_delta)),
771 (11, previously_failed_blinded_path_idxs, optional_vec),
772 (13, max_path_length, (default_value, MAX_PATH_LENGTH_ESTIMATE)),
774 let blinded_route_hints = blinded_route_hints.unwrap_or(vec![]);
775 let payee = if blinded_route_hints.len() != 0 {
776 if clear_route_hints.len() != 0 || payee_pubkey.is_some() { return Err(DecodeError::InvalidValue) }
778 route_hints: blinded_route_hints,
779 features: features.and_then(|f: Features| f.bolt12()),
783 route_hints: clear_route_hints,
784 node_id: payee_pubkey.ok_or(DecodeError::InvalidValue)?,
785 features: features.and_then(|f| f.bolt11()),
786 final_cltv_expiry_delta: final_cltv_expiry_delta.0.unwrap(),
790 max_total_cltv_expiry_delta: _init_tlv_based_struct_field!(max_total_cltv_expiry_delta, (default_value, unused)),
791 max_path_count: _init_tlv_based_struct_field!(max_path_count, (default_value, unused)),
793 max_channel_saturation_power_of_half: _init_tlv_based_struct_field!(max_channel_saturation_power_of_half, (default_value, unused)),
795 previously_failed_channels: previously_failed_channels.unwrap_or(Vec::new()),
796 previously_failed_blinded_path_idxs: previously_failed_blinded_path_idxs.unwrap_or(Vec::new()),
797 max_path_length: _init_tlv_based_struct_field!(max_path_length, (default_value, unused)),
803 impl PaymentParameters {
804 /// Creates a payee with the node id of the given `pubkey`.
806 /// The `final_cltv_expiry_delta` should match the expected final CLTV delta the recipient has
808 pub fn from_node_id(payee_pubkey: PublicKey, final_cltv_expiry_delta: u32) -> Self {
810 payee: Payee::Clear { node_id: payee_pubkey, route_hints: vec![], features: None, final_cltv_expiry_delta },
812 max_total_cltv_expiry_delta: DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA,
813 max_path_count: DEFAULT_MAX_PATH_COUNT,
814 max_path_length: MAX_PATH_LENGTH_ESTIMATE,
815 max_channel_saturation_power_of_half: DEFAULT_MAX_CHANNEL_SATURATION_POW_HALF,
816 previously_failed_channels: Vec::new(),
817 previously_failed_blinded_path_idxs: Vec::new(),
821 /// Creates a payee with the node id of the given `pubkey` to use for keysend payments.
823 /// The `final_cltv_expiry_delta` should match the expected final CLTV delta the recipient has
826 /// Note that MPP keysend is not widely supported yet. The `allow_mpp` lets you choose
827 /// whether your router will be allowed to find a multi-part route for this payment. If you
828 /// set `allow_mpp` to true, you should ensure a payment secret is set on send, likely via
829 /// [`RecipientOnionFields::secret_only`].
831 /// [`RecipientOnionFields::secret_only`]: crate::ln::channelmanager::RecipientOnionFields::secret_only
832 pub fn for_keysend(payee_pubkey: PublicKey, final_cltv_expiry_delta: u32, allow_mpp: bool) -> Self {
833 Self::from_node_id(payee_pubkey, final_cltv_expiry_delta)
834 .with_bolt11_features(Bolt11InvoiceFeatures::for_keysend(allow_mpp))
835 .expect("PaymentParameters::from_node_id should always initialize the payee as unblinded")
838 /// Creates parameters for paying to a blinded payee from the provided invoice. Sets
839 /// [`Payee::Blinded::route_hints`], [`Payee::Blinded::features`], and
840 /// [`PaymentParameters::expiry_time`].
841 pub fn from_bolt12_invoice(invoice: &Bolt12Invoice) -> Self {
842 Self::blinded(invoice.payment_paths().to_vec())
843 .with_bolt12_features(invoice.invoice_features().clone()).unwrap()
844 .with_expiry_time(invoice.created_at().as_secs().saturating_add(invoice.relative_expiry().as_secs()))
847 /// Creates parameters for paying to a blinded payee from the provided blinded route hints.
848 pub fn blinded(blinded_route_hints: Vec<(BlindedPayInfo, BlindedPath)>) -> Self {
850 payee: Payee::Blinded { route_hints: blinded_route_hints, features: None },
852 max_total_cltv_expiry_delta: DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA,
853 max_path_count: DEFAULT_MAX_PATH_COUNT,
854 max_path_length: MAX_PATH_LENGTH_ESTIMATE,
855 max_channel_saturation_power_of_half: DEFAULT_MAX_CHANNEL_SATURATION_POW_HALF,
856 previously_failed_channels: Vec::new(),
857 previously_failed_blinded_path_idxs: Vec::new(),
861 /// Includes the payee's features. Errors if the parameters were not initialized with
862 /// [`PaymentParameters::from_bolt12_invoice`].
864 /// This is not exported to bindings users since bindings don't support move semantics
865 pub fn with_bolt12_features(self, features: Bolt12InvoiceFeatures) -> Result<Self, ()> {
867 Payee::Clear { .. } => Err(()),
868 Payee::Blinded { route_hints, .. } =>
869 Ok(Self { payee: Payee::Blinded { route_hints, features: Some(features) }, ..self })
873 /// Includes the payee's features. Errors if the parameters were initialized with
874 /// [`PaymentParameters::from_bolt12_invoice`].
876 /// This is not exported to bindings users since bindings don't support move semantics
877 pub fn with_bolt11_features(self, features: Bolt11InvoiceFeatures) -> Result<Self, ()> {
879 Payee::Blinded { .. } => Err(()),
880 Payee::Clear { route_hints, node_id, final_cltv_expiry_delta, .. } =>
882 payee: Payee::Clear {
883 route_hints, node_id, features: Some(features), final_cltv_expiry_delta
889 /// Includes hints for routing to the payee. Errors if the parameters were initialized with
890 /// [`PaymentParameters::from_bolt12_invoice`].
892 /// This is not exported to bindings users since bindings don't support move semantics
893 pub fn with_route_hints(self, route_hints: Vec<RouteHint>) -> Result<Self, ()> {
895 Payee::Blinded { .. } => Err(()),
896 Payee::Clear { node_id, features, final_cltv_expiry_delta, .. } =>
898 payee: Payee::Clear {
899 route_hints, node_id, features, final_cltv_expiry_delta,
905 /// Includes a payment expiration in seconds relative to the UNIX epoch.
907 /// This is not exported to bindings users since bindings don't support move semantics
908 pub fn with_expiry_time(self, expiry_time: u64) -> Self {
909 Self { expiry_time: Some(expiry_time), ..self }
912 /// Includes a limit for the total CLTV expiry delta which is considered during routing
914 /// This is not exported to bindings users since bindings don't support move semantics
915 pub fn with_max_total_cltv_expiry_delta(self, max_total_cltv_expiry_delta: u32) -> Self {
916 Self { max_total_cltv_expiry_delta, ..self }
919 /// Includes a limit for the maximum number of payment paths that may be used.
921 /// This is not exported to bindings users since bindings don't support move semantics
922 pub fn with_max_path_count(self, max_path_count: u8) -> Self {
923 Self { max_path_count, ..self }
926 /// Includes a limit for the maximum share of a channel's total capacity that can be sent over, as
927 /// a power of 1/2. See [`PaymentParameters::max_channel_saturation_power_of_half`].
929 /// This is not exported to bindings users since bindings don't support move semantics
930 pub fn with_max_channel_saturation_power_of_half(self, max_channel_saturation_power_of_half: u8) -> Self {
931 Self { max_channel_saturation_power_of_half, ..self }
934 pub(crate) fn insert_previously_failed_blinded_path(&mut self, failed_blinded_tail: &BlindedTail) {
935 let mut found_blinded_tail = false;
936 for (idx, (_, path)) in self.payee.blinded_route_hints().iter().enumerate() {
937 if failed_blinded_tail.hops == path.blinded_hops &&
938 failed_blinded_tail.blinding_point == path.blinding_point
940 self.previously_failed_blinded_path_idxs.push(idx as u64);
941 found_blinded_tail = true;
944 debug_assert!(found_blinded_tail);
948 /// The recipient of a payment, differing based on whether they've hidden their identity with route
950 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
952 /// The recipient provided blinded paths and payinfo to reach them. The blinded paths themselves
953 /// will be included in the final [`Route`].
955 /// Aggregated routing info and blinded paths, for routing to the payee without knowing their
957 route_hints: Vec<(BlindedPayInfo, BlindedPath)>,
958 /// Features supported by the payee.
960 /// May be set from the payee's invoice. May be `None` if the invoice does not contain any
962 features: Option<Bolt12InvoiceFeatures>,
964 /// The recipient included these route hints in their BOLT11 invoice.
966 /// The node id of the payee.
968 /// Hints for routing to the payee, containing channels connecting the payee to public nodes.
969 route_hints: Vec<RouteHint>,
970 /// Features supported by the payee.
972 /// May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
973 /// does not contain any features.
975 /// [`for_keysend`]: PaymentParameters::for_keysend
976 features: Option<Bolt11InvoiceFeatures>,
977 /// The minimum CLTV delta at the end of the route. This value must not be zero.
978 final_cltv_expiry_delta: u32,
983 fn node_id(&self) -> Option<PublicKey> {
985 Self::Clear { node_id, .. } => Some(*node_id),
989 fn node_features(&self) -> Option<NodeFeatures> {
991 Self::Clear { features, .. } => features.as_ref().map(|f| f.to_context()),
992 Self::Blinded { features, .. } => features.as_ref().map(|f| f.to_context()),
995 fn supports_basic_mpp(&self) -> bool {
997 Self::Clear { features, .. } => features.as_ref().map_or(false, |f| f.supports_basic_mpp()),
998 Self::Blinded { features, .. } => features.as_ref().map_or(false, |f| f.supports_basic_mpp()),
1001 fn features(&self) -> Option<FeaturesRef> {
1003 Self::Clear { features, .. } => features.as_ref().map(|f| FeaturesRef::Bolt11(f)),
1004 Self::Blinded { features, .. } => features.as_ref().map(|f| FeaturesRef::Bolt12(f)),
1007 fn final_cltv_expiry_delta(&self) -> Option<u32> {
1009 Self::Clear { final_cltv_expiry_delta, .. } => Some(*final_cltv_expiry_delta),
1013 pub(crate) fn blinded_route_hints(&self) -> &[(BlindedPayInfo, BlindedPath)] {
1015 Self::Blinded { route_hints, .. } => &route_hints[..],
1016 Self::Clear { .. } => &[]
1020 fn unblinded_route_hints(&self) -> &[RouteHint] {
1022 Self::Blinded { .. } => &[],
1023 Self::Clear { route_hints, .. } => &route_hints[..]
1028 enum FeaturesRef<'a> {
1029 Bolt11(&'a Bolt11InvoiceFeatures),
1030 Bolt12(&'a Bolt12InvoiceFeatures),
1033 Bolt11(Bolt11InvoiceFeatures),
1034 Bolt12(Bolt12InvoiceFeatures),
1038 fn bolt12(self) -> Option<Bolt12InvoiceFeatures> {
1040 Self::Bolt12(f) => Some(f),
1044 fn bolt11(self) -> Option<Bolt11InvoiceFeatures> {
1046 Self::Bolt11(f) => Some(f),
1052 impl<'a> Writeable for FeaturesRef<'a> {
1053 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1055 Self::Bolt11(f) => Ok(f.write(w)?),
1056 Self::Bolt12(f) => Ok(f.write(w)?),
1061 impl ReadableArgs<bool> for Features {
1062 fn read<R: io::Read>(reader: &mut R, bolt11: bool) -> Result<Self, DecodeError> {
1063 if bolt11 { return Ok(Self::Bolt11(Readable::read(reader)?)) }
1064 Ok(Self::Bolt12(Readable::read(reader)?))
1068 /// A list of hops along a payment path terminating with a channel to the recipient.
1069 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
1070 pub struct RouteHint(pub Vec<RouteHintHop>);
1072 impl Writeable for RouteHint {
1073 fn write<W: crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1074 (self.0.len() as u64).write(writer)?;
1075 for hop in self.0.iter() {
1082 impl Readable for RouteHint {
1083 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
1084 let hop_count: u64 = Readable::read(reader)?;
1085 let mut hops = Vec::with_capacity(cmp::min(hop_count, 16) as usize);
1086 for _ in 0..hop_count {
1087 hops.push(Readable::read(reader)?);
1093 /// A channel descriptor for a hop along a payment path.
1095 /// While this generally comes from BOLT 11's `r` field, this struct includes more fields than are
1096 /// available in BOLT 11. Thus, encoding and decoding this via `lightning-invoice` is lossy, as
1097 /// fields not supported in BOLT 11 will be stripped.
1098 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
1099 pub struct RouteHintHop {
1100 /// The node_id of the non-target end of the route
1101 pub src_node_id: PublicKey,
1102 /// The short_channel_id of this channel
1103 pub short_channel_id: u64,
1104 /// The fees which must be paid to use this channel
1105 pub fees: RoutingFees,
1106 /// The difference in CLTV values between this node and the next node.
1107 pub cltv_expiry_delta: u16,
1108 /// The minimum value, in msat, which must be relayed to the next hop.
1109 pub htlc_minimum_msat: Option<u64>,
1110 /// The maximum value in msat available for routing with a single HTLC.
1111 pub htlc_maximum_msat: Option<u64>,
1114 impl_writeable_tlv_based!(RouteHintHop, {
1115 (0, src_node_id, required),
1116 (1, htlc_minimum_msat, option),
1117 (2, short_channel_id, required),
1118 (3, htlc_maximum_msat, option),
1119 (4, fees, required),
1120 (6, cltv_expiry_delta, required),
1123 #[derive(Eq, PartialEq)]
1124 #[repr(align(64))] // Force the size to 64 bytes
1125 struct RouteGraphNode {
1128 // The maximum value a yet-to-be-constructed payment path might flow through this node.
1129 // This value is upper-bounded by us by:
1130 // - how much is needed for a path being constructed
1131 // - how much value can channels following this node (up to the destination) can contribute,
1132 // considering their capacity and fees
1133 value_contribution_msat: u64,
1134 total_cltv_delta: u32,
1135 /// The number of hops walked up to this node.
1136 path_length_to_node: u8,
1139 impl cmp::Ord for RouteGraphNode {
1140 fn cmp(&self, other: &RouteGraphNode) -> cmp::Ordering {
1141 other.score.cmp(&self.score).then_with(|| other.node_id.cmp(&self.node_id))
1145 impl cmp::PartialOrd for RouteGraphNode {
1146 fn partial_cmp(&self, other: &RouteGraphNode) -> Option<cmp::Ordering> {
1147 Some(self.cmp(other))
1151 // While RouteGraphNode can be laid out with fewer bytes, performance appears to be improved
1152 // substantially when it is laid out at exactly 64 bytes.
1154 // Thus, we use `#[repr(C)]` on the struct to force a suboptimal layout and check that it stays 64
1156 #[cfg(any(ldk_bench, not(any(test, fuzzing))))]
1157 const _GRAPH_NODE_SMALL: usize = 64 - core::mem::size_of::<RouteGraphNode>();
1158 #[cfg(any(ldk_bench, not(any(test, fuzzing))))]
1159 const _GRAPH_NODE_FIXED_SIZE: usize = core::mem::size_of::<RouteGraphNode>() - 64;
1161 /// A [`CandidateRouteHop::FirstHop`] entry.
1162 #[derive(Clone, Debug)]
1163 pub struct FirstHopCandidate<'a> {
1164 /// Channel details of the first hop
1166 /// [`ChannelDetails::get_outbound_payment_scid`] MUST be `Some` (indicating the channel
1167 /// has been funded and is able to pay), and accessor methods may panic otherwise.
1169 /// [`find_route`] validates this prior to constructing a [`CandidateRouteHop`].
1171 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1172 pub details: &'a ChannelDetails,
1173 /// The node id of the payer, which is also the source side of this candidate route hop.
1175 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1176 pub payer_node_id: &'a NodeId,
1179 /// A [`CandidateRouteHop::PublicHop`] entry.
1180 #[derive(Clone, Debug)]
1181 pub struct PublicHopCandidate<'a> {
1182 /// Information about the channel, including potentially its capacity and
1183 /// direction-specific information.
1185 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1186 pub info: DirectedChannelInfo<'a>,
1187 /// The short channel ID of the channel, i.e. the identifier by which we refer to this
1189 pub short_channel_id: u64,
1192 /// A [`CandidateRouteHop::PrivateHop`] entry.
1193 #[derive(Clone, Debug)]
1194 pub struct PrivateHopCandidate<'a> {
1195 /// Information about the private hop communicated via BOLT 11.
1197 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1198 pub hint: &'a RouteHintHop,
1199 /// Node id of the next hop in BOLT 11 route hint.
1201 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1202 pub target_node_id: &'a NodeId
1205 /// A [`CandidateRouteHop::Blinded`] entry.
1206 #[derive(Clone, Debug)]
1207 pub struct BlindedPathCandidate<'a> {
1208 /// The node id of the introduction node, resolved from either the [`NetworkGraph`] or first
1211 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1212 pub source_node_id: &'a NodeId,
1213 /// Information about the blinded path including the fee, HTLC amount limits, and
1214 /// cryptographic material required to build an HTLC through the given path.
1216 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1217 pub hint: &'a (BlindedPayInfo, BlindedPath),
1218 /// Index of the hint in the original list of blinded hints.
1220 /// This is used to cheaply uniquely identify this blinded path, even though we don't have
1221 /// a short channel ID for this hop.
1225 /// A [`CandidateRouteHop::OneHopBlinded`] entry.
1226 #[derive(Clone, Debug)]
1227 pub struct OneHopBlindedPathCandidate<'a> {
1228 /// The node id of the introduction node, resolved from either the [`NetworkGraph`] or first
1231 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1232 pub source_node_id: &'a NodeId,
1233 /// Information about the blinded path including the fee, HTLC amount limits, and
1234 /// cryptographic material required to build an HTLC terminating with the given path.
1236 /// Note that the [`BlindedPayInfo`] is ignored here.
1238 /// This is not exported to bindings users as lifetimes are not expressible in most languages.
1239 pub hint: &'a (BlindedPayInfo, BlindedPath),
1240 /// Index of the hint in the original list of blinded hints.
1242 /// This is used to cheaply uniquely identify this blinded path, even though we don't have
1243 /// a short channel ID for this hop.
1247 /// A wrapper around the various hop representations.
1249 /// Can be used to examine the properties of a hop,
1250 /// potentially to decide whether to include it in a route.
1251 #[derive(Clone, Debug)]
1252 pub enum CandidateRouteHop<'a> {
1253 /// A hop from the payer, where the outbound liquidity is known.
1254 FirstHop(FirstHopCandidate<'a>),
1255 /// A hop found in the [`ReadOnlyNetworkGraph`].
1256 PublicHop(PublicHopCandidate<'a>),
1257 /// A private hop communicated by the payee, generally via a BOLT 11 invoice.
1259 /// Because BOLT 11 route hints can take multiple hops to get to the destination, this may not
1260 /// terminate at the payee.
1261 PrivateHop(PrivateHopCandidate<'a>),
1262 /// A blinded path which starts with an introduction point and ultimately terminates with the
1265 /// Because we don't know the payee's identity, [`CandidateRouteHop::target`] will return
1266 /// `None` in this state.
1268 /// Because blinded paths are "all or nothing", and we cannot use just one part of a blinded
1269 /// path, the full path is treated as a single [`CandidateRouteHop`].
1270 Blinded(BlindedPathCandidate<'a>),
1271 /// Similar to [`Self::Blinded`], but the path here only has one hop.
1273 /// While we treat this similarly to [`CandidateRouteHop::Blinded`] in many respects (e.g.
1274 /// returning `None` from [`CandidateRouteHop::target`]), in this case we do actually know the
1275 /// payee's identity - it's the introduction point!
1277 /// [`BlindedPayInfo`] provided for 1-hop blinded paths is ignored because it is meant to apply
1278 /// to the hops *between* the introduction node and the destination.
1280 /// This primarily exists to track that we need to included a blinded path at the end of our
1281 /// [`Route`], even though it doesn't actually add an additional hop in the payment.
1282 OneHopBlinded(OneHopBlindedPathCandidate<'a>),
1285 impl<'a> CandidateRouteHop<'a> {
1286 /// Returns the short channel ID for this hop, if one is known.
1288 /// This SCID could be an alias or a globally unique SCID, and thus is only expected to
1289 /// uniquely identify this channel in conjunction with the [`CandidateRouteHop::source`].
1291 /// Returns `Some` as long as the candidate is a [`CandidateRouteHop::PublicHop`], a
1292 /// [`CandidateRouteHop::PrivateHop`] from a BOLT 11 route hint, or a
1293 /// [`CandidateRouteHop::FirstHop`] with a known [`ChannelDetails::get_outbound_payment_scid`]
1294 /// (which is always true for channels which are funded and ready for use).
1296 /// In other words, this should always return `Some` as long as the candidate hop is not a
1297 /// [`CandidateRouteHop::Blinded`] or a [`CandidateRouteHop::OneHopBlinded`].
1299 /// Note that this is deliberately not public as it is somewhat of a footgun because it doesn't
1300 /// define a global namespace.
1302 fn short_channel_id(&self) -> Option<u64> {
1304 CandidateRouteHop::FirstHop(hop) => hop.details.get_outbound_payment_scid(),
1305 CandidateRouteHop::PublicHop(hop) => Some(hop.short_channel_id),
1306 CandidateRouteHop::PrivateHop(hop) => Some(hop.hint.short_channel_id),
1307 CandidateRouteHop::Blinded(_) => None,
1308 CandidateRouteHop::OneHopBlinded(_) => None,
1312 /// Returns the globally unique short channel ID for this hop, if one is known.
1314 /// This only returns `Some` if the channel is public (either our own, or one we've learned
1315 /// from the public network graph), and thus the short channel ID we have for this channel is
1316 /// globally unique and identifies this channel in a global namespace.
1318 pub fn globally_unique_short_channel_id(&self) -> Option<u64> {
1320 CandidateRouteHop::FirstHop(hop) => if hop.details.is_public { hop.details.short_channel_id } else { None },
1321 CandidateRouteHop::PublicHop(hop) => Some(hop.short_channel_id),
1322 CandidateRouteHop::PrivateHop(_) => None,
1323 CandidateRouteHop::Blinded(_) => None,
1324 CandidateRouteHop::OneHopBlinded(_) => None,
1328 // NOTE: This may alloc memory so avoid calling it in a hot code path.
1329 fn features(&self) -> ChannelFeatures {
1331 CandidateRouteHop::FirstHop(hop) => hop.details.counterparty.features.to_context(),
1332 CandidateRouteHop::PublicHop(hop) => hop.info.channel().features.clone(),
1333 CandidateRouteHop::PrivateHop(_) => ChannelFeatures::empty(),
1334 CandidateRouteHop::Blinded(_) => ChannelFeatures::empty(),
1335 CandidateRouteHop::OneHopBlinded(_) => ChannelFeatures::empty(),
1339 /// Returns the required difference in HTLC CLTV expiry between the [`Self::source`] and the
1340 /// next-hop for an HTLC taking this hop.
1342 /// This is the time that the node(s) in this hop have to claim the HTLC on-chain if the
1343 /// next-hop goes on chain with a payment preimage.
1345 pub fn cltv_expiry_delta(&self) -> u32 {
1347 CandidateRouteHop::FirstHop(_) => 0,
1348 CandidateRouteHop::PublicHop(hop) => hop.info.direction().cltv_expiry_delta as u32,
1349 CandidateRouteHop::PrivateHop(hop) => hop.hint.cltv_expiry_delta as u32,
1350 CandidateRouteHop::Blinded(hop) => hop.hint.0.cltv_expiry_delta as u32,
1351 CandidateRouteHop::OneHopBlinded(_) => 0,
1355 /// Returns the minimum amount that can be sent over this hop, in millisatoshis.
1357 pub fn htlc_minimum_msat(&self) -> u64 {
1359 CandidateRouteHop::FirstHop(hop) => hop.details.next_outbound_htlc_minimum_msat,
1360 CandidateRouteHop::PublicHop(hop) => hop.info.direction().htlc_minimum_msat,
1361 CandidateRouteHop::PrivateHop(hop) => hop.hint.htlc_minimum_msat.unwrap_or(0),
1362 CandidateRouteHop::Blinded(hop) => hop.hint.0.htlc_minimum_msat,
1363 CandidateRouteHop::OneHopBlinded { .. } => 0,
1367 /// Returns the fees that must be paid to route an HTLC over this channel.
1369 pub fn fees(&self) -> RoutingFees {
1371 CandidateRouteHop::FirstHop(_) => RoutingFees {
1372 base_msat: 0, proportional_millionths: 0,
1374 CandidateRouteHop::PublicHop(hop) => hop.info.direction().fees,
1375 CandidateRouteHop::PrivateHop(hop) => hop.hint.fees,
1376 CandidateRouteHop::Blinded(hop) => {
1378 base_msat: hop.hint.0.fee_base_msat,
1379 proportional_millionths: hop.hint.0.fee_proportional_millionths
1382 CandidateRouteHop::OneHopBlinded(_) =>
1383 RoutingFees { base_msat: 0, proportional_millionths: 0 },
1387 /// Fetch the effective capacity of this hop.
1389 /// Note that this may be somewhat expensive, so calls to this should be limited and results
1391 fn effective_capacity(&self) -> EffectiveCapacity {
1393 CandidateRouteHop::FirstHop(hop) => EffectiveCapacity::ExactLiquidity {
1394 liquidity_msat: hop.details.next_outbound_htlc_limit_msat,
1396 CandidateRouteHop::PublicHop(hop) => hop.info.effective_capacity(),
1397 CandidateRouteHop::PrivateHop(PrivateHopCandidate { hint: RouteHintHop { htlc_maximum_msat: Some(max), .. }, .. }) =>
1398 EffectiveCapacity::HintMaxHTLC { amount_msat: *max },
1399 CandidateRouteHop::PrivateHop(PrivateHopCandidate { hint: RouteHintHop { htlc_maximum_msat: None, .. }, .. }) =>
1400 EffectiveCapacity::Infinite,
1401 CandidateRouteHop::Blinded(hop) =>
1402 EffectiveCapacity::HintMaxHTLC { amount_msat: hop.hint.0.htlc_maximum_msat },
1403 CandidateRouteHop::OneHopBlinded(_) => EffectiveCapacity::Infinite,
1407 /// Returns an ID describing the given hop.
1409 /// See the docs on [`CandidateHopId`] for when this is, or is not, unique.
1411 fn id(&self) -> CandidateHopId {
1413 CandidateRouteHop::Blinded(hop) => CandidateHopId::Blinded(hop.hint_idx),
1414 CandidateRouteHop::OneHopBlinded(hop) => CandidateHopId::Blinded(hop.hint_idx),
1415 _ => CandidateHopId::Clear((self.short_channel_id().unwrap(), self.source() < self.target().unwrap())),
1418 fn blinded_path(&self) -> Option<&'a BlindedPath> {
1420 CandidateRouteHop::Blinded(BlindedPathCandidate { hint, .. }) | CandidateRouteHop::OneHopBlinded(OneHopBlindedPathCandidate { hint, .. }) => {
1426 fn blinded_hint_idx(&self) -> Option<usize> {
1428 Self::Blinded(BlindedPathCandidate { hint_idx, .. }) |
1429 Self::OneHopBlinded(OneHopBlindedPathCandidate { hint_idx, .. }) => {
1435 /// Returns the source node id of current hop.
1437 /// Source node id refers to the node forwarding the HTLC through this hop.
1439 /// For [`Self::FirstHop`] we return payer's node id.
1441 pub fn source(&self) -> NodeId {
1443 CandidateRouteHop::FirstHop(hop) => *hop.payer_node_id,
1444 CandidateRouteHop::PublicHop(hop) => *hop.info.source(),
1445 CandidateRouteHop::PrivateHop(hop) => hop.hint.src_node_id.into(),
1446 CandidateRouteHop::Blinded(hop) => *hop.source_node_id,
1447 CandidateRouteHop::OneHopBlinded(hop) => *hop.source_node_id,
1450 /// Returns the target node id of this hop, if known.
1452 /// Target node id refers to the node receiving the HTLC after this hop.
1454 /// For [`Self::Blinded`] we return `None` because the ultimate destination after the blinded
1455 /// path is unknown.
1457 /// For [`Self::OneHopBlinded`] we return `None` because the target is the same as the source,
1458 /// and such a return value would be somewhat nonsensical.
1460 pub fn target(&self) -> Option<NodeId> {
1462 CandidateRouteHop::FirstHop(hop) => Some(hop.details.counterparty.node_id.into()),
1463 CandidateRouteHop::PublicHop(hop) => Some(*hop.info.target()),
1464 CandidateRouteHop::PrivateHop(hop) => Some(*hop.target_node_id),
1465 CandidateRouteHop::Blinded(_) => None,
1466 CandidateRouteHop::OneHopBlinded(_) => None,
1471 /// A unique(ish) identifier for a specific [`CandidateRouteHop`].
1473 /// For blinded paths, this ID is unique only within a given [`find_route`] call.
1475 /// For other hops, because SCIDs between private channels and public channels can conflict, this
1476 /// isn't guaranteed to be unique at all.
1478 /// For our uses, this is generally fine, but it is not public as it is otherwise a rather
1479 /// difficult-to-use API.
1480 #[derive(Clone, Copy, Eq, Hash, Ord, PartialOrd, PartialEq)]
1481 enum CandidateHopId {
1482 /// Contains (scid, src_node_id < target_node_id)
1484 /// Index of the blinded route hint in [`Payee::Blinded::route_hints`].
1489 fn max_htlc_from_capacity(capacity: EffectiveCapacity, max_channel_saturation_power_of_half: u8) -> u64 {
1490 let saturation_shift: u32 = max_channel_saturation_power_of_half as u32;
1492 EffectiveCapacity::ExactLiquidity { liquidity_msat } => liquidity_msat,
1493 EffectiveCapacity::Infinite => u64::max_value(),
1494 EffectiveCapacity::Unknown => EffectiveCapacity::Unknown.as_msat(),
1495 EffectiveCapacity::AdvertisedMaxHTLC { amount_msat } =>
1496 amount_msat.checked_shr(saturation_shift).unwrap_or(0),
1497 // Treat htlc_maximum_msat from a route hint as an exact liquidity amount, since the invoice is
1498 // expected to have been generated from up-to-date capacity information.
1499 EffectiveCapacity::HintMaxHTLC { amount_msat } => amount_msat,
1500 EffectiveCapacity::Total { capacity_msat, htlc_maximum_msat } =>
1501 cmp::min(capacity_msat.checked_shr(saturation_shift).unwrap_or(0), htlc_maximum_msat),
1505 fn iter_equal<I1: Iterator, I2: Iterator>(mut iter_a: I1, mut iter_b: I2)
1506 -> bool where I1::Item: PartialEq<I2::Item> {
1508 let a = iter_a.next();
1509 let b = iter_b.next();
1510 if a.is_none() && b.is_none() { return true; }
1511 if a.is_none() || b.is_none() { return false; }
1512 if a.unwrap().ne(&b.unwrap()) { return false; }
1516 /// It's useful to keep track of the hops associated with the fees required to use them,
1517 /// so that we can choose cheaper paths (as per Dijkstra's algorithm).
1518 /// Fee values should be updated only in the context of the whole path, see update_value_and_recompute_fees.
1519 /// These fee values are useful to choose hops as we traverse the graph "payee-to-payer".
1521 #[repr(C)] // Force fields to appear in the order we define them.
1522 struct PathBuildingHop<'a> {
1523 candidate: CandidateRouteHop<'a>,
1524 /// If we've already processed a node as the best node, we shouldn't process it again. Normally
1525 /// we'd just ignore it if we did as all channels would have a higher new fee, but because we
1526 /// may decrease the amounts in use as we walk the graph, the actual calculated fee may
1527 /// decrease as well. Thus, we have to explicitly track which nodes have been processed and
1528 /// avoid processing them again.
1529 was_processed: bool,
1530 /// Used to compare channels when choosing the for routing.
1531 /// Includes paying for the use of a hop and the following hops, as well as
1532 /// an estimated cost of reaching this hop.
1533 /// Might get stale when fees are recomputed. Primarily for internal use.
1534 total_fee_msat: u64,
1535 /// A mirror of the same field in RouteGraphNode. Note that this is only used during the graph
1536 /// walk and may be invalid thereafter.
1537 path_htlc_minimum_msat: u64,
1538 /// All penalties incurred from this channel on the way to the destination, as calculated using
1539 /// channel scoring.
1540 path_penalty_msat: u64,
1542 // The last 16 bytes are on the next cache line by default in glibc's malloc. Thus, we should
1543 // only place fields which are not hot there. Luckily, the next three fields are only read if
1544 // we end up on the selected path, and only in the final path layout phase, so we don't care
1545 // too much if reading them is slow.
1549 /// All the fees paid *after* this channel on the way to the destination
1550 next_hops_fee_msat: u64,
1551 /// Fee paid for the use of the current channel (see candidate.fees()).
1552 /// The value will be actually deducted from the counterparty balance on the previous link.
1553 hop_use_fee_msat: u64,
1555 #[cfg(all(not(ldk_bench), any(test, fuzzing)))]
1556 // In tests, we apply further sanity checks on cases where we skip nodes we already processed
1557 // to ensure it is specifically in cases where the fee has gone down because of a decrease in
1558 // value_contribution_msat, which requires tracking it here. See comments below where it is
1559 // used for more info.
1560 value_contribution_msat: u64,
1563 // Checks that the entries in the `find_route` `dist` map fit in (exactly) two standard x86-64
1564 // cache lines. Sadly, they're not guaranteed to actually lie on a cache line (and in fact,
1565 // generally won't, because at least glibc's malloc will align to a nice, big, round
1566 // boundary...plus 16), but at least it will reduce the amount of data we'll need to load.
1568 // Note that these assertions only pass on somewhat recent rustc, and thus are gated on the
1571 const _NODE_MAP_SIZE_TWO_CACHE_LINES: usize = 128 - core::mem::size_of::<(NodeId, PathBuildingHop)>();
1573 const _NODE_MAP_SIZE_EXACTLY_CACHE_LINES: usize = core::mem::size_of::<(NodeId, PathBuildingHop)>() - 128;
1575 impl<'a> core::fmt::Debug for PathBuildingHop<'a> {
1576 fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
1577 let mut debug_struct = f.debug_struct("PathBuildingHop");
1579 .field("node_id", &self.candidate.target())
1580 .field("short_channel_id", &self.candidate.short_channel_id())
1581 .field("total_fee_msat", &self.total_fee_msat)
1582 .field("next_hops_fee_msat", &self.next_hops_fee_msat)
1583 .field("hop_use_fee_msat", &self.hop_use_fee_msat)
1584 .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)))
1585 .field("path_penalty_msat", &self.path_penalty_msat)
1586 .field("path_htlc_minimum_msat", &self.path_htlc_minimum_msat)
1587 .field("cltv_expiry_delta", &self.candidate.cltv_expiry_delta());
1588 #[cfg(all(not(ldk_bench), any(test, fuzzing)))]
1589 let debug_struct = debug_struct
1590 .field("value_contribution_msat", &self.value_contribution_msat);
1591 debug_struct.finish()
1595 // Instantiated with a list of hops with correct data in them collected during path finding,
1596 // an instance of this struct should be further modified only via given methods.
1598 struct PaymentPath<'a> {
1599 hops: Vec<(PathBuildingHop<'a>, NodeFeatures)>,
1602 impl<'a> PaymentPath<'a> {
1603 // TODO: Add a value_msat field to PaymentPath and use it instead of this function.
1604 fn get_value_msat(&self) -> u64 {
1605 self.hops.last().unwrap().0.fee_msat
1608 fn get_path_penalty_msat(&self) -> u64 {
1609 self.hops.first().map(|h| h.0.path_penalty_msat).unwrap_or(u64::max_value())
1612 fn get_total_fee_paid_msat(&self) -> u64 {
1613 if self.hops.len() < 1 {
1617 // Can't use next_hops_fee_msat because it gets outdated.
1618 for (i, (hop, _)) in self.hops.iter().enumerate() {
1619 if i != self.hops.len() - 1 {
1620 result += hop.fee_msat;
1626 fn get_cost_msat(&self) -> u64 {
1627 self.get_total_fee_paid_msat().saturating_add(self.get_path_penalty_msat())
1630 // If the amount transferred by the path is updated, the fees should be adjusted. Any other way
1631 // to change fees may result in an inconsistency.
1633 // Sometimes we call this function right after constructing a path which is inconsistent in
1634 // that it the value being transferred has decreased while we were doing path finding, leading
1635 // to the fees being paid not lining up with the actual limits.
1637 // Note that this function is not aware of the available_liquidity limit, and thus does not
1638 // support increasing the value being transferred beyond what was selected during the initial
1641 // Returns the amount that this path contributes to the total payment value, which may be greater
1642 // than `value_msat` if we had to overpay to meet the final node's `htlc_minimum_msat`.
1643 fn update_value_and_recompute_fees(&mut self, value_msat: u64) -> u64 {
1644 let mut extra_contribution_msat = 0;
1645 let mut total_fee_paid_msat = 0 as u64;
1646 for i in (0..self.hops.len()).rev() {
1647 let last_hop = i == self.hops.len() - 1;
1649 // For non-last-hop, this value will represent the fees paid on the current hop. It
1650 // will consist of the fees for the use of the next hop, and extra fees to match
1651 // htlc_minimum_msat of the current channel. Last hop is handled separately.
1652 let mut cur_hop_fees_msat = 0;
1654 cur_hop_fees_msat = self.hops.get(i + 1).unwrap().0.hop_use_fee_msat;
1657 let cur_hop = &mut self.hops.get_mut(i).unwrap().0;
1658 cur_hop.next_hops_fee_msat = total_fee_paid_msat;
1659 cur_hop.path_penalty_msat += extra_contribution_msat;
1660 // Overpay in fees if we can't save these funds due to htlc_minimum_msat.
1661 // We try to account for htlc_minimum_msat in scoring (add_entry!), so that nodes don't
1662 // set it too high just to maliciously take more fees by exploiting this
1663 // match htlc_minimum_msat logic.
1664 let mut cur_hop_transferred_amount_msat = total_fee_paid_msat + value_msat;
1665 if let Some(extra_fees_msat) = cur_hop.candidate.htlc_minimum_msat().checked_sub(cur_hop_transferred_amount_msat) {
1666 // Note that there is a risk that *previous hops* (those closer to us, as we go
1667 // payee->our_node here) would exceed their htlc_maximum_msat or available balance.
1669 // This might make us end up with a broken route, although this should be super-rare
1670 // in practice, both because of how healthy channels look like, and how we pick
1671 // channels in add_entry.
1672 // Also, this can't be exploited more heavily than *announce a free path and fail
1674 cur_hop_transferred_amount_msat += extra_fees_msat;
1676 // We remember and return the extra fees on the final hop to allow accounting for
1677 // them in the path's value contribution.
1679 extra_contribution_msat = extra_fees_msat;
1681 total_fee_paid_msat += extra_fees_msat;
1682 cur_hop_fees_msat += extra_fees_msat;
1687 // Final hop is a special case: it usually has just value_msat (by design), but also
1688 // it still could overpay for the htlc_minimum_msat.
1689 cur_hop.fee_msat = cur_hop_transferred_amount_msat;
1691 // Propagate updated fees for the use of the channels to one hop back, where they
1692 // will be actually paid (fee_msat). The last hop is handled above separately.
1693 cur_hop.fee_msat = cur_hop_fees_msat;
1696 // Fee for the use of the current hop which will be deducted on the previous hop.
1697 // Irrelevant for the first hop, as it doesn't have the previous hop, and the use of
1698 // this channel is free for us.
1700 if let Some(new_fee) = compute_fees(cur_hop_transferred_amount_msat, cur_hop.candidate.fees()) {
1701 cur_hop.hop_use_fee_msat = new_fee;
1702 total_fee_paid_msat += new_fee;
1704 // It should not be possible because this function is called only to reduce the
1705 // value. In that case, compute_fee was already called with the same fees for
1706 // larger amount and there was no overflow.
1711 value_msat + extra_contribution_msat
1716 /// Calculate the fees required to route the given amount over a channel with the given fees.
1717 fn compute_fees(amount_msat: u64, channel_fees: RoutingFees) -> Option<u64> {
1718 amount_msat.checked_mul(channel_fees.proportional_millionths as u64)
1719 .and_then(|part| (channel_fees.base_msat as u64).checked_add(part / 1_000_000))
1723 /// Calculate the fees required to route the given amount over a channel with the given fees,
1724 /// saturating to [`u64::max_value`].
1725 fn compute_fees_saturating(amount_msat: u64, channel_fees: RoutingFees) -> u64 {
1726 amount_msat.checked_mul(channel_fees.proportional_millionths as u64)
1727 .map(|prop| prop / 1_000_000).unwrap_or(u64::max_value())
1728 .saturating_add(channel_fees.base_msat as u64)
1731 /// The default `features` we assume for a node in a route, when no `features` are known about that
1734 /// Default features are:
1735 /// * variable_length_onion_optional
1736 fn default_node_features() -> NodeFeatures {
1737 let mut features = NodeFeatures::empty();
1738 features.set_variable_length_onion_optional();
1742 struct LoggedPayeePubkey(Option<PublicKey>);
1743 impl fmt::Display for LoggedPayeePubkey {
1744 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1747 "payee node id ".fmt(f)?;
1751 "blinded payee".fmt(f)
1757 struct LoggedCandidateHop<'a>(&'a CandidateRouteHop<'a>);
1758 impl<'a> fmt::Display for LoggedCandidateHop<'a> {
1759 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1761 CandidateRouteHop::Blinded(BlindedPathCandidate { hint, .. }) | CandidateRouteHop::OneHopBlinded(OneHopBlindedPathCandidate { hint, .. }) => {
1762 "blinded route hint with introduction node ".fmt(f)?;
1763 match &hint.1.introduction_node {
1764 IntroductionNode::NodeId(pubkey) => write!(f, "id {}", pubkey)?,
1765 IntroductionNode::DirectedShortChannelId(direction, scid) => {
1767 Direction::NodeOne => {
1768 write!(f, "one on channel with SCID {}", scid)?;
1770 Direction::NodeTwo => {
1771 write!(f, "two on channel with SCID {}", scid)?;
1776 " and blinding point ".fmt(f)?;
1777 hint.1.blinding_point.fmt(f)
1779 CandidateRouteHop::FirstHop(_) => {
1780 "first hop with SCID ".fmt(f)?;
1781 self.0.short_channel_id().unwrap().fmt(f)
1783 CandidateRouteHop::PrivateHop(_) => {
1784 "route hint with SCID ".fmt(f)?;
1785 self.0.short_channel_id().unwrap().fmt(f)
1789 self.0.short_channel_id().unwrap().fmt(f)
1796 fn sort_first_hop_channels(
1797 channels: &mut Vec<&ChannelDetails>, used_liquidities: &HashMap<CandidateHopId, u64>,
1798 recommended_value_msat: u64, our_node_pubkey: &PublicKey
1800 // Sort the first_hops channels to the same node(s) in priority order of which channel we'd
1801 // most like to use.
1803 // First, if channels are below `recommended_value_msat`, sort them in descending order,
1804 // preferring larger channels to avoid splitting the payment into more MPP parts than is
1807 // Second, because simply always sorting in descending order would always use our largest
1808 // available outbound capacity, needlessly fragmenting our available channel capacities,
1809 // sort channels above `recommended_value_msat` in ascending order, preferring channels
1810 // which have enough, but not too much, capacity for the payment.
1812 // Available outbound balances factor in liquidity already reserved for previously found paths.
1813 channels.sort_unstable_by(|chan_a, chan_b| {
1814 let chan_a_outbound_limit_msat = chan_a.next_outbound_htlc_limit_msat
1815 .saturating_sub(*used_liquidities.get(&CandidateHopId::Clear((chan_a.get_outbound_payment_scid().unwrap(),
1816 our_node_pubkey < &chan_a.counterparty.node_id))).unwrap_or(&0));
1817 let chan_b_outbound_limit_msat = chan_b.next_outbound_htlc_limit_msat
1818 .saturating_sub(*used_liquidities.get(&CandidateHopId::Clear((chan_b.get_outbound_payment_scid().unwrap(),
1819 our_node_pubkey < &chan_b.counterparty.node_id))).unwrap_or(&0));
1820 if chan_b_outbound_limit_msat < recommended_value_msat || chan_a_outbound_limit_msat < recommended_value_msat {
1821 // Sort in descending order
1822 chan_b_outbound_limit_msat.cmp(&chan_a_outbound_limit_msat)
1824 // Sort in ascending order
1825 chan_a_outbound_limit_msat.cmp(&chan_b_outbound_limit_msat)
1830 /// Finds a route from us (payer) to the given target node (payee).
1832 /// If the payee provided features in their invoice, they should be provided via the `payee` field
1833 /// in the given [`RouteParameters::payment_params`].
1834 /// Without this, MPP will only be used if the payee's features are available in the network graph.
1836 /// Private routing paths between a public node and the target may be included in the `payee` field
1837 /// of [`RouteParameters::payment_params`].
1839 /// If some channels aren't announced, it may be useful to fill in `first_hops` with the results
1840 /// from [`ChannelManager::list_usable_channels`]. If it is filled in, the view of these channels
1841 /// from `network_graph` will be ignored, and only those in `first_hops` will be used.
1843 /// The fees on channels from us to the next hop are ignored as they are assumed to all be equal.
1844 /// However, the enabled/disabled bit on such channels as well as the `htlc_minimum_msat` /
1845 /// `htlc_maximum_msat` *are* checked as they may change based on the receiving node.
1849 /// Panics if first_hops contains channels without `short_channel_id`s;
1850 /// [`ChannelManager::list_usable_channels`] will never include such channels.
1852 /// [`ChannelManager::list_usable_channels`]: crate::ln::channelmanager::ChannelManager::list_usable_channels
1853 /// [`Event::PaymentPathFailed`]: crate::events::Event::PaymentPathFailed
1854 /// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
1855 pub fn find_route<L: Deref, GL: Deref, S: ScoreLookUp>(
1856 our_node_pubkey: &PublicKey, route_params: &RouteParameters,
1857 network_graph: &NetworkGraph<GL>, first_hops: Option<&[&ChannelDetails]>, logger: L,
1858 scorer: &S, score_params: &S::ScoreParams, random_seed_bytes: &[u8; 32]
1859 ) -> Result<Route, LightningError>
1860 where L::Target: Logger, GL::Target: Logger {
1861 let graph_lock = network_graph.read_only();
1862 let mut route = get_route(our_node_pubkey, &route_params, &graph_lock, first_hops, logger,
1863 scorer, score_params, random_seed_bytes)?;
1864 add_random_cltv_offset(&mut route, &route_params.payment_params, &graph_lock, random_seed_bytes);
1868 pub(crate) fn get_route<L: Deref, S: ScoreLookUp>(
1869 our_node_pubkey: &PublicKey, route_params: &RouteParameters, network_graph: &ReadOnlyNetworkGraph,
1870 first_hops: Option<&[&ChannelDetails]>, logger: L, scorer: &S, score_params: &S::ScoreParams,
1871 _random_seed_bytes: &[u8; 32]
1872 ) -> Result<Route, LightningError>
1873 where L::Target: Logger {
1875 let payment_params = &route_params.payment_params;
1876 let max_path_length = core::cmp::min(payment_params.max_path_length, MAX_PATH_LENGTH_ESTIMATE);
1877 let final_value_msat = route_params.final_value_msat;
1878 // If we're routing to a blinded recipient, we won't have their node id. Therefore, keep the
1879 // unblinded payee id as an option. We also need a non-optional "payee id" for path construction,
1880 // so use a dummy id for this in the blinded case.
1881 let payee_node_id_opt = payment_params.payee.node_id().map(|pk| NodeId::from_pubkey(&pk));
1882 const DUMMY_BLINDED_PAYEE_ID: [u8; 33] = [2; 33];
1883 let maybe_dummy_payee_pk = payment_params.payee.node_id().unwrap_or_else(|| PublicKey::from_slice(&DUMMY_BLINDED_PAYEE_ID).unwrap());
1884 let maybe_dummy_payee_node_id = NodeId::from_pubkey(&maybe_dummy_payee_pk);
1885 let our_node_id = NodeId::from_pubkey(&our_node_pubkey);
1887 if payee_node_id_opt.map_or(false, |payee| payee == our_node_id) {
1888 return Err(LightningError{err: "Cannot generate a route to ourselves".to_owned(), action: ErrorAction::IgnoreError});
1890 if our_node_id == maybe_dummy_payee_node_id {
1891 return Err(LightningError{err: "Invalid origin node id provided, use a different one".to_owned(), action: ErrorAction::IgnoreError});
1894 if final_value_msat > MAX_VALUE_MSAT {
1895 return Err(LightningError{err: "Cannot generate a route of more value than all existing satoshis".to_owned(), action: ErrorAction::IgnoreError});
1898 if final_value_msat == 0 {
1899 return Err(LightningError{err: "Cannot send a payment of 0 msat".to_owned(), action: ErrorAction::IgnoreError});
1902 let introduction_node_id_cache = payment_params.payee.blinded_route_hints().iter()
1903 .map(|(_, path)| path.public_introduction_node_id(network_graph))
1904 .collect::<Vec<_>>();
1905 match &payment_params.payee {
1906 Payee::Clear { route_hints, node_id, .. } => {
1907 for route in route_hints.iter() {
1908 for hop in &route.0 {
1909 if hop.src_node_id == *node_id {
1910 return Err(LightningError{err: "Route hint cannot have the payee as the source.".to_owned(), action: ErrorAction::IgnoreError});
1915 Payee::Blinded { route_hints, .. } => {
1916 if introduction_node_id_cache.iter().all(|introduction_node_id| *introduction_node_id == Some(&our_node_id)) {
1917 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});
1919 for ((_, blinded_path), introduction_node_id) in route_hints.iter().zip(introduction_node_id_cache.iter()) {
1920 if blinded_path.blinded_hops.len() == 0 {
1921 return Err(LightningError{err: "0-hop blinded path provided".to_owned(), action: ErrorAction::IgnoreError});
1922 } else if *introduction_node_id == Some(&our_node_id) {
1923 log_info!(logger, "Got blinded path with ourselves as the introduction node, ignoring");
1924 } else if blinded_path.blinded_hops.len() == 1 &&
1926 .iter().zip(introduction_node_id_cache.iter())
1927 .filter(|((_, p), _)| p.blinded_hops.len() == 1)
1928 .any(|(_, p_introduction_node_id)| p_introduction_node_id != introduction_node_id)
1930 return Err(LightningError{err: format!("1-hop blinded paths must all have matching introduction node ids"), action: ErrorAction::IgnoreError});
1935 let final_cltv_expiry_delta = payment_params.payee.final_cltv_expiry_delta().unwrap_or(0);
1936 if payment_params.max_total_cltv_expiry_delta <= final_cltv_expiry_delta {
1937 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});
1940 // The general routing idea is the following:
1941 // 1. Fill first/last hops communicated by the caller.
1942 // 2. Attempt to construct a path from payer to payee for transferring
1943 // any ~sufficient (described later) value.
1944 // If succeed, remember which channels were used and how much liquidity they have available,
1945 // so that future paths don't rely on the same liquidity.
1946 // 3. Proceed to the next step if:
1947 // - we hit the recommended target value;
1948 // - OR if we could not construct a new path. Any next attempt will fail too.
1949 // Otherwise, repeat step 2.
1950 // 4. See if we managed to collect paths which aggregately are able to transfer target value
1951 // (not recommended value).
1952 // 5. If yes, proceed. If not, fail routing.
1953 // 6. Select the paths which have the lowest cost (fee plus scorer penalty) per amount
1954 // transferred up to the transfer target value.
1955 // 7. Reduce the value of the last path until we are sending only the target value.
1956 // 8. If our maximum channel saturation limit caused us to pick two identical paths, combine
1957 // them so that we're not sending two HTLCs along the same path.
1959 // As for the actual search algorithm, we do a payee-to-payer Dijkstra's sorting by each node's
1960 // distance from the payee
1962 // We are not a faithful Dijkstra's implementation because we can change values which impact
1963 // earlier nodes while processing later nodes. Specifically, if we reach a channel with a lower
1964 // liquidity limit (via htlc_maximum_msat, on-chain capacity or assumed liquidity limits) than
1965 // the value we are currently attempting to send over a path, we simply reduce the value being
1966 // sent along the path for any hops after that channel. This may imply that later fees (which
1967 // we've already tabulated) are lower because a smaller value is passing through the channels
1968 // (and the proportional fee is thus lower). There isn't a trivial way to recalculate the
1969 // channels which were selected earlier (and which may still be used for other paths without a
1970 // lower liquidity limit), so we simply accept that some liquidity-limited paths may be
1973 // One potentially problematic case for this algorithm would be if there are many
1974 // liquidity-limited paths which are liquidity-limited near the destination (ie early in our
1975 // graph walking), we may never find a path which is not liquidity-limited and has lower
1976 // proportional fee (and only lower absolute fee when considering the ultimate value sent).
1977 // Because we only consider paths with at least 5% of the total value being sent, the damage
1978 // from such a case should be limited, however this could be further reduced in the future by
1979 // calculating fees on the amount we wish to route over a path, ie ignoring the liquidity
1980 // limits for the purposes of fee calculation.
1982 // Alternatively, we could store more detailed path information in the heap (targets, below)
1983 // and index the best-path map (dist, below) by node *and* HTLC limits, however that would blow
1984 // up the runtime significantly both algorithmically (as we'd traverse nodes multiple times)
1985 // and practically (as we would need to store dynamically-allocated path information in heap
1986 // objects, increasing malloc traffic and indirect memory access significantly). Further, the
1987 // results of such an algorithm would likely be biased towards lower-value paths.
1989 // Further, we could return to a faithful Dijkstra's algorithm by rejecting paths with limits
1990 // outside of our current search value, running a path search more times to gather candidate
1991 // paths at different values. While this may be acceptable, further path searches may increase
1992 // runtime for little gain. Specifically, the current algorithm rather efficiently explores the
1993 // graph for candidate paths, calculating the maximum value which can realistically be sent at
1994 // the same time, remaining generic across different payment values.
1996 let network_channels = network_graph.channels();
1997 let network_nodes = network_graph.nodes();
1999 if payment_params.max_path_count == 0 {
2000 return Err(LightningError{err: "Can't find a route with no paths allowed.".to_owned(), action: ErrorAction::IgnoreError});
2003 // Allow MPP only if we have a features set from somewhere that indicates the payee supports
2004 // it. If the payee supports it they're supposed to include it in the invoice, so that should
2006 let allow_mpp = if payment_params.max_path_count == 1 {
2008 } else if payment_params.payee.supports_basic_mpp() {
2010 } else if let Some(payee) = payee_node_id_opt {
2011 network_nodes.get(&payee).map_or(false, |node| node.announcement_info.as_ref().map_or(false,
2012 |info| info.features.supports_basic_mpp()))
2015 let max_total_routing_fee_msat = route_params.max_total_routing_fee_msat.unwrap_or(u64::max_value());
2017 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",
2018 our_node_pubkey, LoggedPayeePubkey(payment_params.payee.node_id()),
2019 if allow_mpp { "with" } else { "without" },
2020 first_hops.map(|hops| hops.len()).unwrap_or(0), if first_hops.is_some() { "" } else { "not " },
2021 network_graph.nodes().len(), network_graph.channels().len(),
2022 max_total_routing_fee_msat);
2025 // Prepare the data we'll use for payee-to-payer search by
2026 // inserting first hops suggested by the caller as targets.
2027 // Our search will then attempt to reach them while traversing from the payee node.
2028 let mut first_hop_targets: HashMap<_, Vec<&ChannelDetails>> =
2029 hash_map_with_capacity(if first_hops.is_some() { first_hops.as_ref().unwrap().len() } else { 0 });
2030 if let Some(hops) = first_hops {
2032 if chan.get_outbound_payment_scid().is_none() {
2033 panic!("first_hops should be filled in with usable channels, not pending ones");
2035 if chan.counterparty.node_id == *our_node_pubkey {
2036 return Err(LightningError{err: "First hop cannot have our_node_pubkey as a destination.".to_owned(), action: ErrorAction::IgnoreError});
2039 .entry(NodeId::from_pubkey(&chan.counterparty.node_id))
2040 .or_insert(Vec::new())
2043 if first_hop_targets.is_empty() {
2044 return Err(LightningError{err: "Cannot route when there are no outbound routes away from us".to_owned(), action: ErrorAction::IgnoreError});
2048 let mut private_hop_key_cache = hash_map_with_capacity(
2049 payment_params.payee.unblinded_route_hints().iter().map(|path| path.0.len()).sum()
2052 // Because we store references to private hop node_ids in `dist`, below, we need them to exist
2053 // (as `NodeId`, not `PublicKey`) for the lifetime of `dist`. Thus, we calculate all the keys
2054 // we'll need here and simply fetch them when routing.
2055 private_hop_key_cache.insert(maybe_dummy_payee_pk, NodeId::from_pubkey(&maybe_dummy_payee_pk));
2056 for route in payment_params.payee.unblinded_route_hints().iter() {
2057 for hop in route.0.iter() {
2058 private_hop_key_cache.insert(hop.src_node_id, NodeId::from_pubkey(&hop.src_node_id));
2062 // The main heap containing all candidate next-hops sorted by their score (max(fee,
2063 // htlc_minimum)). Ideally this would be a heap which allowed cheap score reduction instead of
2064 // adding duplicate entries when we find a better path to a given node.
2065 let mut targets: BinaryHeap<RouteGraphNode> = BinaryHeap::new();
2067 // Map from node_id to information about the best current path to that node, including feerate
2069 let mut dist: HashMap<NodeId, PathBuildingHop> = hash_map_with_capacity(network_nodes.len());
2071 // During routing, if we ignore a path due to an htlc_minimum_msat limit, we set this,
2072 // indicating that we may wish to try again with a higher value, potentially paying to meet an
2073 // htlc_minimum with extra fees while still finding a cheaper path.
2074 let mut hit_minimum_limit;
2076 // When arranging a route, we select multiple paths so that we can make a multi-path payment.
2077 // We start with a path_value of the exact amount we want, and if that generates a route we may
2078 // return it immediately. Otherwise, we don't stop searching for paths until we have 3x the
2079 // amount we want in total across paths, selecting the best subset at the end.
2080 const ROUTE_CAPACITY_PROVISION_FACTOR: u64 = 3;
2081 let recommended_value_msat = final_value_msat * ROUTE_CAPACITY_PROVISION_FACTOR as u64;
2082 let mut path_value_msat = final_value_msat;
2084 // Routing Fragmentation Mitigation heuristic:
2086 // Routing fragmentation across many payment paths increases the overall routing
2087 // fees as you have irreducible routing fees per-link used (`fee_base_msat`).
2088 // Taking too many smaller paths also increases the chance of payment failure.
2089 // Thus to avoid this effect, we require from our collected links to provide
2090 // at least a minimal contribution to the recommended value yet-to-be-fulfilled.
2091 // This requirement is currently set to be 1/max_path_count of the payment
2092 // value to ensure we only ever return routes that do not violate this limit.
2093 let minimal_value_contribution_msat: u64 = if allow_mpp {
2094 (final_value_msat + (payment_params.max_path_count as u64 - 1)) / payment_params.max_path_count as u64
2099 // When we start collecting routes we enforce the max_channel_saturation_power_of_half
2100 // requirement strictly. After we've collected enough (or if we fail to find new routes) we
2101 // drop the requirement by setting this to 0.
2102 let mut channel_saturation_pow_half = payment_params.max_channel_saturation_power_of_half;
2104 // Keep track of how much liquidity has been used in selected channels or blinded paths. Used to
2105 // determine if the channel can be used by additional MPP paths or to inform path finding
2106 // decisions. It is aware of direction *only* to ensure that the correct htlc_maximum_msat value
2107 // is used. Hence, liquidity used in one direction will not offset any used in the opposite
2109 let mut used_liquidities: HashMap<CandidateHopId, u64> =
2110 hash_map_with_capacity(network_nodes.len());
2112 // Keeping track of how much value we already collected across other paths. Helps to decide
2113 // when we want to stop looking for new paths.
2114 let mut already_collected_value_msat = 0;
2116 for (_, channels) in first_hop_targets.iter_mut() {
2117 sort_first_hop_channels(channels, &used_liquidities, recommended_value_msat,
2121 log_trace!(logger, "Building path from {} to payer {} for value {} msat.",
2122 LoggedPayeePubkey(payment_params.payee.node_id()), our_node_pubkey, final_value_msat);
2124 // Remember how many candidates we ignored to allow for some logging afterwards.
2125 let mut num_ignored_value_contribution: u32 = 0;
2126 let mut num_ignored_path_length_limit: u32 = 0;
2127 let mut num_ignored_cltv_delta_limit: u32 = 0;
2128 let mut num_ignored_previously_failed: u32 = 0;
2129 let mut num_ignored_total_fee_limit: u32 = 0;
2130 let mut num_ignored_avoid_overpayment: u32 = 0;
2131 let mut num_ignored_htlc_minimum_msat_limit: u32 = 0;
2133 macro_rules! add_entry {
2134 // Adds entry which goes from $candidate.source() to $candidate.target() over the $candidate hop.
2135 // $next_hops_fee_msat represents the fees paid for using all the channels *after* this one,
2136 // since that value has to be transferred over this channel.
2137 // Returns the contribution amount of $candidate if the channel caused an update to `targets`.
2138 ( $candidate: expr, $next_hops_fee_msat: expr,
2139 $next_hops_value_contribution: expr, $next_hops_path_htlc_minimum_msat: expr,
2140 $next_hops_path_penalty_msat: expr, $next_hops_cltv_delta: expr, $next_hops_path_length: expr ) => { {
2141 // We "return" whether we updated the path at the end, and how much we can route via
2142 // this channel, via this:
2143 let mut hop_contribution_amt_msat = None;
2144 // Channels to self should not be used. This is more of belt-and-suspenders, because in
2145 // practice these cases should be caught earlier:
2146 // - for regular channels at channel announcement (TODO)
2147 // - for first and last hops early in get_route
2148 let src_node_id = $candidate.source();
2149 if Some(src_node_id) != $candidate.target() {
2150 let scid_opt = $candidate.short_channel_id();
2151 let effective_capacity = $candidate.effective_capacity();
2152 let htlc_maximum_msat = max_htlc_from_capacity(effective_capacity, channel_saturation_pow_half);
2154 // It is tricky to subtract $next_hops_fee_msat from available liquidity here.
2155 // It may be misleading because we might later choose to reduce the value transferred
2156 // over these channels, and the channel which was insufficient might become sufficient.
2157 // Worst case: we drop a good channel here because it can't cover the high following
2158 // fees caused by one expensive channel, but then this channel could have been used
2159 // if the amount being transferred over this path is lower.
2160 // We do this for now, but this is a subject for removal.
2161 if let Some(mut available_value_contribution_msat) = htlc_maximum_msat.checked_sub($next_hops_fee_msat) {
2162 let used_liquidity_msat = used_liquidities
2163 .get(&$candidate.id())
2164 .map_or(0, |used_liquidity_msat| {
2165 available_value_contribution_msat = available_value_contribution_msat
2166 .saturating_sub(*used_liquidity_msat);
2167 *used_liquidity_msat
2170 // Verify the liquidity offered by this channel complies to the minimal contribution.
2171 let contributes_sufficient_value = available_value_contribution_msat >= minimal_value_contribution_msat;
2172 // Do not consider candidate hops that would exceed the maximum path length.
2173 let path_length_to_node = $next_hops_path_length
2174 + if $candidate.blinded_hint_idx().is_some() { 0 } else { 1 };
2175 let exceeds_max_path_length = path_length_to_node > max_path_length;
2177 // Do not consider candidates that exceed the maximum total cltv expiry limit.
2178 // In order to already account for some of the privacy enhancing random CLTV
2179 // expiry delta offset we add on top later, we subtract a rough estimate
2180 // (2*MEDIAN_HOP_CLTV_EXPIRY_DELTA) here.
2181 let max_total_cltv_expiry_delta = (payment_params.max_total_cltv_expiry_delta - final_cltv_expiry_delta)
2182 .checked_sub(2*MEDIAN_HOP_CLTV_EXPIRY_DELTA)
2183 .unwrap_or(payment_params.max_total_cltv_expiry_delta - final_cltv_expiry_delta);
2184 let hop_total_cltv_delta = ($next_hops_cltv_delta as u32)
2185 .saturating_add($candidate.cltv_expiry_delta());
2186 let exceeds_cltv_delta_limit = hop_total_cltv_delta > max_total_cltv_expiry_delta;
2188 let value_contribution_msat = cmp::min(available_value_contribution_msat, $next_hops_value_contribution);
2189 // Includes paying fees for the use of the following channels.
2190 let amount_to_transfer_over_msat: u64 = match value_contribution_msat.checked_add($next_hops_fee_msat) {
2191 Some(result) => result,
2192 // Can't overflow due to how the values were computed right above.
2193 None => unreachable!(),
2195 #[allow(unused_comparisons)] // $next_hops_path_htlc_minimum_msat is 0 in some calls so rustc complains
2196 let over_path_minimum_msat = amount_to_transfer_over_msat >= $candidate.htlc_minimum_msat() &&
2197 amount_to_transfer_over_msat >= $next_hops_path_htlc_minimum_msat;
2199 #[allow(unused_comparisons)] // $next_hops_path_htlc_minimum_msat is 0 in some calls so rustc complains
2200 let may_overpay_to_meet_path_minimum_msat =
2201 ((amount_to_transfer_over_msat < $candidate.htlc_minimum_msat() &&
2202 recommended_value_msat >= $candidate.htlc_minimum_msat()) ||
2203 (amount_to_transfer_over_msat < $next_hops_path_htlc_minimum_msat &&
2204 recommended_value_msat >= $next_hops_path_htlc_minimum_msat));
2206 let payment_failed_on_this_channel = match scid_opt {
2207 Some(scid) => payment_params.previously_failed_channels.contains(&scid),
2208 None => match $candidate.blinded_hint_idx() {
2210 payment_params.previously_failed_blinded_path_idxs.contains(&(idx as u64))
2216 let (should_log_candidate, first_hop_details) = match $candidate {
2217 CandidateRouteHop::FirstHop(hop) => (true, Some(hop.details)),
2218 CandidateRouteHop::PrivateHop(_) => (true, None),
2219 CandidateRouteHop::Blinded(_) => (true, None),
2220 CandidateRouteHop::OneHopBlinded(_) => (true, None),
2224 // If HTLC minimum is larger than the amount we're going to transfer, we shouldn't
2225 // bother considering this channel. If retrying with recommended_value_msat may
2226 // allow us to hit the HTLC minimum limit, set htlc_minimum_limit so that we go
2227 // around again with a higher amount.
2228 if !contributes_sufficient_value {
2229 if should_log_candidate {
2230 log_trace!(logger, "Ignoring {} due to insufficient value contribution.", LoggedCandidateHop(&$candidate));
2232 if let Some(details) = first_hop_details {
2234 "First hop candidate next_outbound_htlc_limit_msat: {}",
2235 details.next_outbound_htlc_limit_msat,
2239 num_ignored_value_contribution += 1;
2240 } else if exceeds_max_path_length {
2241 if should_log_candidate {
2242 log_trace!(logger, "Ignoring {} due to exceeding maximum path length limit.", LoggedCandidateHop(&$candidate));
2244 num_ignored_path_length_limit += 1;
2245 } else if exceeds_cltv_delta_limit {
2246 if should_log_candidate {
2247 log_trace!(logger, "Ignoring {} due to exceeding CLTV delta limit.", LoggedCandidateHop(&$candidate));
2249 if let Some(_) = first_hop_details {
2251 "First hop candidate cltv_expiry_delta: {}. Limit: {}",
2252 hop_total_cltv_delta,
2253 max_total_cltv_expiry_delta,
2257 num_ignored_cltv_delta_limit += 1;
2258 } else if payment_failed_on_this_channel {
2259 if should_log_candidate {
2260 log_trace!(logger, "Ignoring {} due to a failed previous payment attempt.", LoggedCandidateHop(&$candidate));
2262 num_ignored_previously_failed += 1;
2263 } else if may_overpay_to_meet_path_minimum_msat {
2264 if should_log_candidate {
2266 "Ignoring {} to avoid overpaying to meet htlc_minimum_msat limit.",
2267 LoggedCandidateHop(&$candidate));
2269 if let Some(details) = first_hop_details {
2271 "First hop candidate next_outbound_htlc_minimum_msat: {}",
2272 details.next_outbound_htlc_minimum_msat,
2276 num_ignored_avoid_overpayment += 1;
2277 hit_minimum_limit = true;
2278 } else if over_path_minimum_msat {
2279 // Note that low contribution here (limited by available_liquidity_msat)
2280 // might violate htlc_minimum_msat on the hops which are next along the
2281 // payment path (upstream to the payee). To avoid that, we recompute
2282 // path fees knowing the final path contribution after constructing it.
2283 let curr_min = cmp::max(
2284 $next_hops_path_htlc_minimum_msat, $candidate.htlc_minimum_msat()
2286 let path_htlc_minimum_msat = compute_fees_saturating(curr_min, $candidate.fees())
2287 .saturating_add(curr_min);
2288 let hm_entry = dist.entry(src_node_id);
2289 let old_entry = hm_entry.or_insert_with(|| {
2290 // If there was previously no known way to access the source node
2291 // (recall it goes payee-to-payer) of short_channel_id, first add a
2292 // semi-dummy record just to compute the fees to reach the source node.
2293 // This will affect our decision on selecting short_channel_id
2294 // as a way to reach the $candidate.target() node.
2296 candidate: $candidate.clone(),
2298 next_hops_fee_msat: u64::max_value(),
2299 hop_use_fee_msat: u64::max_value(),
2300 total_fee_msat: u64::max_value(),
2301 path_htlc_minimum_msat,
2302 path_penalty_msat: u64::max_value(),
2303 was_processed: false,
2304 #[cfg(all(not(ldk_bench), any(test, fuzzing)))]
2305 value_contribution_msat,
2309 #[allow(unused_mut)] // We only use the mut in cfg(test)
2310 let mut should_process = !old_entry.was_processed;
2311 #[cfg(all(not(ldk_bench), any(test, fuzzing)))]
2313 // In test/fuzzing builds, we do extra checks to make sure the skipping
2314 // of already-seen nodes only happens in cases we expect (see below).
2315 if !should_process { should_process = true; }
2319 let mut hop_use_fee_msat = 0;
2320 let mut total_fee_msat: u64 = $next_hops_fee_msat;
2322 // Ignore hop_use_fee_msat for channel-from-us as we assume all channels-from-us
2323 // will have the same effective-fee
2324 if src_node_id != our_node_id {
2325 // Note that `u64::max_value` means we'll always fail the
2326 // `old_entry.total_fee_msat > total_fee_msat` check below
2327 hop_use_fee_msat = compute_fees_saturating(amount_to_transfer_over_msat, $candidate.fees());
2328 total_fee_msat = total_fee_msat.saturating_add(hop_use_fee_msat);
2331 // Ignore hops if augmenting the current path to them would put us over `max_total_routing_fee_msat`
2332 if total_fee_msat > max_total_routing_fee_msat {
2333 if should_log_candidate {
2334 log_trace!(logger, "Ignoring {} due to exceeding max total routing fee limit.", LoggedCandidateHop(&$candidate));
2336 if let Some(_) = first_hop_details {
2338 "First hop candidate routing fee: {}. Limit: {}",
2340 max_total_routing_fee_msat,
2344 num_ignored_total_fee_limit += 1;
2346 let channel_usage = ChannelUsage {
2347 amount_msat: amount_to_transfer_over_msat,
2348 inflight_htlc_msat: used_liquidity_msat,
2351 let channel_penalty_msat =
2352 scorer.channel_penalty_msat($candidate,
2355 let path_penalty_msat = $next_hops_path_penalty_msat
2356 .saturating_add(channel_penalty_msat);
2358 // Update the way of reaching $candidate.source()
2359 // with the given short_channel_id (from $candidate.target()),
2360 // if this way is cheaper than the already known
2361 // (considering the cost to "reach" this channel from the route destination,
2362 // the cost of using this channel,
2363 // and the cost of routing to the source node of this channel).
2364 // Also, consider that htlc_minimum_msat_difference, because we might end up
2365 // paying it. Consider the following exploit:
2366 // we use 2 paths to transfer 1.5 BTC. One of them is 0-fee normal 1 BTC path,
2367 // and for the other one we picked a 1sat-fee path with htlc_minimum_msat of
2368 // 1 BTC. Now, since the latter is more expensive, we gonna try to cut it
2369 // by 0.5 BTC, but then match htlc_minimum_msat by paying a fee of 0.5 BTC
2371 // Ideally the scoring could be smarter (e.g. 0.5*htlc_minimum_msat here),
2372 // but it may require additional tracking - we don't want to double-count
2373 // the fees included in $next_hops_path_htlc_minimum_msat, but also
2374 // can't use something that may decrease on future hops.
2375 let old_cost = cmp::max(old_entry.total_fee_msat, old_entry.path_htlc_minimum_msat)
2376 .saturating_add(old_entry.path_penalty_msat);
2377 let new_cost = cmp::max(total_fee_msat, path_htlc_minimum_msat)
2378 .saturating_add(path_penalty_msat);
2380 if !old_entry.was_processed && new_cost < old_cost {
2381 let new_graph_node = RouteGraphNode {
2382 node_id: src_node_id,
2383 score: cmp::max(total_fee_msat, path_htlc_minimum_msat).saturating_add(path_penalty_msat),
2384 total_cltv_delta: hop_total_cltv_delta,
2385 value_contribution_msat,
2386 path_length_to_node,
2388 targets.push(new_graph_node);
2389 old_entry.next_hops_fee_msat = $next_hops_fee_msat;
2390 old_entry.hop_use_fee_msat = hop_use_fee_msat;
2391 old_entry.total_fee_msat = total_fee_msat;
2392 old_entry.candidate = $candidate.clone();
2393 old_entry.fee_msat = 0; // This value will be later filled with hop_use_fee_msat of the following channel
2394 old_entry.path_htlc_minimum_msat = path_htlc_minimum_msat;
2395 old_entry.path_penalty_msat = path_penalty_msat;
2396 #[cfg(all(not(ldk_bench), any(test, fuzzing)))]
2398 old_entry.value_contribution_msat = value_contribution_msat;
2400 hop_contribution_amt_msat = Some(value_contribution_msat);
2401 } else if old_entry.was_processed && new_cost < old_cost {
2402 #[cfg(all(not(ldk_bench), any(test, fuzzing)))]
2404 // If we're skipping processing a node which was previously
2405 // processed even though we found another path to it with a
2406 // cheaper fee, check that it was because the second path we
2407 // found (which we are processing now) has a lower value
2408 // contribution due to an HTLC minimum limit.
2410 // e.g. take a graph with two paths from node 1 to node 2, one
2411 // through channel A, and one through channel B. Channel A and
2412 // B are both in the to-process heap, with their scores set by
2413 // a higher htlc_minimum than fee.
2414 // Channel A is processed first, and the channels onwards from
2415 // node 1 are added to the to-process heap. Thereafter, we pop
2416 // Channel B off of the heap, note that it has a much more
2417 // restrictive htlc_maximum_msat, and recalculate the fees for
2418 // all of node 1's channels using the new, reduced, amount.
2420 // This would be bogus - we'd be selecting a higher-fee path
2421 // with a lower htlc_maximum_msat instead of the one we'd
2422 // already decided to use.
2423 debug_assert!(path_htlc_minimum_msat < old_entry.path_htlc_minimum_msat);
2425 value_contribution_msat + path_penalty_msat <
2426 old_entry.value_contribution_msat + old_entry.path_penalty_msat
2433 if should_log_candidate {
2435 "Ignoring {} due to its htlc_minimum_msat limit.",
2436 LoggedCandidateHop(&$candidate));
2438 if let Some(details) = first_hop_details {
2440 "First hop candidate next_outbound_htlc_minimum_msat: {}",
2441 details.next_outbound_htlc_minimum_msat,
2445 num_ignored_htlc_minimum_msat_limit += 1;
2449 hop_contribution_amt_msat
2453 let default_node_features = default_node_features();
2455 // Find ways (channels with destination) to reach a given node and store them
2456 // in the corresponding data structures (routing graph etc).
2457 // $fee_to_target_msat represents how much it costs to reach to this node from the payee,
2458 // meaning how much will be paid in fees after this node (to the best of our knowledge).
2459 // This data can later be helpful to optimize routing (pay lower fees).
2460 macro_rules! add_entries_to_cheapest_to_target_node {
2461 ( $node: expr, $node_id: expr, $next_hops_value_contribution: expr,
2462 $next_hops_cltv_delta: expr, $next_hops_path_length: expr ) => {
2463 let fee_to_target_msat;
2464 let next_hops_path_htlc_minimum_msat;
2465 let next_hops_path_penalty_msat;
2466 let skip_node = if let Some(elem) = dist.get_mut(&$node_id) {
2467 let was_processed = elem.was_processed;
2468 elem.was_processed = true;
2469 fee_to_target_msat = elem.total_fee_msat;
2470 next_hops_path_htlc_minimum_msat = elem.path_htlc_minimum_msat;
2471 next_hops_path_penalty_msat = elem.path_penalty_msat;
2474 // Entries are added to dist in add_entry!() when there is a channel from a node.
2475 // Because there are no channels from payee, it will not have a dist entry at this point.
2476 // If we're processing any other node, it is always be the result of a channel from it.
2477 debug_assert_eq!($node_id, maybe_dummy_payee_node_id);
2478 fee_to_target_msat = 0;
2479 next_hops_path_htlc_minimum_msat = 0;
2480 next_hops_path_penalty_msat = 0;
2485 if let Some(first_channels) = first_hop_targets.get(&$node_id) {
2486 for details in first_channels {
2487 let candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
2488 details, payer_node_id: &our_node_id,
2490 add_entry!(&candidate, fee_to_target_msat,
2491 $next_hops_value_contribution,
2492 next_hops_path_htlc_minimum_msat, next_hops_path_penalty_msat,
2493 $next_hops_cltv_delta, $next_hops_path_length);
2497 let features = if let Some(node_info) = $node.announcement_info.as_ref() {
2500 &default_node_features
2503 if !features.requires_unknown_bits() {
2504 for chan_id in $node.channels.iter() {
2505 let chan = network_channels.get(chan_id).unwrap();
2506 if !chan.features.requires_unknown_bits() {
2507 if let Some((directed_channel, source)) = chan.as_directed_to(&$node_id) {
2508 if first_hops.is_none() || *source != our_node_id {
2509 if directed_channel.direction().enabled {
2510 let candidate = CandidateRouteHop::PublicHop(PublicHopCandidate {
2511 info: directed_channel,
2512 short_channel_id: *chan_id,
2514 add_entry!(&candidate,
2516 $next_hops_value_contribution,
2517 next_hops_path_htlc_minimum_msat,
2518 next_hops_path_penalty_msat,
2519 $next_hops_cltv_delta, $next_hops_path_length);
2530 let mut payment_paths = Vec::<PaymentPath>::new();
2532 // TODO: diversify by nodes (so that all paths aren't doomed if one node is offline).
2533 'paths_collection: loop {
2534 // For every new path, start from scratch, except for used_liquidities, which
2535 // helps to avoid reusing previously selected paths in future iterations.
2538 hit_minimum_limit = false;
2540 // If first hop is a private channel and the only way to reach the payee, this is the only
2541 // place where it could be added.
2542 payee_node_id_opt.map(|payee| first_hop_targets.get(&payee).map(|first_channels| {
2543 for details in first_channels {
2544 let candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
2545 details, payer_node_id: &our_node_id,
2547 let added = add_entry!(&candidate, 0, path_value_msat,
2548 0, 0u64, 0, 0).is_some();
2549 log_trace!(logger, "{} direct route to payee via {}",
2550 if added { "Added" } else { "Skipped" }, LoggedCandidateHop(&candidate));
2554 // Add the payee as a target, so that the payee-to-payer
2555 // search algorithm knows what to start with.
2556 payee_node_id_opt.map(|payee| match network_nodes.get(&payee) {
2557 // The payee is not in our network graph, so nothing to add here.
2558 // There is still a chance of reaching them via last_hops though,
2559 // so don't yet fail the payment here.
2560 // If not, targets.pop() will not even let us enter the loop in step 2.
2563 add_entries_to_cheapest_to_target_node!(node, payee, path_value_msat, 0, 0);
2568 // If a caller provided us with last hops, add them to routing targets. Since this happens
2569 // earlier than general path finding, they will be somewhat prioritized, although currently
2570 // it matters only if the fees are exactly the same.
2571 for (hint_idx, hint) in payment_params.payee.blinded_route_hints().iter().enumerate() {
2572 // Only add the hops in this route to our candidate set if either
2573 // we have a direct channel to the first hop or the first hop is
2574 // in the regular network graph.
2575 let source_node_id = match introduction_node_id_cache[hint_idx] {
2576 Some(node_id) => node_id,
2577 None => match &hint.1.introduction_node {
2578 IntroductionNode::NodeId(pubkey) => {
2579 let node_id = NodeId::from_pubkey(&pubkey);
2580 match first_hop_targets.get_key_value(&node_id).map(|(key, _)| key) {
2581 Some(node_id) => node_id,
2585 IntroductionNode::DirectedShortChannelId(direction, scid) => {
2586 let first_hop = first_hop_targets.iter().find(|(_, channels)|
2589 .any(|details| Some(*scid) == details.get_outbound_payment_scid())
2592 Some((counterparty_node_id, _)) => {
2593 direction.select_node_id(&our_node_id, counterparty_node_id)
2600 if our_node_id == *source_node_id { continue }
2601 let candidate = if hint.1.blinded_hops.len() == 1 {
2602 CandidateRouteHop::OneHopBlinded(
2603 OneHopBlindedPathCandidate { source_node_id, hint, hint_idx }
2606 CandidateRouteHop::Blinded(BlindedPathCandidate { source_node_id, hint, hint_idx })
2608 let mut path_contribution_msat = path_value_msat;
2609 if let Some(hop_used_msat) = add_entry!(&candidate,
2610 0, path_contribution_msat, 0, 0_u64, 0, 0)
2612 path_contribution_msat = hop_used_msat;
2614 if let Some(first_channels) = first_hop_targets.get(source_node_id) {
2615 let mut first_channels = first_channels.clone();
2616 sort_first_hop_channels(
2617 &mut first_channels, &used_liquidities, recommended_value_msat, our_node_pubkey
2619 for details in first_channels {
2620 let first_hop_candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
2621 details, payer_node_id: &our_node_id,
2623 let blinded_path_fee = match compute_fees(path_contribution_msat, candidate.fees()) {
2627 let path_min = candidate.htlc_minimum_msat().saturating_add(
2628 compute_fees_saturating(candidate.htlc_minimum_msat(), candidate.fees()));
2629 add_entry!(&first_hop_candidate, blinded_path_fee, path_contribution_msat, path_min,
2630 0_u64, candidate.cltv_expiry_delta(), 0);
2634 for route in payment_params.payee.unblinded_route_hints().iter()
2635 .filter(|route| !route.0.is_empty())
2637 let first_hop_src_id = NodeId::from_pubkey(&route.0.first().unwrap().src_node_id);
2638 let first_hop_src_is_reachable =
2639 // Only add the hops in this route to our candidate set if either we are part of
2640 // the first hop, we have a direct channel to the first hop, or the first hop is in
2641 // the regular network graph.
2642 our_node_id == first_hop_src_id ||
2643 first_hop_targets.get(&first_hop_src_id).is_some() ||
2644 network_nodes.get(&first_hop_src_id).is_some();
2645 if first_hop_src_is_reachable {
2646 // We start building the path from reverse, i.e., from payee
2647 // to the first RouteHintHop in the path.
2648 let hop_iter = route.0.iter().rev();
2649 let prev_hop_iter = core::iter::once(&maybe_dummy_payee_pk).chain(
2650 route.0.iter().skip(1).rev().map(|hop| &hop.src_node_id));
2651 let mut hop_used = true;
2652 let mut aggregate_next_hops_fee_msat: u64 = 0;
2653 let mut aggregate_next_hops_path_htlc_minimum_msat: u64 = 0;
2654 let mut aggregate_next_hops_path_penalty_msat: u64 = 0;
2655 let mut aggregate_next_hops_cltv_delta: u32 = 0;
2656 let mut aggregate_next_hops_path_length: u8 = 0;
2657 let mut aggregate_path_contribution_msat = path_value_msat;
2659 for (idx, (hop, prev_hop_id)) in hop_iter.zip(prev_hop_iter).enumerate() {
2660 let target = private_hop_key_cache.get(prev_hop_id).unwrap();
2662 if let Some(first_channels) = first_hop_targets.get(target) {
2663 if first_channels.iter().any(|d| d.outbound_scid_alias == Some(hop.short_channel_id)) {
2664 log_trace!(logger, "Ignoring route hint with SCID {} (and any previous) due to it being a direct channel of ours.",
2665 hop.short_channel_id);
2670 let candidate = network_channels
2671 .get(&hop.short_channel_id)
2672 .and_then(|channel| channel.as_directed_to(target))
2673 .map(|(info, _)| CandidateRouteHop::PublicHop(PublicHopCandidate {
2675 short_channel_id: hop.short_channel_id,
2677 .unwrap_or_else(|| CandidateRouteHop::PrivateHop(PrivateHopCandidate { hint: hop, target_node_id: target }));
2679 if let Some(hop_used_msat) = add_entry!(&candidate,
2680 aggregate_next_hops_fee_msat, aggregate_path_contribution_msat,
2681 aggregate_next_hops_path_htlc_minimum_msat, aggregate_next_hops_path_penalty_msat,
2682 aggregate_next_hops_cltv_delta, aggregate_next_hops_path_length)
2684 aggregate_path_contribution_msat = hop_used_msat;
2686 // If this hop was not used then there is no use checking the preceding
2687 // hops in the RouteHint. We can break by just searching for a direct
2688 // channel between last checked hop and first_hop_targets.
2692 let used_liquidity_msat = used_liquidities
2693 .get(&candidate.id()).copied()
2695 let channel_usage = ChannelUsage {
2696 amount_msat: final_value_msat + aggregate_next_hops_fee_msat,
2697 inflight_htlc_msat: used_liquidity_msat,
2698 effective_capacity: candidate.effective_capacity(),
2700 let channel_penalty_msat = scorer.channel_penalty_msat(
2701 &candidate, channel_usage, score_params
2703 aggregate_next_hops_path_penalty_msat = aggregate_next_hops_path_penalty_msat
2704 .saturating_add(channel_penalty_msat);
2706 aggregate_next_hops_cltv_delta = aggregate_next_hops_cltv_delta
2707 .saturating_add(hop.cltv_expiry_delta as u32);
2709 aggregate_next_hops_path_length = aggregate_next_hops_path_length
2712 // Searching for a direct channel between last checked hop and first_hop_targets
2713 if let Some(first_channels) = first_hop_targets.get(target) {
2714 let mut first_channels = first_channels.clone();
2715 sort_first_hop_channels(
2716 &mut first_channels, &used_liquidities, recommended_value_msat, our_node_pubkey
2718 for details in first_channels {
2719 let first_hop_candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
2720 details, payer_node_id: &our_node_id,
2722 add_entry!(&first_hop_candidate,
2723 aggregate_next_hops_fee_msat, aggregate_path_contribution_msat,
2724 aggregate_next_hops_path_htlc_minimum_msat, aggregate_next_hops_path_penalty_msat,
2725 aggregate_next_hops_cltv_delta, aggregate_next_hops_path_length);
2733 // In the next values of the iterator, the aggregate fees already reflects
2734 // the sum of value sent from payer (final_value_msat) and routing fees
2735 // for the last node in the RouteHint. We need to just add the fees to
2736 // route through the current node so that the preceding node (next iteration)
2738 let hops_fee = compute_fees(aggregate_next_hops_fee_msat + final_value_msat, hop.fees)
2739 .map_or(None, |inc| inc.checked_add(aggregate_next_hops_fee_msat));
2740 aggregate_next_hops_fee_msat = if let Some(val) = hops_fee { val } else { break; };
2742 // The next channel will need to relay this channel's min_htlc *plus* the fees taken by
2743 // this route hint's source node to forward said min over this channel.
2744 aggregate_next_hops_path_htlc_minimum_msat = {
2745 let curr_htlc_min = cmp::max(
2746 candidate.htlc_minimum_msat(), aggregate_next_hops_path_htlc_minimum_msat
2748 let curr_htlc_min_fee = if let Some(val) = compute_fees(curr_htlc_min, hop.fees) { val } else { break };
2749 if let Some(min) = curr_htlc_min.checked_add(curr_htlc_min_fee) { min } else { break }
2752 if idx == route.0.len() - 1 {
2753 // The last hop in this iterator is the first hop in
2754 // overall RouteHint.
2755 // If this hop connects to a node with which we have a direct channel,
2756 // ignore the network graph and, if the last hop was added, add our
2757 // direct channel to the candidate set.
2759 // Note that we *must* check if the last hop was added as `add_entry`
2760 // always assumes that the third argument is a node to which we have a
2762 if let Some(first_channels) = first_hop_targets.get(&NodeId::from_pubkey(&hop.src_node_id)) {
2763 let mut first_channels = first_channels.clone();
2764 sort_first_hop_channels(
2765 &mut first_channels, &used_liquidities, recommended_value_msat, our_node_pubkey
2767 for details in first_channels {
2768 let first_hop_candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
2769 details, payer_node_id: &our_node_id,
2771 add_entry!(&first_hop_candidate,
2772 aggregate_next_hops_fee_msat,
2773 aggregate_path_contribution_msat,
2774 aggregate_next_hops_path_htlc_minimum_msat,
2775 aggregate_next_hops_path_penalty_msat,
2776 aggregate_next_hops_cltv_delta,
2777 aggregate_next_hops_path_length);
2785 log_trace!(logger, "Starting main path collection loop with {} nodes pre-filled from first/last hops.", targets.len());
2787 // At this point, targets are filled with the data from first and
2788 // last hops communicated by the caller, and the payment receiver.
2789 let mut found_new_path = false;
2792 // If this loop terminates due the exhaustion of targets, two situations are possible:
2793 // - not enough outgoing liquidity:
2794 // 0 < already_collected_value_msat < final_value_msat
2795 // - enough outgoing liquidity:
2796 // final_value_msat <= already_collected_value_msat < recommended_value_msat
2797 // Both these cases (and other cases except reaching recommended_value_msat) mean that
2798 // paths_collection will be stopped because found_new_path==false.
2799 // This is not necessarily a routing failure.
2800 'path_construction: while let Some(RouteGraphNode { node_id, total_cltv_delta, mut value_contribution_msat, path_length_to_node, .. }) = targets.pop() {
2802 // Since we're going payee-to-payer, hitting our node as a target means we should stop
2803 // traversing the graph and arrange the path out of what we found.
2804 if node_id == our_node_id {
2805 let mut new_entry = dist.remove(&our_node_id).unwrap();
2806 let mut ordered_hops: Vec<(PathBuildingHop, NodeFeatures)> = vec!((new_entry.clone(), default_node_features.clone()));
2809 let mut features_set = false;
2810 let target = ordered_hops.last().unwrap().0.candidate.target().unwrap_or(maybe_dummy_payee_node_id);
2811 if let Some(first_channels) = first_hop_targets.get(&target) {
2812 for details in first_channels {
2813 if let CandidateRouteHop::FirstHop(FirstHopCandidate { details: last_hop_details, .. })
2814 = ordered_hops.last().unwrap().0.candidate
2816 if details.get_outbound_payment_scid() == last_hop_details.get_outbound_payment_scid() {
2817 ordered_hops.last_mut().unwrap().1 = details.counterparty.features.to_context();
2818 features_set = true;
2825 if let Some(node) = network_nodes.get(&target) {
2826 if let Some(node_info) = node.announcement_info.as_ref() {
2827 ordered_hops.last_mut().unwrap().1 = node_info.features.clone();
2829 ordered_hops.last_mut().unwrap().1 = default_node_features.clone();
2832 // We can fill in features for everything except hops which were
2833 // provided via the invoice we're paying. We could guess based on the
2834 // recipient's features but for now we simply avoid guessing at all.
2838 // Means we successfully traversed from the payer to the payee, now
2839 // save this path for the payment route. Also, update the liquidity
2840 // remaining on the used hops, so that we take them into account
2841 // while looking for more paths.
2842 if target == maybe_dummy_payee_node_id {
2846 new_entry = match dist.remove(&target) {
2847 Some(payment_hop) => payment_hop,
2848 // We can't arrive at None because, if we ever add an entry to targets,
2849 // we also fill in the entry in dist (see add_entry!).
2850 None => unreachable!(),
2852 // We "propagate" the fees one hop backward (topologically) here,
2853 // so that fees paid for a HTLC forwarding on the current channel are
2854 // associated with the previous channel (where they will be subtracted).
2855 ordered_hops.last_mut().unwrap().0.fee_msat = new_entry.hop_use_fee_msat;
2856 ordered_hops.push((new_entry.clone(), default_node_features.clone()));
2858 ordered_hops.last_mut().unwrap().0.fee_msat = value_contribution_msat;
2859 ordered_hops.last_mut().unwrap().0.hop_use_fee_msat = 0;
2861 log_trace!(logger, "Found a path back to us from the target with {} hops contributing up to {} msat: \n {:#?}",
2862 ordered_hops.len(), value_contribution_msat, ordered_hops.iter().map(|h| &(h.0)).collect::<Vec<&PathBuildingHop>>());
2864 let mut payment_path = PaymentPath {hops: ordered_hops};
2866 // We could have possibly constructed a slightly inconsistent path: since we reduce
2867 // value being transferred along the way, we could have violated htlc_minimum_msat
2868 // on some channels we already passed (assuming dest->source direction). Here, we
2869 // recompute the fees again, so that if that's the case, we match the currently
2870 // underpaid htlc_minimum_msat with fees.
2871 debug_assert_eq!(payment_path.get_value_msat(), value_contribution_msat);
2872 let desired_value_contribution = cmp::min(value_contribution_msat, final_value_msat);
2873 value_contribution_msat = payment_path.update_value_and_recompute_fees(desired_value_contribution);
2875 // Since a path allows to transfer as much value as
2876 // the smallest channel it has ("bottleneck"), we should recompute
2877 // the fees so sender HTLC don't overpay fees when traversing
2878 // larger channels than the bottleneck. This may happen because
2879 // when we were selecting those channels we were not aware how much value
2880 // this path will transfer, and the relative fee for them
2881 // might have been computed considering a larger value.
2882 // Remember that we used these channels so that we don't rely
2883 // on the same liquidity in future paths.
2884 let mut prevented_redundant_path_selection = false;
2885 for (hop, _) in payment_path.hops.iter() {
2886 let spent_on_hop_msat = value_contribution_msat + hop.next_hops_fee_msat;
2887 let used_liquidity_msat = used_liquidities
2888 .entry(hop.candidate.id())
2889 .and_modify(|used_liquidity_msat| *used_liquidity_msat += spent_on_hop_msat)
2890 .or_insert(spent_on_hop_msat);
2891 let hop_capacity = hop.candidate.effective_capacity();
2892 let hop_max_msat = max_htlc_from_capacity(hop_capacity, channel_saturation_pow_half);
2893 if *used_liquidity_msat == hop_max_msat {
2894 // If this path used all of this channel's available liquidity, we know
2895 // this path will not be selected again in the next loop iteration.
2896 prevented_redundant_path_selection = true;
2898 debug_assert!(*used_liquidity_msat <= hop_max_msat);
2900 if !prevented_redundant_path_selection {
2901 // If we weren't capped by hitting a liquidity limit on a channel in the path,
2902 // we'll probably end up picking the same path again on the next iteration.
2903 // Decrease the available liquidity of a hop in the middle of the path.
2904 let victim_candidate = &payment_path.hops[(payment_path.hops.len()) / 2].0.candidate;
2905 let exhausted = u64::max_value();
2907 "Disabling route candidate {} for future path building iterations to avoid duplicates.",
2908 LoggedCandidateHop(victim_candidate));
2909 if let Some(scid) = victim_candidate.short_channel_id() {
2910 *used_liquidities.entry(CandidateHopId::Clear((scid, false))).or_default() = exhausted;
2911 *used_liquidities.entry(CandidateHopId::Clear((scid, true))).or_default() = exhausted;
2915 // Track the total amount all our collected paths allow to send so that we know
2916 // when to stop looking for more paths
2917 already_collected_value_msat += value_contribution_msat;
2919 payment_paths.push(payment_path);
2920 found_new_path = true;
2921 break 'path_construction;
2924 // If we found a path back to the payee, we shouldn't try to process it again. This is
2925 // the equivalent of the `elem.was_processed` check in
2926 // add_entries_to_cheapest_to_target_node!() (see comment there for more info).
2927 if node_id == maybe_dummy_payee_node_id { continue 'path_construction; }
2929 // Otherwise, since the current target node is not us,
2930 // keep "unrolling" the payment graph from payee to payer by
2931 // finding a way to reach the current target from the payer side.
2932 match network_nodes.get(&node_id) {
2935 add_entries_to_cheapest_to_target_node!(node, node_id,
2936 value_contribution_msat,
2937 total_cltv_delta, path_length_to_node);
2943 if !found_new_path && channel_saturation_pow_half != 0 {
2944 channel_saturation_pow_half = 0;
2945 continue 'paths_collection;
2947 // If we don't support MPP, no use trying to gather more value ever.
2948 break 'paths_collection;
2952 // Stop either when the recommended value is reached or if no new path was found in this
2954 // In the latter case, making another path finding attempt won't help,
2955 // because we deterministically terminated the search due to low liquidity.
2956 if !found_new_path && channel_saturation_pow_half != 0 {
2957 channel_saturation_pow_half = 0;
2958 } else if !found_new_path && hit_minimum_limit && already_collected_value_msat < final_value_msat && path_value_msat != recommended_value_msat {
2959 log_trace!(logger, "Failed to collect enough value, but running again to collect extra paths with a potentially higher limit.");
2960 path_value_msat = recommended_value_msat;
2961 } else if already_collected_value_msat >= recommended_value_msat || !found_new_path {
2962 log_trace!(logger, "Have now collected {} msat (seeking {} msat) in paths. Last path loop {} a new path.",
2963 already_collected_value_msat, recommended_value_msat, if found_new_path { "found" } else { "did not find" });
2964 break 'paths_collection;
2965 } else if found_new_path && already_collected_value_msat == final_value_msat && payment_paths.len() == 1 {
2966 // Further, if this was our first walk of the graph, and we weren't limited by an
2967 // htlc_minimum_msat, return immediately because this path should suffice. If we were
2968 // limited by an htlc_minimum_msat value, find another path with a higher value,
2969 // potentially allowing us to pay fees to meet the htlc_minimum on the new path while
2970 // still keeping a lower total fee than this path.
2971 if !hit_minimum_limit {
2972 log_trace!(logger, "Collected exactly our payment amount on the first pass, without hitting an htlc_minimum_msat limit, exiting.");
2973 break 'paths_collection;
2975 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.");
2976 path_value_msat = recommended_value_msat;
2980 let num_ignored_total = num_ignored_value_contribution + num_ignored_path_length_limit +
2981 num_ignored_cltv_delta_limit + num_ignored_previously_failed +
2982 num_ignored_avoid_overpayment + num_ignored_htlc_minimum_msat_limit +
2983 num_ignored_total_fee_limit;
2984 if num_ignored_total > 0 {
2986 "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.",
2987 num_ignored_value_contribution, num_ignored_path_length_limit,
2988 num_ignored_cltv_delta_limit, num_ignored_previously_failed,
2989 num_ignored_htlc_minimum_msat_limit, num_ignored_avoid_overpayment,
2990 num_ignored_total_fee_limit, num_ignored_total);
2994 if payment_paths.len() == 0 {
2995 return Err(LightningError{err: "Failed to find a path to the given destination".to_owned(), action: ErrorAction::IgnoreError});
2998 if already_collected_value_msat < final_value_msat {
2999 return Err(LightningError{err: "Failed to find a sufficient route to the given destination".to_owned(), action: ErrorAction::IgnoreError});
3003 let mut selected_route = payment_paths;
3005 debug_assert_eq!(selected_route.iter().map(|p| p.get_value_msat()).sum::<u64>(), already_collected_value_msat);
3006 let mut overpaid_value_msat = already_collected_value_msat - final_value_msat;
3008 // First, sort by the cost-per-value of the path, dropping the paths that cost the most for
3009 // the value they contribute towards the payment amount.
3010 // We sort in descending order as we will remove from the front in `retain`, next.
3011 selected_route.sort_unstable_by(|a, b|
3012 (((b.get_cost_msat() as u128) << 64) / (b.get_value_msat() as u128))
3013 .cmp(&(((a.get_cost_msat() as u128) << 64) / (a.get_value_msat() as u128)))
3016 // We should make sure that at least 1 path left.
3017 let mut paths_left = selected_route.len();
3018 selected_route.retain(|path| {
3019 if paths_left == 1 {
3022 let path_value_msat = path.get_value_msat();
3023 if path_value_msat <= overpaid_value_msat {
3024 overpaid_value_msat -= path_value_msat;
3030 debug_assert!(selected_route.len() > 0);
3032 if overpaid_value_msat != 0 {
3034 // Now, subtract the remaining overpaid value from the most-expensive path.
3035 // TODO: this could also be optimized by also sorting by feerate_per_sat_routed,
3036 // so that the sender pays less fees overall. And also htlc_minimum_msat.
3037 selected_route.sort_unstable_by(|a, b| {
3038 let a_f = a.hops.iter().map(|hop| hop.0.candidate.fees().proportional_millionths as u64).sum::<u64>();
3039 let b_f = b.hops.iter().map(|hop| hop.0.candidate.fees().proportional_millionths as u64).sum::<u64>();
3040 a_f.cmp(&b_f).then_with(|| b.get_cost_msat().cmp(&a.get_cost_msat()))
3042 let expensive_payment_path = selected_route.first_mut().unwrap();
3044 // We already dropped all the paths with value below `overpaid_value_msat` above, thus this
3045 // can't go negative.
3046 let expensive_path_new_value_msat = expensive_payment_path.get_value_msat() - overpaid_value_msat;
3047 expensive_payment_path.update_value_and_recompute_fees(expensive_path_new_value_msat);
3051 // Sort by the path itself and combine redundant paths.
3052 // Note that we sort by SCIDs alone as its simpler but when combining we have to ensure we
3053 // compare both SCIDs and NodeIds as individual nodes may use random aliases causing collisions
3055 selected_route.sort_unstable_by_key(|path| {
3056 let mut key = [CandidateHopId::Clear((42, true)) ; MAX_PATH_LENGTH_ESTIMATE as usize];
3057 debug_assert!(path.hops.len() <= key.len());
3058 for (scid, key) in path.hops.iter() .map(|h| h.0.candidate.id()).zip(key.iter_mut()) {
3063 for idx in 0..(selected_route.len() - 1) {
3064 if idx + 1 >= selected_route.len() { break; }
3065 if iter_equal(selected_route[idx ].hops.iter().map(|h| (h.0.candidate.id(), h.0.candidate.target())),
3066 selected_route[idx + 1].hops.iter().map(|h| (h.0.candidate.id(), h.0.candidate.target()))) {
3067 let new_value = selected_route[idx].get_value_msat() + selected_route[idx + 1].get_value_msat();
3068 selected_route[idx].update_value_and_recompute_fees(new_value);
3069 selected_route.remove(idx + 1);
3073 let mut paths = Vec::new();
3074 for payment_path in selected_route {
3075 let mut hops = Vec::with_capacity(payment_path.hops.len());
3076 for (hop, node_features) in payment_path.hops.iter()
3077 .filter(|(h, _)| h.candidate.short_channel_id().is_some())
3079 let target = hop.candidate.target().expect("target is defined when short_channel_id is defined");
3080 let maybe_announced_channel = if let CandidateRouteHop::PublicHop(_) = hop.candidate {
3081 // If we sourced the hop from the graph we're sure the target node is announced.
3083 } else if let CandidateRouteHop::FirstHop(first_hop) = &hop.candidate {
3084 // If this is a first hop we also know if it's announced.
3085 first_hop.details.is_public
3087 // If we sourced it any other way, we double-check the network graph to see if
3088 // there are announced channels between the endpoints. If so, the hop might be
3089 // referring to any of the announced channels, as its `short_channel_id` might be
3090 // an alias, in which case we don't take any chances here.
3091 network_graph.node(&target).map_or(false, |hop_node|
3092 hop_node.channels.iter().any(|scid| network_graph.channel(*scid)
3093 .map_or(false, |c| c.as_directed_from(&hop.candidate.source()).is_some()))
3097 hops.push(RouteHop {
3098 pubkey: PublicKey::from_slice(target.as_slice()).map_err(|_| LightningError{err: format!("Public key {:?} is invalid", &target), action: ErrorAction::IgnoreAndLog(Level::Trace)})?,
3099 node_features: node_features.clone(),
3100 short_channel_id: hop.candidate.short_channel_id().unwrap(),
3101 channel_features: hop.candidate.features(),
3102 fee_msat: hop.fee_msat,
3103 cltv_expiry_delta: hop.candidate.cltv_expiry_delta(),
3104 maybe_announced_channel,
3107 let mut final_cltv_delta = final_cltv_expiry_delta;
3108 let blinded_tail = payment_path.hops.last().and_then(|(h, _)| {
3109 if let Some(blinded_path) = h.candidate.blinded_path() {
3110 final_cltv_delta = h.candidate.cltv_expiry_delta();
3112 hops: blinded_path.blinded_hops.clone(),
3113 blinding_point: blinded_path.blinding_point,
3114 excess_final_cltv_expiry_delta: 0,
3115 final_value_msat: h.fee_msat,
3119 // Propagate the cltv_expiry_delta one hop backwards since the delta from the current hop is
3120 // applicable for the previous hop.
3121 hops.iter_mut().rev().fold(final_cltv_delta, |prev_cltv_expiry_delta, hop| {
3122 core::mem::replace(&mut hop.cltv_expiry_delta, prev_cltv_expiry_delta)
3125 paths.push(Path { hops, blinded_tail });
3127 // Make sure we would never create a route with more paths than we allow.
3128 debug_assert!(paths.len() <= payment_params.max_path_count.into());
3130 if let Some(node_features) = payment_params.payee.node_features() {
3131 for path in paths.iter_mut() {
3132 path.hops.last_mut().unwrap().node_features = node_features.clone();
3136 let route = Route { paths, route_params: Some(route_params.clone()) };
3138 // Make sure we would never create a route whose total fees exceed max_total_routing_fee_msat.
3139 if let Some(max_total_routing_fee_msat) = route_params.max_total_routing_fee_msat {
3140 if route.get_total_fees() > max_total_routing_fee_msat {
3141 return Err(LightningError{err: format!("Failed to find route that adheres to the maximum total fee limit of {}msat",
3142 max_total_routing_fee_msat), action: ErrorAction::IgnoreError});
3146 log_info!(logger, "Got route: {}", log_route!(route));
3150 // When an adversarial intermediary node observes a payment, it may be able to infer its
3151 // destination, if the remaining CLTV expiry delta exactly matches a feasible path in the network
3152 // graph. In order to improve privacy, this method obfuscates the CLTV expiry deltas along the
3153 // payment path by adding a randomized 'shadow route' offset to the final hop.
3154 fn add_random_cltv_offset(route: &mut Route, payment_params: &PaymentParameters,
3155 network_graph: &ReadOnlyNetworkGraph, random_seed_bytes: &[u8; 32]
3157 let network_channels = network_graph.channels();
3158 let network_nodes = network_graph.nodes();
3160 for path in route.paths.iter_mut() {
3161 let mut shadow_ctlv_expiry_delta_offset: u32 = 0;
3163 // Remember the last three nodes of the random walk and avoid looping back on them.
3164 // Init with the last three nodes from the actual path, if possible.
3165 let mut nodes_to_avoid: [NodeId; 3] = [NodeId::from_pubkey(&path.hops.last().unwrap().pubkey),
3166 NodeId::from_pubkey(&path.hops.get(path.hops.len().saturating_sub(2)).unwrap().pubkey),
3167 NodeId::from_pubkey(&path.hops.get(path.hops.len().saturating_sub(3)).unwrap().pubkey)];
3169 // Choose the last publicly known node as the starting point for the random walk.
3170 let mut cur_hop: Option<NodeId> = None;
3171 let mut path_nonce = [0u8; 12];
3172 if let Some(starting_hop) = path.hops.iter().rev()
3173 .find(|h| network_nodes.contains_key(&NodeId::from_pubkey(&h.pubkey))) {
3174 cur_hop = Some(NodeId::from_pubkey(&starting_hop.pubkey));
3175 path_nonce.copy_from_slice(&cur_hop.unwrap().as_slice()[..12]);
3178 // Init PRNG with the path-dependant nonce, which is static for private paths.
3179 let mut prng = ChaCha20::new(random_seed_bytes, &path_nonce);
3180 let mut random_path_bytes = [0u8; ::core::mem::size_of::<usize>()];
3182 // Pick a random path length in [1 .. 3]
3183 prng.process_in_place(&mut random_path_bytes);
3184 let random_walk_length = usize::from_be_bytes(random_path_bytes).wrapping_rem(3).wrapping_add(1);
3186 for random_hop in 0..random_walk_length {
3187 // If we don't find a suitable offset in the public network graph, we default to
3188 // MEDIAN_HOP_CLTV_EXPIRY_DELTA.
3189 let mut random_hop_offset = MEDIAN_HOP_CLTV_EXPIRY_DELTA;
3191 if let Some(cur_node_id) = cur_hop {
3192 if let Some(cur_node) = network_nodes.get(&cur_node_id) {
3193 // Randomly choose the next unvisited hop.
3194 prng.process_in_place(&mut random_path_bytes);
3195 if let Some(random_channel) = usize::from_be_bytes(random_path_bytes)
3196 .checked_rem(cur_node.channels.len())
3197 .and_then(|index| cur_node.channels.get(index))
3198 .and_then(|id| network_channels.get(id)) {
3199 random_channel.as_directed_from(&cur_node_id).map(|(dir_info, next_id)| {
3200 if !nodes_to_avoid.iter().any(|x| x == next_id) {
3201 nodes_to_avoid[random_hop] = *next_id;
3202 random_hop_offset = dir_info.direction().cltv_expiry_delta.into();
3203 cur_hop = Some(*next_id);
3210 shadow_ctlv_expiry_delta_offset = shadow_ctlv_expiry_delta_offset
3211 .checked_add(random_hop_offset)
3212 .unwrap_or(shadow_ctlv_expiry_delta_offset);
3215 // Limit the total offset to reduce the worst-case locked liquidity timevalue
3216 const MAX_SHADOW_CLTV_EXPIRY_DELTA_OFFSET: u32 = 3*144;
3217 shadow_ctlv_expiry_delta_offset = cmp::min(shadow_ctlv_expiry_delta_offset, MAX_SHADOW_CLTV_EXPIRY_DELTA_OFFSET);
3219 // Limit the offset so we never exceed the max_total_cltv_expiry_delta. To improve plausibility,
3220 // we choose the limit to be the largest possible multiple of MEDIAN_HOP_CLTV_EXPIRY_DELTA.
3221 let path_total_cltv_expiry_delta: u32 = path.hops.iter().map(|h| h.cltv_expiry_delta).sum();
3222 let mut max_path_offset = payment_params.max_total_cltv_expiry_delta - path_total_cltv_expiry_delta;
3223 max_path_offset = cmp::max(
3224 max_path_offset - (max_path_offset % MEDIAN_HOP_CLTV_EXPIRY_DELTA),
3225 max_path_offset % MEDIAN_HOP_CLTV_EXPIRY_DELTA);
3226 shadow_ctlv_expiry_delta_offset = cmp::min(shadow_ctlv_expiry_delta_offset, max_path_offset);
3228 // Add 'shadow' CLTV offset to the final hop
3229 if let Some(tail) = path.blinded_tail.as_mut() {
3230 tail.excess_final_cltv_expiry_delta = tail.excess_final_cltv_expiry_delta
3231 .checked_add(shadow_ctlv_expiry_delta_offset).unwrap_or(tail.excess_final_cltv_expiry_delta);
3233 if let Some(last_hop) = path.hops.last_mut() {
3234 last_hop.cltv_expiry_delta = last_hop.cltv_expiry_delta
3235 .checked_add(shadow_ctlv_expiry_delta_offset).unwrap_or(last_hop.cltv_expiry_delta);
3240 /// Construct a route from us (payer) to the target node (payee) via the given hops (which should
3241 /// exclude the payer, but include the payee). This may be useful, e.g., for probing the chosen path.
3243 /// Re-uses logic from `find_route`, so the restrictions described there also apply here.
3244 pub fn build_route_from_hops<L: Deref, GL: Deref>(
3245 our_node_pubkey: &PublicKey, hops: &[PublicKey], route_params: &RouteParameters,
3246 network_graph: &NetworkGraph<GL>, logger: L, random_seed_bytes: &[u8; 32]
3247 ) -> Result<Route, LightningError>
3248 where L::Target: Logger, GL::Target: Logger {
3249 let graph_lock = network_graph.read_only();
3250 let mut route = build_route_from_hops_internal(our_node_pubkey, hops, &route_params,
3251 &graph_lock, logger, random_seed_bytes)?;
3252 add_random_cltv_offset(&mut route, &route_params.payment_params, &graph_lock, random_seed_bytes);
3256 fn build_route_from_hops_internal<L: Deref>(
3257 our_node_pubkey: &PublicKey, hops: &[PublicKey], route_params: &RouteParameters,
3258 network_graph: &ReadOnlyNetworkGraph, logger: L, random_seed_bytes: &[u8; 32],
3259 ) -> Result<Route, LightningError> where L::Target: Logger {
3262 our_node_id: NodeId,
3263 hop_ids: [Option<NodeId>; MAX_PATH_LENGTH_ESTIMATE as usize],
3266 impl ScoreLookUp for HopScorer {
3267 type ScoreParams = ();
3268 fn channel_penalty_msat(&self, candidate: &CandidateRouteHop,
3269 _usage: ChannelUsage, _score_params: &Self::ScoreParams) -> u64
3271 let mut cur_id = self.our_node_id;
3272 for i in 0..self.hop_ids.len() {
3273 if let Some(next_id) = self.hop_ids[i] {
3274 if cur_id == candidate.source() && Some(next_id) == candidate.target() {
3286 impl<'a> Writeable for HopScorer {
3288 fn write<W: Writer>(&self, _w: &mut W) -> Result<(), io::Error> {
3293 if hops.len() > MAX_PATH_LENGTH_ESTIMATE.into() {
3294 return Err(LightningError{err: "Cannot build a route exceeding the maximum path length.".to_owned(), action: ErrorAction::IgnoreError});
3297 let our_node_id = NodeId::from_pubkey(our_node_pubkey);
3298 let mut hop_ids = [None; MAX_PATH_LENGTH_ESTIMATE as usize];
3299 for i in 0..hops.len() {
3300 hop_ids[i] = Some(NodeId::from_pubkey(&hops[i]));
3303 let scorer = HopScorer { our_node_id, hop_ids };
3305 get_route(our_node_pubkey, route_params, network_graph, None, logger, &scorer, &Default::default(), random_seed_bytes)
3310 use crate::blinded_path::{BlindedHop, BlindedPath, IntroductionNode};
3311 use crate::routing::gossip::{NetworkGraph, P2PGossipSync, NodeId, EffectiveCapacity};
3312 use crate::routing::utxo::UtxoResult;
3313 use crate::routing::router::{get_route, build_route_from_hops_internal, add_random_cltv_offset, default_node_features,
3314 BlindedTail, InFlightHtlcs, Path, PaymentParameters, Route, RouteHint, RouteHintHop, RouteHop, RoutingFees,
3315 DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA, MAX_PATH_LENGTH_ESTIMATE, RouteParameters, CandidateRouteHop, PublicHopCandidate};
3316 use crate::routing::scoring::{ChannelUsage, FixedPenaltyScorer, ScoreLookUp, ProbabilisticScorer, ProbabilisticScoringFeeParameters, ProbabilisticScoringDecayParameters};
3317 use crate::routing::test_utils::{add_channel, add_or_update_node, build_graph, build_line_graph, id_to_feature_flags, get_nodes, update_channel};
3318 use crate::chain::transaction::OutPoint;
3319 use crate::sign::EntropySource;
3320 use crate::ln::types::ChannelId;
3321 use crate::ln::features::{BlindedHopFeatures, ChannelFeatures, InitFeatures, NodeFeatures};
3322 use crate::ln::msgs::{ErrorAction, LightningError, UnsignedChannelUpdate, MAX_VALUE_MSAT};
3323 use crate::ln::channelmanager;
3324 use crate::offers::invoice::BlindedPayInfo;
3325 use crate::util::config::UserConfig;
3326 use crate::util::test_utils as ln_test_utils;
3327 use crate::crypto::chacha20::ChaCha20;
3328 use crate::util::ser::{Readable, Writeable};
3330 use crate::util::ser::Writer;
3332 use bitcoin::amount::Amount;
3333 use bitcoin::hashes::Hash;
3334 use bitcoin::network::Network;
3335 use bitcoin::blockdata::constants::ChainHash;
3336 use bitcoin::blockdata::script::Builder;
3337 use bitcoin::blockdata::opcodes;
3338 use bitcoin::blockdata::transaction::TxOut;
3339 use bitcoin::hashes::hex::FromHex;
3340 use bitcoin::secp256k1::{PublicKey,SecretKey};
3341 use bitcoin::secp256k1::Secp256k1;
3343 use crate::io::Cursor;
3344 use crate::prelude::*;
3345 use crate::sync::Arc;
3347 fn get_channel_details(short_channel_id: Option<u64>, node_id: PublicKey,
3348 features: InitFeatures, outbound_capacity_msat: u64) -> channelmanager::ChannelDetails {
3349 channelmanager::ChannelDetails {
3350 channel_id: ChannelId::new_zero(),
3351 counterparty: channelmanager::ChannelCounterparty {
3354 unspendable_punishment_reserve: 0,
3355 forwarding_info: None,
3356 outbound_htlc_minimum_msat: None,
3357 outbound_htlc_maximum_msat: None,
3359 funding_txo: Some(OutPoint { txid: bitcoin::Txid::from_slice(&[0; 32]).unwrap(), index: 0 }),
3362 outbound_scid_alias: None,
3363 inbound_scid_alias: None,
3364 channel_value_satoshis: 0,
3367 outbound_capacity_msat,
3368 next_outbound_htlc_limit_msat: outbound_capacity_msat,
3369 next_outbound_htlc_minimum_msat: 0,
3370 inbound_capacity_msat: 42,
3371 unspendable_punishment_reserve: None,
3372 confirmations_required: None,
3373 confirmations: None,
3374 force_close_spend_delay: None,
3375 is_outbound: true, is_channel_ready: true,
3376 is_usable: true, is_public: true,
3377 inbound_htlc_minimum_msat: None,
3378 inbound_htlc_maximum_msat: None,
3380 feerate_sat_per_1000_weight: None,
3381 channel_shutdown_state: Some(channelmanager::ChannelShutdownState::NotShuttingDown),
3382 pending_inbound_htlcs: Vec::new(),
3383 pending_outbound_htlcs: Vec::new(),
3388 fn simple_route_test() {
3389 let (secp_ctx, network_graph, _, _, logger) = build_graph();
3390 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
3391 let mut payment_params = PaymentParameters::from_node_id(nodes[2], 42);
3392 let scorer = ln_test_utils::TestScorer::new();
3393 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3394 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3396 // Simple route to 2 via 1
3398 let route_params = RouteParameters::from_payment_params_and_value(
3399 payment_params.clone(), 0);
3400 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
3401 &route_params, &network_graph.read_only(), None, Arc::clone(&logger), &scorer,
3402 &Default::default(), &random_seed_bytes) {
3403 assert_eq!(err, "Cannot send a payment of 0 msat");
3404 } else { panic!(); }
3406 payment_params.max_path_length = 2;
3407 let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
3408 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3409 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3410 assert_eq!(route.paths[0].hops.len(), 2);
3412 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
3413 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
3414 assert_eq!(route.paths[0].hops[0].fee_msat, 100);
3415 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
3416 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
3417 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
3419 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
3420 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
3421 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
3422 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
3423 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
3424 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
3426 route_params.payment_params.max_path_length = 1;
3427 get_route(&our_id, &route_params, &network_graph.read_only(), None,
3428 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap_err();
3432 fn invalid_first_hop_test() {
3433 let (secp_ctx, network_graph, _, _, logger) = build_graph();
3434 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
3435 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
3436 let scorer = ln_test_utils::TestScorer::new();
3437 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3438 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3440 // Simple route to 2 via 1
3442 let our_chans = vec![get_channel_details(Some(2), our_id, InitFeatures::from_le_bytes(vec![0b11]), 100000)];
3444 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
3445 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
3446 &route_params, &network_graph.read_only(), Some(&our_chans.iter().collect::<Vec<_>>()),
3447 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes) {
3448 assert_eq!(err, "First hop cannot have our_node_pubkey as a destination.");
3449 } else { panic!(); }
3451 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3452 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3453 assert_eq!(route.paths[0].hops.len(), 2);
3457 fn htlc_minimum_test() {
3458 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
3459 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3460 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
3461 let scorer = ln_test_utils::TestScorer::new();
3462 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3463 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3465 // Simple route to 2 via 1
3467 // Disable other paths
3468 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3469 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3470 short_channel_id: 12,
3472 flags: 2, // to disable
3473 cltv_expiry_delta: 0,
3474 htlc_minimum_msat: 0,
3475 htlc_maximum_msat: MAX_VALUE_MSAT,
3477 fee_proportional_millionths: 0,
3478 excess_data: Vec::new()
3480 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
3481 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3482 short_channel_id: 3,
3484 flags: 2, // to disable
3485 cltv_expiry_delta: 0,
3486 htlc_minimum_msat: 0,
3487 htlc_maximum_msat: MAX_VALUE_MSAT,
3489 fee_proportional_millionths: 0,
3490 excess_data: Vec::new()
3492 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
3493 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3494 short_channel_id: 13,
3496 flags: 2, // to disable
3497 cltv_expiry_delta: 0,
3498 htlc_minimum_msat: 0,
3499 htlc_maximum_msat: MAX_VALUE_MSAT,
3501 fee_proportional_millionths: 0,
3502 excess_data: Vec::new()
3504 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3505 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3506 short_channel_id: 6,
3508 flags: 2, // to disable
3509 cltv_expiry_delta: 0,
3510 htlc_minimum_msat: 0,
3511 htlc_maximum_msat: MAX_VALUE_MSAT,
3513 fee_proportional_millionths: 0,
3514 excess_data: Vec::new()
3516 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3517 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3518 short_channel_id: 7,
3520 flags: 2, // to disable
3521 cltv_expiry_delta: 0,
3522 htlc_minimum_msat: 0,
3523 htlc_maximum_msat: MAX_VALUE_MSAT,
3525 fee_proportional_millionths: 0,
3526 excess_data: Vec::new()
3529 // Check against amount_to_transfer_over_msat.
3530 // Set minimal HTLC of 200_000_000 msat.
3531 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3532 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3533 short_channel_id: 2,
3536 cltv_expiry_delta: 0,
3537 htlc_minimum_msat: 200_000_000,
3538 htlc_maximum_msat: MAX_VALUE_MSAT,
3540 fee_proportional_millionths: 0,
3541 excess_data: Vec::new()
3544 // Second hop only allows to forward 199_999_999 at most, thus not allowing the first hop to
3546 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
3547 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3548 short_channel_id: 4,
3551 cltv_expiry_delta: 0,
3552 htlc_minimum_msat: 0,
3553 htlc_maximum_msat: 199_999_999,
3555 fee_proportional_millionths: 0,
3556 excess_data: Vec::new()
3559 // Not possible to send 199_999_999, because the minimum on channel=2 is 200_000_000.
3560 let route_params = RouteParameters::from_payment_params_and_value(
3561 payment_params, 199_999_999);
3562 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
3563 &route_params, &network_graph.read_only(), None, Arc::clone(&logger), &scorer,
3564 &Default::default(), &random_seed_bytes) {
3565 assert_eq!(err, "Failed to find a path to the given destination");
3566 } else { panic!(); }
3568 // Lift the restriction on the first hop.
3569 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3570 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3571 short_channel_id: 2,
3574 cltv_expiry_delta: 0,
3575 htlc_minimum_msat: 0,
3576 htlc_maximum_msat: MAX_VALUE_MSAT,
3578 fee_proportional_millionths: 0,
3579 excess_data: Vec::new()
3582 // A payment above the minimum should pass
3583 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3584 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3585 assert_eq!(route.paths[0].hops.len(), 2);
3589 fn htlc_minimum_overpay_test() {
3590 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
3591 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3592 let config = UserConfig::default();
3593 let payment_params = PaymentParameters::from_node_id(nodes[2], 42)
3594 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
3596 let scorer = ln_test_utils::TestScorer::new();
3597 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3598 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3600 // A route to node#2 via two paths.
3601 // One path allows transferring 35-40 sats, another one also allows 35-40 sats.
3602 // Thus, they can't send 60 without overpaying.
3603 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3604 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3605 short_channel_id: 2,
3608 cltv_expiry_delta: 0,
3609 htlc_minimum_msat: 35_000,
3610 htlc_maximum_msat: 40_000,
3612 fee_proportional_millionths: 0,
3613 excess_data: Vec::new()
3615 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3616 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3617 short_channel_id: 12,
3620 cltv_expiry_delta: 0,
3621 htlc_minimum_msat: 35_000,
3622 htlc_maximum_msat: 40_000,
3624 fee_proportional_millionths: 0,
3625 excess_data: Vec::new()
3629 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
3630 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3631 short_channel_id: 13,
3634 cltv_expiry_delta: 0,
3635 htlc_minimum_msat: 0,
3636 htlc_maximum_msat: MAX_VALUE_MSAT,
3638 fee_proportional_millionths: 0,
3639 excess_data: Vec::new()
3641 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
3642 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3643 short_channel_id: 4,
3646 cltv_expiry_delta: 0,
3647 htlc_minimum_msat: 0,
3648 htlc_maximum_msat: MAX_VALUE_MSAT,
3650 fee_proportional_millionths: 0,
3651 excess_data: Vec::new()
3654 // Disable other paths
3655 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3656 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3657 short_channel_id: 1,
3659 flags: 2, // to disable
3660 cltv_expiry_delta: 0,
3661 htlc_minimum_msat: 0,
3662 htlc_maximum_msat: MAX_VALUE_MSAT,
3664 fee_proportional_millionths: 0,
3665 excess_data: Vec::new()
3668 let mut route_params = RouteParameters::from_payment_params_and_value(
3669 payment_params.clone(), 60_000);
3670 route_params.max_total_routing_fee_msat = Some(15_000);
3671 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3672 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3673 // Overpay fees to hit htlc_minimum_msat.
3674 let overpaid_fees = route.paths[0].hops[0].fee_msat + route.paths[1].hops[0].fee_msat;
3675 // TODO: this could be better balanced to overpay 10k and not 15k.
3676 assert_eq!(overpaid_fees, 15_000);
3678 // Now, test that if there are 2 paths, a "cheaper" by fee path wouldn't be prioritized
3679 // while taking even more fee to match htlc_minimum_msat.
3680 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3681 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3682 short_channel_id: 12,
3685 cltv_expiry_delta: 0,
3686 htlc_minimum_msat: 65_000,
3687 htlc_maximum_msat: 80_000,
3689 fee_proportional_millionths: 0,
3690 excess_data: Vec::new()
3692 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3693 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3694 short_channel_id: 2,
3697 cltv_expiry_delta: 0,
3698 htlc_minimum_msat: 0,
3699 htlc_maximum_msat: MAX_VALUE_MSAT,
3701 fee_proportional_millionths: 0,
3702 excess_data: Vec::new()
3704 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
3705 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3706 short_channel_id: 4,
3709 cltv_expiry_delta: 0,
3710 htlc_minimum_msat: 0,
3711 htlc_maximum_msat: MAX_VALUE_MSAT,
3713 fee_proportional_millionths: 100_000,
3714 excess_data: Vec::new()
3717 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3718 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3719 // Fine to overpay for htlc_minimum_msat if it allows us to save fee.
3720 assert_eq!(route.paths.len(), 1);
3721 assert_eq!(route.paths[0].hops[0].short_channel_id, 12);
3722 let fees = route.paths[0].hops[0].fee_msat;
3723 assert_eq!(fees, 5_000);
3725 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 50_000);
3726 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3727 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3728 // Not fine to overpay for htlc_minimum_msat if it requires paying more than fee on
3729 // the other channel.
3730 assert_eq!(route.paths.len(), 1);
3731 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
3732 let fees = route.paths[0].hops[0].fee_msat;
3733 assert_eq!(fees, 5_000);
3737 fn htlc_minimum_recipient_overpay_test() {
3738 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
3739 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3740 let config = UserConfig::default();
3741 let payment_params = PaymentParameters::from_node_id(nodes[2], 42).with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config)).unwrap();
3742 let scorer = ln_test_utils::TestScorer::new();
3743 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3744 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3746 // Route to node2 over a single path which requires overpaying the recipient themselves.
3748 // First disable all paths except the us -> node1 -> node2 path
3749 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3750 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3751 short_channel_id: 13,
3754 cltv_expiry_delta: 0,
3755 htlc_minimum_msat: 0,
3756 htlc_maximum_msat: 0,
3758 fee_proportional_millionths: 0,
3759 excess_data: Vec::new()
3762 // Set channel 4 to free but with a high htlc_minimum_msat
3763 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
3764 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3765 short_channel_id: 4,
3768 cltv_expiry_delta: 0,
3769 htlc_minimum_msat: 15_000,
3770 htlc_maximum_msat: MAX_VALUE_MSAT,
3772 fee_proportional_millionths: 0,
3773 excess_data: Vec::new()
3776 // Now check that we'll fail to find a path if we fail to find a path if the htlc_minimum
3777 // is overrun. Note that the fees are actually calculated on 3*payment amount as that's
3778 // what we try to find a route for, so this test only just happens to work out to exactly
3780 let mut route_params = RouteParameters::from_payment_params_and_value(
3781 payment_params.clone(), 5_000);
3782 route_params.max_total_routing_fee_msat = Some(9_999);
3783 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
3784 &route_params, &network_graph.read_only(), None, Arc::clone(&logger), &scorer,
3785 &Default::default(), &random_seed_bytes) {
3786 assert_eq!(err, "Failed to find route that adheres to the maximum total fee limit of 9999msat");
3787 } else { panic!(); }
3789 let mut route_params = RouteParameters::from_payment_params_and_value(
3790 payment_params.clone(), 5_000);
3791 route_params.max_total_routing_fee_msat = Some(10_000);
3792 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3793 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3794 assert_eq!(route.get_total_fees(), 10_000);
3798 fn disable_channels_test() {
3799 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
3800 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3801 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
3802 let scorer = ln_test_utils::TestScorer::new();
3803 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3804 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3806 // // Disable channels 4 and 12 by flags=2
3807 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
3808 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3809 short_channel_id: 4,
3811 flags: 2, // to disable
3812 cltv_expiry_delta: 0,
3813 htlc_minimum_msat: 0,
3814 htlc_maximum_msat: MAX_VALUE_MSAT,
3816 fee_proportional_millionths: 0,
3817 excess_data: Vec::new()
3819 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3820 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
3821 short_channel_id: 12,
3823 flags: 2, // to disable
3824 cltv_expiry_delta: 0,
3825 htlc_minimum_msat: 0,
3826 htlc_maximum_msat: MAX_VALUE_MSAT,
3828 fee_proportional_millionths: 0,
3829 excess_data: Vec::new()
3832 // If all the channels require some features we don't understand, route should fail
3833 let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
3834 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
3835 &route_params, &network_graph.read_only(), None, Arc::clone(&logger), &scorer,
3836 &Default::default(), &random_seed_bytes) {
3837 assert_eq!(err, "Failed to find a path to the given destination");
3838 } else { panic!(); }
3840 // If we specify a channel to node7, that overrides our local channel view and that gets used
3841 let our_chans = vec![get_channel_details(Some(42), nodes[7].clone(),
3842 InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)];
3843 route_params.payment_params.max_path_length = 2;
3844 let route = get_route(&our_id, &route_params, &network_graph.read_only(),
3845 Some(&our_chans.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
3846 &Default::default(), &random_seed_bytes).unwrap();
3847 assert_eq!(route.paths[0].hops.len(), 2);
3849 assert_eq!(route.paths[0].hops[0].pubkey, nodes[7]);
3850 assert_eq!(route.paths[0].hops[0].short_channel_id, 42);
3851 assert_eq!(route.paths[0].hops[0].fee_msat, 200);
3852 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (13 << 4) | 1);
3853 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
3854 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
3856 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
3857 assert_eq!(route.paths[0].hops[1].short_channel_id, 13);
3858 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
3859 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
3860 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
3861 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(13));
3865 fn disable_node_test() {
3866 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
3867 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3868 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
3869 let scorer = ln_test_utils::TestScorer::new();
3870 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3871 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3873 // Disable nodes 1, 2, and 8 by requiring unknown feature bits
3874 let mut unknown_features = NodeFeatures::empty();
3875 unknown_features.set_unknown_feature_required();
3876 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[0], unknown_features.clone(), 1);
3877 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[1], unknown_features.clone(), 1);
3878 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[7], unknown_features.clone(), 1);
3880 // If all nodes require some features we don't understand, route should fail
3881 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
3882 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
3883 &route_params, &network_graph.read_only(), None, Arc::clone(&logger), &scorer,
3884 &Default::default(), &random_seed_bytes) {
3885 assert_eq!(err, "Failed to find a path to the given destination");
3886 } else { panic!(); }
3888 // If we specify a channel to node7, that overrides our local channel view and that gets used
3889 let our_chans = vec![get_channel_details(Some(42), nodes[7].clone(),
3890 InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)];
3891 let route = get_route(&our_id, &route_params, &network_graph.read_only(),
3892 Some(&our_chans.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
3893 &Default::default(), &random_seed_bytes).unwrap();
3894 assert_eq!(route.paths[0].hops.len(), 2);
3896 assert_eq!(route.paths[0].hops[0].pubkey, nodes[7]);
3897 assert_eq!(route.paths[0].hops[0].short_channel_id, 42);
3898 assert_eq!(route.paths[0].hops[0].fee_msat, 200);
3899 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (13 << 4) | 1);
3900 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
3901 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
3903 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
3904 assert_eq!(route.paths[0].hops[1].short_channel_id, 13);
3905 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
3906 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
3907 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
3908 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(13));
3910 // Note that we don't test disabling node 3 and failing to route to it, as we (somewhat
3911 // naively) assume that the user checked the feature bits on the invoice, which override
3912 // the node_announcement.
3916 fn our_chans_test() {
3917 let (secp_ctx, network_graph, _, _, logger) = build_graph();
3918 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
3919 let scorer = ln_test_utils::TestScorer::new();
3920 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3921 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3923 // Route to 1 via 2 and 3 because our channel to 1 is disabled
3924 let payment_params = PaymentParameters::from_node_id(nodes[0], 42);
3925 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
3926 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
3927 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
3928 assert_eq!(route.paths[0].hops.len(), 3);
3930 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
3931 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
3932 assert_eq!(route.paths[0].hops[0].fee_msat, 200);
3933 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
3934 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
3935 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
3937 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
3938 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
3939 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
3940 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (3 << 4) | 2);
3941 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
3942 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
3944 assert_eq!(route.paths[0].hops[2].pubkey, nodes[0]);
3945 assert_eq!(route.paths[0].hops[2].short_channel_id, 3);
3946 assert_eq!(route.paths[0].hops[2].fee_msat, 100);
3947 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, 42);
3948 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(1));
3949 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(3));
3951 // If we specify a channel to node7, that overrides our local channel view and that gets used
3952 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
3953 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
3954 let our_chans = vec![get_channel_details(Some(42), nodes[7].clone(),
3955 InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)];
3956 let route = get_route(&our_id, &route_params, &network_graph.read_only(),
3957 Some(&our_chans.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
3958 &Default::default(), &random_seed_bytes).unwrap();
3959 assert_eq!(route.paths[0].hops.len(), 2);
3961 assert_eq!(route.paths[0].hops[0].pubkey, nodes[7]);
3962 assert_eq!(route.paths[0].hops[0].short_channel_id, 42);
3963 assert_eq!(route.paths[0].hops[0].fee_msat, 200);
3964 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (13 << 4) | 1);
3965 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &vec![0b11]);
3966 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
3968 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
3969 assert_eq!(route.paths[0].hops[1].short_channel_id, 13);
3970 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
3971 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
3972 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
3973 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(13));
3976 fn last_hops(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
3977 let zero_fees = RoutingFees {
3979 proportional_millionths: 0,
3981 vec![RouteHint(vec![RouteHintHop {
3982 src_node_id: nodes[3],
3983 short_channel_id: 8,
3985 cltv_expiry_delta: (8 << 4) | 1,
3986 htlc_minimum_msat: None,
3987 htlc_maximum_msat: None,
3989 ]), RouteHint(vec![RouteHintHop {
3990 src_node_id: nodes[4],
3991 short_channel_id: 9,
3994 proportional_millionths: 0,
3996 cltv_expiry_delta: (9 << 4) | 1,
3997 htlc_minimum_msat: None,
3998 htlc_maximum_msat: None,
3999 }]), RouteHint(vec![RouteHintHop {
4000 src_node_id: nodes[5],
4001 short_channel_id: 10,
4003 cltv_expiry_delta: (10 << 4) | 1,
4004 htlc_minimum_msat: None,
4005 htlc_maximum_msat: None,
4009 fn last_hops_multi_private_channels(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
4010 let zero_fees = RoutingFees {
4012 proportional_millionths: 0,
4014 vec![RouteHint(vec![RouteHintHop {
4015 src_node_id: nodes[2],
4016 short_channel_id: 5,
4019 proportional_millionths: 0,
4021 cltv_expiry_delta: (5 << 4) | 1,
4022 htlc_minimum_msat: None,
4023 htlc_maximum_msat: None,
4025 src_node_id: nodes[3],
4026 short_channel_id: 8,
4028 cltv_expiry_delta: (8 << 4) | 1,
4029 htlc_minimum_msat: None,
4030 htlc_maximum_msat: None,
4032 ]), RouteHint(vec![RouteHintHop {
4033 src_node_id: nodes[4],
4034 short_channel_id: 9,
4037 proportional_millionths: 0,
4039 cltv_expiry_delta: (9 << 4) | 1,
4040 htlc_minimum_msat: None,
4041 htlc_maximum_msat: None,
4042 }]), RouteHint(vec![RouteHintHop {
4043 src_node_id: nodes[5],
4044 short_channel_id: 10,
4046 cltv_expiry_delta: (10 << 4) | 1,
4047 htlc_minimum_msat: None,
4048 htlc_maximum_msat: None,
4053 fn partial_route_hint_test() {
4054 let (secp_ctx, network_graph, _, _, logger) = build_graph();
4055 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
4056 let scorer = ln_test_utils::TestScorer::new();
4057 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4058 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4060 // Simple test across 2, 3, 5, and 4 via a last_hop channel
4061 // Tests the behaviour when the RouteHint contains a suboptimal hop.
4062 // RouteHint may be partially used by the algo to build the best path.
4064 // First check that last hop can't have its source as the payee.
4065 let invalid_last_hop = RouteHint(vec![RouteHintHop {
4066 src_node_id: nodes[6],
4067 short_channel_id: 8,
4070 proportional_millionths: 0,
4072 cltv_expiry_delta: (8 << 4) | 1,
4073 htlc_minimum_msat: None,
4074 htlc_maximum_msat: None,
4077 let mut invalid_last_hops = last_hops_multi_private_channels(&nodes);
4078 invalid_last_hops.push(invalid_last_hop);
4080 let payment_params = PaymentParameters::from_node_id(nodes[6], 42)
4081 .with_route_hints(invalid_last_hops).unwrap();
4082 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4083 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
4084 &route_params, &network_graph.read_only(), None, Arc::clone(&logger), &scorer,
4085 &Default::default(), &random_seed_bytes) {
4086 assert_eq!(err, "Route hint cannot have the payee as the source.");
4087 } else { panic!(); }
4090 let mut payment_params = PaymentParameters::from_node_id(nodes[6], 42)
4091 .with_route_hints(last_hops_multi_private_channels(&nodes)).unwrap();
4092 payment_params.max_path_length = 5;
4093 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4094 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4095 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4096 assert_eq!(route.paths[0].hops.len(), 5);
4098 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4099 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4100 assert_eq!(route.paths[0].hops[0].fee_msat, 100);
4101 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
4102 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4103 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4105 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4106 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4107 assert_eq!(route.paths[0].hops[1].fee_msat, 0);
4108 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (6 << 4) | 1);
4109 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4110 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4112 assert_eq!(route.paths[0].hops[2].pubkey, nodes[4]);
4113 assert_eq!(route.paths[0].hops[2].short_channel_id, 6);
4114 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4115 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, (11 << 4) | 1);
4116 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(5));
4117 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(6));
4119 assert_eq!(route.paths[0].hops[3].pubkey, nodes[3]);
4120 assert_eq!(route.paths[0].hops[3].short_channel_id, 11);
4121 assert_eq!(route.paths[0].hops[3].fee_msat, 0);
4122 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, (8 << 4) | 1);
4123 // If we have a peer in the node map, we'll use their features here since we don't have
4124 // a way of figuring out their features from the invoice:
4125 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), &id_to_feature_flags(4));
4126 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &id_to_feature_flags(11));
4128 assert_eq!(route.paths[0].hops[4].pubkey, nodes[6]);
4129 assert_eq!(route.paths[0].hops[4].short_channel_id, 8);
4130 assert_eq!(route.paths[0].hops[4].fee_msat, 100);
4131 assert_eq!(route.paths[0].hops[4].cltv_expiry_delta, 42);
4132 assert_eq!(route.paths[0].hops[4].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4133 assert_eq!(route.paths[0].hops[4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4136 fn empty_last_hop(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
4137 let zero_fees = RoutingFees {
4139 proportional_millionths: 0,
4141 vec![RouteHint(vec![RouteHintHop {
4142 src_node_id: nodes[3],
4143 short_channel_id: 8,
4145 cltv_expiry_delta: (8 << 4) | 1,
4146 htlc_minimum_msat: None,
4147 htlc_maximum_msat: None,
4148 }]), RouteHint(vec![
4150 ]), RouteHint(vec![RouteHintHop {
4151 src_node_id: nodes[5],
4152 short_channel_id: 10,
4154 cltv_expiry_delta: (10 << 4) | 1,
4155 htlc_minimum_msat: None,
4156 htlc_maximum_msat: None,
4161 fn ignores_empty_last_hops_test() {
4162 let (secp_ctx, network_graph, _, _, logger) = build_graph();
4163 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
4164 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(empty_last_hop(&nodes)).unwrap();
4165 let scorer = ln_test_utils::TestScorer::new();
4166 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4167 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4169 // Test handling of an empty RouteHint passed in Invoice.
4170 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4171 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4172 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4173 assert_eq!(route.paths[0].hops.len(), 5);
4175 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4176 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4177 assert_eq!(route.paths[0].hops[0].fee_msat, 100);
4178 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
4179 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4180 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4182 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4183 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4184 assert_eq!(route.paths[0].hops[1].fee_msat, 0);
4185 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (6 << 4) | 1);
4186 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4187 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4189 assert_eq!(route.paths[0].hops[2].pubkey, nodes[4]);
4190 assert_eq!(route.paths[0].hops[2].short_channel_id, 6);
4191 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4192 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, (11 << 4) | 1);
4193 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(5));
4194 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(6));
4196 assert_eq!(route.paths[0].hops[3].pubkey, nodes[3]);
4197 assert_eq!(route.paths[0].hops[3].short_channel_id, 11);
4198 assert_eq!(route.paths[0].hops[3].fee_msat, 0);
4199 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, (8 << 4) | 1);
4200 // If we have a peer in the node map, we'll use their features here since we don't have
4201 // a way of figuring out their features from the invoice:
4202 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), &id_to_feature_flags(4));
4203 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &id_to_feature_flags(11));
4205 assert_eq!(route.paths[0].hops[4].pubkey, nodes[6]);
4206 assert_eq!(route.paths[0].hops[4].short_channel_id, 8);
4207 assert_eq!(route.paths[0].hops[4].fee_msat, 100);
4208 assert_eq!(route.paths[0].hops[4].cltv_expiry_delta, 42);
4209 assert_eq!(route.paths[0].hops[4].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4210 assert_eq!(route.paths[0].hops[4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4213 /// Builds a trivial last-hop hint that passes through the two nodes given, with channel 0xff00
4215 fn multi_hop_last_hops_hint(hint_hops: [PublicKey; 2]) -> Vec<RouteHint> {
4216 let zero_fees = RoutingFees {
4218 proportional_millionths: 0,
4220 vec![RouteHint(vec![RouteHintHop {
4221 src_node_id: hint_hops[0],
4222 short_channel_id: 0xff00,
4225 proportional_millionths: 0,
4227 cltv_expiry_delta: (5 << 4) | 1,
4228 htlc_minimum_msat: None,
4229 htlc_maximum_msat: None,
4231 src_node_id: hint_hops[1],
4232 short_channel_id: 0xff01,
4234 cltv_expiry_delta: (8 << 4) | 1,
4235 htlc_minimum_msat: None,
4236 htlc_maximum_msat: None,
4241 fn multi_hint_last_hops_test() {
4242 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
4243 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4244 let last_hops = multi_hop_last_hops_hint([nodes[2], nodes[3]]);
4245 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(last_hops.clone()).unwrap();
4246 let scorer = ln_test_utils::TestScorer::new();
4247 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4248 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4249 // Test through channels 2, 3, 0xff00, 0xff01.
4250 // Test shows that multi-hop route hints are considered and factored correctly into the
4253 // Disabling channels 6 & 7 by flags=2
4254 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4255 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4256 short_channel_id: 6,
4258 flags: 2, // to disable
4259 cltv_expiry_delta: 0,
4260 htlc_minimum_msat: 0,
4261 htlc_maximum_msat: MAX_VALUE_MSAT,
4263 fee_proportional_millionths: 0,
4264 excess_data: Vec::new()
4266 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4267 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4268 short_channel_id: 7,
4270 flags: 2, // to disable
4271 cltv_expiry_delta: 0,
4272 htlc_minimum_msat: 0,
4273 htlc_maximum_msat: MAX_VALUE_MSAT,
4275 fee_proportional_millionths: 0,
4276 excess_data: Vec::new()
4279 let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4280 route_params.payment_params.max_path_length = 4;
4281 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4282 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4283 assert_eq!(route.paths[0].hops.len(), 4);
4285 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4286 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4287 assert_eq!(route.paths[0].hops[0].fee_msat, 200);
4288 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, 65);
4289 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4290 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4292 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4293 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4294 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
4295 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 81);
4296 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4297 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4299 assert_eq!(route.paths[0].hops[2].pubkey, nodes[3]);
4300 assert_eq!(route.paths[0].hops[2].short_channel_id, last_hops[0].0[0].short_channel_id);
4301 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4302 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, 129);
4303 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(4));
4304 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4306 assert_eq!(route.paths[0].hops[3].pubkey, nodes[6]);
4307 assert_eq!(route.paths[0].hops[3].short_channel_id, last_hops[0].0[1].short_channel_id);
4308 assert_eq!(route.paths[0].hops[3].fee_msat, 100);
4309 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, 42);
4310 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4311 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4312 route_params.payment_params.max_path_length = 3;
4313 get_route(&our_id, &route_params, &network_graph.read_only(), None,
4314 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap_err();
4318 fn private_multi_hint_last_hops_test() {
4319 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
4320 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4322 let non_announced_privkey = SecretKey::from_slice(&<Vec<u8>>::from_hex(&format!("{:02x}", 0xf0).repeat(32)).unwrap()[..]).unwrap();
4323 let non_announced_pubkey = PublicKey::from_secret_key(&secp_ctx, &non_announced_privkey);
4325 let last_hops = multi_hop_last_hops_hint([nodes[2], non_announced_pubkey]);
4326 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(last_hops.clone()).unwrap();
4327 let scorer = ln_test_utils::TestScorer::new();
4328 // Test through channels 2, 3, 0xff00, 0xff01.
4329 // Test shows that multiple hop hints are considered.
4331 // Disabling channels 6 & 7 by flags=2
4332 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4333 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4334 short_channel_id: 6,
4336 flags: 2, // to disable
4337 cltv_expiry_delta: 0,
4338 htlc_minimum_msat: 0,
4339 htlc_maximum_msat: MAX_VALUE_MSAT,
4341 fee_proportional_millionths: 0,
4342 excess_data: Vec::new()
4344 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4345 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4346 short_channel_id: 7,
4348 flags: 2, // to disable
4349 cltv_expiry_delta: 0,
4350 htlc_minimum_msat: 0,
4351 htlc_maximum_msat: MAX_VALUE_MSAT,
4353 fee_proportional_millionths: 0,
4354 excess_data: Vec::new()
4357 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4358 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4359 Arc::clone(&logger), &scorer, &Default::default(), &[42u8; 32]).unwrap();
4360 assert_eq!(route.paths[0].hops.len(), 4);
4362 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4363 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4364 assert_eq!(route.paths[0].hops[0].fee_msat, 200);
4365 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, 65);
4366 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4367 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4369 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4370 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4371 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
4372 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 81);
4373 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4374 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4376 assert_eq!(route.paths[0].hops[2].pubkey, non_announced_pubkey);
4377 assert_eq!(route.paths[0].hops[2].short_channel_id, last_hops[0].0[0].short_channel_id);
4378 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4379 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, 129);
4380 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4381 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4383 assert_eq!(route.paths[0].hops[3].pubkey, nodes[6]);
4384 assert_eq!(route.paths[0].hops[3].short_channel_id, last_hops[0].0[1].short_channel_id);
4385 assert_eq!(route.paths[0].hops[3].fee_msat, 100);
4386 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, 42);
4387 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4388 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4391 fn last_hops_with_public_channel(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
4392 let zero_fees = RoutingFees {
4394 proportional_millionths: 0,
4396 vec![RouteHint(vec![RouteHintHop {
4397 src_node_id: nodes[4],
4398 short_channel_id: 11,
4400 cltv_expiry_delta: (11 << 4) | 1,
4401 htlc_minimum_msat: None,
4402 htlc_maximum_msat: None,
4404 src_node_id: nodes[3],
4405 short_channel_id: 8,
4407 cltv_expiry_delta: (8 << 4) | 1,
4408 htlc_minimum_msat: None,
4409 htlc_maximum_msat: None,
4410 }]), RouteHint(vec![RouteHintHop {
4411 src_node_id: nodes[4],
4412 short_channel_id: 9,
4415 proportional_millionths: 0,
4417 cltv_expiry_delta: (9 << 4) | 1,
4418 htlc_minimum_msat: None,
4419 htlc_maximum_msat: None,
4420 }]), RouteHint(vec![RouteHintHop {
4421 src_node_id: nodes[5],
4422 short_channel_id: 10,
4424 cltv_expiry_delta: (10 << 4) | 1,
4425 htlc_minimum_msat: None,
4426 htlc_maximum_msat: None,
4431 fn last_hops_with_public_channel_test() {
4432 let (secp_ctx, network_graph, _, _, logger) = build_graph();
4433 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
4434 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(last_hops_with_public_channel(&nodes)).unwrap();
4435 let scorer = ln_test_utils::TestScorer::new();
4436 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4437 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4438 // This test shows that public routes can be present in the invoice
4439 // which would be handled in the same manner.
4441 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4442 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4443 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4444 assert_eq!(route.paths[0].hops.len(), 5);
4446 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4447 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4448 assert_eq!(route.paths[0].hops[0].fee_msat, 100);
4449 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
4450 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4451 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4453 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4454 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4455 assert_eq!(route.paths[0].hops[1].fee_msat, 0);
4456 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (6 << 4) | 1);
4457 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4458 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4460 assert_eq!(route.paths[0].hops[2].pubkey, nodes[4]);
4461 assert_eq!(route.paths[0].hops[2].short_channel_id, 6);
4462 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4463 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, (11 << 4) | 1);
4464 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(5));
4465 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(6));
4467 assert_eq!(route.paths[0].hops[3].pubkey, nodes[3]);
4468 assert_eq!(route.paths[0].hops[3].short_channel_id, 11);
4469 assert_eq!(route.paths[0].hops[3].fee_msat, 0);
4470 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, (8 << 4) | 1);
4471 // If we have a peer in the node map, we'll use their features here since we don't have
4472 // a way of figuring out their features from the invoice:
4473 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), &id_to_feature_flags(4));
4474 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &id_to_feature_flags(11));
4476 assert_eq!(route.paths[0].hops[4].pubkey, nodes[6]);
4477 assert_eq!(route.paths[0].hops[4].short_channel_id, 8);
4478 assert_eq!(route.paths[0].hops[4].fee_msat, 100);
4479 assert_eq!(route.paths[0].hops[4].cltv_expiry_delta, 42);
4480 assert_eq!(route.paths[0].hops[4].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4481 assert_eq!(route.paths[0].hops[4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4485 fn our_chans_last_hop_connect_test() {
4486 let (secp_ctx, network_graph, _, _, logger) = build_graph();
4487 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
4488 let scorer = ln_test_utils::TestScorer::new();
4489 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4490 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4492 // Simple test with outbound channel to 4 to test that last_hops and first_hops connect
4493 let our_chans = vec![get_channel_details(Some(42), nodes[3].clone(), InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)];
4494 let mut last_hops = last_hops(&nodes);
4495 let payment_params = PaymentParameters::from_node_id(nodes[6], 42)
4496 .with_route_hints(last_hops.clone()).unwrap();
4497 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
4498 let route = get_route(&our_id, &route_params, &network_graph.read_only(),
4499 Some(&our_chans.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
4500 &Default::default(), &random_seed_bytes).unwrap();
4501 assert_eq!(route.paths[0].hops.len(), 2);
4503 assert_eq!(route.paths[0].hops[0].pubkey, nodes[3]);
4504 assert_eq!(route.paths[0].hops[0].short_channel_id, 42);
4505 assert_eq!(route.paths[0].hops[0].fee_msat, 0);
4506 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (8 << 4) | 1);
4507 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &vec![0b11]);
4508 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
4510 assert_eq!(route.paths[0].hops[1].pubkey, nodes[6]);
4511 assert_eq!(route.paths[0].hops[1].short_channel_id, 8);
4512 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
4513 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
4514 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4515 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4517 last_hops[0].0[0].fees.base_msat = 1000;
4519 // Revert to via 6 as the fee on 8 goes up
4520 let payment_params = PaymentParameters::from_node_id(nodes[6], 42)
4521 .with_route_hints(last_hops).unwrap();
4522 let route_params = RouteParameters::from_payment_params_and_value(
4523 payment_params.clone(), 100);
4524 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4525 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4526 assert_eq!(route.paths[0].hops.len(), 4);
4528 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4529 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4530 assert_eq!(route.paths[0].hops[0].fee_msat, 200); // fee increased as its % of value transferred across node
4531 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
4532 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4533 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4535 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4536 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4537 assert_eq!(route.paths[0].hops[1].fee_msat, 100);
4538 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (7 << 4) | 1);
4539 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4540 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4542 assert_eq!(route.paths[0].hops[2].pubkey, nodes[5]);
4543 assert_eq!(route.paths[0].hops[2].short_channel_id, 7);
4544 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4545 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, (10 << 4) | 1);
4546 // If we have a peer in the node map, we'll use their features here since we don't have
4547 // a way of figuring out their features from the invoice:
4548 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(6));
4549 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(7));
4551 assert_eq!(route.paths[0].hops[3].pubkey, nodes[6]);
4552 assert_eq!(route.paths[0].hops[3].short_channel_id, 10);
4553 assert_eq!(route.paths[0].hops[3].fee_msat, 100);
4554 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, 42);
4555 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4556 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4558 // ...but still use 8 for larger payments as 6 has a variable feerate
4559 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 2000);
4560 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4561 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4562 assert_eq!(route.paths[0].hops.len(), 5);
4564 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
4565 assert_eq!(route.paths[0].hops[0].short_channel_id, 2);
4566 assert_eq!(route.paths[0].hops[0].fee_msat, 3000);
4567 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (4 << 4) | 1);
4568 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(2));
4569 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(2));
4571 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
4572 assert_eq!(route.paths[0].hops[1].short_channel_id, 4);
4573 assert_eq!(route.paths[0].hops[1].fee_msat, 0);
4574 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (6 << 4) | 1);
4575 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
4576 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(4));
4578 assert_eq!(route.paths[0].hops[2].pubkey, nodes[4]);
4579 assert_eq!(route.paths[0].hops[2].short_channel_id, 6);
4580 assert_eq!(route.paths[0].hops[2].fee_msat, 0);
4581 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, (11 << 4) | 1);
4582 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(5));
4583 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(6));
4585 assert_eq!(route.paths[0].hops[3].pubkey, nodes[3]);
4586 assert_eq!(route.paths[0].hops[3].short_channel_id, 11);
4587 assert_eq!(route.paths[0].hops[3].fee_msat, 1000);
4588 assert_eq!(route.paths[0].hops[3].cltv_expiry_delta, (8 << 4) | 1);
4589 // If we have a peer in the node map, we'll use their features here since we don't have
4590 // a way of figuring out their features from the invoice:
4591 assert_eq!(route.paths[0].hops[3].node_features.le_flags(), &id_to_feature_flags(4));
4592 assert_eq!(route.paths[0].hops[3].channel_features.le_flags(), &id_to_feature_flags(11));
4594 assert_eq!(route.paths[0].hops[4].pubkey, nodes[6]);
4595 assert_eq!(route.paths[0].hops[4].short_channel_id, 8);
4596 assert_eq!(route.paths[0].hops[4].fee_msat, 2000);
4597 assert_eq!(route.paths[0].hops[4].cltv_expiry_delta, 42);
4598 assert_eq!(route.paths[0].hops[4].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4599 assert_eq!(route.paths[0].hops[4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
4602 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> {
4603 let source_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&<Vec<u8>>::from_hex(&format!("{:02}", 41).repeat(32)).unwrap()[..]).unwrap());
4604 let middle_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&<Vec<u8>>::from_hex(&format!("{:02}", 42).repeat(32)).unwrap()[..]).unwrap());
4605 let target_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&<Vec<u8>>::from_hex(&format!("{:02}", 43).repeat(32)).unwrap()[..]).unwrap());
4607 // If we specify a channel to a middle hop, that overrides our local channel view and that gets used
4608 let last_hops = RouteHint(vec![RouteHintHop {
4609 src_node_id: middle_node_id,
4610 short_channel_id: 8,
4613 proportional_millionths: last_hop_fee_prop,
4615 cltv_expiry_delta: (8 << 4) | 1,
4616 htlc_minimum_msat: None,
4617 htlc_maximum_msat: last_hop_htlc_max,
4619 let payment_params = PaymentParameters::from_node_id(target_node_id, 42).with_route_hints(vec![last_hops]).unwrap();
4620 let our_chans = vec![get_channel_details(Some(42), middle_node_id, InitFeatures::from_le_bytes(vec![0b11]), outbound_capacity_msat)];
4621 let scorer = ln_test_utils::TestScorer::new();
4622 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4623 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4624 let logger = ln_test_utils::TestLogger::new();
4625 let network_graph = NetworkGraph::new(Network::Testnet, &logger);
4626 let route_params = RouteParameters::from_payment_params_and_value(payment_params, route_val);
4627 let route = get_route(&source_node_id, &route_params, &network_graph.read_only(),
4628 Some(&our_chans.iter().collect::<Vec<_>>()), &logger, &scorer, &Default::default(),
4629 &random_seed_bytes);
4634 fn unannounced_path_test() {
4635 // We should be able to send a payment to a destination without any help of a routing graph
4636 // if we have a channel with a common counterparty that appears in the first and last hop
4638 let route = do_unannounced_path_test(None, 1, 2000000, 1000000).unwrap();
4640 let middle_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&<Vec<u8>>::from_hex(&format!("{:02}", 42).repeat(32)).unwrap()[..]).unwrap());
4641 let target_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&<Vec<u8>>::from_hex(&format!("{:02}", 43).repeat(32)).unwrap()[..]).unwrap());
4642 assert_eq!(route.paths[0].hops.len(), 2);
4644 assert_eq!(route.paths[0].hops[0].pubkey, middle_node_id);
4645 assert_eq!(route.paths[0].hops[0].short_channel_id, 42);
4646 assert_eq!(route.paths[0].hops[0].fee_msat, 1001);
4647 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (8 << 4) | 1);
4648 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &[0b11]);
4649 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &[0; 0]); // We can't learn any flags from invoices, sadly
4651 assert_eq!(route.paths[0].hops[1].pubkey, target_node_id);
4652 assert_eq!(route.paths[0].hops[1].short_channel_id, 8);
4653 assert_eq!(route.paths[0].hops[1].fee_msat, 1000000);
4654 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
4655 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
4656 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &[0; 0]); // We can't learn any flags from invoices, sadly
4660 fn overflow_unannounced_path_test_liquidity_underflow() {
4661 // Previously, when we had a last-hop hint connected directly to a first-hop channel, where
4662 // the last-hop had a fee which overflowed a u64, we'd panic.
4663 // This was due to us adding the first-hop from us unconditionally, causing us to think
4664 // we'd built a path (as our node is in the "best candidate" set), when we had not.
4665 // In this test, we previously hit a subtraction underflow due to having less available
4666 // liquidity at the last hop than 0.
4667 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());
4671 fn overflow_unannounced_path_test_feerate_overflow() {
4672 // This tests for the same case as above, except instead of hitting a subtraction
4673 // underflow, we hit a case where the fee charged at a hop overflowed.
4674 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());
4678 fn available_amount_while_routing_test() {
4679 // Tests whether we choose the correct available channel amount while routing.
4681 let (secp_ctx, network_graph, gossip_sync, chain_monitor, logger) = build_graph();
4682 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4683 let scorer = ln_test_utils::TestScorer::new();
4684 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4685 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4686 let config = UserConfig::default();
4687 let payment_params = PaymentParameters::from_node_id(nodes[2], 42)
4688 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
4691 // We will use a simple single-path route from
4692 // our node to node2 via node0: channels {1, 3}.
4694 // First disable all other paths.
4695 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4696 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4697 short_channel_id: 2,
4700 cltv_expiry_delta: 0,
4701 htlc_minimum_msat: 0,
4702 htlc_maximum_msat: 100_000,
4704 fee_proportional_millionths: 0,
4705 excess_data: Vec::new()
4707 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4708 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4709 short_channel_id: 12,
4712 cltv_expiry_delta: 0,
4713 htlc_minimum_msat: 0,
4714 htlc_maximum_msat: 100_000,
4716 fee_proportional_millionths: 0,
4717 excess_data: Vec::new()
4720 // Make the first channel (#1) very permissive,
4721 // and we will be testing all limits on the second channel.
4722 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4723 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4724 short_channel_id: 1,
4727 cltv_expiry_delta: 0,
4728 htlc_minimum_msat: 0,
4729 htlc_maximum_msat: 1_000_000_000,
4731 fee_proportional_millionths: 0,
4732 excess_data: Vec::new()
4735 // First, let's see if routing works if we have absolutely no idea about the available amount.
4736 // In this case, it should be set to 250_000 sats.
4737 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4738 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4739 short_channel_id: 3,
4742 cltv_expiry_delta: 0,
4743 htlc_minimum_msat: 0,
4744 htlc_maximum_msat: 250_000_000,
4746 fee_proportional_millionths: 0,
4747 excess_data: Vec::new()
4751 // Attempt to route more than available results in a failure.
4752 let route_params = RouteParameters::from_payment_params_and_value(
4753 payment_params.clone(), 250_000_001);
4754 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4755 &our_id, &route_params, &network_graph.read_only(), None,
4756 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes) {
4757 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4758 } else { panic!(); }
4762 // Now, attempt to route an exact amount we have should be fine.
4763 let route_params = RouteParameters::from_payment_params_and_value(
4764 payment_params.clone(), 250_000_000);
4765 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4766 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4767 assert_eq!(route.paths.len(), 1);
4768 let path = route.paths.last().unwrap();
4769 assert_eq!(path.hops.len(), 2);
4770 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
4771 assert_eq!(path.final_value_msat(), 250_000_000);
4774 // Check that setting next_outbound_htlc_limit_msat in first_hops limits the channels.
4775 // Disable channel #1 and use another first hop.
4776 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4777 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4778 short_channel_id: 1,
4781 cltv_expiry_delta: 0,
4782 htlc_minimum_msat: 0,
4783 htlc_maximum_msat: 1_000_000_000,
4785 fee_proportional_millionths: 0,
4786 excess_data: Vec::new()
4789 // Now, limit the first_hop by the next_outbound_htlc_limit_msat of 200_000 sats.
4790 let our_chans = vec![get_channel_details(Some(42), nodes[0].clone(), InitFeatures::from_le_bytes(vec![0b11]), 200_000_000)];
4793 // Attempt to route more than available results in a failure.
4794 let route_params = RouteParameters::from_payment_params_and_value(
4795 payment_params.clone(), 200_000_001);
4796 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4797 &our_id, &route_params, &network_graph.read_only(),
4798 Some(&our_chans.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
4799 &Default::default(), &random_seed_bytes) {
4800 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4801 } else { panic!(); }
4805 // Now, attempt to route an exact amount we have should be fine.
4806 let route_params = RouteParameters::from_payment_params_and_value(
4807 payment_params.clone(), 200_000_000);
4808 let route = get_route(&our_id, &route_params, &network_graph.read_only(),
4809 Some(&our_chans.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
4810 &Default::default(), &random_seed_bytes).unwrap();
4811 assert_eq!(route.paths.len(), 1);
4812 let path = route.paths.last().unwrap();
4813 assert_eq!(path.hops.len(), 2);
4814 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
4815 assert_eq!(path.final_value_msat(), 200_000_000);
4818 // Enable channel #1 back.
4819 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4820 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4821 short_channel_id: 1,
4824 cltv_expiry_delta: 0,
4825 htlc_minimum_msat: 0,
4826 htlc_maximum_msat: 1_000_000_000,
4828 fee_proportional_millionths: 0,
4829 excess_data: Vec::new()
4833 // Now let's see if routing works if we know only htlc_maximum_msat.
4834 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4835 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4836 short_channel_id: 3,
4839 cltv_expiry_delta: 0,
4840 htlc_minimum_msat: 0,
4841 htlc_maximum_msat: 15_000,
4843 fee_proportional_millionths: 0,
4844 excess_data: Vec::new()
4848 // Attempt to route more than available results in a failure.
4849 let route_params = RouteParameters::from_payment_params_and_value(
4850 payment_params.clone(), 15_001);
4851 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4852 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
4853 &scorer, &Default::default(), &random_seed_bytes) {
4854 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4855 } else { panic!(); }
4859 // Now, attempt to route an exact amount we have should be fine.
4860 let route_params = RouteParameters::from_payment_params_and_value(
4861 payment_params.clone(), 15_000);
4862 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4863 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4864 assert_eq!(route.paths.len(), 1);
4865 let path = route.paths.last().unwrap();
4866 assert_eq!(path.hops.len(), 2);
4867 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
4868 assert_eq!(path.final_value_msat(), 15_000);
4871 // Now let's see if routing works if we know only capacity from the UTXO.
4873 // We can't change UTXO capacity on the fly, so we'll disable
4874 // the existing channel and add another one with the capacity we need.
4875 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4876 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4877 short_channel_id: 3,
4880 cltv_expiry_delta: 0,
4881 htlc_minimum_msat: 0,
4882 htlc_maximum_msat: MAX_VALUE_MSAT,
4884 fee_proportional_millionths: 0,
4885 excess_data: Vec::new()
4888 let good_script = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2)
4889 .push_slice(&PublicKey::from_secret_key(&secp_ctx, &privkeys[0]).serialize())
4890 .push_slice(&PublicKey::from_secret_key(&secp_ctx, &privkeys[2]).serialize())
4891 .push_opcode(opcodes::all::OP_PUSHNUM_2)
4892 .push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script().to_p2wsh();
4894 *chain_monitor.utxo_ret.lock().unwrap() =
4895 UtxoResult::Sync(Ok(TxOut { value: Amount::from_sat(15), script_pubkey: good_script.clone() }));
4896 gossip_sync.add_utxo_lookup(Some(chain_monitor));
4898 add_channel(&gossip_sync, &secp_ctx, &privkeys[0], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(3)), 333);
4899 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4900 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4901 short_channel_id: 333,
4904 cltv_expiry_delta: (3 << 4) | 1,
4905 htlc_minimum_msat: 0,
4906 htlc_maximum_msat: 15_000,
4908 fee_proportional_millionths: 0,
4909 excess_data: Vec::new()
4911 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4912 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4913 short_channel_id: 333,
4916 cltv_expiry_delta: (3 << 4) | 2,
4917 htlc_minimum_msat: 0,
4918 htlc_maximum_msat: 15_000,
4920 fee_proportional_millionths: 0,
4921 excess_data: Vec::new()
4925 // Attempt to route more than available results in a failure.
4926 let route_params = RouteParameters::from_payment_params_and_value(
4927 payment_params.clone(), 15_001);
4928 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4929 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
4930 &scorer, &Default::default(), &random_seed_bytes) {
4931 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4932 } else { panic!(); }
4936 // Now, attempt to route an exact amount we have should be fine.
4937 let route_params = RouteParameters::from_payment_params_and_value(
4938 payment_params.clone(), 15_000);
4939 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4940 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4941 assert_eq!(route.paths.len(), 1);
4942 let path = route.paths.last().unwrap();
4943 assert_eq!(path.hops.len(), 2);
4944 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
4945 assert_eq!(path.final_value_msat(), 15_000);
4948 // Now let's see if routing chooses htlc_maximum_msat over UTXO capacity.
4949 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4950 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
4951 short_channel_id: 333,
4954 cltv_expiry_delta: 0,
4955 htlc_minimum_msat: 0,
4956 htlc_maximum_msat: 10_000,
4958 fee_proportional_millionths: 0,
4959 excess_data: Vec::new()
4963 // Attempt to route more than available results in a failure.
4964 let route_params = RouteParameters::from_payment_params_and_value(
4965 payment_params.clone(), 10_001);
4966 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4967 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
4968 &scorer, &Default::default(), &random_seed_bytes) {
4969 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4970 } else { panic!(); }
4974 // Now, attempt to route an exact amount we have should be fine.
4975 let route_params = RouteParameters::from_payment_params_and_value(
4976 payment_params.clone(), 10_000);
4977 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
4978 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
4979 assert_eq!(route.paths.len(), 1);
4980 let path = route.paths.last().unwrap();
4981 assert_eq!(path.hops.len(), 2);
4982 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
4983 assert_eq!(path.final_value_msat(), 10_000);
4988 fn available_liquidity_last_hop_test() {
4989 // Check that available liquidity properly limits the path even when only
4990 // one of the latter hops is limited.
4991 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
4992 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4993 let scorer = ln_test_utils::TestScorer::new();
4994 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4995 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4996 let config = UserConfig::default();
4997 let payment_params = PaymentParameters::from_node_id(nodes[3], 42)
4998 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
5001 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
5002 // {12, 13, 11} have the capacities of 100, {6} has a capacity of 50.
5003 // Total capacity: 50 sats.
5005 // Disable other potential paths.
5006 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5007 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5008 short_channel_id: 2,
5011 cltv_expiry_delta: 0,
5012 htlc_minimum_msat: 0,
5013 htlc_maximum_msat: 100_000,
5015 fee_proportional_millionths: 0,
5016 excess_data: Vec::new()
5018 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5019 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5020 short_channel_id: 7,
5023 cltv_expiry_delta: 0,
5024 htlc_minimum_msat: 0,
5025 htlc_maximum_msat: 100_000,
5027 fee_proportional_millionths: 0,
5028 excess_data: Vec::new()
5033 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5034 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5035 short_channel_id: 12,
5038 cltv_expiry_delta: 0,
5039 htlc_minimum_msat: 0,
5040 htlc_maximum_msat: 100_000,
5042 fee_proportional_millionths: 0,
5043 excess_data: Vec::new()
5045 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
5046 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5047 short_channel_id: 13,
5050 cltv_expiry_delta: 0,
5051 htlc_minimum_msat: 0,
5052 htlc_maximum_msat: 100_000,
5054 fee_proportional_millionths: 0,
5055 excess_data: Vec::new()
5058 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5059 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5060 short_channel_id: 6,
5063 cltv_expiry_delta: 0,
5064 htlc_minimum_msat: 0,
5065 htlc_maximum_msat: 50_000,
5067 fee_proportional_millionths: 0,
5068 excess_data: Vec::new()
5070 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
5071 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5072 short_channel_id: 11,
5075 cltv_expiry_delta: 0,
5076 htlc_minimum_msat: 0,
5077 htlc_maximum_msat: 100_000,
5079 fee_proportional_millionths: 0,
5080 excess_data: Vec::new()
5083 // Attempt to route more than available results in a failure.
5084 let route_params = RouteParameters::from_payment_params_and_value(
5085 payment_params.clone(), 60_000);
5086 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5087 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
5088 &scorer, &Default::default(), &random_seed_bytes) {
5089 assert_eq!(err, "Failed to find a sufficient route to the given destination");
5090 } else { panic!(); }
5094 // Now, attempt to route 49 sats (just a bit below the capacity).
5095 let route_params = RouteParameters::from_payment_params_and_value(
5096 payment_params.clone(), 49_000);
5097 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5098 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5099 assert_eq!(route.paths.len(), 1);
5100 let mut total_amount_paid_msat = 0;
5101 for path in &route.paths {
5102 assert_eq!(path.hops.len(), 4);
5103 assert_eq!(path.hops.last().unwrap().pubkey, nodes[3]);
5104 total_amount_paid_msat += path.final_value_msat();
5106 assert_eq!(total_amount_paid_msat, 49_000);
5110 // Attempt to route an exact amount is also fine
5111 let route_params = RouteParameters::from_payment_params_and_value(
5112 payment_params, 50_000);
5113 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5114 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5115 assert_eq!(route.paths.len(), 1);
5116 let mut total_amount_paid_msat = 0;
5117 for path in &route.paths {
5118 assert_eq!(path.hops.len(), 4);
5119 assert_eq!(path.hops.last().unwrap().pubkey, nodes[3]);
5120 total_amount_paid_msat += path.final_value_msat();
5122 assert_eq!(total_amount_paid_msat, 50_000);
5127 fn ignore_fee_first_hop_test() {
5128 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5129 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5130 let scorer = ln_test_utils::TestScorer::new();
5131 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5132 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5133 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
5135 // Path via node0 is channels {1, 3}. Limit them to 100 and 50 sats (total limit 50).
5136 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5137 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5138 short_channel_id: 1,
5141 cltv_expiry_delta: 0,
5142 htlc_minimum_msat: 0,
5143 htlc_maximum_msat: 100_000,
5144 fee_base_msat: 1_000_000,
5145 fee_proportional_millionths: 0,
5146 excess_data: Vec::new()
5148 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
5149 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5150 short_channel_id: 3,
5153 cltv_expiry_delta: 0,
5154 htlc_minimum_msat: 0,
5155 htlc_maximum_msat: 50_000,
5157 fee_proportional_millionths: 0,
5158 excess_data: Vec::new()
5162 let route_params = RouteParameters::from_payment_params_and_value(
5163 payment_params, 50_000);
5164 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5165 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5166 assert_eq!(route.paths.len(), 1);
5167 let mut total_amount_paid_msat = 0;
5168 for path in &route.paths {
5169 assert_eq!(path.hops.len(), 2);
5170 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
5171 total_amount_paid_msat += path.final_value_msat();
5173 assert_eq!(total_amount_paid_msat, 50_000);
5178 fn simple_mpp_route_test() {
5179 let (secp_ctx, _, _, _, _) = build_graph();
5180 let (_, _, _, nodes) = get_nodes(&secp_ctx);
5181 let config = UserConfig::default();
5182 let clear_payment_params = PaymentParameters::from_node_id(nodes[2], 42)
5183 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
5185 do_simple_mpp_route_test(clear_payment_params);
5187 // MPP to a 1-hop blinded path for nodes[2]
5188 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
5189 let blinded_path = BlindedPath {
5190 introduction_node: IntroductionNode::NodeId(nodes[2]),
5191 blinding_point: ln_test_utils::pubkey(42),
5192 blinded_hops: vec![BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }],
5194 let blinded_payinfo = BlindedPayInfo { // These fields are ignored for 1-hop blinded paths
5196 fee_proportional_millionths: 0,
5197 htlc_minimum_msat: 0,
5198 htlc_maximum_msat: 0,
5199 cltv_expiry_delta: 0,
5200 features: BlindedHopFeatures::empty(),
5202 let one_hop_blinded_payment_params = PaymentParameters::blinded(vec![(blinded_payinfo.clone(), blinded_path.clone())])
5203 .with_bolt12_features(bolt12_features.clone()).unwrap();
5204 do_simple_mpp_route_test(one_hop_blinded_payment_params.clone());
5206 // MPP to 3 2-hop blinded paths
5207 let mut blinded_path_node_0 = blinded_path.clone();
5208 blinded_path_node_0.introduction_node = IntroductionNode::NodeId(nodes[0]);
5209 blinded_path_node_0.blinded_hops.push(blinded_path.blinded_hops[0].clone());
5210 let mut node_0_payinfo = blinded_payinfo.clone();
5211 node_0_payinfo.htlc_maximum_msat = 50_000;
5213 let mut blinded_path_node_7 = blinded_path_node_0.clone();
5214 blinded_path_node_7.introduction_node = IntroductionNode::NodeId(nodes[7]);
5215 let mut node_7_payinfo = blinded_payinfo.clone();
5216 node_7_payinfo.htlc_maximum_msat = 60_000;
5218 let mut blinded_path_node_1 = blinded_path_node_0.clone();
5219 blinded_path_node_1.introduction_node = IntroductionNode::NodeId(nodes[1]);
5220 let mut node_1_payinfo = blinded_payinfo.clone();
5221 node_1_payinfo.htlc_maximum_msat = 180_000;
5223 let two_hop_blinded_payment_params = PaymentParameters::blinded(
5225 (node_0_payinfo, blinded_path_node_0),
5226 (node_7_payinfo, blinded_path_node_7),
5227 (node_1_payinfo, blinded_path_node_1)
5229 .with_bolt12_features(bolt12_features).unwrap();
5230 do_simple_mpp_route_test(two_hop_blinded_payment_params);
5234 fn do_simple_mpp_route_test(payment_params: PaymentParameters) {
5235 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5236 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5237 let scorer = ln_test_utils::TestScorer::new();
5238 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5239 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5241 // We need a route consisting of 3 paths:
5242 // From our node to node2 via node0, node7, node1 (three paths one hop each).
5243 // To achieve this, the amount being transferred should be around
5244 // the total capacity of these 3 paths.
5246 // First, we set limits on these (previously unlimited) channels.
5247 // Their aggregate capacity will be 50 + 60 + 180 = 290 sats.
5249 // Path via node0 is channels {1, 3}. Limit them to 100 and 50 sats (total limit 50).
5250 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5251 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5252 short_channel_id: 1,
5255 cltv_expiry_delta: 0,
5256 htlc_minimum_msat: 0,
5257 htlc_maximum_msat: 100_000,
5259 fee_proportional_millionths: 0,
5260 excess_data: Vec::new()
5262 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
5263 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5264 short_channel_id: 3,
5267 cltv_expiry_delta: 0,
5268 htlc_minimum_msat: 0,
5269 htlc_maximum_msat: 50_000,
5271 fee_proportional_millionths: 0,
5272 excess_data: Vec::new()
5275 // Path via node7 is channels {12, 13}. Limit them to 60 and 60 sats
5276 // (total limit 60).
5277 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5278 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5279 short_channel_id: 12,
5282 cltv_expiry_delta: 0,
5283 htlc_minimum_msat: 0,
5284 htlc_maximum_msat: 60_000,
5286 fee_proportional_millionths: 0,
5287 excess_data: Vec::new()
5289 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
5290 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5291 short_channel_id: 13,
5294 cltv_expiry_delta: 0,
5295 htlc_minimum_msat: 0,
5296 htlc_maximum_msat: 60_000,
5298 fee_proportional_millionths: 0,
5299 excess_data: Vec::new()
5302 // Path via node1 is channels {2, 4}. Limit them to 200 and 180 sats
5303 // (total capacity 180 sats).
5304 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5305 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5306 short_channel_id: 2,
5309 cltv_expiry_delta: 0,
5310 htlc_minimum_msat: 0,
5311 htlc_maximum_msat: 200_000,
5313 fee_proportional_millionths: 0,
5314 excess_data: Vec::new()
5316 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
5317 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5318 short_channel_id: 4,
5321 cltv_expiry_delta: 0,
5322 htlc_minimum_msat: 0,
5323 htlc_maximum_msat: 180_000,
5325 fee_proportional_millionths: 0,
5326 excess_data: Vec::new()
5330 // Attempt to route more than available results in a failure.
5331 let route_params = RouteParameters::from_payment_params_and_value(
5332 payment_params.clone(), 300_000);
5333 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5334 &our_id, &route_params, &network_graph.read_only(), None,
5335 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes) {
5336 assert_eq!(err, "Failed to find a sufficient route to the given destination");
5337 } else { panic!(); }
5341 // Attempt to route while setting max_path_count to 0 results in a failure.
5342 let zero_payment_params = payment_params.clone().with_max_path_count(0);
5343 let route_params = RouteParameters::from_payment_params_and_value(
5344 zero_payment_params, 100);
5345 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5346 &our_id, &route_params, &network_graph.read_only(), None,
5347 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes) {
5348 assert_eq!(err, "Can't find a route with no paths allowed.");
5349 } else { panic!(); }
5353 // Attempt to route while setting max_path_count to 3 results in a failure.
5354 // This is the case because the minimal_value_contribution_msat would require each path
5355 // to account for 1/3 of the total value, which is violated by 2 out of 3 paths.
5356 let fail_payment_params = payment_params.clone().with_max_path_count(3);
5357 let route_params = RouteParameters::from_payment_params_and_value(
5358 fail_payment_params, 250_000);
5359 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5360 &our_id, &route_params, &network_graph.read_only(), None,
5361 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes) {
5362 assert_eq!(err, "Failed to find a sufficient route to the given destination");
5363 } else { panic!(); }
5367 // Now, attempt to route 250 sats (just a bit below the capacity).
5368 // Our algorithm should provide us with these 3 paths.
5369 let route_params = RouteParameters::from_payment_params_and_value(
5370 payment_params.clone(), 250_000);
5371 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5372 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5373 assert_eq!(route.paths.len(), 3);
5374 let mut total_amount_paid_msat = 0;
5375 for path in &route.paths {
5376 if let Some(bt) = &path.blinded_tail {
5377 assert_eq!(path.hops.len() + if bt.hops.len() == 1 { 0 } else { 1 }, 2);
5379 assert_eq!(path.hops.len(), 2);
5380 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
5382 total_amount_paid_msat += path.final_value_msat();
5384 assert_eq!(total_amount_paid_msat, 250_000);
5388 // Attempt to route an exact amount is also fine
5389 let route_params = RouteParameters::from_payment_params_and_value(
5390 payment_params.clone(), 290_000);
5391 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5392 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5393 assert_eq!(route.paths.len(), 3);
5394 let mut total_amount_paid_msat = 0;
5395 for path in &route.paths {
5396 if payment_params.payee.blinded_route_hints().len() != 0 {
5397 assert!(path.blinded_tail.is_some()) } else { assert!(path.blinded_tail.is_none()) }
5398 if let Some(bt) = &path.blinded_tail {
5399 assert_eq!(path.hops.len() + if bt.hops.len() == 1 { 0 } else { 1 }, 2);
5400 if bt.hops.len() > 1 {
5401 let network_graph = network_graph.read_only();
5403 NodeId::from_pubkey(&path.hops.last().unwrap().pubkey),
5404 payment_params.payee.blinded_route_hints().iter()
5405 .find(|(p, _)| p.htlc_maximum_msat == path.final_value_msat())
5406 .and_then(|(_, p)| p.public_introduction_node_id(&network_graph))
5411 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
5414 assert_eq!(path.hops.len(), 2);
5415 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
5417 total_amount_paid_msat += path.final_value_msat();
5419 assert_eq!(total_amount_paid_msat, 290_000);
5424 fn long_mpp_route_test() {
5425 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5426 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5427 let scorer = ln_test_utils::TestScorer::new();
5428 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5429 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5430 let config = UserConfig::default();
5431 let payment_params = PaymentParameters::from_node_id(nodes[3], 42)
5432 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
5435 // We need a route consisting of 3 paths:
5436 // From our node to node3 via {node0, node2}, {node7, node2, node4} and {node7, node2}.
5437 // Note that these paths overlap (channels 5, 12, 13).
5438 // We will route 300 sats.
5439 // Each path will have 100 sats capacity, those channels which
5440 // are used twice will have 200 sats capacity.
5442 // Disable other potential paths.
5443 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5444 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5445 short_channel_id: 2,
5448 cltv_expiry_delta: 0,
5449 htlc_minimum_msat: 0,
5450 htlc_maximum_msat: 100_000,
5452 fee_proportional_millionths: 0,
5453 excess_data: Vec::new()
5455 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5456 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5457 short_channel_id: 7,
5460 cltv_expiry_delta: 0,
5461 htlc_minimum_msat: 0,
5462 htlc_maximum_msat: 100_000,
5464 fee_proportional_millionths: 0,
5465 excess_data: Vec::new()
5468 // Path via {node0, node2} is channels {1, 3, 5}.
5469 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5470 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5471 short_channel_id: 1,
5474 cltv_expiry_delta: 0,
5475 htlc_minimum_msat: 0,
5476 htlc_maximum_msat: 100_000,
5478 fee_proportional_millionths: 0,
5479 excess_data: Vec::new()
5481 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
5482 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5483 short_channel_id: 3,
5486 cltv_expiry_delta: 0,
5487 htlc_minimum_msat: 0,
5488 htlc_maximum_msat: 100_000,
5490 fee_proportional_millionths: 0,
5491 excess_data: Vec::new()
5494 // Capacity of 200 sats because this channel will be used by 3rd path as well.
5495 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
5496 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5497 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5498 short_channel_id: 5,
5501 cltv_expiry_delta: 0,
5502 htlc_minimum_msat: 0,
5503 htlc_maximum_msat: 200_000,
5505 fee_proportional_millionths: 0,
5506 excess_data: Vec::new()
5508 update_channel(&gossip_sync, &secp_ctx, &privkeys[3], UnsignedChannelUpdate {
5509 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5510 short_channel_id: 5,
5512 flags: 3, // disable direction 1
5513 cltv_expiry_delta: 0,
5514 htlc_minimum_msat: 0,
5515 htlc_maximum_msat: 200_000,
5517 fee_proportional_millionths: 0,
5518 excess_data: Vec::new()
5521 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
5522 // Add 100 sats to the capacities of {12, 13}, because these channels
5523 // are also used for 3rd path. 100 sats for the rest. Total capacity: 100 sats.
5524 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5525 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5526 short_channel_id: 12,
5529 cltv_expiry_delta: 0,
5530 htlc_minimum_msat: 0,
5531 htlc_maximum_msat: 200_000,
5533 fee_proportional_millionths: 0,
5534 excess_data: Vec::new()
5536 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
5537 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5538 short_channel_id: 13,
5541 cltv_expiry_delta: 0,
5542 htlc_minimum_msat: 0,
5543 htlc_maximum_msat: 200_000,
5545 fee_proportional_millionths: 0,
5546 excess_data: Vec::new()
5549 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5550 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5551 short_channel_id: 6,
5554 cltv_expiry_delta: 0,
5555 htlc_minimum_msat: 0,
5556 htlc_maximum_msat: 100_000,
5558 fee_proportional_millionths: 0,
5559 excess_data: Vec::new()
5561 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
5562 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5563 short_channel_id: 11,
5566 cltv_expiry_delta: 0,
5567 htlc_minimum_msat: 0,
5568 htlc_maximum_msat: 100_000,
5570 fee_proportional_millionths: 0,
5571 excess_data: Vec::new()
5574 // Path via {node7, node2} is channels {12, 13, 5}.
5575 // We already limited them to 200 sats (they are used twice for 100 sats).
5576 // Nothing to do here.
5579 // Attempt to route more than available results in a failure.
5580 let route_params = RouteParameters::from_payment_params_and_value(
5581 payment_params.clone(), 350_000);
5582 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5583 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
5584 &scorer, &Default::default(), &random_seed_bytes) {
5585 assert_eq!(err, "Failed to find a sufficient route to the given destination");
5586 } else { panic!(); }
5590 // Now, attempt to route 300 sats (exact amount we can route).
5591 // Our algorithm should provide us with these 3 paths, 100 sats each.
5592 let route_params = RouteParameters::from_payment_params_and_value(
5593 payment_params, 300_000);
5594 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5595 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5596 assert_eq!(route.paths.len(), 3);
5598 let mut total_amount_paid_msat = 0;
5599 for path in &route.paths {
5600 assert_eq!(path.hops.last().unwrap().pubkey, nodes[3]);
5601 total_amount_paid_msat += path.final_value_msat();
5603 assert_eq!(total_amount_paid_msat, 300_000);
5609 fn mpp_cheaper_route_test() {
5610 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5611 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5612 let scorer = ln_test_utils::TestScorer::new();
5613 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5614 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5615 let config = UserConfig::default();
5616 let payment_params = PaymentParameters::from_node_id(nodes[3], 42)
5617 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
5620 // This test checks that if we have two cheaper paths and one more expensive path,
5621 // so that liquidity-wise any 2 of 3 combination is sufficient,
5622 // two cheaper paths will be taken.
5623 // These paths have equal available liquidity.
5625 // We need a combination of 3 paths:
5626 // From our node to node3 via {node0, node2}, {node7, node2, node4} and {node7, node2}.
5627 // Note that these paths overlap (channels 5, 12, 13).
5628 // Each path will have 100 sats capacity, those channels which
5629 // are used twice will have 200 sats capacity.
5631 // Disable other potential paths.
5632 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5633 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5634 short_channel_id: 2,
5637 cltv_expiry_delta: 0,
5638 htlc_minimum_msat: 0,
5639 htlc_maximum_msat: 100_000,
5641 fee_proportional_millionths: 0,
5642 excess_data: Vec::new()
5644 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5645 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5646 short_channel_id: 7,
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()
5657 // Path via {node0, node2} is channels {1, 3, 5}.
5658 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5659 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5660 short_channel_id: 1,
5663 cltv_expiry_delta: 0,
5664 htlc_minimum_msat: 0,
5665 htlc_maximum_msat: 100_000,
5667 fee_proportional_millionths: 0,
5668 excess_data: Vec::new()
5670 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
5671 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5672 short_channel_id: 3,
5675 cltv_expiry_delta: 0,
5676 htlc_minimum_msat: 0,
5677 htlc_maximum_msat: 100_000,
5679 fee_proportional_millionths: 0,
5680 excess_data: Vec::new()
5683 // Capacity of 200 sats because this channel will be used by 3rd path as well.
5684 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
5685 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5686 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5687 short_channel_id: 5,
5690 cltv_expiry_delta: 0,
5691 htlc_minimum_msat: 0,
5692 htlc_maximum_msat: 200_000,
5694 fee_proportional_millionths: 0,
5695 excess_data: Vec::new()
5697 update_channel(&gossip_sync, &secp_ctx, &privkeys[3], UnsignedChannelUpdate {
5698 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5699 short_channel_id: 5,
5701 flags: 3, // disable direction 1
5702 cltv_expiry_delta: 0,
5703 htlc_minimum_msat: 0,
5704 htlc_maximum_msat: 200_000,
5706 fee_proportional_millionths: 0,
5707 excess_data: Vec::new()
5710 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
5711 // Add 100 sats to the capacities of {12, 13}, because these channels
5712 // are also used for 3rd path. 100 sats for the rest. Total capacity: 100 sats.
5713 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5714 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5715 short_channel_id: 12,
5718 cltv_expiry_delta: 0,
5719 htlc_minimum_msat: 0,
5720 htlc_maximum_msat: 200_000,
5722 fee_proportional_millionths: 0,
5723 excess_data: Vec::new()
5725 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
5726 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5727 short_channel_id: 13,
5730 cltv_expiry_delta: 0,
5731 htlc_minimum_msat: 0,
5732 htlc_maximum_msat: 200_000,
5734 fee_proportional_millionths: 0,
5735 excess_data: Vec::new()
5738 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5739 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5740 short_channel_id: 6,
5743 cltv_expiry_delta: 0,
5744 htlc_minimum_msat: 0,
5745 htlc_maximum_msat: 100_000,
5746 fee_base_msat: 1_000,
5747 fee_proportional_millionths: 0,
5748 excess_data: Vec::new()
5750 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
5751 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5752 short_channel_id: 11,
5755 cltv_expiry_delta: 0,
5756 htlc_minimum_msat: 0,
5757 htlc_maximum_msat: 100_000,
5759 fee_proportional_millionths: 0,
5760 excess_data: Vec::new()
5763 // Path via {node7, node2} is channels {12, 13, 5}.
5764 // We already limited them to 200 sats (they are used twice for 100 sats).
5765 // Nothing to do here.
5768 // Now, attempt to route 180 sats.
5769 // Our algorithm should provide us with these 2 paths.
5770 let route_params = RouteParameters::from_payment_params_and_value(
5771 payment_params, 180_000);
5772 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5773 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5774 assert_eq!(route.paths.len(), 2);
5776 let mut total_value_transferred_msat = 0;
5777 let mut total_paid_msat = 0;
5778 for path in &route.paths {
5779 assert_eq!(path.hops.last().unwrap().pubkey, nodes[3]);
5780 total_value_transferred_msat += path.final_value_msat();
5781 for hop in &path.hops {
5782 total_paid_msat += hop.fee_msat;
5785 // If we paid fee, this would be higher.
5786 assert_eq!(total_value_transferred_msat, 180_000);
5787 let total_fees_paid = total_paid_msat - total_value_transferred_msat;
5788 assert_eq!(total_fees_paid, 0);
5793 fn fees_on_mpp_route_test() {
5794 // This test makes sure that MPP algorithm properly takes into account
5795 // fees charged on the channels, by making the fees impactful:
5796 // if the fee is not properly accounted for, the behavior is different.
5797 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5798 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5799 let scorer = ln_test_utils::TestScorer::new();
5800 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5801 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5802 let config = UserConfig::default();
5803 let payment_params = PaymentParameters::from_node_id(nodes[3], 42)
5804 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
5807 // We need a route consisting of 2 paths:
5808 // From our node to node3 via {node0, node2} and {node7, node2, node4}.
5809 // We will route 200 sats, Each path will have 100 sats capacity.
5811 // This test is not particularly stable: e.g.,
5812 // there's a way to route via {node0, node2, node4}.
5813 // It works while pathfinding is deterministic, but can be broken otherwise.
5814 // It's fine to ignore this concern for now.
5816 // Disable other potential paths.
5817 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5818 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5819 short_channel_id: 2,
5822 cltv_expiry_delta: 0,
5823 htlc_minimum_msat: 0,
5824 htlc_maximum_msat: 100_000,
5826 fee_proportional_millionths: 0,
5827 excess_data: Vec::new()
5830 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5831 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5832 short_channel_id: 7,
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 // Path via {node0, node2} is channels {1, 3, 5}.
5844 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5845 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5846 short_channel_id: 1,
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()
5856 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
5857 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5858 short_channel_id: 3,
5861 cltv_expiry_delta: 0,
5862 htlc_minimum_msat: 0,
5863 htlc_maximum_msat: 100_000,
5865 fee_proportional_millionths: 0,
5866 excess_data: Vec::new()
5869 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
5870 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5871 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5872 short_channel_id: 5,
5875 cltv_expiry_delta: 0,
5876 htlc_minimum_msat: 0,
5877 htlc_maximum_msat: 100_000,
5879 fee_proportional_millionths: 0,
5880 excess_data: Vec::new()
5882 update_channel(&gossip_sync, &secp_ctx, &privkeys[3], UnsignedChannelUpdate {
5883 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5884 short_channel_id: 5,
5886 flags: 3, // Disable direction 1
5887 cltv_expiry_delta: 0,
5888 htlc_minimum_msat: 0,
5889 htlc_maximum_msat: 100_000,
5891 fee_proportional_millionths: 0,
5892 excess_data: Vec::new()
5895 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
5896 // All channels should be 100 sats capacity. But for the fee experiment,
5897 // we'll add absolute fee of 150 sats paid for the use channel 6 (paid to node2 on channel 13).
5898 // Since channel 12 allows to deliver only 250 sats to channel 13, channel 13 can transfer only
5899 // 100 sats (and pay 150 sats in fees for the use of channel 6),
5900 // so no matter how large are other channels,
5901 // the whole path will be limited by 100 sats with just these 2 conditions:
5902 // - channel 12 capacity is 250 sats
5903 // - fee for channel 6 is 150 sats
5904 // Let's test this by enforcing these 2 conditions and removing other limits.
5905 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5906 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5907 short_channel_id: 12,
5910 cltv_expiry_delta: 0,
5911 htlc_minimum_msat: 0,
5912 htlc_maximum_msat: 250_000,
5914 fee_proportional_millionths: 0,
5915 excess_data: Vec::new()
5917 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
5918 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5919 short_channel_id: 13,
5922 cltv_expiry_delta: 0,
5923 htlc_minimum_msat: 0,
5924 htlc_maximum_msat: MAX_VALUE_MSAT,
5926 fee_proportional_millionths: 0,
5927 excess_data: Vec::new()
5930 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5931 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5932 short_channel_id: 6,
5935 cltv_expiry_delta: 0,
5936 htlc_minimum_msat: 0,
5937 htlc_maximum_msat: MAX_VALUE_MSAT,
5938 fee_base_msat: 150_000,
5939 fee_proportional_millionths: 0,
5940 excess_data: Vec::new()
5942 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
5943 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
5944 short_channel_id: 11,
5947 cltv_expiry_delta: 0,
5948 htlc_minimum_msat: 0,
5949 htlc_maximum_msat: MAX_VALUE_MSAT,
5951 fee_proportional_millionths: 0,
5952 excess_data: Vec::new()
5956 // Attempt to route more than available results in a failure.
5957 let route_params = RouteParameters::from_payment_params_and_value(
5958 payment_params.clone(), 210_000);
5959 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5960 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
5961 &scorer, &Default::default(), &random_seed_bytes) {
5962 assert_eq!(err, "Failed to find a sufficient route to the given destination");
5963 } else { panic!(); }
5967 // Attempt to route while setting max_total_routing_fee_msat to 149_999 results in a failure.
5968 let route_params = RouteParameters { payment_params: payment_params.clone(), final_value_msat: 200_000,
5969 max_total_routing_fee_msat: Some(149_999) };
5970 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
5971 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
5972 &scorer, &Default::default(), &random_seed_bytes) {
5973 assert_eq!(err, "Failed to find a sufficient route to the given destination");
5974 } else { panic!(); }
5978 // Now, attempt to route 200 sats (exact amount we can route).
5979 let route_params = RouteParameters { payment_params: payment_params.clone(), final_value_msat: 200_000,
5980 max_total_routing_fee_msat: Some(150_000) };
5981 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
5982 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
5983 assert_eq!(route.paths.len(), 2);
5985 let mut total_amount_paid_msat = 0;
5986 for path in &route.paths {
5987 assert_eq!(path.hops.last().unwrap().pubkey, nodes[3]);
5988 total_amount_paid_msat += path.final_value_msat();
5990 assert_eq!(total_amount_paid_msat, 200_000);
5991 assert_eq!(route.get_total_fees(), 150_000);
5996 fn mpp_with_last_hops() {
5997 // Previously, if we tried to send an MPP payment to a destination which was only reachable
5998 // via a single last-hop route hint, we'd fail to route if we first collected routes
5999 // totaling close but not quite enough to fund the full payment.
6001 // This was because we considered last-hop hints to have exactly the sought payment amount
6002 // instead of the amount we were trying to collect, needlessly limiting our path searching
6003 // at the very first hop.
6005 // Specifically, this interacted with our "all paths must fund at least 5% of total target"
6006 // criterion to cause us to refuse all routes at the last hop hint which would be considered
6007 // to only have the remaining to-collect amount in available liquidity.
6009 // This bug appeared in production in some specific channel configurations.
6010 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
6011 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
6012 let scorer = ln_test_utils::TestScorer::new();
6013 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6014 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6015 let config = UserConfig::default();
6016 let payment_params = PaymentParameters::from_node_id(PublicKey::from_slice(&[02; 33]).unwrap(), 42)
6017 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config)).unwrap()
6018 .with_route_hints(vec![RouteHint(vec![RouteHintHop {
6019 src_node_id: nodes[2],
6020 short_channel_id: 42,
6021 fees: RoutingFees { base_msat: 0, proportional_millionths: 0 },
6022 cltv_expiry_delta: 42,
6023 htlc_minimum_msat: None,
6024 htlc_maximum_msat: None,
6025 }])]).unwrap().with_max_channel_saturation_power_of_half(0);
6027 // Keep only two paths from us to nodes[2], both with a 99sat HTLC maximum, with one with
6028 // no fee and one with a 1msat fee. Previously, trying to route 100 sats to nodes[2] here
6029 // would first use the no-fee route and then fail to find a path along the second route as
6030 // we think we can only send up to 1 additional sat over the last-hop but refuse to as its
6031 // under 5% of our payment amount.
6032 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6033 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6034 short_channel_id: 1,
6037 cltv_expiry_delta: (5 << 4) | 5,
6038 htlc_minimum_msat: 0,
6039 htlc_maximum_msat: 99_000,
6040 fee_base_msat: u32::max_value(),
6041 fee_proportional_millionths: u32::max_value(),
6042 excess_data: Vec::new()
6044 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6045 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6046 short_channel_id: 2,
6049 cltv_expiry_delta: (5 << 4) | 3,
6050 htlc_minimum_msat: 0,
6051 htlc_maximum_msat: 99_000,
6052 fee_base_msat: u32::max_value(),
6053 fee_proportional_millionths: u32::max_value(),
6054 excess_data: Vec::new()
6056 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
6057 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6058 short_channel_id: 4,
6061 cltv_expiry_delta: (4 << 4) | 1,
6062 htlc_minimum_msat: 0,
6063 htlc_maximum_msat: MAX_VALUE_MSAT,
6065 fee_proportional_millionths: 0,
6066 excess_data: Vec::new()
6068 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
6069 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6070 short_channel_id: 13,
6072 flags: 0|2, // Channel disabled
6073 cltv_expiry_delta: (13 << 4) | 1,
6074 htlc_minimum_msat: 0,
6075 htlc_maximum_msat: MAX_VALUE_MSAT,
6077 fee_proportional_millionths: 2000000,
6078 excess_data: Vec::new()
6081 // Get a route for 100 sats and check that we found the MPP route no problem and didn't
6083 let route_params = RouteParameters::from_payment_params_and_value(
6084 payment_params, 100_000);
6085 let mut route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
6086 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6087 assert_eq!(route.paths.len(), 2);
6088 route.paths.sort_by_key(|path| path.hops[0].short_channel_id);
6089 // Paths are manually ordered ordered by SCID, so:
6090 // * the first is channel 1 (0 fee, but 99 sat maximum) -> channel 3 -> channel 42
6091 // * the second is channel 2 (1 msat fee) -> channel 4 -> channel 42
6092 assert_eq!(route.paths[0].hops[0].short_channel_id, 1);
6093 assert_eq!(route.paths[0].hops[0].fee_msat, 0);
6094 assert_eq!(route.paths[0].hops[2].fee_msat, 99_000);
6095 assert_eq!(route.paths[1].hops[0].short_channel_id, 2);
6096 assert_eq!(route.paths[1].hops[0].fee_msat, 1);
6097 assert_eq!(route.paths[1].hops[2].fee_msat, 1_000);
6098 assert_eq!(route.get_total_fees(), 1);
6099 assert_eq!(route.get_total_amount(), 100_000);
6103 fn drop_lowest_channel_mpp_route_test() {
6104 // This test checks that low-capacity channel is dropped when after
6105 // path finding we realize that we found more capacity than we need.
6106 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
6107 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
6108 let scorer = ln_test_utils::TestScorer::new();
6109 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6110 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6111 let config = UserConfig::default();
6112 let payment_params = PaymentParameters::from_node_id(nodes[2], 42)
6113 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
6115 .with_max_channel_saturation_power_of_half(0);
6117 // We need a route consisting of 3 paths:
6118 // From our node to node2 via node0, node7, node1 (three paths one hop each).
6120 // The first and the second paths should be sufficient, but the third should be
6121 // cheaper, so that we select it but drop later.
6123 // First, we set limits on these (previously unlimited) channels.
6124 // Their aggregate capacity will be 50 + 60 + 20 = 130 sats.
6126 // Path via node0 is channels {1, 3}. Limit them to 100 and 50 sats (total limit 50);
6127 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6128 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6129 short_channel_id: 1,
6132 cltv_expiry_delta: 0,
6133 htlc_minimum_msat: 0,
6134 htlc_maximum_msat: 100_000,
6136 fee_proportional_millionths: 0,
6137 excess_data: Vec::new()
6139 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
6140 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6141 short_channel_id: 3,
6144 cltv_expiry_delta: 0,
6145 htlc_minimum_msat: 0,
6146 htlc_maximum_msat: 50_000,
6148 fee_proportional_millionths: 0,
6149 excess_data: Vec::new()
6152 // Path via node7 is channels {12, 13}. Limit them to 60 and 60 sats (total limit 60);
6153 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6154 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6155 short_channel_id: 12,
6158 cltv_expiry_delta: 0,
6159 htlc_minimum_msat: 0,
6160 htlc_maximum_msat: 60_000,
6162 fee_proportional_millionths: 0,
6163 excess_data: Vec::new()
6165 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
6166 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6167 short_channel_id: 13,
6170 cltv_expiry_delta: 0,
6171 htlc_minimum_msat: 0,
6172 htlc_maximum_msat: 60_000,
6174 fee_proportional_millionths: 0,
6175 excess_data: Vec::new()
6178 // Path via node1 is channels {2, 4}. Limit them to 20 and 20 sats (total capacity 20 sats).
6179 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6180 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6181 short_channel_id: 2,
6184 cltv_expiry_delta: 0,
6185 htlc_minimum_msat: 0,
6186 htlc_maximum_msat: 20_000,
6188 fee_proportional_millionths: 0,
6189 excess_data: Vec::new()
6191 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
6192 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6193 short_channel_id: 4,
6196 cltv_expiry_delta: 0,
6197 htlc_minimum_msat: 0,
6198 htlc_maximum_msat: 20_000,
6200 fee_proportional_millionths: 0,
6201 excess_data: Vec::new()
6205 // Attempt to route more than available results in a failure.
6206 let route_params = RouteParameters::from_payment_params_and_value(
6207 payment_params.clone(), 150_000);
6208 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
6209 &our_id, &route_params, &network_graph.read_only(), None, Arc::clone(&logger),
6210 &scorer, &Default::default(), &random_seed_bytes) {
6211 assert_eq!(err, "Failed to find a sufficient route to the given destination");
6212 } else { panic!(); }
6216 // Now, attempt to route 125 sats (just a bit below the capacity of 3 channels).
6217 // Our algorithm should provide us with these 3 paths.
6218 let route_params = RouteParameters::from_payment_params_and_value(
6219 payment_params.clone(), 125_000);
6220 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
6221 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6222 assert_eq!(route.paths.len(), 3);
6223 let mut total_amount_paid_msat = 0;
6224 for path in &route.paths {
6225 assert_eq!(path.hops.len(), 2);
6226 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
6227 total_amount_paid_msat += path.final_value_msat();
6229 assert_eq!(total_amount_paid_msat, 125_000);
6233 // Attempt to route without the last small cheap channel
6234 let route_params = RouteParameters::from_payment_params_and_value(
6235 payment_params, 90_000);
6236 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
6237 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6238 assert_eq!(route.paths.len(), 2);
6239 let mut total_amount_paid_msat = 0;
6240 for path in &route.paths {
6241 assert_eq!(path.hops.len(), 2);
6242 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
6243 total_amount_paid_msat += path.final_value_msat();
6245 assert_eq!(total_amount_paid_msat, 90_000);
6250 fn min_criteria_consistency() {
6251 // Test that we don't use an inconsistent metric between updating and walking nodes during
6252 // our Dijkstra's pass. In the initial version of MPP, the "best source" for a given node
6253 // was updated with a different criterion from the heap sorting, resulting in loops in
6254 // calculated paths. We test for that specific case here.
6256 // We construct a network that looks like this:
6258 // node2 -1(3)2- node3
6262 // node1 -1(5)2- node4 -1(1)2- node6
6268 // We create a loop on the side of our real path - our destination is node 6, with a
6269 // previous hop of node 4. From 4, the cheapest previous path is channel 2 from node 2,
6270 // followed by node 3 over channel 3. Thereafter, the cheapest next-hop is back to node 4
6271 // (this time over channel 4). Channel 4 has 0 htlc_minimum_msat whereas channel 1 (the
6272 // other channel with a previous-hop of node 4) has a high (but irrelevant to the overall
6273 // payment) htlc_minimum_msat. In the original algorithm, this resulted in node4's
6274 // "previous hop" being set to node 3, creating a loop in the path.
6275 let secp_ctx = Secp256k1::new();
6276 let logger = Arc::new(ln_test_utils::TestLogger::new());
6277 let network = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
6278 let gossip_sync = P2PGossipSync::new(Arc::clone(&network), None, Arc::clone(&logger));
6279 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
6280 let scorer = ln_test_utils::TestScorer::new();
6281 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6282 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6283 let payment_params = PaymentParameters::from_node_id(nodes[6], 42);
6285 add_channel(&gossip_sync, &secp_ctx, &our_privkey, &privkeys[1], ChannelFeatures::from_le_bytes(id_to_feature_flags(6)), 6);
6286 for (key, flags) in [(&our_privkey, 0), (&privkeys[1], 3)] {
6287 update_channel(&gossip_sync, &secp_ctx, key, UnsignedChannelUpdate {
6288 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6289 short_channel_id: 6,
6292 cltv_expiry_delta: (6 << 4) | 0,
6293 htlc_minimum_msat: 0,
6294 htlc_maximum_msat: MAX_VALUE_MSAT,
6296 fee_proportional_millionths: 0,
6297 excess_data: Vec::new()
6300 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[1], NodeFeatures::from_le_bytes(id_to_feature_flags(1)), 0);
6302 add_channel(&gossip_sync, &secp_ctx, &privkeys[1], &privkeys[4], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
6303 for (key, flags) in [(&privkeys[1], 0), (&privkeys[4], 3)] {
6304 update_channel(&gossip_sync, &secp_ctx, key, UnsignedChannelUpdate {
6305 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6306 short_channel_id: 5,
6309 cltv_expiry_delta: (5 << 4) | 0,
6310 htlc_minimum_msat: 0,
6311 htlc_maximum_msat: MAX_VALUE_MSAT,
6313 fee_proportional_millionths: 0,
6314 excess_data: Vec::new()
6317 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[4], NodeFeatures::from_le_bytes(id_to_feature_flags(4)), 0);
6319 add_channel(&gossip_sync, &secp_ctx, &privkeys[4], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(4)), 4);
6320 for (key, flags) in [(&privkeys[4], 0), (&privkeys[3], 3)] {
6321 update_channel(&gossip_sync, &secp_ctx, key, UnsignedChannelUpdate {
6322 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6323 short_channel_id: 4,
6326 cltv_expiry_delta: (4 << 4) | 0,
6327 htlc_minimum_msat: 0,
6328 htlc_maximum_msat: MAX_VALUE_MSAT,
6330 fee_proportional_millionths: 0,
6331 excess_data: Vec::new()
6334 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[3], NodeFeatures::from_le_bytes(id_to_feature_flags(3)), 0);
6336 add_channel(&gossip_sync, &secp_ctx, &privkeys[3], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(3)), 3);
6337 for (key, flags) in [(&privkeys[3], 0), (&privkeys[2], 3)] {
6338 update_channel(&gossip_sync, &secp_ctx, key, UnsignedChannelUpdate {
6339 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6340 short_channel_id: 3,
6343 cltv_expiry_delta: (3 << 4) | 0,
6344 htlc_minimum_msat: 0,
6345 htlc_maximum_msat: MAX_VALUE_MSAT,
6347 fee_proportional_millionths: 0,
6348 excess_data: Vec::new()
6351 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[2], NodeFeatures::from_le_bytes(id_to_feature_flags(2)), 0);
6353 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[4], ChannelFeatures::from_le_bytes(id_to_feature_flags(2)), 2);
6354 for (key, flags) in [(&privkeys[2], 0), (&privkeys[4], 3)] {
6355 update_channel(&gossip_sync, &secp_ctx, key, UnsignedChannelUpdate {
6356 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6357 short_channel_id: 2,
6360 cltv_expiry_delta: (2 << 4) | 0,
6361 htlc_minimum_msat: 0,
6362 htlc_maximum_msat: MAX_VALUE_MSAT,
6364 fee_proportional_millionths: 0,
6365 excess_data: Vec::new()
6369 add_channel(&gossip_sync, &secp_ctx, &privkeys[4], &privkeys[6], ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 1);
6370 for (key, flags) in [(&privkeys[4], 0), (&privkeys[6], 3)] {
6371 update_channel(&gossip_sync, &secp_ctx, key, UnsignedChannelUpdate {
6372 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6373 short_channel_id: 1,
6376 cltv_expiry_delta: (1 << 4) | 0,
6377 htlc_minimum_msat: 100,
6378 htlc_maximum_msat: MAX_VALUE_MSAT,
6380 fee_proportional_millionths: 0,
6381 excess_data: Vec::new()
6384 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[6], NodeFeatures::from_le_bytes(id_to_feature_flags(6)), 0);
6387 // Now ensure the route flows simply over nodes 1 and 4 to 6.
6388 let route_params = RouteParameters::from_payment_params_and_value(
6389 payment_params, 10_000);
6390 let route = get_route(&our_id, &route_params, &network.read_only(), None,
6391 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6392 assert_eq!(route.paths.len(), 1);
6393 assert_eq!(route.paths[0].hops.len(), 3);
6395 assert_eq!(route.paths[0].hops[0].pubkey, nodes[1]);
6396 assert_eq!(route.paths[0].hops[0].short_channel_id, 6);
6397 assert_eq!(route.paths[0].hops[0].fee_msat, 100);
6398 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (5 << 4) | 0);
6399 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(1));
6400 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(6));
6402 assert_eq!(route.paths[0].hops[1].pubkey, nodes[4]);
6403 assert_eq!(route.paths[0].hops[1].short_channel_id, 5);
6404 assert_eq!(route.paths[0].hops[1].fee_msat, 0);
6405 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, (1 << 4) | 0);
6406 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(4));
6407 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(5));
6409 assert_eq!(route.paths[0].hops[2].pubkey, nodes[6]);
6410 assert_eq!(route.paths[0].hops[2].short_channel_id, 1);
6411 assert_eq!(route.paths[0].hops[2].fee_msat, 10_000);
6412 assert_eq!(route.paths[0].hops[2].cltv_expiry_delta, 42);
6413 assert_eq!(route.paths[0].hops[2].node_features.le_flags(), &id_to_feature_flags(6));
6414 assert_eq!(route.paths[0].hops[2].channel_features.le_flags(), &id_to_feature_flags(1));
6420 fn exact_fee_liquidity_limit() {
6421 // Test that if, while walking the graph, we find a hop that has exactly enough liquidity
6422 // for us, including later hop fees, we take it. In the first version of our MPP algorithm
6423 // we calculated fees on a higher value, resulting in us ignoring such paths.
6424 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
6425 let (our_privkey, our_id, _, nodes) = get_nodes(&secp_ctx);
6426 let scorer = ln_test_utils::TestScorer::new();
6427 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6428 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6429 let payment_params = PaymentParameters::from_node_id(nodes[2], 42);
6431 // We modify the graph to set the htlc_maximum of channel 2 to below the value we wish to
6433 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6434 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6435 short_channel_id: 2,
6438 cltv_expiry_delta: 0,
6439 htlc_minimum_msat: 0,
6440 htlc_maximum_msat: 85_000,
6442 fee_proportional_millionths: 0,
6443 excess_data: Vec::new()
6446 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6447 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6448 short_channel_id: 12,
6451 cltv_expiry_delta: (4 << 4) | 1,
6452 htlc_minimum_msat: 0,
6453 htlc_maximum_msat: 270_000,
6455 fee_proportional_millionths: 1000000,
6456 excess_data: Vec::new()
6460 // Now, attempt to route 90 sats, which is exactly 90 sats at the last hop, plus the
6461 // 200% fee charged channel 13 in the 1-to-2 direction.
6462 let mut route_params = RouteParameters::from_payment_params_and_value(
6463 payment_params, 90_000);
6464 route_params.max_total_routing_fee_msat = Some(90_000*2);
6465 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
6466 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6467 assert_eq!(route.paths.len(), 1);
6468 assert_eq!(route.paths[0].hops.len(), 2);
6470 assert_eq!(route.paths[0].hops[0].pubkey, nodes[7]);
6471 assert_eq!(route.paths[0].hops[0].short_channel_id, 12);
6472 assert_eq!(route.paths[0].hops[0].fee_msat, 90_000*2);
6473 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (13 << 4) | 1);
6474 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(8));
6475 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(12));
6477 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
6478 assert_eq!(route.paths[0].hops[1].short_channel_id, 13);
6479 assert_eq!(route.paths[0].hops[1].fee_msat, 90_000);
6480 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
6481 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), &id_to_feature_flags(3));
6482 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(13));
6487 fn htlc_max_reduction_below_min() {
6488 // Test that if, while walking the graph, we reduce the value being sent to meet an
6489 // htlc_maximum_msat, we don't end up undershooting a later htlc_minimum_msat. In the
6490 // initial version of MPP we'd accept such routes but reject them while recalculating fees,
6491 // resulting in us thinking there is no possible path, even if other paths exist.
6492 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
6493 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
6494 let scorer = ln_test_utils::TestScorer::new();
6495 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6496 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6497 let config = UserConfig::default();
6498 let payment_params = PaymentParameters::from_node_id(nodes[2], 42)
6499 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
6502 // We modify the graph to set the htlc_minimum of channel 2 and 4 as needed - channel 2
6503 // gets an htlc_maximum_msat of 80_000 and channel 4 an htlc_minimum_msat of 90_000. We
6504 // then try to send 90_000.
6505 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
6506 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6507 short_channel_id: 2,
6510 cltv_expiry_delta: 0,
6511 htlc_minimum_msat: 0,
6512 htlc_maximum_msat: 80_000,
6514 fee_proportional_millionths: 0,
6515 excess_data: Vec::new()
6517 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
6518 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
6519 short_channel_id: 4,
6522 cltv_expiry_delta: (4 << 4) | 1,
6523 htlc_minimum_msat: 90_000,
6524 htlc_maximum_msat: MAX_VALUE_MSAT,
6526 fee_proportional_millionths: 0,
6527 excess_data: Vec::new()
6531 // Now, attempt to route 90 sats, hitting the htlc_minimum on channel 4, but
6532 // overshooting the htlc_maximum on channel 2. Thus, we should pick the (absurdly
6533 // expensive) channels 12-13 path.
6534 let mut route_params = RouteParameters::from_payment_params_and_value(
6535 payment_params, 90_000);
6536 route_params.max_total_routing_fee_msat = Some(90_000*2);
6537 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
6538 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6539 assert_eq!(route.paths.len(), 1);
6540 assert_eq!(route.paths[0].hops.len(), 2);
6542 assert_eq!(route.paths[0].hops[0].pubkey, nodes[7]);
6543 assert_eq!(route.paths[0].hops[0].short_channel_id, 12);
6544 assert_eq!(route.paths[0].hops[0].fee_msat, 90_000*2);
6545 assert_eq!(route.paths[0].hops[0].cltv_expiry_delta, (13 << 4) | 1);
6546 assert_eq!(route.paths[0].hops[0].node_features.le_flags(), &id_to_feature_flags(8));
6547 assert_eq!(route.paths[0].hops[0].channel_features.le_flags(), &id_to_feature_flags(12));
6549 assert_eq!(route.paths[0].hops[1].pubkey, nodes[2]);
6550 assert_eq!(route.paths[0].hops[1].short_channel_id, 13);
6551 assert_eq!(route.paths[0].hops[1].fee_msat, 90_000);
6552 assert_eq!(route.paths[0].hops[1].cltv_expiry_delta, 42);
6553 assert_eq!(route.paths[0].hops[1].node_features.le_flags(), channelmanager::provided_bolt11_invoice_features(&config).le_flags());
6554 assert_eq!(route.paths[0].hops[1].channel_features.le_flags(), &id_to_feature_flags(13));
6559 fn multiple_direct_first_hops() {
6560 // Previously we'd only ever considered one first hop path per counterparty.
6561 // However, as we don't restrict users to one channel per peer, we really need to support
6562 // looking at all first hop paths.
6563 // Here we test that we do not ignore all-but-the-last first hop paths per counterparty (as
6564 // we used to do by overwriting the `first_hop_targets` hashmap entry) and that we can MPP
6565 // route over multiple channels with the same first hop.
6566 let secp_ctx = Secp256k1::new();
6567 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6568 let logger = Arc::new(ln_test_utils::TestLogger::new());
6569 let network_graph = NetworkGraph::new(Network::Testnet, Arc::clone(&logger));
6570 let scorer = ln_test_utils::TestScorer::new();
6571 let config = UserConfig::default();
6572 let payment_params = PaymentParameters::from_node_id(nodes[0], 42)
6573 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
6575 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6576 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6579 let route_params = RouteParameters::from_payment_params_and_value(
6580 payment_params.clone(), 100_000);
6581 let route = get_route(&our_id, &route_params, &network_graph.read_only(), Some(&[
6582 &get_channel_details(Some(3), nodes[0], channelmanager::provided_init_features(&config), 200_000),
6583 &get_channel_details(Some(2), nodes[0], channelmanager::provided_init_features(&config), 10_000),
6584 ]), Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6585 assert_eq!(route.paths.len(), 1);
6586 assert_eq!(route.paths[0].hops.len(), 1);
6588 assert_eq!(route.paths[0].hops[0].pubkey, nodes[0]);
6589 assert_eq!(route.paths[0].hops[0].short_channel_id, 3);
6590 assert_eq!(route.paths[0].hops[0].fee_msat, 100_000);
6593 let route_params = RouteParameters::from_payment_params_and_value(
6594 payment_params.clone(), 100_000);
6595 let route = get_route(&our_id, &route_params, &network_graph.read_only(), Some(&[
6596 &get_channel_details(Some(3), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6597 &get_channel_details(Some(2), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6598 ]), Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6599 assert_eq!(route.paths.len(), 2);
6600 assert_eq!(route.paths[0].hops.len(), 1);
6601 assert_eq!(route.paths[1].hops.len(), 1);
6603 assert!((route.paths[0].hops[0].short_channel_id == 3 && route.paths[1].hops[0].short_channel_id == 2) ||
6604 (route.paths[0].hops[0].short_channel_id == 2 && route.paths[1].hops[0].short_channel_id == 3));
6606 assert_eq!(route.paths[0].hops[0].pubkey, nodes[0]);
6607 assert_eq!(route.paths[0].hops[0].fee_msat, 50_000);
6609 assert_eq!(route.paths[1].hops[0].pubkey, nodes[0]);
6610 assert_eq!(route.paths[1].hops[0].fee_msat, 50_000);
6614 // If we have a bunch of outbound channels to the same node, where most are not
6615 // sufficient to pay the full payment, but one is, we should default to just using the
6616 // one single channel that has sufficient balance, avoiding MPP.
6618 // If we have several options above the 3xpayment value threshold, we should pick the
6619 // smallest of them, avoiding further fragmenting our available outbound balance to
6621 let route_params = RouteParameters::from_payment_params_and_value(
6622 payment_params, 100_000);
6623 let route = get_route(&our_id, &route_params, &network_graph.read_only(), Some(&[
6624 &get_channel_details(Some(2), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6625 &get_channel_details(Some(3), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6626 &get_channel_details(Some(5), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6627 &get_channel_details(Some(6), nodes[0], channelmanager::provided_init_features(&config), 300_000),
6628 &get_channel_details(Some(7), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6629 &get_channel_details(Some(8), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6630 &get_channel_details(Some(9), nodes[0], channelmanager::provided_init_features(&config), 50_000),
6631 &get_channel_details(Some(4), nodes[0], channelmanager::provided_init_features(&config), 1_000_000),
6632 ]), Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6633 assert_eq!(route.paths.len(), 1);
6634 assert_eq!(route.paths[0].hops.len(), 1);
6636 assert_eq!(route.paths[0].hops[0].pubkey, nodes[0]);
6637 assert_eq!(route.paths[0].hops[0].short_channel_id, 6);
6638 assert_eq!(route.paths[0].hops[0].fee_msat, 100_000);
6643 fn prefers_shorter_route_with_higher_fees() {
6644 let (secp_ctx, network_graph, _, _, logger) = build_graph();
6645 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6646 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(last_hops(&nodes)).unwrap();
6648 // Without penalizing each hop 100 msats, a longer path with lower fees is chosen.
6649 let scorer = ln_test_utils::TestScorer::new();
6650 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6651 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6652 let route_params = RouteParameters::from_payment_params_and_value(
6653 payment_params.clone(), 100);
6654 let route = get_route( &our_id, &route_params, &network_graph.read_only(), None,
6655 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6656 let path = route.paths[0].hops.iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
6658 assert_eq!(route.get_total_fees(), 100);
6659 assert_eq!(route.get_total_amount(), 100);
6660 assert_eq!(path, vec![2, 4, 6, 11, 8]);
6662 // Applying a 100 msat penalty to each hop results in taking channels 7 and 10 to nodes[6]
6663 // from nodes[2] rather than channel 6, 11, and 8, even though the longer path is cheaper.
6664 let scorer = FixedPenaltyScorer::with_penalty(100);
6665 let route_params = RouteParameters::from_payment_params_and_value(
6666 payment_params, 100);
6667 let route = get_route( &our_id, &route_params, &network_graph.read_only(), None,
6668 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6669 let path = route.paths[0].hops.iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
6671 assert_eq!(route.get_total_fees(), 300);
6672 assert_eq!(route.get_total_amount(), 100);
6673 assert_eq!(path, vec![2, 4, 7, 10]);
6676 struct BadChannelScorer {
6677 short_channel_id: u64,
6681 impl Writeable for BadChannelScorer {
6682 fn write<W: Writer>(&self, _w: &mut W) -> Result<(), crate::io::Error> { unimplemented!() }
6684 impl ScoreLookUp for BadChannelScorer {
6685 type ScoreParams = ();
6686 fn channel_penalty_msat(&self, candidate: &CandidateRouteHop, _: ChannelUsage, _score_params:&Self::ScoreParams) -> u64 {
6687 if candidate.short_channel_id() == Some(self.short_channel_id) { u64::max_value() } else { 0 }
6691 struct BadNodeScorer {
6696 impl Writeable for BadNodeScorer {
6697 fn write<W: Writer>(&self, _w: &mut W) -> Result<(), crate::io::Error> { unimplemented!() }
6700 impl ScoreLookUp for BadNodeScorer {
6701 type ScoreParams = ();
6702 fn channel_penalty_msat(&self, candidate: &CandidateRouteHop, _: ChannelUsage, _score_params:&Self::ScoreParams) -> u64 {
6703 if candidate.target() == Some(self.node_id) { u64::max_value() } else { 0 }
6708 fn avoids_routing_through_bad_channels_and_nodes() {
6709 let (secp_ctx, network, _, _, logger) = build_graph();
6710 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6711 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(last_hops(&nodes)).unwrap();
6712 let network_graph = network.read_only();
6714 // A path to nodes[6] exists when no penalties are applied to any channel.
6715 let scorer = ln_test_utils::TestScorer::new();
6716 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6717 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6718 let route_params = RouteParameters::from_payment_params_and_value(
6719 payment_params, 100);
6720 let route = get_route( &our_id, &route_params, &network_graph, None, Arc::clone(&logger),
6721 &scorer, &Default::default(), &random_seed_bytes).unwrap();
6722 let path = route.paths[0].hops.iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
6724 assert_eq!(route.get_total_fees(), 100);
6725 assert_eq!(route.get_total_amount(), 100);
6726 assert_eq!(path, vec![2, 4, 6, 11, 8]);
6728 // A different path to nodes[6] exists if channel 6 cannot be routed over.
6729 let scorer = BadChannelScorer { short_channel_id: 6 };
6730 let route = get_route( &our_id, &route_params, &network_graph, None, Arc::clone(&logger),
6731 &scorer, &Default::default(), &random_seed_bytes).unwrap();
6732 let path = route.paths[0].hops.iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
6734 assert_eq!(route.get_total_fees(), 300);
6735 assert_eq!(route.get_total_amount(), 100);
6736 assert_eq!(path, vec![2, 4, 7, 10]);
6738 // A path to nodes[6] does not exist if nodes[2] cannot be routed through.
6739 let scorer = BadNodeScorer { node_id: NodeId::from_pubkey(&nodes[2]) };
6740 match get_route( &our_id, &route_params, &network_graph, None, Arc::clone(&logger),
6741 &scorer, &Default::default(), &random_seed_bytes) {
6742 Err(LightningError { err, .. } ) => {
6743 assert_eq!(err, "Failed to find a path to the given destination");
6745 Ok(_) => panic!("Expected error"),
6750 fn total_fees_single_path() {
6752 paths: vec![Path { hops: vec![
6754 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
6755 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6756 short_channel_id: 0, fee_msat: 100, cltv_expiry_delta: 0, maybe_announced_channel: true,
6759 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
6760 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6761 short_channel_id: 0, fee_msat: 150, cltv_expiry_delta: 0, maybe_announced_channel: true,
6764 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
6765 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6766 short_channel_id: 0, fee_msat: 225, cltv_expiry_delta: 0, maybe_announced_channel: true,
6768 ], blinded_tail: None }],
6772 assert_eq!(route.get_total_fees(), 250);
6773 assert_eq!(route.get_total_amount(), 225);
6777 fn total_fees_multi_path() {
6779 paths: vec![Path { hops: vec![
6781 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
6782 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6783 short_channel_id: 0, fee_msat: 100, cltv_expiry_delta: 0, maybe_announced_channel: true,
6786 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
6787 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6788 short_channel_id: 0, fee_msat: 150, cltv_expiry_delta: 0, maybe_announced_channel: true,
6790 ], blinded_tail: None }, Path { hops: vec![
6792 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
6793 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6794 short_channel_id: 0, fee_msat: 100, cltv_expiry_delta: 0, maybe_announced_channel: true,
6797 pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
6798 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
6799 short_channel_id: 0, fee_msat: 150, cltv_expiry_delta: 0, maybe_announced_channel: true,
6801 ], blinded_tail: None }],
6805 assert_eq!(route.get_total_fees(), 200);
6806 assert_eq!(route.get_total_amount(), 300);
6810 fn total_empty_route_no_panic() {
6811 // In an earlier version of `Route::get_total_fees` and `Route::get_total_amount`, they
6812 // would both panic if the route was completely empty. We test to ensure they return 0
6813 // here, even though its somewhat nonsensical as a route.
6814 let route = Route { paths: Vec::new(), route_params: None };
6816 assert_eq!(route.get_total_fees(), 0);
6817 assert_eq!(route.get_total_amount(), 0);
6821 fn limits_total_cltv_delta() {
6822 let (secp_ctx, network, _, _, logger) = build_graph();
6823 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6824 let network_graph = network.read_only();
6826 let scorer = ln_test_utils::TestScorer::new();
6828 // Make sure that generally there is at least one route available
6829 let feasible_max_total_cltv_delta = 1008;
6830 let feasible_payment_params = PaymentParameters::from_node_id(nodes[6], 0).with_route_hints(last_hops(&nodes)).unwrap()
6831 .with_max_total_cltv_expiry_delta(feasible_max_total_cltv_delta);
6832 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6833 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6834 let route_params = RouteParameters::from_payment_params_and_value(
6835 feasible_payment_params, 100);
6836 let route = get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger),
6837 &scorer, &Default::default(), &random_seed_bytes).unwrap();
6838 let path = route.paths[0].hops.iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
6839 assert_ne!(path.len(), 0);
6841 // But not if we exclude all paths on the basis of their accumulated CLTV delta
6842 let fail_max_total_cltv_delta = 23;
6843 let fail_payment_params = PaymentParameters::from_node_id(nodes[6], 0).with_route_hints(last_hops(&nodes)).unwrap()
6844 .with_max_total_cltv_expiry_delta(fail_max_total_cltv_delta);
6845 let route_params = RouteParameters::from_payment_params_and_value(
6846 fail_payment_params, 100);
6847 match get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger), &scorer,
6848 &Default::default(), &random_seed_bytes)
6850 Err(LightningError { err, .. } ) => {
6851 assert_eq!(err, "Failed to find a path to the given destination");
6853 Ok(_) => panic!("Expected error"),
6858 fn avoids_recently_failed_paths() {
6859 // Ensure that the router always avoids all of the `previously_failed_channels` channels by
6860 // randomly inserting channels into it until we can't find a route anymore.
6861 let (secp_ctx, network, _, _, logger) = build_graph();
6862 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6863 let network_graph = network.read_only();
6865 let scorer = ln_test_utils::TestScorer::new();
6866 let mut payment_params = PaymentParameters::from_node_id(nodes[6], 0).with_route_hints(last_hops(&nodes)).unwrap()
6867 .with_max_path_count(1);
6868 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6869 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6871 // We should be able to find a route initially, and then after we fail a few random
6872 // channels eventually we won't be able to any longer.
6873 let route_params = RouteParameters::from_payment_params_and_value(
6874 payment_params.clone(), 100);
6875 assert!(get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger),
6876 &scorer, &Default::default(), &random_seed_bytes).is_ok());
6878 let route_params = RouteParameters::from_payment_params_and_value(
6879 payment_params.clone(), 100);
6880 if let Ok(route) = get_route(&our_id, &route_params, &network_graph, None,
6881 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes)
6883 for chan in route.paths[0].hops.iter() {
6884 assert!(!payment_params.previously_failed_channels.contains(&chan.short_channel_id));
6886 let victim = (u64::from_ne_bytes(random_seed_bytes[0..8].try_into().unwrap()) as usize)
6887 % route.paths[0].hops.len();
6888 payment_params.previously_failed_channels.push(route.paths[0].hops[victim].short_channel_id);
6894 fn limits_path_length() {
6895 let (secp_ctx, network, _, _, logger) = build_line_graph();
6896 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6897 let network_graph = network.read_only();
6899 let scorer = ln_test_utils::TestScorer::new();
6900 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6901 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6903 // First check we can actually create a long route on this graph.
6904 let feasible_payment_params = PaymentParameters::from_node_id(nodes[18], 0);
6905 let route_params = RouteParameters::from_payment_params_and_value(
6906 feasible_payment_params, 100);
6907 let route = get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger),
6908 &scorer, &Default::default(), &random_seed_bytes).unwrap();
6909 let path = route.paths[0].hops.iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
6910 assert!(path.len() == MAX_PATH_LENGTH_ESTIMATE.into());
6912 // But we can't create a path surpassing the MAX_PATH_LENGTH_ESTIMATE limit.
6913 let fail_payment_params = PaymentParameters::from_node_id(nodes[19], 0);
6914 let route_params = RouteParameters::from_payment_params_and_value(
6915 fail_payment_params, 100);
6916 match get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger), &scorer,
6917 &Default::default(), &random_seed_bytes)
6919 Err(LightningError { err, .. } ) => {
6920 assert_eq!(err, "Failed to find a path to the given destination");
6922 Ok(_) => panic!("Expected error"),
6927 fn adds_and_limits_cltv_offset() {
6928 let (secp_ctx, network_graph, _, _, logger) = build_graph();
6929 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6931 let scorer = ln_test_utils::TestScorer::new();
6933 let payment_params = PaymentParameters::from_node_id(nodes[6], 42).with_route_hints(last_hops(&nodes)).unwrap();
6934 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
6935 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6936 let route_params = RouteParameters::from_payment_params_and_value(
6937 payment_params.clone(), 100);
6938 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
6939 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6940 assert_eq!(route.paths.len(), 1);
6942 let cltv_expiry_deltas_before = route.paths[0].hops.iter().map(|h| h.cltv_expiry_delta).collect::<Vec<u32>>();
6944 // Check whether the offset added to the last hop by default is in [1 .. DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA]
6945 let mut route_default = route.clone();
6946 add_random_cltv_offset(&mut route_default, &payment_params, &network_graph.read_only(), &random_seed_bytes);
6947 let cltv_expiry_deltas_default = route_default.paths[0].hops.iter().map(|h| h.cltv_expiry_delta).collect::<Vec<u32>>();
6948 assert_eq!(cltv_expiry_deltas_before.split_last().unwrap().1, cltv_expiry_deltas_default.split_last().unwrap().1);
6949 assert!(cltv_expiry_deltas_default.last() > cltv_expiry_deltas_before.last());
6950 assert!(cltv_expiry_deltas_default.last().unwrap() <= &DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA);
6952 // Check that no offset is added when we restrict the max_total_cltv_expiry_delta
6953 let mut route_limited = route.clone();
6954 let limited_max_total_cltv_expiry_delta = cltv_expiry_deltas_before.iter().sum();
6955 let limited_payment_params = payment_params.with_max_total_cltv_expiry_delta(limited_max_total_cltv_expiry_delta);
6956 add_random_cltv_offset(&mut route_limited, &limited_payment_params, &network_graph.read_only(), &random_seed_bytes);
6957 let cltv_expiry_deltas_limited = route_limited.paths[0].hops.iter().map(|h| h.cltv_expiry_delta).collect::<Vec<u32>>();
6958 assert_eq!(cltv_expiry_deltas_before, cltv_expiry_deltas_limited);
6962 fn adds_plausible_cltv_offset() {
6963 let (secp_ctx, network, _, _, logger) = build_graph();
6964 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
6965 let network_graph = network.read_only();
6966 let network_nodes = network_graph.nodes();
6967 let network_channels = network_graph.channels();
6968 let scorer = ln_test_utils::TestScorer::new();
6969 let payment_params = PaymentParameters::from_node_id(nodes[3], 0);
6970 let keys_manager = ln_test_utils::TestKeysInterface::new(&[4u8; 32], Network::Testnet);
6971 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6973 let route_params = RouteParameters::from_payment_params_and_value(
6974 payment_params.clone(), 100);
6975 let mut route = get_route(&our_id, &route_params, &network_graph, None,
6976 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes).unwrap();
6977 add_random_cltv_offset(&mut route, &payment_params, &network_graph, &random_seed_bytes);
6979 let mut path_plausibility = vec![];
6981 for p in route.paths {
6982 // 1. Select random observation point
6983 let mut prng = ChaCha20::new(&random_seed_bytes, &[0u8; 12]);
6984 let mut random_bytes = [0u8; ::core::mem::size_of::<usize>()];
6986 prng.process_in_place(&mut random_bytes);
6987 let random_path_index = usize::from_be_bytes(random_bytes).wrapping_rem(p.hops.len());
6988 let observation_point = NodeId::from_pubkey(&p.hops.get(random_path_index).unwrap().pubkey);
6990 // 2. Calculate what CLTV expiry delta we would observe there
6991 let observed_cltv_expiry_delta: u32 = p.hops[random_path_index..].iter().map(|h| h.cltv_expiry_delta).sum();
6993 // 3. Starting from the observation point, find candidate paths
6994 let mut candidates: VecDeque<(NodeId, Vec<u32>)> = VecDeque::new();
6995 candidates.push_back((observation_point, vec![]));
6997 let mut found_plausible_candidate = false;
6999 'candidate_loop: while let Some((cur_node_id, cur_path_cltv_deltas)) = candidates.pop_front() {
7000 if let Some(remaining) = observed_cltv_expiry_delta.checked_sub(cur_path_cltv_deltas.iter().sum::<u32>()) {
7001 if remaining == 0 || remaining.wrapping_rem(40) == 0 || remaining.wrapping_rem(144) == 0 {
7002 found_plausible_candidate = true;
7003 break 'candidate_loop;
7007 if let Some(cur_node) = network_nodes.get(&cur_node_id) {
7008 for channel_id in &cur_node.channels {
7009 if let Some(channel_info) = network_channels.get(&channel_id) {
7010 if let Some((dir_info, next_id)) = channel_info.as_directed_from(&cur_node_id) {
7011 let next_cltv_expiry_delta = dir_info.direction().cltv_expiry_delta as u32;
7012 if cur_path_cltv_deltas.iter().sum::<u32>()
7013 .saturating_add(next_cltv_expiry_delta) <= observed_cltv_expiry_delta {
7014 let mut new_path_cltv_deltas = cur_path_cltv_deltas.clone();
7015 new_path_cltv_deltas.push(next_cltv_expiry_delta);
7016 candidates.push_back((*next_id, new_path_cltv_deltas));
7024 path_plausibility.push(found_plausible_candidate);
7026 assert!(path_plausibility.iter().all(|x| *x));
7030 fn builds_correct_path_from_hops() {
7031 let (secp_ctx, network, _, _, logger) = build_graph();
7032 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7033 let network_graph = network.read_only();
7035 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7036 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7038 let payment_params = PaymentParameters::from_node_id(nodes[3], 0);
7039 let hops = [nodes[1], nodes[2], nodes[4], nodes[3]];
7040 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 100);
7041 let route = build_route_from_hops_internal(&our_id, &hops, &route_params, &network_graph,
7042 Arc::clone(&logger), &random_seed_bytes).unwrap();
7043 let route_hop_pubkeys = route.paths[0].hops.iter().map(|hop| hop.pubkey).collect::<Vec<_>>();
7044 assert_eq!(hops.len(), route.paths[0].hops.len());
7045 for (idx, hop_pubkey) in hops.iter().enumerate() {
7046 assert!(*hop_pubkey == route_hop_pubkeys[idx]);
7051 fn avoids_saturating_channels() {
7052 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
7053 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
7054 let decay_params = ProbabilisticScoringDecayParameters::default();
7055 let scorer = ProbabilisticScorer::new(decay_params, &*network_graph, Arc::clone(&logger));
7057 // Set the fee on channel 13 to 100% to match channel 4 giving us two equivalent paths (us
7058 // -> node 7 -> node2 and us -> node 1 -> node 2) which we should balance over.
7059 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
7060 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
7061 short_channel_id: 4,
7064 cltv_expiry_delta: (4 << 4) | 1,
7065 htlc_minimum_msat: 0,
7066 htlc_maximum_msat: 250_000_000,
7068 fee_proportional_millionths: 0,
7069 excess_data: Vec::new()
7071 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
7072 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
7073 short_channel_id: 13,
7076 cltv_expiry_delta: (13 << 4) | 1,
7077 htlc_minimum_msat: 0,
7078 htlc_maximum_msat: 250_000_000,
7080 fee_proportional_millionths: 0,
7081 excess_data: Vec::new()
7084 let config = UserConfig::default();
7085 let payment_params = PaymentParameters::from_node_id(nodes[2], 42)
7086 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
7088 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7089 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7090 // 100,000 sats is less than the available liquidity on each channel, set above.
7091 let route_params = RouteParameters::from_payment_params_and_value(
7092 payment_params, 100_000_000);
7093 let route = get_route(&our_id, &route_params, &network_graph.read_only(), None,
7094 Arc::clone(&logger), &scorer, &ProbabilisticScoringFeeParameters::default(), &random_seed_bytes).unwrap();
7095 assert_eq!(route.paths.len(), 2);
7096 assert!((route.paths[0].hops[1].short_channel_id == 4 && route.paths[1].hops[1].short_channel_id == 13) ||
7097 (route.paths[1].hops[1].short_channel_id == 4 && route.paths[0].hops[1].short_channel_id == 13));
7100 #[cfg(feature = "std")]
7101 pub(super) fn random_init_seed() -> u64 {
7102 // Because the default HashMap in std pulls OS randomness, we can use it as a (bad) RNG.
7103 use core::hash::{BuildHasher, Hasher};
7104 let seed = std::collections::hash_map::RandomState::new().build_hasher().finish();
7105 println!("Using seed of {}", seed);
7110 #[cfg(feature = "std")]
7111 fn generate_routes() {
7112 use crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters};
7114 let logger = ln_test_utils::TestLogger::new();
7115 let graph = match super::bench_utils::read_network_graph(&logger) {
7123 let params = ProbabilisticScoringFeeParameters::default();
7124 let mut scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), &graph, &logger);
7125 let features = super::Bolt11InvoiceFeatures::empty();
7127 super::bench_utils::generate_test_routes(&graph, &mut scorer, ¶ms, features, random_init_seed(), 0, 2);
7131 #[cfg(feature = "std")]
7132 fn generate_routes_mpp() {
7133 use crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters};
7135 let logger = ln_test_utils::TestLogger::new();
7136 let graph = match super::bench_utils::read_network_graph(&logger) {
7144 let params = ProbabilisticScoringFeeParameters::default();
7145 let mut scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), &graph, &logger);
7146 let features = channelmanager::provided_bolt11_invoice_features(&UserConfig::default());
7148 super::bench_utils::generate_test_routes(&graph, &mut scorer, ¶ms, features, random_init_seed(), 0, 2);
7152 #[cfg(feature = "std")]
7153 fn generate_large_mpp_routes() {
7154 use crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters};
7156 let logger = ln_test_utils::TestLogger::new();
7157 let graph = match super::bench_utils::read_network_graph(&logger) {
7165 let params = ProbabilisticScoringFeeParameters::default();
7166 let mut scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), &graph, &logger);
7167 let features = channelmanager::provided_bolt11_invoice_features(&UserConfig::default());
7169 super::bench_utils::generate_test_routes(&graph, &mut scorer, ¶ms, features, random_init_seed(), 1_000_000, 2);
7173 fn honors_manual_penalties() {
7174 let (secp_ctx, network_graph, _, _, logger) = build_line_graph();
7175 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7177 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7178 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7180 let mut scorer_params = ProbabilisticScoringFeeParameters::default();
7181 let scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), Arc::clone(&network_graph), Arc::clone(&logger));
7183 // First check set manual penalties are returned by the scorer.
7184 let usage = ChannelUsage {
7186 inflight_htlc_msat: 0,
7187 effective_capacity: EffectiveCapacity::Total { capacity_msat: 1_024_000, htlc_maximum_msat: 1_000 },
7189 scorer_params.set_manual_penalty(&NodeId::from_pubkey(&nodes[3]), 123);
7190 scorer_params.set_manual_penalty(&NodeId::from_pubkey(&nodes[4]), 456);
7191 let network_graph = network_graph.read_only();
7192 let channels = network_graph.channels();
7193 let channel = channels.get(&5).unwrap();
7194 let info = channel.as_directed_from(&NodeId::from_pubkey(&nodes[3])).unwrap();
7195 let candidate: CandidateRouteHop = CandidateRouteHop::PublicHop(PublicHopCandidate {
7197 short_channel_id: 5,
7199 assert_eq!(scorer.channel_penalty_msat(&candidate, usage, &scorer_params), 456);
7201 // Then check we can get a normal route
7202 let payment_params = PaymentParameters::from_node_id(nodes[10], 42);
7203 let route_params = RouteParameters::from_payment_params_and_value(
7204 payment_params, 100);
7205 let route = get_route(&our_id, &route_params, &network_graph, None,
7206 Arc::clone(&logger), &scorer, &scorer_params, &random_seed_bytes);
7207 assert!(route.is_ok());
7209 // Then check that we can't get a route if we ban an intermediate node.
7210 scorer_params.add_banned(&NodeId::from_pubkey(&nodes[3]));
7211 let route = get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger), &scorer, &scorer_params,&random_seed_bytes);
7212 assert!(route.is_err());
7214 // Finally make sure we can route again, when we remove the ban.
7215 scorer_params.remove_banned(&NodeId::from_pubkey(&nodes[3]));
7216 let route = get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger), &scorer, &scorer_params,&random_seed_bytes);
7217 assert!(route.is_ok());
7221 fn abide_by_route_hint_max_htlc() {
7222 // Check that we abide by any htlc_maximum_msat provided in the route hints of the payment
7223 // params in the final route.
7224 let (secp_ctx, network_graph, _, _, logger) = build_graph();
7225 let netgraph = network_graph.read_only();
7226 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7227 let scorer = ln_test_utils::TestScorer::new();
7228 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7229 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7230 let config = UserConfig::default();
7232 let max_htlc_msat = 50_000;
7233 let route_hint_1 = RouteHint(vec![RouteHintHop {
7234 src_node_id: nodes[2],
7235 short_channel_id: 42,
7238 proportional_millionths: 0,
7240 cltv_expiry_delta: 10,
7241 htlc_minimum_msat: None,
7242 htlc_maximum_msat: Some(max_htlc_msat),
7244 let dest_node_id = ln_test_utils::pubkey(42);
7245 let payment_params = PaymentParameters::from_node_id(dest_node_id, 42)
7246 .with_route_hints(vec![route_hint_1.clone()]).unwrap()
7247 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
7250 // Make sure we'll error if our route hints don't have enough liquidity according to their
7251 // htlc_maximum_msat.
7252 let mut route_params = RouteParameters::from_payment_params_and_value(
7253 payment_params, max_htlc_msat + 1);
7254 route_params.max_total_routing_fee_msat = None;
7255 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id,
7256 &route_params, &netgraph, None, Arc::clone(&logger), &scorer, &Default::default(),
7259 assert_eq!(err, "Failed to find a sufficient route to the given destination");
7260 } else { panic!(); }
7262 // Make sure we'll split an MPP payment across route hints if their htlc_maximum_msat warrants.
7263 let mut route_hint_2 = route_hint_1.clone();
7264 route_hint_2.0[0].short_channel_id = 43;
7265 let payment_params = PaymentParameters::from_node_id(dest_node_id, 42)
7266 .with_route_hints(vec![route_hint_1, route_hint_2]).unwrap()
7267 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
7269 let mut route_params = RouteParameters::from_payment_params_and_value(
7270 payment_params, max_htlc_msat + 1);
7271 route_params.max_total_routing_fee_msat = Some(max_htlc_msat * 2);
7272 let route = get_route(&our_id, &route_params, &netgraph, None, Arc::clone(&logger),
7273 &scorer, &Default::default(), &random_seed_bytes).unwrap();
7274 assert_eq!(route.paths.len(), 2);
7275 assert!(route.paths[0].hops.last().unwrap().fee_msat <= max_htlc_msat);
7276 assert!(route.paths[1].hops.last().unwrap().fee_msat <= max_htlc_msat);
7280 fn direct_channel_to_hints_with_max_htlc() {
7281 // Check that if we have a first hop channel peer that's connected to multiple provided route
7282 // hints, that we properly split the payment between the route hints if needed.
7283 let logger = Arc::new(ln_test_utils::TestLogger::new());
7284 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
7285 let scorer = ln_test_utils::TestScorer::new();
7286 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7287 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7288 let config = UserConfig::default();
7290 let our_node_id = ln_test_utils::pubkey(42);
7291 let intermed_node_id = ln_test_utils::pubkey(43);
7292 let first_hop = vec![get_channel_details(Some(42), intermed_node_id, InitFeatures::from_le_bytes(vec![0b11]), 10_000_000)];
7294 let amt_msat = 900_000;
7295 let max_htlc_msat = 500_000;
7296 let route_hint_1 = RouteHint(vec![RouteHintHop {
7297 src_node_id: intermed_node_id,
7298 short_channel_id: 44,
7301 proportional_millionths: 0,
7303 cltv_expiry_delta: 10,
7304 htlc_minimum_msat: None,
7305 htlc_maximum_msat: Some(max_htlc_msat),
7307 src_node_id: intermed_node_id,
7308 short_channel_id: 45,
7311 proportional_millionths: 0,
7313 cltv_expiry_delta: 10,
7314 htlc_minimum_msat: None,
7315 // Check that later route hint max htlcs don't override earlier ones
7316 htlc_maximum_msat: Some(max_htlc_msat - 50),
7318 let mut route_hint_2 = route_hint_1.clone();
7319 route_hint_2.0[0].short_channel_id = 46;
7320 route_hint_2.0[1].short_channel_id = 47;
7321 let dest_node_id = ln_test_utils::pubkey(44);
7322 let payment_params = PaymentParameters::from_node_id(dest_node_id, 42)
7323 .with_route_hints(vec![route_hint_1, route_hint_2]).unwrap()
7324 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config))
7327 let route_params = RouteParameters::from_payment_params_and_value(
7328 payment_params, amt_msat);
7329 let route = get_route(&our_node_id, &route_params, &network_graph.read_only(),
7330 Some(&first_hop.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
7331 &Default::default(), &random_seed_bytes).unwrap();
7332 assert_eq!(route.paths.len(), 2);
7333 assert!(route.paths[0].hops.last().unwrap().fee_msat <= max_htlc_msat);
7334 assert!(route.paths[1].hops.last().unwrap().fee_msat <= max_htlc_msat);
7335 assert_eq!(route.get_total_amount(), amt_msat);
7337 // Re-run but with two first hop channels connected to the same route hint peers that must be
7339 let first_hops = vec![
7340 get_channel_details(Some(42), intermed_node_id, InitFeatures::from_le_bytes(vec![0b11]), amt_msat - 10),
7341 get_channel_details(Some(43), intermed_node_id, InitFeatures::from_le_bytes(vec![0b11]), amt_msat - 10),
7343 let route = get_route(&our_node_id, &route_params, &network_graph.read_only(),
7344 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
7345 &Default::default(), &random_seed_bytes).unwrap();
7346 assert_eq!(route.paths.len(), 2);
7347 assert!(route.paths[0].hops.last().unwrap().fee_msat <= max_htlc_msat);
7348 assert!(route.paths[1].hops.last().unwrap().fee_msat <= max_htlc_msat);
7349 assert_eq!(route.get_total_amount(), amt_msat);
7351 // Make sure this works for blinded route hints.
7352 let blinded_path = BlindedPath {
7353 introduction_node: IntroductionNode::NodeId(intermed_node_id),
7354 blinding_point: ln_test_utils::pubkey(42),
7356 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42), encrypted_payload: vec![] },
7357 BlindedHop { blinded_node_id: ln_test_utils::pubkey(43), encrypted_payload: vec![] },
7360 let blinded_payinfo = BlindedPayInfo {
7362 fee_proportional_millionths: 0,
7363 htlc_minimum_msat: 1,
7364 htlc_maximum_msat: max_htlc_msat,
7365 cltv_expiry_delta: 10,
7366 features: BlindedHopFeatures::empty(),
7368 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
7369 let payment_params = PaymentParameters::blinded(vec![
7370 (blinded_payinfo.clone(), blinded_path.clone()),
7371 (blinded_payinfo.clone(), blinded_path.clone())])
7372 .with_bolt12_features(bolt12_features).unwrap();
7373 let route_params = RouteParameters::from_payment_params_and_value(
7374 payment_params, amt_msat);
7375 let route = get_route(&our_node_id, &route_params, &network_graph.read_only(),
7376 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
7377 &Default::default(), &random_seed_bytes).unwrap();
7378 assert_eq!(route.paths.len(), 2);
7379 assert!(route.paths[0].hops.last().unwrap().fee_msat <= max_htlc_msat);
7380 assert!(route.paths[1].hops.last().unwrap().fee_msat <= max_htlc_msat);
7381 assert_eq!(route.get_total_amount(), amt_msat);
7385 fn blinded_route_ser() {
7386 let blinded_path_1 = BlindedPath {
7387 introduction_node: IntroductionNode::NodeId(ln_test_utils::pubkey(42)),
7388 blinding_point: ln_test_utils::pubkey(43),
7390 BlindedHop { blinded_node_id: ln_test_utils::pubkey(44), encrypted_payload: Vec::new() },
7391 BlindedHop { blinded_node_id: ln_test_utils::pubkey(45), encrypted_payload: Vec::new() }
7394 let blinded_path_2 = BlindedPath {
7395 introduction_node: IntroductionNode::NodeId(ln_test_utils::pubkey(46)),
7396 blinding_point: ln_test_utils::pubkey(47),
7398 BlindedHop { blinded_node_id: ln_test_utils::pubkey(48), encrypted_payload: Vec::new() },
7399 BlindedHop { blinded_node_id: ln_test_utils::pubkey(49), encrypted_payload: Vec::new() }
7402 // (De)serialize a Route with 1 blinded path out of two total paths.
7403 let mut route = Route { paths: vec![Path {
7404 hops: vec![RouteHop {
7405 pubkey: ln_test_utils::pubkey(50),
7406 node_features: NodeFeatures::empty(),
7407 short_channel_id: 42,
7408 channel_features: ChannelFeatures::empty(),
7410 cltv_expiry_delta: 0,
7411 maybe_announced_channel: true,
7413 blinded_tail: Some(BlindedTail {
7414 hops: blinded_path_1.blinded_hops,
7415 blinding_point: blinded_path_1.blinding_point,
7416 excess_final_cltv_expiry_delta: 40,
7417 final_value_msat: 100,
7419 hops: vec![RouteHop {
7420 pubkey: ln_test_utils::pubkey(51),
7421 node_features: NodeFeatures::empty(),
7422 short_channel_id: 43,
7423 channel_features: ChannelFeatures::empty(),
7425 cltv_expiry_delta: 0,
7426 maybe_announced_channel: true,
7427 }], blinded_tail: None }],
7430 let encoded_route = route.encode();
7431 let decoded_route: Route = Readable::read(&mut Cursor::new(&encoded_route[..])).unwrap();
7432 assert_eq!(decoded_route.paths[0].blinded_tail, route.paths[0].blinded_tail);
7433 assert_eq!(decoded_route.paths[1].blinded_tail, route.paths[1].blinded_tail);
7435 // (De)serialize a Route with two paths, each containing a blinded tail.
7436 route.paths[1].blinded_tail = Some(BlindedTail {
7437 hops: blinded_path_2.blinded_hops,
7438 blinding_point: blinded_path_2.blinding_point,
7439 excess_final_cltv_expiry_delta: 41,
7440 final_value_msat: 101,
7442 let encoded_route = route.encode();
7443 let decoded_route: Route = Readable::read(&mut Cursor::new(&encoded_route[..])).unwrap();
7444 assert_eq!(decoded_route.paths[0].blinded_tail, route.paths[0].blinded_tail);
7445 assert_eq!(decoded_route.paths[1].blinded_tail, route.paths[1].blinded_tail);
7449 fn blinded_path_inflight_processing() {
7450 // Ensure we'll score the channel that's inbound to a blinded path's introduction node, and
7451 // account for the blinded tail's final amount_msat.
7452 let mut inflight_htlcs = InFlightHtlcs::new();
7453 let blinded_path = BlindedPath {
7454 introduction_node: IntroductionNode::NodeId(ln_test_utils::pubkey(43)),
7455 blinding_point: ln_test_utils::pubkey(48),
7456 blinded_hops: vec![BlindedHop { blinded_node_id: ln_test_utils::pubkey(49), encrypted_payload: Vec::new() }],
7459 hops: vec![RouteHop {
7460 pubkey: ln_test_utils::pubkey(42),
7461 node_features: NodeFeatures::empty(),
7462 short_channel_id: 42,
7463 channel_features: ChannelFeatures::empty(),
7465 cltv_expiry_delta: 0,
7466 maybe_announced_channel: false,
7469 pubkey: ln_test_utils::pubkey(43),
7470 node_features: NodeFeatures::empty(),
7471 short_channel_id: 43,
7472 channel_features: ChannelFeatures::empty(),
7474 cltv_expiry_delta: 0,
7475 maybe_announced_channel: false,
7477 blinded_tail: Some(BlindedTail {
7478 hops: blinded_path.blinded_hops,
7479 blinding_point: blinded_path.blinding_point,
7480 excess_final_cltv_expiry_delta: 0,
7481 final_value_msat: 200,
7484 inflight_htlcs.process_path(&path, ln_test_utils::pubkey(44));
7485 assert_eq!(*inflight_htlcs.0.get(&(42, true)).unwrap(), 301);
7486 assert_eq!(*inflight_htlcs.0.get(&(43, false)).unwrap(), 201);
7490 fn blinded_path_cltv_shadow_offset() {
7491 // Make sure we add a shadow offset when sending to blinded paths.
7492 let blinded_path = BlindedPath {
7493 introduction_node: IntroductionNode::NodeId(ln_test_utils::pubkey(43)),
7494 blinding_point: ln_test_utils::pubkey(44),
7496 BlindedHop { blinded_node_id: ln_test_utils::pubkey(45), encrypted_payload: Vec::new() },
7497 BlindedHop { blinded_node_id: ln_test_utils::pubkey(46), encrypted_payload: Vec::new() }
7500 let mut route = Route { paths: vec![Path {
7501 hops: vec![RouteHop {
7502 pubkey: ln_test_utils::pubkey(42),
7503 node_features: NodeFeatures::empty(),
7504 short_channel_id: 42,
7505 channel_features: ChannelFeatures::empty(),
7507 cltv_expiry_delta: 0,
7508 maybe_announced_channel: false,
7511 pubkey: ln_test_utils::pubkey(43),
7512 node_features: NodeFeatures::empty(),
7513 short_channel_id: 43,
7514 channel_features: ChannelFeatures::empty(),
7516 cltv_expiry_delta: 0,
7517 maybe_announced_channel: false,
7520 blinded_tail: Some(BlindedTail {
7521 hops: blinded_path.blinded_hops,
7522 blinding_point: blinded_path.blinding_point,
7523 excess_final_cltv_expiry_delta: 0,
7524 final_value_msat: 200,
7526 }], route_params: None};
7528 let payment_params = PaymentParameters::from_node_id(ln_test_utils::pubkey(47), 18);
7529 let (_, network_graph, _, _, _) = build_line_graph();
7530 add_random_cltv_offset(&mut route, &payment_params, &network_graph.read_only(), &[0; 32]);
7531 assert_eq!(route.paths[0].blinded_tail.as_ref().unwrap().excess_final_cltv_expiry_delta, 40);
7532 assert_eq!(route.paths[0].hops.last().unwrap().cltv_expiry_delta, 40);
7536 fn simple_blinded_route_hints() {
7537 do_simple_blinded_route_hints(1);
7538 do_simple_blinded_route_hints(2);
7539 do_simple_blinded_route_hints(3);
7542 fn do_simple_blinded_route_hints(num_blinded_hops: usize) {
7543 // Check that we can generate a route to a blinded path with the expected hops.
7544 let (secp_ctx, network, _, _, logger) = build_graph();
7545 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7546 let network_graph = network.read_only();
7548 let scorer = ln_test_utils::TestScorer::new();
7549 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7550 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7552 let mut blinded_path = BlindedPath {
7553 introduction_node: IntroductionNode::NodeId(nodes[2]),
7554 blinding_point: ln_test_utils::pubkey(42),
7555 blinded_hops: Vec::with_capacity(num_blinded_hops),
7557 for i in 0..num_blinded_hops {
7558 blinded_path.blinded_hops.push(
7559 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 + i as u8), encrypted_payload: Vec::new() },
7562 let blinded_payinfo = BlindedPayInfo {
7564 fee_proportional_millionths: 500,
7565 htlc_minimum_msat: 1000,
7566 htlc_maximum_msat: 100_000_000,
7567 cltv_expiry_delta: 15,
7568 features: BlindedHopFeatures::empty(),
7571 let payment_params = PaymentParameters::blinded(vec![(blinded_payinfo.clone(), blinded_path.clone())]);
7572 let route_params = RouteParameters::from_payment_params_and_value(
7573 payment_params, 1001);
7574 let route = get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger),
7575 &scorer, &Default::default(), &random_seed_bytes).unwrap();
7576 assert_eq!(route.paths.len(), 1);
7577 assert_eq!(route.paths[0].hops.len(), 2);
7579 let tail = route.paths[0].blinded_tail.as_ref().unwrap();
7580 assert_eq!(tail.hops, blinded_path.blinded_hops);
7581 assert_eq!(tail.excess_final_cltv_expiry_delta, 0);
7582 assert_eq!(tail.final_value_msat, 1001);
7584 let final_hop = route.paths[0].hops.last().unwrap();
7586 NodeId::from_pubkey(&final_hop.pubkey),
7587 *blinded_path.public_introduction_node_id(&network_graph).unwrap()
7589 if tail.hops.len() > 1 {
7590 assert_eq!(final_hop.fee_msat,
7591 blinded_payinfo.fee_base_msat as u64 + blinded_payinfo.fee_proportional_millionths as u64 * tail.final_value_msat / 1000000);
7592 assert_eq!(final_hop.cltv_expiry_delta, blinded_payinfo.cltv_expiry_delta as u32);
7594 assert_eq!(final_hop.fee_msat, 0);
7595 assert_eq!(final_hop.cltv_expiry_delta, 0);
7600 fn blinded_path_routing_errors() {
7601 // Check that we can generate a route to a blinded path with the expected hops.
7602 let (secp_ctx, network, _, _, logger) = build_graph();
7603 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7604 let network_graph = network.read_only();
7606 let scorer = ln_test_utils::TestScorer::new();
7607 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7608 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7610 let mut invalid_blinded_path = BlindedPath {
7611 introduction_node: IntroductionNode::NodeId(nodes[2]),
7612 blinding_point: ln_test_utils::pubkey(42),
7614 BlindedHop { blinded_node_id: ln_test_utils::pubkey(43), encrypted_payload: vec![0; 43] },
7617 let blinded_payinfo = BlindedPayInfo {
7619 fee_proportional_millionths: 500,
7620 htlc_minimum_msat: 1000,
7621 htlc_maximum_msat: 100_000_000,
7622 cltv_expiry_delta: 15,
7623 features: BlindedHopFeatures::empty(),
7626 let mut invalid_blinded_path_2 = invalid_blinded_path.clone();
7627 invalid_blinded_path_2.introduction_node = IntroductionNode::NodeId(ln_test_utils::pubkey(45));
7628 let payment_params = PaymentParameters::blinded(vec![
7629 (blinded_payinfo.clone(), invalid_blinded_path.clone()),
7630 (blinded_payinfo.clone(), invalid_blinded_path_2)]);
7631 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 1001);
7632 match get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger),
7633 &scorer, &Default::default(), &random_seed_bytes)
7635 Err(LightningError { err, .. }) => {
7636 assert_eq!(err, "1-hop blinded paths must all have matching introduction node ids");
7638 _ => panic!("Expected error")
7641 invalid_blinded_path.introduction_node = IntroductionNode::NodeId(our_id);
7642 let payment_params = PaymentParameters::blinded(vec![(blinded_payinfo.clone(), invalid_blinded_path.clone())]);
7643 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 1001);
7644 match get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger), &scorer,
7645 &Default::default(), &random_seed_bytes)
7647 Err(LightningError { err, .. }) => {
7648 assert_eq!(err, "Cannot generate a route to blinded paths if we are the introduction node to all of them");
7650 _ => panic!("Expected error")
7653 invalid_blinded_path.introduction_node = IntroductionNode::NodeId(ln_test_utils::pubkey(46));
7654 invalid_blinded_path.blinded_hops.clear();
7655 let payment_params = PaymentParameters::blinded(vec![(blinded_payinfo, invalid_blinded_path)]);
7656 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 1001);
7657 match get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger), &scorer,
7658 &Default::default(), &random_seed_bytes)
7660 Err(LightningError { err, .. }) => {
7661 assert_eq!(err, "0-hop blinded path provided");
7663 _ => panic!("Expected error")
7668 fn matching_intro_node_paths_provided() {
7669 // Check that if multiple blinded paths with the same intro node are provided in payment
7670 // parameters, we'll return the correct paths in the resulting MPP route.
7671 let (secp_ctx, network, _, _, logger) = build_graph();
7672 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7673 let network_graph = network.read_only();
7675 let scorer = ln_test_utils::TestScorer::new();
7676 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7677 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7678 let config = UserConfig::default();
7680 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
7681 let blinded_path_1 = BlindedPath {
7682 introduction_node: IntroductionNode::NodeId(nodes[2]),
7683 blinding_point: ln_test_utils::pubkey(42),
7685 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
7686 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
7689 let blinded_payinfo_1 = BlindedPayInfo {
7691 fee_proportional_millionths: 0,
7692 htlc_minimum_msat: 0,
7693 htlc_maximum_msat: 30_000,
7694 cltv_expiry_delta: 0,
7695 features: BlindedHopFeatures::empty(),
7698 let mut blinded_path_2 = blinded_path_1.clone();
7699 blinded_path_2.blinding_point = ln_test_utils::pubkey(43);
7700 let mut blinded_payinfo_2 = blinded_payinfo_1.clone();
7701 blinded_payinfo_2.htlc_maximum_msat = 70_000;
7703 let blinded_hints = vec![
7704 (blinded_payinfo_1.clone(), blinded_path_1.clone()),
7705 (blinded_payinfo_2.clone(), blinded_path_2.clone()),
7707 let payment_params = PaymentParameters::blinded(blinded_hints.clone())
7708 .with_bolt12_features(bolt12_features).unwrap();
7710 let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, 100_000);
7711 route_params.max_total_routing_fee_msat = Some(100_000);
7712 let route = get_route(&our_id, &route_params, &network_graph, None, Arc::clone(&logger),
7713 &scorer, &Default::default(), &random_seed_bytes).unwrap();
7714 assert_eq!(route.paths.len(), 2);
7715 let mut total_amount_paid_msat = 0;
7716 for path in route.paths.into_iter() {
7717 assert_eq!(path.hops.last().unwrap().pubkey, nodes[2]);
7718 if let Some(bt) = &path.blinded_tail {
7719 assert_eq!(bt.blinding_point,
7720 blinded_hints.iter().find(|(p, _)| p.htlc_maximum_msat == path.final_value_msat())
7721 .map(|(_, bp)| bp.blinding_point).unwrap());
7722 } else { panic!(); }
7723 total_amount_paid_msat += path.final_value_msat();
7725 assert_eq!(total_amount_paid_msat, 100_000);
7729 fn direct_to_intro_node() {
7730 // This previously caused a debug panic in the router when asserting
7731 // `used_liquidity_msat <= hop_max_msat`, because when adding first_hop<>blinded_route_hint
7732 // direct channels we failed to account for the fee charged for use of the blinded path.
7735 // node0 -1(1)2 - node1
7736 // such that there isn't enough liquidity to reach node1, but the router thinks there is if it
7737 // doesn't account for the blinded path fee.
7739 let secp_ctx = Secp256k1::new();
7740 let logger = Arc::new(ln_test_utils::TestLogger::new());
7741 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
7742 let gossip_sync = P2PGossipSync::new(Arc::clone(&network_graph), None, Arc::clone(&logger));
7743 let scorer = ln_test_utils::TestScorer::new();
7744 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7745 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7747 let amt_msat = 10_000_000;
7748 let (_, _, privkeys, nodes) = get_nodes(&secp_ctx);
7749 add_channel(&gossip_sync, &secp_ctx, &privkeys[0], &privkeys[1],
7750 ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 1);
7751 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
7752 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
7753 short_channel_id: 1,
7756 cltv_expiry_delta: 42,
7757 htlc_minimum_msat: 1_000,
7758 htlc_maximum_msat: 10_000_000,
7760 fee_proportional_millionths: 0,
7761 excess_data: Vec::new()
7763 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
7764 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
7765 short_channel_id: 1,
7768 cltv_expiry_delta: 42,
7769 htlc_minimum_msat: 1_000,
7770 htlc_maximum_msat: 10_000_000,
7772 fee_proportional_millionths: 0,
7773 excess_data: Vec::new()
7775 let first_hops = vec![
7776 get_channel_details(Some(1), nodes[1], InitFeatures::from_le_bytes(vec![0b11]), 10_000_000)];
7778 let blinded_path = BlindedPath {
7779 introduction_node: IntroductionNode::NodeId(nodes[1]),
7780 blinding_point: ln_test_utils::pubkey(42),
7782 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
7783 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
7786 let blinded_payinfo = BlindedPayInfo {
7787 fee_base_msat: 1000,
7788 fee_proportional_millionths: 0,
7789 htlc_minimum_msat: 1000,
7790 htlc_maximum_msat: MAX_VALUE_MSAT,
7791 cltv_expiry_delta: 0,
7792 features: BlindedHopFeatures::empty(),
7794 let blinded_hints = vec![(blinded_payinfo.clone(), blinded_path)];
7796 let payment_params = PaymentParameters::blinded(blinded_hints.clone());
7798 let netgraph = network_graph.read_only();
7799 let route_params = RouteParameters::from_payment_params_and_value(
7800 payment_params.clone(), amt_msat);
7801 if let Err(LightningError { err, .. }) = get_route(&nodes[0], &route_params, &netgraph,
7802 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
7803 &Default::default(), &random_seed_bytes) {
7804 assert_eq!(err, "Failed to find a path to the given destination");
7805 } else { panic!("Expected error") }
7807 // Sending an exact amount accounting for the blinded path fee works.
7808 let amt_minus_blinded_path_fee = amt_msat - blinded_payinfo.fee_base_msat as u64;
7809 let route_params = RouteParameters::from_payment_params_and_value(
7810 payment_params, amt_minus_blinded_path_fee);
7811 let route = get_route(&nodes[0], &route_params, &netgraph,
7812 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
7813 &Default::default(), &random_seed_bytes).unwrap();
7814 assert_eq!(route.get_total_fees(), blinded_payinfo.fee_base_msat as u64);
7815 assert_eq!(route.get_total_amount(), amt_minus_blinded_path_fee);
7819 fn direct_to_matching_intro_nodes() {
7820 // This previously caused us to enter `unreachable` code in the following situation:
7821 // 1. We add a route candidate for intro_node contributing a high amount
7822 // 2. We add a first_hop<>intro_node route candidate for the same high amount
7823 // 3. We see a cheaper blinded route hint for the same intro node but a much lower contribution
7824 // amount, and update our route candidate for intro_node for the lower amount
7825 // 4. We then attempt to update the aforementioned first_hop<>intro_node route candidate for the
7826 // lower contribution amount, but fail (this was previously caused by failure to account for
7827 // blinded path fees when adding first_hop<>intro_node candidates)
7828 // 5. We go to construct the path from these route candidates and our first_hop<>intro_node
7829 // candidate still thinks its path is contributing the original higher amount. This caused us
7830 // to hit an `unreachable` overflow when calculating the cheaper intro_node fees over the
7832 let secp_ctx = Secp256k1::new();
7833 let logger = Arc::new(ln_test_utils::TestLogger::new());
7834 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
7835 let scorer = ln_test_utils::TestScorer::new();
7836 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7837 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7838 let config = UserConfig::default();
7840 // Values are taken from the fuzz input that uncovered this panic.
7841 let amt_msat = 21_7020_5185_1403_2640;
7842 let (_, _, _, nodes) = get_nodes(&secp_ctx);
7843 let first_hops = vec![
7844 get_channel_details(Some(1), nodes[1], channelmanager::provided_init_features(&config),
7845 18446744073709551615)];
7847 let blinded_path = BlindedPath {
7848 introduction_node: IntroductionNode::NodeId(nodes[1]),
7849 blinding_point: ln_test_utils::pubkey(42),
7851 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
7852 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
7855 let blinded_payinfo = BlindedPayInfo {
7856 fee_base_msat: 5046_2720,
7857 fee_proportional_millionths: 0,
7858 htlc_minimum_msat: 4503_5996_2737_0496,
7859 htlc_maximum_msat: 45_0359_9627_3704_9600,
7860 cltv_expiry_delta: 0,
7861 features: BlindedHopFeatures::empty(),
7863 let mut blinded_hints = vec![
7864 (blinded_payinfo.clone(), blinded_path.clone()),
7865 (blinded_payinfo.clone(), blinded_path.clone()),
7867 blinded_hints[1].0.fee_base_msat = 419_4304;
7868 blinded_hints[1].0.fee_proportional_millionths = 257;
7869 blinded_hints[1].0.htlc_minimum_msat = 280_8908_6115_8400;
7870 blinded_hints[1].0.htlc_maximum_msat = 2_8089_0861_1584_0000;
7871 blinded_hints[1].0.cltv_expiry_delta = 0;
7873 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
7874 let payment_params = PaymentParameters::blinded(blinded_hints.clone())
7875 .with_bolt12_features(bolt12_features).unwrap();
7877 let netgraph = network_graph.read_only();
7878 let route_params = RouteParameters::from_payment_params_and_value(
7879 payment_params, amt_msat);
7880 let route = get_route(&nodes[0], &route_params, &netgraph,
7881 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
7882 &Default::default(), &random_seed_bytes).unwrap();
7883 assert_eq!(route.get_total_fees(), blinded_payinfo.fee_base_msat as u64);
7884 assert_eq!(route.get_total_amount(), amt_msat);
7888 fn we_are_intro_node_candidate_hops() {
7889 // This previously led to a panic in the router because we'd generate a Path with only a
7890 // BlindedTail and 0 unblinded hops, due to the only candidate hops being blinded route hints
7891 // where the origin node is the intro node. We now fully disallow considering candidate hops
7892 // where the origin node is the intro node.
7893 let (secp_ctx, network_graph, _, _, logger) = build_graph();
7894 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7895 let scorer = ln_test_utils::TestScorer::new();
7896 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7897 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7898 let config = UserConfig::default();
7900 // Values are taken from the fuzz input that uncovered this panic.
7901 let amt_msat = 21_7020_5185_1423_0019;
7903 let blinded_path = BlindedPath {
7904 introduction_node: IntroductionNode::NodeId(our_id),
7905 blinding_point: ln_test_utils::pubkey(42),
7907 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
7908 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
7911 let blinded_payinfo = BlindedPayInfo {
7912 fee_base_msat: 5052_9027,
7913 fee_proportional_millionths: 0,
7914 htlc_minimum_msat: 21_7020_5185_1423_0019,
7915 htlc_maximum_msat: 1844_6744_0737_0955_1615,
7916 cltv_expiry_delta: 0,
7917 features: BlindedHopFeatures::empty(),
7919 let mut blinded_hints = vec![
7920 (blinded_payinfo.clone(), blinded_path.clone()),
7921 (blinded_payinfo.clone(), blinded_path.clone()),
7923 blinded_hints[1].1.introduction_node = IntroductionNode::NodeId(nodes[6]);
7925 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
7926 let payment_params = PaymentParameters::blinded(blinded_hints.clone())
7927 .with_bolt12_features(bolt12_features.clone()).unwrap();
7929 let netgraph = network_graph.read_only();
7930 let route_params = RouteParameters::from_payment_params_and_value(
7931 payment_params, amt_msat);
7932 if let Err(LightningError { err, .. }) = get_route(
7933 &our_id, &route_params, &netgraph, None, Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes
7935 assert_eq!(err, "Failed to find a path to the given destination");
7940 fn we_are_intro_node_bp_in_final_path_fee_calc() {
7941 // This previously led to a debug panic in the router because we'd find an invalid Path with
7942 // 0 unblinded hops and a blinded tail, leading to the generation of a final
7943 // PaymentPathHop::fee_msat that included both the blinded path fees and the final value of
7944 // the payment, when it was intended to only include the final value of the payment.
7945 let (secp_ctx, network_graph, _, _, logger) = build_graph();
7946 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
7947 let scorer = ln_test_utils::TestScorer::new();
7948 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
7949 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7950 let config = UserConfig::default();
7952 // Values are taken from the fuzz input that uncovered this panic.
7953 let amt_msat = 21_7020_5185_1423_0019;
7955 let blinded_path = BlindedPath {
7956 introduction_node: IntroductionNode::NodeId(our_id),
7957 blinding_point: ln_test_utils::pubkey(42),
7959 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
7960 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
7963 let blinded_payinfo = BlindedPayInfo {
7964 fee_base_msat: 10_4425_1395,
7965 fee_proportional_millionths: 0,
7966 htlc_minimum_msat: 21_7301_9934_9094_0931,
7967 htlc_maximum_msat: 1844_6744_0737_0955_1615,
7968 cltv_expiry_delta: 0,
7969 features: BlindedHopFeatures::empty(),
7971 let mut blinded_hints = vec![
7972 (blinded_payinfo.clone(), blinded_path.clone()),
7973 (blinded_payinfo.clone(), blinded_path.clone()),
7974 (blinded_payinfo.clone(), blinded_path.clone()),
7976 blinded_hints[1].0.fee_base_msat = 5052_9027;
7977 blinded_hints[1].0.htlc_minimum_msat = 21_7020_5185_1423_0019;
7978 blinded_hints[1].0.htlc_maximum_msat = 1844_6744_0737_0955_1615;
7980 blinded_hints[2].1.introduction_node = IntroductionNode::NodeId(nodes[6]);
7982 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
7983 let payment_params = PaymentParameters::blinded(blinded_hints.clone())
7984 .with_bolt12_features(bolt12_features.clone()).unwrap();
7986 let netgraph = network_graph.read_only();
7987 let route_params = RouteParameters::from_payment_params_and_value(
7988 payment_params, amt_msat);
7989 if let Err(LightningError { err, .. }) = get_route(
7990 &our_id, &route_params, &netgraph, None, Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes
7992 assert_eq!(err, "Failed to find a path to the given destination");
7997 fn min_htlc_overpay_violates_max_htlc() {
7998 do_min_htlc_overpay_violates_max_htlc(true);
7999 do_min_htlc_overpay_violates_max_htlc(false);
8001 fn do_min_htlc_overpay_violates_max_htlc(blinded_payee: bool) {
8002 // Test that if overpaying to meet a later hop's min_htlc and causes us to violate an earlier
8003 // hop's max_htlc, we don't consider that candidate hop valid. Previously we would add this hop
8004 // to `targets` and build an invalid path with it, and subsequently hit a debug panic asserting
8005 // that the used liquidity for a hop was less than its available liquidity limit.
8006 let secp_ctx = Secp256k1::new();
8007 let logger = Arc::new(ln_test_utils::TestLogger::new());
8008 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
8009 let scorer = ln_test_utils::TestScorer::new();
8010 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
8011 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8012 let config = UserConfig::default();
8014 // Values are taken from the fuzz input that uncovered this panic.
8015 let amt_msat = 7_4009_8048;
8016 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
8017 let first_hop_outbound_capacity = 2_7345_2000;
8018 let first_hops = vec![get_channel_details(
8019 Some(200), nodes[0], channelmanager::provided_init_features(&config),
8020 first_hop_outbound_capacity
8023 let base_fee = 1_6778_3453;
8024 let htlc_min = 2_5165_8240;
8025 let payment_params = if blinded_payee {
8026 let blinded_path = BlindedPath {
8027 introduction_node: IntroductionNode::NodeId(nodes[0]),
8028 blinding_point: ln_test_utils::pubkey(42),
8030 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
8031 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
8034 let blinded_payinfo = BlindedPayInfo {
8035 fee_base_msat: base_fee,
8036 fee_proportional_millionths: 0,
8037 htlc_minimum_msat: htlc_min,
8038 htlc_maximum_msat: htlc_min * 1000,
8039 cltv_expiry_delta: 0,
8040 features: BlindedHopFeatures::empty(),
8042 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
8043 PaymentParameters::blinded(vec![(blinded_payinfo, blinded_path)])
8044 .with_bolt12_features(bolt12_features.clone()).unwrap()
8046 let route_hint = RouteHint(vec![RouteHintHop {
8047 src_node_id: nodes[0],
8048 short_channel_id: 42,
8050 base_msat: base_fee,
8051 proportional_millionths: 0,
8053 cltv_expiry_delta: 10,
8054 htlc_minimum_msat: Some(htlc_min),
8055 htlc_maximum_msat: None,
8058 PaymentParameters::from_node_id(nodes[1], 42)
8059 .with_route_hints(vec![route_hint]).unwrap()
8060 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config)).unwrap()
8063 let netgraph = network_graph.read_only();
8064 let route_params = RouteParameters::from_payment_params_and_value(
8065 payment_params, amt_msat);
8066 if let Err(LightningError { err, .. }) = get_route(
8067 &our_id, &route_params, &netgraph, Some(&first_hops.iter().collect::<Vec<_>>()),
8068 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes
8070 assert_eq!(err, "Failed to find a path to the given destination");
8075 fn previously_used_liquidity_violates_max_htlc() {
8076 do_previously_used_liquidity_violates_max_htlc(true);
8077 do_previously_used_liquidity_violates_max_htlc(false);
8080 fn do_previously_used_liquidity_violates_max_htlc(blinded_payee: bool) {
8081 // Test that if a candidate first_hop<>route_hint_src_node channel does not have enough
8082 // contribution amount to cover the next hop's min_htlc plus fees, we will not consider that
8083 // candidate. In this case, the candidate does not have enough due to a previous path taking up
8084 // some of its liquidity. Previously we would construct an invalid path and hit a debug panic
8085 // asserting that the used liquidity for a hop was less than its available liquidity limit.
8086 let secp_ctx = Secp256k1::new();
8087 let logger = Arc::new(ln_test_utils::TestLogger::new());
8088 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
8089 let scorer = ln_test_utils::TestScorer::new();
8090 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
8091 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8092 let config = UserConfig::default();
8094 // Values are taken from the fuzz input that uncovered this panic.
8095 let amt_msat = 52_4288;
8096 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
8097 let first_hops = vec![get_channel_details(
8098 Some(161), nodes[0], channelmanager::provided_init_features(&config), 486_4000
8099 ), get_channel_details(
8100 Some(122), nodes[0], channelmanager::provided_init_features(&config), 179_5000
8103 let base_fees = [0, 425_9840, 0, 0];
8104 let htlc_mins = [1_4392, 19_7401, 1027, 6_5535];
8105 let payment_params = if blinded_payee {
8106 let blinded_path = BlindedPath {
8107 introduction_node: IntroductionNode::NodeId(nodes[0]),
8108 blinding_point: ln_test_utils::pubkey(42),
8110 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
8111 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
8114 let mut blinded_hints = Vec::new();
8115 for (base_fee, htlc_min) in base_fees.iter().zip(htlc_mins.iter()) {
8116 blinded_hints.push((BlindedPayInfo {
8117 fee_base_msat: *base_fee,
8118 fee_proportional_millionths: 0,
8119 htlc_minimum_msat: *htlc_min,
8120 htlc_maximum_msat: htlc_min * 100,
8121 cltv_expiry_delta: 10,
8122 features: BlindedHopFeatures::empty(),
8123 }, blinded_path.clone()));
8125 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
8126 PaymentParameters::blinded(blinded_hints.clone())
8127 .with_bolt12_features(bolt12_features.clone()).unwrap()
8129 let mut route_hints = Vec::new();
8130 for (idx, (base_fee, htlc_min)) in base_fees.iter().zip(htlc_mins.iter()).enumerate() {
8131 route_hints.push(RouteHint(vec![RouteHintHop {
8132 src_node_id: nodes[0],
8133 short_channel_id: 42 + idx as u64,
8135 base_msat: *base_fee,
8136 proportional_millionths: 0,
8138 cltv_expiry_delta: 10,
8139 htlc_minimum_msat: Some(*htlc_min),
8140 htlc_maximum_msat: Some(htlc_min * 100),
8143 PaymentParameters::from_node_id(nodes[1], 42)
8144 .with_route_hints(route_hints).unwrap()
8145 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config)).unwrap()
8148 let netgraph = network_graph.read_only();
8149 let route_params = RouteParameters::from_payment_params_and_value(
8150 payment_params, amt_msat);
8152 let route = get_route(
8153 &our_id, &route_params, &netgraph, Some(&first_hops.iter().collect::<Vec<_>>()),
8154 Arc::clone(&logger), &scorer, &Default::default(), &random_seed_bytes
8156 assert_eq!(route.paths.len(), 1);
8157 assert_eq!(route.get_total_amount(), amt_msat);
8161 fn candidate_path_min() {
8162 // Test that if a candidate first_hop<>network_node channel does not have enough contribution
8163 // amount to cover the next channel's min htlc plus fees, we will not consider that candidate.
8164 // Previously, we were storing RouteGraphNodes with a path_min that did not include fees, and
8165 // would add a connecting first_hop node that did not have enough contribution amount, leading
8166 // to a debug panic upon invalid path construction.
8167 let secp_ctx = Secp256k1::new();
8168 let logger = Arc::new(ln_test_utils::TestLogger::new());
8169 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
8170 let gossip_sync = P2PGossipSync::new(network_graph.clone(), None, logger.clone());
8171 let scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), network_graph.clone(), logger.clone());
8172 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
8173 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8174 let config = UserConfig::default();
8176 // Values are taken from the fuzz input that uncovered this panic.
8177 let amt_msat = 7_4009_8048;
8178 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
8179 let first_hops = vec![get_channel_details(
8180 Some(200), nodes[0], channelmanager::provided_init_features(&config), 2_7345_2000
8183 add_channel(&gossip_sync, &secp_ctx, &privkeys[0], &privkeys[6], ChannelFeatures::from_le_bytes(id_to_feature_flags(6)), 6);
8184 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
8185 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
8186 short_channel_id: 6,
8189 cltv_expiry_delta: (6 << 4) | 0,
8190 htlc_minimum_msat: 0,
8191 htlc_maximum_msat: MAX_VALUE_MSAT,
8193 fee_proportional_millionths: 0,
8194 excess_data: Vec::new()
8196 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[0], NodeFeatures::from_le_bytes(id_to_feature_flags(1)), 0);
8198 let htlc_min = 2_5165_8240;
8199 let blinded_hints = vec![
8201 fee_base_msat: 1_6778_3453,
8202 fee_proportional_millionths: 0,
8203 htlc_minimum_msat: htlc_min,
8204 htlc_maximum_msat: htlc_min * 100,
8205 cltv_expiry_delta: 10,
8206 features: BlindedHopFeatures::empty(),
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() }
8216 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
8217 let payment_params = PaymentParameters::blinded(blinded_hints.clone())
8218 .with_bolt12_features(bolt12_features.clone()).unwrap();
8219 let route_params = RouteParameters::from_payment_params_and_value(
8220 payment_params, amt_msat);
8221 let netgraph = network_graph.read_only();
8223 if let Err(LightningError { err, .. }) = get_route(
8224 &our_id, &route_params, &netgraph, Some(&first_hops.iter().collect::<Vec<_>>()),
8225 Arc::clone(&logger), &scorer, &ProbabilisticScoringFeeParameters::default(),
8228 assert_eq!(err, "Failed to find a path to the given destination");
8233 fn path_contribution_includes_min_htlc_overpay() {
8234 // Previously, the fuzzer hit a debug panic because we wouldn't include the amount overpaid to
8235 // meet a last hop's min_htlc in the total collected paths value. We now include this value and
8236 // also penalize hops along the overpaying path to ensure that it gets deprioritized in path
8237 // selection, both tested here.
8238 let secp_ctx = Secp256k1::new();
8239 let logger = Arc::new(ln_test_utils::TestLogger::new());
8240 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
8241 let scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), network_graph.clone(), logger.clone());
8242 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
8243 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8244 let config = UserConfig::default();
8246 // Values are taken from the fuzz input that uncovered this panic.
8247 let amt_msat = 562_0000;
8248 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
8249 let first_hops = vec![
8250 get_channel_details(
8251 Some(83), nodes[0], channelmanager::provided_init_features(&config), 2199_0000,
8255 let htlc_mins = [49_0000, 1125_0000];
8256 let payment_params = {
8257 let blinded_path = BlindedPath {
8258 introduction_node: IntroductionNode::NodeId(nodes[0]),
8259 blinding_point: ln_test_utils::pubkey(42),
8261 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() },
8262 BlindedHop { blinded_node_id: ln_test_utils::pubkey(42 as u8), encrypted_payload: Vec::new() }
8265 let mut blinded_hints = Vec::new();
8266 for htlc_min in htlc_mins.iter() {
8267 blinded_hints.push((BlindedPayInfo {
8269 fee_proportional_millionths: 0,
8270 htlc_minimum_msat: *htlc_min,
8271 htlc_maximum_msat: *htlc_min * 100,
8272 cltv_expiry_delta: 10,
8273 features: BlindedHopFeatures::empty(),
8274 }, blinded_path.clone()));
8276 let bolt12_features = channelmanager::provided_bolt12_invoice_features(&config);
8277 PaymentParameters::blinded(blinded_hints.clone())
8278 .with_bolt12_features(bolt12_features.clone()).unwrap()
8281 let netgraph = network_graph.read_only();
8282 let route_params = RouteParameters::from_payment_params_and_value(
8283 payment_params, amt_msat);
8284 let route = get_route(
8285 &our_id, &route_params, &netgraph, Some(&first_hops.iter().collect::<Vec<_>>()),
8286 Arc::clone(&logger), &scorer, &ProbabilisticScoringFeeParameters::default(),
8289 assert_eq!(route.paths.len(), 1);
8290 assert_eq!(route.get_total_amount(), amt_msat);
8294 fn first_hop_preferred_over_hint() {
8295 // Check that if we have a first hop to a peer we'd always prefer that over a route hint
8296 // they gave us, but we'd still consider all subsequent hints if they are more attractive.
8297 let secp_ctx = Secp256k1::new();
8298 let logger = Arc::new(ln_test_utils::TestLogger::new());
8299 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
8300 let gossip_sync = P2PGossipSync::new(Arc::clone(&network_graph), None, Arc::clone(&logger));
8301 let scorer = ln_test_utils::TestScorer::new();
8302 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
8303 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8304 let config = UserConfig::default();
8306 let amt_msat = 1_000_000;
8307 let (our_privkey, our_node_id, privkeys, nodes) = get_nodes(&secp_ctx);
8309 add_channel(&gossip_sync, &secp_ctx, &our_privkey, &privkeys[0],
8310 ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 1);
8311 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
8312 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
8313 short_channel_id: 1,
8316 cltv_expiry_delta: 42,
8317 htlc_minimum_msat: 1_000,
8318 htlc_maximum_msat: 10_000_000,
8320 fee_proportional_millionths: 0,
8321 excess_data: Vec::new()
8323 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
8324 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
8325 short_channel_id: 1,
8328 cltv_expiry_delta: 42,
8329 htlc_minimum_msat: 1_000,
8330 htlc_maximum_msat: 10_000_000,
8332 fee_proportional_millionths: 0,
8333 excess_data: Vec::new()
8336 add_channel(&gossip_sync, &secp_ctx, &privkeys[0], &privkeys[1],
8337 ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 2);
8338 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
8339 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
8340 short_channel_id: 2,
8343 cltv_expiry_delta: 42,
8344 htlc_minimum_msat: 1_000,
8345 htlc_maximum_msat: 10_000_000,
8347 fee_proportional_millionths: 0,
8348 excess_data: Vec::new()
8350 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
8351 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
8352 short_channel_id: 2,
8355 cltv_expiry_delta: 42,
8356 htlc_minimum_msat: 1_000,
8357 htlc_maximum_msat: 10_000_000,
8359 fee_proportional_millionths: 0,
8360 excess_data: Vec::new()
8363 let dest_node_id = nodes[2];
8365 let route_hint = RouteHint(vec![RouteHintHop {
8366 src_node_id: our_node_id,
8367 short_channel_id: 44,
8370 proportional_millionths: 0,
8372 cltv_expiry_delta: 10,
8373 htlc_minimum_msat: None,
8374 htlc_maximum_msat: Some(5_000_000),
8377 src_node_id: nodes[0],
8378 short_channel_id: 45,
8381 proportional_millionths: 0,
8383 cltv_expiry_delta: 10,
8384 htlc_minimum_msat: None,
8385 htlc_maximum_msat: None,
8388 let payment_params = PaymentParameters::from_node_id(dest_node_id, 42)
8389 .with_route_hints(vec![route_hint]).unwrap()
8390 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config)).unwrap();
8391 let route_params = RouteParameters::from_payment_params_and_value(
8392 payment_params, amt_msat);
8394 // First create an insufficient first hop for channel with SCID 1 and check we'd use the
8396 let first_hop = get_channel_details(Some(1), nodes[0],
8397 channelmanager::provided_init_features(&config), 999_999);
8398 let first_hops = vec![first_hop];
8400 let route = get_route(&our_node_id, &route_params.clone(), &network_graph.read_only(),
8401 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
8402 &Default::default(), &random_seed_bytes).unwrap();
8403 assert_eq!(route.paths.len(), 1);
8404 assert_eq!(route.get_total_amount(), amt_msat);
8405 assert_eq!(route.paths[0].hops.len(), 2);
8406 assert_eq!(route.paths[0].hops[0].short_channel_id, 44);
8407 assert_eq!(route.paths[0].hops[1].short_channel_id, 45);
8408 assert_eq!(route.get_total_fees(), 123);
8410 // Now check we would trust our first hop info, i.e., fail if we detect the route hint is
8411 // for a first hop channel.
8412 let mut first_hop = get_channel_details(Some(1), nodes[0], channelmanager::provided_init_features(&config), 999_999);
8413 first_hop.outbound_scid_alias = Some(44);
8414 let first_hops = vec![first_hop];
8416 let route_res = get_route(&our_node_id, &route_params.clone(), &network_graph.read_only(),
8417 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
8418 &Default::default(), &random_seed_bytes);
8419 assert!(route_res.is_err());
8421 // Finally check we'd use the first hop if has sufficient outbound capacity. But we'd stil
8422 // use the cheaper second hop of the route hint.
8423 let mut first_hop = get_channel_details(Some(1), nodes[0],
8424 channelmanager::provided_init_features(&config), 10_000_000);
8425 first_hop.outbound_scid_alias = Some(44);
8426 let first_hops = vec![first_hop];
8428 let route = get_route(&our_node_id, &route_params.clone(), &network_graph.read_only(),
8429 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
8430 &Default::default(), &random_seed_bytes).unwrap();
8431 assert_eq!(route.paths.len(), 1);
8432 assert_eq!(route.get_total_amount(), amt_msat);
8433 assert_eq!(route.paths[0].hops.len(), 2);
8434 assert_eq!(route.paths[0].hops[0].short_channel_id, 1);
8435 assert_eq!(route.paths[0].hops[1].short_channel_id, 45);
8436 assert_eq!(route.get_total_fees(), 123);
8440 fn allow_us_being_first_hint() {
8441 // Check that we consider a route hint even if we are the src of the first hop.
8442 let secp_ctx = Secp256k1::new();
8443 let logger = Arc::new(ln_test_utils::TestLogger::new());
8444 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, Arc::clone(&logger)));
8445 let scorer = ln_test_utils::TestScorer::new();
8446 let keys_manager = ln_test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
8447 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8448 let config = UserConfig::default();
8450 let (_, our_node_id, _, nodes) = get_nodes(&secp_ctx);
8452 let amt_msat = 1_000_000;
8453 let dest_node_id = nodes[1];
8455 let first_hop = get_channel_details(Some(1), nodes[0], channelmanager::provided_init_features(&config), 10_000_000);
8456 let first_hops = vec![first_hop];
8458 let route_hint = RouteHint(vec![RouteHintHop {
8459 src_node_id: our_node_id,
8460 short_channel_id: 44,
8463 proportional_millionths: 0,
8465 cltv_expiry_delta: 10,
8466 htlc_minimum_msat: None,
8467 htlc_maximum_msat: None,
8470 let payment_params = PaymentParameters::from_node_id(dest_node_id, 42)
8471 .with_route_hints(vec![route_hint]).unwrap()
8472 .with_bolt11_features(channelmanager::provided_bolt11_invoice_features(&config)).unwrap();
8474 let route_params = RouteParameters::from_payment_params_and_value(
8475 payment_params, amt_msat);
8478 let route = get_route(&our_node_id, &route_params, &network_graph.read_only(),
8479 Some(&first_hops.iter().collect::<Vec<_>>()), Arc::clone(&logger), &scorer,
8480 &Default::default(), &random_seed_bytes).unwrap();
8482 assert_eq!(route.paths.len(), 1);
8483 assert_eq!(route.get_total_amount(), amt_msat);
8484 assert_eq!(route.get_total_fees(), 0);
8485 assert_eq!(route.paths[0].hops.len(), 1);
8487 assert_eq!(route.paths[0].hops[0].short_channel_id, 44);
8491 #[cfg(all(any(test, ldk_bench), feature = "std"))]
8492 pub(crate) mod bench_utils {
8495 use std::time::Duration;
8497 use bitcoin::hashes::Hash;
8498 use bitcoin::secp256k1::SecretKey;
8500 use crate::chain::transaction::OutPoint;
8501 use crate::routing::scoring::ScoreUpdate;
8502 use crate::sign::KeysManager;
8503 use crate::ln::types::ChannelId;
8504 use crate::ln::channelmanager::{self, ChannelCounterparty};
8505 use crate::util::config::UserConfig;
8506 use crate::util::test_utils::TestLogger;
8508 /// Tries to open a network graph file, or panics with a URL to fetch it.
8509 pub(crate) fn get_route_file() -> Result<std::fs::File, &'static str> {
8510 let res = File::open("net_graph-2023-01-18.bin") // By default we're run in RL/lightning
8511 .or_else(|_| File::open("lightning/net_graph-2023-01-18.bin")) // We may be run manually in RL/
8512 .or_else(|_| { // Fall back to guessing based on the binary location
8513 // path is likely something like .../rust-lightning/target/debug/deps/lightning-...
8514 let mut path = std::env::current_exe().unwrap();
8515 path.pop(); // lightning-...
8517 path.pop(); // debug
8518 path.pop(); // target
8519 path.push("lightning");
8520 path.push("net_graph-2023-01-18.bin");
8523 .or_else(|_| { // Fall back to guessing based on the binary location for a subcrate
8524 // path is likely something like .../rust-lightning/bench/target/debug/deps/bench..
8525 let mut path = std::env::current_exe().unwrap();
8526 path.pop(); // bench...
8528 path.pop(); // debug
8529 path.pop(); // target
8530 path.pop(); // bench
8531 path.push("lightning");
8532 path.push("net_graph-2023-01-18.bin");
8535 .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");
8536 #[cfg(require_route_graph_test)]
8537 return Ok(res.unwrap());
8538 #[cfg(not(require_route_graph_test))]
8542 pub(crate) fn read_network_graph(logger: &TestLogger) -> Result<NetworkGraph<&TestLogger>, &'static str> {
8543 get_route_file().map(|mut f| NetworkGraph::read(&mut f, logger).unwrap())
8546 pub(crate) fn payer_pubkey() -> PublicKey {
8547 let secp_ctx = Secp256k1::new();
8548 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap())
8552 pub(crate) fn first_hop(node_id: PublicKey) -> ChannelDetails {
8554 channel_id: ChannelId::new_zero(),
8555 counterparty: ChannelCounterparty {
8556 features: channelmanager::provided_init_features(&UserConfig::default()),
8558 unspendable_punishment_reserve: 0,
8559 forwarding_info: None,
8560 outbound_htlc_minimum_msat: None,
8561 outbound_htlc_maximum_msat: None,
8563 funding_txo: Some(OutPoint {
8564 txid: bitcoin::Txid::from_slice(&[0; 32]).unwrap(), index: 0
8567 short_channel_id: Some(1),
8568 inbound_scid_alias: None,
8569 outbound_scid_alias: None,
8570 channel_value_satoshis: 10_000_000_000,
8572 balance_msat: 10_000_000_000,
8573 outbound_capacity_msat: 10_000_000_000,
8574 next_outbound_htlc_minimum_msat: 0,
8575 next_outbound_htlc_limit_msat: 10_000_000_000,
8576 inbound_capacity_msat: 0,
8577 unspendable_punishment_reserve: None,
8578 confirmations_required: None,
8579 confirmations: None,
8580 force_close_spend_delay: None,
8582 is_channel_ready: true,
8585 inbound_htlc_minimum_msat: None,
8586 inbound_htlc_maximum_msat: None,
8588 feerate_sat_per_1000_weight: None,
8589 channel_shutdown_state: Some(channelmanager::ChannelShutdownState::NotShuttingDown),
8590 pending_inbound_htlcs: Vec::new(),
8591 pending_outbound_htlcs: Vec::new(),
8595 pub(crate) fn generate_test_routes<S: ScoreLookUp + ScoreUpdate>(graph: &NetworkGraph<&TestLogger>, scorer: &mut S,
8596 score_params: &S::ScoreParams, features: Bolt11InvoiceFeatures, mut seed: u64,
8597 starting_amount: u64, route_count: usize,
8598 ) -> Vec<(ChannelDetails, PaymentParameters, u64)> {
8599 let payer = payer_pubkey();
8600 let keys_manager = KeysManager::new(&[0u8; 32], 42, 42);
8601 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8603 let nodes = graph.read_only().nodes().clone();
8604 let mut route_endpoints = Vec::new();
8605 // Fetch 1.5x more routes than we need as after we do some scorer updates we may end up
8606 // with some routes we picked being un-routable.
8607 for _ in 0..route_count * 3 / 2 {
8609 seed = seed.overflowing_mul(6364136223846793005).0.overflowing_add(1).0;
8610 let src = PublicKey::from_slice(nodes.unordered_keys()
8611 .skip((seed as usize) % nodes.len()).next().unwrap().as_slice()).unwrap();
8612 seed = seed.overflowing_mul(6364136223846793005).0.overflowing_add(1).0;
8613 let dst = PublicKey::from_slice(nodes.unordered_keys()
8614 .skip((seed as usize) % nodes.len()).next().unwrap().as_slice()).unwrap();
8615 let params = PaymentParameters::from_node_id(dst, 42)
8616 .with_bolt11_features(features.clone()).unwrap();
8617 let first_hop = first_hop(src);
8618 let amt_msat = starting_amount + seed % 1_000_000;
8619 let route_params = RouteParameters::from_payment_params_and_value(
8620 params.clone(), amt_msat);
8622 get_route(&payer, &route_params, &graph.read_only(), Some(&[&first_hop]),
8623 &TestLogger::new(), scorer, score_params, &random_seed_bytes).is_ok();
8625 // ...and seed the scorer with success and failure data...
8626 seed = seed.overflowing_mul(6364136223846793005).0.overflowing_add(1).0;
8627 let mut score_amt = seed % 1_000_000_000;
8629 // Generate fail/success paths for a wider range of potential amounts with
8630 // MPP enabled to give us a chance to apply penalties for more potential
8632 let mpp_features = channelmanager::provided_bolt11_invoice_features(&UserConfig::default());
8633 let params = PaymentParameters::from_node_id(dst, 42)
8634 .with_bolt11_features(mpp_features).unwrap();
8635 let route_params = RouteParameters::from_payment_params_and_value(
8636 params.clone(), score_amt);
8637 let route_res = get_route(&payer, &route_params, &graph.read_only(),
8638 Some(&[&first_hop]), &TestLogger::new(), scorer, score_params,
8639 &random_seed_bytes);
8640 if let Ok(route) = route_res {
8641 for path in route.paths {
8642 if seed & 0x80 == 0 {
8643 scorer.payment_path_successful(&path, Duration::ZERO);
8645 let short_channel_id = path.hops[path.hops.len() / 2].short_channel_id;
8646 scorer.payment_path_failed(&path, short_channel_id, Duration::ZERO);
8648 seed = seed.overflowing_mul(6364136223846793005).0.overflowing_add(1).0;
8652 // If we couldn't find a path with a higher amount, reduce and try again.
8656 route_endpoints.push((first_hop, params, amt_msat));
8662 // Because we've changed channel scores, it's possible we'll take different routes to the
8663 // selected destinations, possibly causing us to fail because, eg, the newly-selected path
8664 // requires a too-high CLTV delta.
8665 route_endpoints.retain(|(first_hop, params, amt_msat)| {
8666 let route_params = RouteParameters::from_payment_params_and_value(
8667 params.clone(), *amt_msat);
8668 get_route(&payer, &route_params, &graph.read_only(), Some(&[first_hop]),
8669 &TestLogger::new(), scorer, score_params, &random_seed_bytes).is_ok()
8671 route_endpoints.truncate(route_count);
8672 assert_eq!(route_endpoints.len(), route_count);
8680 use crate::routing::scoring::{ScoreUpdate, ScoreLookUp};
8681 use crate::sign::{EntropySource, KeysManager};
8682 use crate::ln::channelmanager;
8683 use crate::ln::features::Bolt11InvoiceFeatures;
8684 use crate::routing::gossip::NetworkGraph;
8685 use crate::routing::scoring::{FixedPenaltyScorer, ProbabilisticScorer, ProbabilisticScoringFeeParameters, ProbabilisticScoringDecayParameters};
8686 use crate::util::config::UserConfig;
8687 use crate::util::logger::{Logger, Record};
8688 use crate::util::test_utils::TestLogger;
8690 use criterion::Criterion;
8692 struct DummyLogger {}
8693 impl Logger for DummyLogger {
8694 fn log(&self, _record: Record) {}
8697 pub fn generate_routes_with_zero_penalty_scorer(bench: &mut Criterion) {
8698 let logger = TestLogger::new();
8699 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8700 let scorer = FixedPenaltyScorer::with_penalty(0);
8701 generate_routes(bench, &network_graph, scorer, &Default::default(),
8702 Bolt11InvoiceFeatures::empty(), 0, "generate_routes_with_zero_penalty_scorer");
8705 pub fn generate_mpp_routes_with_zero_penalty_scorer(bench: &mut Criterion) {
8706 let logger = TestLogger::new();
8707 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8708 let scorer = FixedPenaltyScorer::with_penalty(0);
8709 generate_routes(bench, &network_graph, scorer, &Default::default(),
8710 channelmanager::provided_bolt11_invoice_features(&UserConfig::default()), 0,
8711 "generate_mpp_routes_with_zero_penalty_scorer");
8714 pub fn generate_routes_with_probabilistic_scorer(bench: &mut Criterion) {
8715 let logger = TestLogger::new();
8716 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8717 let params = ProbabilisticScoringFeeParameters::default();
8718 let scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), &network_graph, &logger);
8719 generate_routes(bench, &network_graph, scorer, ¶ms, Bolt11InvoiceFeatures::empty(), 0,
8720 "generate_routes_with_probabilistic_scorer");
8723 pub fn generate_mpp_routes_with_probabilistic_scorer(bench: &mut Criterion) {
8724 let logger = TestLogger::new();
8725 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8726 let params = ProbabilisticScoringFeeParameters::default();
8727 let scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), &network_graph, &logger);
8728 generate_routes(bench, &network_graph, scorer, ¶ms,
8729 channelmanager::provided_bolt11_invoice_features(&UserConfig::default()), 0,
8730 "generate_mpp_routes_with_probabilistic_scorer");
8733 pub fn generate_large_mpp_routes_with_probabilistic_scorer(bench: &mut Criterion) {
8734 let logger = TestLogger::new();
8735 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8736 let params = ProbabilisticScoringFeeParameters::default();
8737 let scorer = ProbabilisticScorer::new(ProbabilisticScoringDecayParameters::default(), &network_graph, &logger);
8738 generate_routes(bench, &network_graph, scorer, ¶ms,
8739 channelmanager::provided_bolt11_invoice_features(&UserConfig::default()), 100_000_000,
8740 "generate_large_mpp_routes_with_probabilistic_scorer");
8743 pub fn generate_routes_with_nonlinear_probabilistic_scorer(bench: &mut Criterion) {
8744 let logger = TestLogger::new();
8745 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8746 let mut params = ProbabilisticScoringFeeParameters::default();
8747 params.linear_success_probability = false;
8748 let scorer = ProbabilisticScorer::new(
8749 ProbabilisticScoringDecayParameters::default(), &network_graph, &logger);
8750 generate_routes(bench, &network_graph, scorer, ¶ms,
8751 channelmanager::provided_bolt11_invoice_features(&UserConfig::default()), 0,
8752 "generate_routes_with_nonlinear_probabilistic_scorer");
8755 pub fn generate_mpp_routes_with_nonlinear_probabilistic_scorer(bench: &mut Criterion) {
8756 let logger = TestLogger::new();
8757 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8758 let mut params = ProbabilisticScoringFeeParameters::default();
8759 params.linear_success_probability = false;
8760 let scorer = ProbabilisticScorer::new(
8761 ProbabilisticScoringDecayParameters::default(), &network_graph, &logger);
8762 generate_routes(bench, &network_graph, scorer, ¶ms,
8763 channelmanager::provided_bolt11_invoice_features(&UserConfig::default()), 0,
8764 "generate_mpp_routes_with_nonlinear_probabilistic_scorer");
8767 pub fn generate_large_mpp_routes_with_nonlinear_probabilistic_scorer(bench: &mut Criterion) {
8768 let logger = TestLogger::new();
8769 let network_graph = bench_utils::read_network_graph(&logger).unwrap();
8770 let mut params = ProbabilisticScoringFeeParameters::default();
8771 params.linear_success_probability = false;
8772 let scorer = ProbabilisticScorer::new(
8773 ProbabilisticScoringDecayParameters::default(), &network_graph, &logger);
8774 generate_routes(bench, &network_graph, scorer, ¶ms,
8775 channelmanager::provided_bolt11_invoice_features(&UserConfig::default()), 100_000_000,
8776 "generate_large_mpp_routes_with_nonlinear_probabilistic_scorer");
8779 fn generate_routes<S: ScoreLookUp + ScoreUpdate>(
8780 bench: &mut Criterion, graph: &NetworkGraph<&TestLogger>, mut scorer: S,
8781 score_params: &S::ScoreParams, features: Bolt11InvoiceFeatures, starting_amount: u64,
8782 bench_name: &'static str,
8784 let payer = bench_utils::payer_pubkey();
8785 let keys_manager = KeysManager::new(&[0u8; 32], 42, 42);
8786 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8788 // First, get 100 (source, destination) pairs for which route-getting actually succeeds...
8789 let route_endpoints = bench_utils::generate_test_routes(graph, &mut scorer, score_params, features, 0xdeadbeef, starting_amount, 50);
8791 // ...then benchmark finding paths between the nodes we learned.
8793 bench.bench_function(bench_name, |b| b.iter(|| {
8794 let (first_hop, params, amt) = &route_endpoints[idx % route_endpoints.len()];
8795 let route_params = RouteParameters::from_payment_params_and_value(params.clone(), *amt);
8796 assert!(get_route(&payer, &route_params, &graph.read_only(), Some(&[first_hop]),
8797 &DummyLogger{}, &scorer, score_params, &random_seed_bytes).is_ok());