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 top-level routing/network map tracking logic lives here.
12 //! You probably want to create a P2PGossipSync and use that as your RoutingMessageHandler and then
13 //! interrogate it to get routes for your own payments.
15 use bitcoin::secp256k1::PublicKey;
17 use ln::channelmanager::ChannelDetails;
18 use ln::features::{ChannelFeatures, InvoiceFeatures, NodeFeatures};
19 use ln::msgs::{DecodeError, ErrorAction, LightningError, MAX_VALUE_MSAT};
20 use routing::gossip::{DirectedChannelInfoWithUpdate, EffectiveCapacity, ReadOnlyNetworkGraph, NetworkGraph, NodeId, RoutingFees};
21 use routing::scoring::{ChannelUsage, Score};
22 use util::ser::{Writeable, Readable, Writer};
23 use util::logger::{Level, Logger};
24 use util::chacha20::ChaCha20;
28 use alloc::collections::BinaryHeap;
33 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
35 /// The node_id of the node at this hop.
36 pub pubkey: PublicKey,
37 /// The node_announcement features of the node at this hop. For the last hop, these may be
38 /// amended to match the features present in the invoice this node generated.
39 pub node_features: NodeFeatures,
40 /// The channel that should be used from the previous hop to reach this node.
41 pub short_channel_id: u64,
42 /// The channel_announcement features of the channel that should be used from the previous hop
43 /// to reach this node.
44 pub channel_features: ChannelFeatures,
45 /// The fee taken on this hop (for paying for the use of the *next* channel in the path).
46 /// For the last hop, this should be the full value of the payment (might be more than
47 /// requested if we had to match htlc_minimum_msat).
49 /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
50 /// expected at the destination, in excess of the current block height.
51 pub cltv_expiry_delta: u32,
54 impl_writeable_tlv_based!(RouteHop, {
55 (0, pubkey, required),
56 (2, node_features, required),
57 (4, short_channel_id, required),
58 (6, channel_features, required),
59 (8, fee_msat, required),
60 (10, cltv_expiry_delta, required),
63 /// A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
64 /// it can take multiple paths. Each path is composed of one or more hops through the network.
65 #[derive(Clone, Hash, PartialEq, Eq)]
67 /// The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
68 /// last RouteHop in each path must be the same. Each entry represents a list of hops, NOT
69 /// INCLUDING our own, where the last hop is the destination. Thus, this must always be at
70 /// least length one. While the maximum length of any given path is variable, keeping the length
71 /// of any path less or equal to 19 should currently ensure it is viable.
72 pub paths: Vec<Vec<RouteHop>>,
73 /// The `payment_params` parameter passed to [`find_route`].
74 /// This is used by `ChannelManager` to track information which may be required for retries,
75 /// provided back to you via [`Event::PaymentPathFailed`].
77 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
78 pub payment_params: Option<PaymentParameters>,
81 pub(crate) trait RoutePath {
82 /// Gets the fees for a given path, excluding any excess paid to the recipient.
83 fn get_path_fees(&self) -> u64;
85 impl RoutePath for Vec<RouteHop> {
86 fn get_path_fees(&self) -> u64 {
87 // Do not count last hop of each path since that's the full value of the payment
88 self.split_last().map(|(_, path_prefix)| path_prefix).unwrap_or(&[])
89 .iter().map(|hop| &hop.fee_msat)
95 /// Returns the total amount of fees paid on this [`Route`].
97 /// This doesn't include any extra payment made to the recipient, which can happen in excess of
98 /// the amount passed to [`find_route`]'s `params.final_value_msat`.
99 pub fn get_total_fees(&self) -> u64 {
100 self.paths.iter().map(|path| path.get_path_fees()).sum()
103 /// Returns the total amount paid on this [`Route`], excluding the fees.
104 pub fn get_total_amount(&self) -> u64 {
105 return self.paths.iter()
106 .map(|path| path.split_last().map(|(hop, _)| hop.fee_msat).unwrap_or(0))
111 const SERIALIZATION_VERSION: u8 = 1;
112 const MIN_SERIALIZATION_VERSION: u8 = 1;
114 impl Writeable for Route {
115 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
116 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
117 (self.paths.len() as u64).write(writer)?;
118 for hops in self.paths.iter() {
119 (hops.len() as u8).write(writer)?;
120 for hop in hops.iter() {
124 write_tlv_fields!(writer, {
125 (1, self.payment_params, option),
131 impl Readable for Route {
132 fn read<R: io::Read>(reader: &mut R) -> Result<Route, DecodeError> {
133 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
134 let path_count: u64 = Readable::read(reader)?;
135 let mut paths = Vec::with_capacity(cmp::min(path_count, 128) as usize);
136 for _ in 0..path_count {
137 let hop_count: u8 = Readable::read(reader)?;
138 let mut hops = Vec::with_capacity(hop_count as usize);
139 for _ in 0..hop_count {
140 hops.push(Readable::read(reader)?);
144 let mut payment_params = None;
145 read_tlv_fields!(reader, {
146 (1, payment_params, option),
148 Ok(Route { paths, payment_params })
152 /// Parameters needed to find a [`Route`].
154 /// Passed to [`find_route`] and [`build_route_from_hops`], but also provided in
155 /// [`Event::PaymentPathFailed`] for retrying a failed payment path.
157 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
158 #[derive(Clone, Debug)]
159 pub struct RouteParameters {
160 /// The parameters of the failed payment path.
161 pub payment_params: PaymentParameters,
163 /// The amount in msats sent on the failed payment path.
164 pub final_value_msat: u64,
166 /// The CLTV on the final hop of the failed payment path.
167 pub final_cltv_expiry_delta: u32,
170 impl_writeable_tlv_based!(RouteParameters, {
171 (0, payment_params, required),
172 (2, final_value_msat, required),
173 (4, final_cltv_expiry_delta, required),
176 /// Maximum total CTLV difference we allow for a full payment path.
177 pub const DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA: u32 = 1008;
179 /// Maximum number of paths we allow an (MPP) payment to have.
180 // The default limit is currently set rather arbitrary - there aren't any real fundamental path-count
181 // limits, but for now more than 10 paths likely carries too much one-path failure.
182 pub const DEFAULT_MAX_PATH_COUNT: u8 = 10;
184 // The median hop CLTV expiry delta currently seen in the network.
185 const MEDIAN_HOP_CLTV_EXPIRY_DELTA: u32 = 40;
187 // During routing, we only consider paths shorter than our maximum length estimate.
188 // In the legacy onion format, the maximum number of hops used to be a fixed value of 20.
189 // However, in the TLV onion format, there is no fixed maximum length, but the `hop_payloads`
190 // field is always 1300 bytes. As the `tlv_payload` for each hop may vary in length, we have to
191 // estimate how many hops the route may have so that it actually fits the `hop_payloads` field.
193 // We estimate 3+32 (payload length and HMAC) + 2+8 (amt_to_forward) + 2+4 (outgoing_cltv_value) +
194 // 2+8 (short_channel_id) = 61 bytes for each intermediate hop and 3+32
195 // (payload length and HMAC) + 2+8 (amt_to_forward) + 2+4 (outgoing_cltv_value) + 2+32+8
196 // (payment_secret and total_msat) = 93 bytes for the final hop.
197 // Since the length of the potentially included `payment_metadata` is unknown to us, we round
198 // down from (1300-93) / 61 = 19.78... to arrive at a conservative estimate of 19.
199 const MAX_PATH_LENGTH_ESTIMATE: u8 = 19;
201 /// The recipient of a payment.
202 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
203 pub struct PaymentParameters {
204 /// The node id of the payee.
205 pub payee_pubkey: PublicKey,
207 /// Features supported by the payee.
209 /// May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
210 /// does not contain any features.
212 /// [`for_keysend`]: Self::for_keysend
213 pub features: Option<InvoiceFeatures>,
215 /// Hints for routing to the payee, containing channels connecting the payee to public nodes.
216 pub route_hints: Vec<RouteHint>,
218 /// Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
219 pub expiry_time: Option<u64>,
221 /// The maximum total CLTV delta we accept for the route.
222 /// Defaults to [`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`].
223 pub max_total_cltv_expiry_delta: u32,
225 /// The maximum number of paths that may be used by (MPP) payments.
226 /// Defaults to [`DEFAULT_MAX_PATH_COUNT`].
227 pub max_path_count: u8,
229 /// Selects the maximum share of a channel's total capacity which will be sent over a channel,
230 /// as a power of 1/2. A higher value prefers to send the payment using more MPP parts whereas
231 /// a lower value prefers to send larger MPP parts, potentially saturating channels and
232 /// increasing failure probability for those paths.
234 /// Note that this restriction will be relaxed during pathfinding after paths which meet this
235 /// restriction have been found. While paths which meet this criteria will be searched for, it
236 /// is ultimately up to the scorer to select them over other paths.
238 /// A value of 0 will allow payments up to and including a channel's total announced usable
239 /// capacity, a value of one will only use up to half its capacity, two 1/4, etc.
242 pub max_channel_saturation_power_of_half: u8,
244 /// A list of SCIDs which this payment was previously attempted over and which caused the
245 /// payment to fail. Future attempts for the same payment shouldn't be relayed through any of
247 pub previously_failed_channels: Vec<u64>,
250 impl_writeable_tlv_based!(PaymentParameters, {
251 (0, payee_pubkey, required),
252 (1, max_total_cltv_expiry_delta, (default_value, DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA)),
253 (2, features, option),
254 (3, max_path_count, (default_value, DEFAULT_MAX_PATH_COUNT)),
255 (4, route_hints, vec_type),
256 (5, max_channel_saturation_power_of_half, (default_value, 1)),
257 (6, expiry_time, option),
258 (7, previously_failed_channels, vec_type),
261 impl PaymentParameters {
262 /// Creates a payee with the node id of the given `pubkey`.
263 pub fn from_node_id(payee_pubkey: PublicKey) -> Self {
269 max_total_cltv_expiry_delta: DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA,
270 max_path_count: DEFAULT_MAX_PATH_COUNT,
271 max_channel_saturation_power_of_half: 1,
272 previously_failed_channels: Vec::new(),
276 /// Creates a payee with the node id of the given `pubkey` to use for keysend payments.
277 pub fn for_keysend(payee_pubkey: PublicKey) -> Self {
278 Self::from_node_id(payee_pubkey).with_features(InvoiceFeatures::for_keysend())
281 /// Includes the payee's features.
283 /// (C-not exported) since bindings don't support move semantics
284 pub fn with_features(self, features: InvoiceFeatures) -> Self {
285 Self { features: Some(features), ..self }
288 /// Includes hints for routing to the payee.
290 /// (C-not exported) since bindings don't support move semantics
291 pub fn with_route_hints(self, route_hints: Vec<RouteHint>) -> Self {
292 Self { route_hints, ..self }
295 /// Includes a payment expiration in seconds relative to the UNIX epoch.
297 /// (C-not exported) since bindings don't support move semantics
298 pub fn with_expiry_time(self, expiry_time: u64) -> Self {
299 Self { expiry_time: Some(expiry_time), ..self }
302 /// Includes a limit for the total CLTV expiry delta which is considered during routing
304 /// (C-not exported) since bindings don't support move semantics
305 pub fn with_max_total_cltv_expiry_delta(self, max_total_cltv_expiry_delta: u32) -> Self {
306 Self { max_total_cltv_expiry_delta, ..self }
309 /// Includes a limit for the maximum number of payment paths that may be used.
311 /// (C-not exported) since bindings don't support move semantics
312 pub fn with_max_path_count(self, max_path_count: u8) -> Self {
313 Self { max_path_count, ..self }
316 /// Includes a limit for the maximum number of payment paths that may be used.
318 /// (C-not exported) since bindings don't support move semantics
319 pub fn with_max_channel_saturation_power_of_half(self, max_channel_saturation_power_of_half: u8) -> Self {
320 Self { max_channel_saturation_power_of_half, ..self }
324 /// A list of hops along a payment path terminating with a channel to the recipient.
325 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
326 pub struct RouteHint(pub Vec<RouteHintHop>);
328 impl Writeable for RouteHint {
329 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
330 (self.0.len() as u64).write(writer)?;
331 for hop in self.0.iter() {
338 impl Readable for RouteHint {
339 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
340 let hop_count: u64 = Readable::read(reader)?;
341 let mut hops = Vec::with_capacity(cmp::min(hop_count, 16) as usize);
342 for _ in 0..hop_count {
343 hops.push(Readable::read(reader)?);
349 /// A channel descriptor for a hop along a payment path.
350 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
351 pub struct RouteHintHop {
352 /// The node_id of the non-target end of the route
353 pub src_node_id: PublicKey,
354 /// The short_channel_id of this channel
355 pub short_channel_id: u64,
356 /// The fees which must be paid to use this channel
357 pub fees: RoutingFees,
358 /// The difference in CLTV values between this node and the next node.
359 pub cltv_expiry_delta: u16,
360 /// The minimum value, in msat, which must be relayed to the next hop.
361 pub htlc_minimum_msat: Option<u64>,
362 /// The maximum value in msat available for routing with a single HTLC.
363 pub htlc_maximum_msat: Option<u64>,
366 impl_writeable_tlv_based!(RouteHintHop, {
367 (0, src_node_id, required),
368 (1, htlc_minimum_msat, option),
369 (2, short_channel_id, required),
370 (3, htlc_maximum_msat, option),
372 (6, cltv_expiry_delta, required),
375 #[derive(Eq, PartialEq)]
376 struct RouteGraphNode {
378 lowest_fee_to_peer_through_node: u64,
379 lowest_fee_to_node: u64,
380 total_cltv_delta: u32,
381 // The maximum value a yet-to-be-constructed payment path might flow through this node.
382 // This value is upper-bounded by us by:
383 // - how much is needed for a path being constructed
384 // - how much value can channels following this node (up to the destination) can contribute,
385 // considering their capacity and fees
386 value_contribution_msat: u64,
387 /// The effective htlc_minimum_msat at this hop. If a later hop on the path had a higher HTLC
388 /// minimum, we use it, plus the fees required at each earlier hop to meet it.
389 path_htlc_minimum_msat: u64,
390 /// All penalties incurred from this hop on the way to the destination, as calculated using
392 path_penalty_msat: u64,
393 /// The number of hops walked up to this node.
394 path_length_to_node: u8,
397 impl cmp::Ord for RouteGraphNode {
398 fn cmp(&self, other: &RouteGraphNode) -> cmp::Ordering {
399 let other_score = cmp::max(other.lowest_fee_to_peer_through_node, other.path_htlc_minimum_msat)
400 .saturating_add(other.path_penalty_msat);
401 let self_score = cmp::max(self.lowest_fee_to_peer_through_node, self.path_htlc_minimum_msat)
402 .saturating_add(self.path_penalty_msat);
403 other_score.cmp(&self_score).then_with(|| other.node_id.cmp(&self.node_id))
407 impl cmp::PartialOrd for RouteGraphNode {
408 fn partial_cmp(&self, other: &RouteGraphNode) -> Option<cmp::Ordering> {
409 Some(self.cmp(other))
413 /// A wrapper around the various hop representations.
415 /// Used to construct a [`PathBuildingHop`] and to estimate [`EffectiveCapacity`].
416 #[derive(Clone, Debug)]
417 enum CandidateRouteHop<'a> {
418 /// A hop from the payer, where the outbound liquidity is known.
420 details: &'a ChannelDetails,
422 /// A hop found in the [`ReadOnlyNetworkGraph`], where the channel capacity may be unknown.
424 info: DirectedChannelInfoWithUpdate<'a>,
425 short_channel_id: u64,
427 /// A hop to the payee found in the payment invoice, though not necessarily a direct channel.
429 hint: &'a RouteHintHop,
433 impl<'a> CandidateRouteHop<'a> {
434 fn short_channel_id(&self) -> u64 {
436 CandidateRouteHop::FirstHop { details } => details.get_outbound_payment_scid().unwrap(),
437 CandidateRouteHop::PublicHop { short_channel_id, .. } => *short_channel_id,
438 CandidateRouteHop::PrivateHop { hint } => hint.short_channel_id,
442 // NOTE: This may alloc memory so avoid calling it in a hot code path.
443 fn features(&self) -> ChannelFeatures {
445 CandidateRouteHop::FirstHop { details } => details.counterparty.features.to_context(),
446 CandidateRouteHop::PublicHop { info, .. } => info.channel().features.clone(),
447 CandidateRouteHop::PrivateHop { .. } => ChannelFeatures::empty(),
451 fn cltv_expiry_delta(&self) -> u32 {
453 CandidateRouteHop::FirstHop { .. } => 0,
454 CandidateRouteHop::PublicHop { info, .. } => info.direction().cltv_expiry_delta as u32,
455 CandidateRouteHop::PrivateHop { hint } => hint.cltv_expiry_delta as u32,
459 fn htlc_minimum_msat(&self) -> u64 {
461 CandidateRouteHop::FirstHop { .. } => 0,
462 CandidateRouteHop::PublicHop { info, .. } => info.direction().htlc_minimum_msat,
463 CandidateRouteHop::PrivateHop { hint } => hint.htlc_minimum_msat.unwrap_or(0),
467 fn fees(&self) -> RoutingFees {
469 CandidateRouteHop::FirstHop { .. } => RoutingFees {
470 base_msat: 0, proportional_millionths: 0,
472 CandidateRouteHop::PublicHop { info, .. } => info.direction().fees,
473 CandidateRouteHop::PrivateHop { hint } => hint.fees,
477 fn effective_capacity(&self) -> EffectiveCapacity {
479 CandidateRouteHop::FirstHop { details } => EffectiveCapacity::ExactLiquidity {
480 liquidity_msat: details.next_outbound_htlc_limit_msat,
482 CandidateRouteHop::PublicHop { info, .. } => info.effective_capacity(),
483 CandidateRouteHop::PrivateHop { .. } => EffectiveCapacity::Infinite,
489 fn max_htlc_from_capacity(capacity: EffectiveCapacity, max_channel_saturation_power_of_half: u8) -> u64 {
490 let saturation_shift: u32 = max_channel_saturation_power_of_half as u32;
492 EffectiveCapacity::ExactLiquidity { liquidity_msat } => liquidity_msat,
493 EffectiveCapacity::Infinite => u64::max_value(),
494 EffectiveCapacity::Unknown => EffectiveCapacity::Unknown.as_msat(),
495 EffectiveCapacity::MaximumHTLC { amount_msat } =>
496 amount_msat.checked_shr(saturation_shift).unwrap_or(0),
497 EffectiveCapacity::Total { capacity_msat, htlc_maximum_msat: None } =>
498 capacity_msat.checked_shr(saturation_shift).unwrap_or(0),
499 EffectiveCapacity::Total { capacity_msat, htlc_maximum_msat: Some(htlc_max) } =>
500 cmp::min(capacity_msat.checked_shr(saturation_shift).unwrap_or(0), htlc_max),
504 fn iter_equal<I1: Iterator, I2: Iterator>(mut iter_a: I1, mut iter_b: I2)
505 -> bool where I1::Item: PartialEq<I2::Item> {
507 let a = iter_a.next();
508 let b = iter_b.next();
509 if a.is_none() && b.is_none() { return true; }
510 if a.is_none() || b.is_none() { return false; }
511 if a.unwrap().ne(&b.unwrap()) { return false; }
515 /// It's useful to keep track of the hops associated with the fees required to use them,
516 /// so that we can choose cheaper paths (as per Dijkstra's algorithm).
517 /// Fee values should be updated only in the context of the whole path, see update_value_and_recompute_fees.
518 /// These fee values are useful to choose hops as we traverse the graph "payee-to-payer".
520 struct PathBuildingHop<'a> {
521 // Note that this should be dropped in favor of loading it from CandidateRouteHop, but doing so
522 // is a larger refactor and will require careful performance analysis.
524 candidate: CandidateRouteHop<'a>,
527 /// Minimal fees required to route to the source node of the current hop via any of its inbound channels.
528 src_lowest_inbound_fees: RoutingFees,
529 /// All the fees paid *after* this channel on the way to the destination
530 next_hops_fee_msat: u64,
531 /// Fee paid for the use of the current channel (see candidate.fees()).
532 /// The value will be actually deducted from the counterparty balance on the previous link.
533 hop_use_fee_msat: u64,
534 /// Used to compare channels when choosing the for routing.
535 /// Includes paying for the use of a hop and the following hops, as well as
536 /// an estimated cost of reaching this hop.
537 /// Might get stale when fees are recomputed. Primarily for internal use.
539 /// A mirror of the same field in RouteGraphNode. Note that this is only used during the graph
540 /// walk and may be invalid thereafter.
541 path_htlc_minimum_msat: u64,
542 /// All penalties incurred from this channel on the way to the destination, as calculated using
544 path_penalty_msat: u64,
545 /// If we've already processed a node as the best node, we shouldn't process it again. Normally
546 /// we'd just ignore it if we did as all channels would have a higher new fee, but because we
547 /// may decrease the amounts in use as we walk the graph, the actual calculated fee may
548 /// decrease as well. Thus, we have to explicitly track which nodes have been processed and
549 /// avoid processing them again.
551 #[cfg(all(not(feature = "_bench_unstable"), any(test, fuzzing)))]
552 // In tests, we apply further sanity checks on cases where we skip nodes we already processed
553 // to ensure it is specifically in cases where the fee has gone down because of a decrease in
554 // value_contribution_msat, which requires tracking it here. See comments below where it is
555 // used for more info.
556 value_contribution_msat: u64,
559 impl<'a> core::fmt::Debug for PathBuildingHop<'a> {
560 fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
561 let mut debug_struct = f.debug_struct("PathBuildingHop");
563 .field("node_id", &self.node_id)
564 .field("short_channel_id", &self.candidate.short_channel_id())
565 .field("total_fee_msat", &self.total_fee_msat)
566 .field("next_hops_fee_msat", &self.next_hops_fee_msat)
567 .field("hop_use_fee_msat", &self.hop_use_fee_msat)
568 .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)))
569 .field("path_penalty_msat", &self.path_penalty_msat)
570 .field("path_htlc_minimum_msat", &self.path_htlc_minimum_msat)
571 .field("cltv_expiry_delta", &self.candidate.cltv_expiry_delta());
572 #[cfg(all(not(feature = "_bench_unstable"), any(test, fuzzing)))]
573 let debug_struct = debug_struct
574 .field("value_contribution_msat", &self.value_contribution_msat);
575 debug_struct.finish()
579 // Instantiated with a list of hops with correct data in them collected during path finding,
580 // an instance of this struct should be further modified only via given methods.
582 struct PaymentPath<'a> {
583 hops: Vec<(PathBuildingHop<'a>, NodeFeatures)>,
586 impl<'a> PaymentPath<'a> {
587 // TODO: Add a value_msat field to PaymentPath and use it instead of this function.
588 fn get_value_msat(&self) -> u64 {
589 self.hops.last().unwrap().0.fee_msat
592 fn get_path_penalty_msat(&self) -> u64 {
593 self.hops.first().map(|h| h.0.path_penalty_msat).unwrap_or(u64::max_value())
596 fn get_total_fee_paid_msat(&self) -> u64 {
597 if self.hops.len() < 1 {
601 // Can't use next_hops_fee_msat because it gets outdated.
602 for (i, (hop, _)) in self.hops.iter().enumerate() {
603 if i != self.hops.len() - 1 {
604 result += hop.fee_msat;
610 fn get_cost_msat(&self) -> u64 {
611 self.get_total_fee_paid_msat().saturating_add(self.get_path_penalty_msat())
614 // If the amount transferred by the path is updated, the fees should be adjusted. Any other way
615 // to change fees may result in an inconsistency.
617 // Sometimes we call this function right after constructing a path which is inconsistent in
618 // that it the value being transferred has decreased while we were doing path finding, leading
619 // to the fees being paid not lining up with the actual limits.
621 // Note that this function is not aware of the available_liquidity limit, and thus does not
622 // support increasing the value being transferred beyond what was selected during the initial
624 fn update_value_and_recompute_fees(&mut self, value_msat: u64) {
625 let mut total_fee_paid_msat = 0 as u64;
626 for i in (0..self.hops.len()).rev() {
627 let last_hop = i == self.hops.len() - 1;
629 // For non-last-hop, this value will represent the fees paid on the current hop. It
630 // will consist of the fees for the use of the next hop, and extra fees to match
631 // htlc_minimum_msat of the current channel. Last hop is handled separately.
632 let mut cur_hop_fees_msat = 0;
634 cur_hop_fees_msat = self.hops.get(i + 1).unwrap().0.hop_use_fee_msat;
637 let mut cur_hop = &mut self.hops.get_mut(i).unwrap().0;
638 cur_hop.next_hops_fee_msat = total_fee_paid_msat;
639 // Overpay in fees if we can't save these funds due to htlc_minimum_msat.
640 // We try to account for htlc_minimum_msat in scoring (add_entry!), so that nodes don't
641 // set it too high just to maliciously take more fees by exploiting this
642 // match htlc_minimum_msat logic.
643 let mut cur_hop_transferred_amount_msat = total_fee_paid_msat + value_msat;
644 if let Some(extra_fees_msat) = cur_hop.candidate.htlc_minimum_msat().checked_sub(cur_hop_transferred_amount_msat) {
645 // Note that there is a risk that *previous hops* (those closer to us, as we go
646 // payee->our_node here) would exceed their htlc_maximum_msat or available balance.
648 // This might make us end up with a broken route, although this should be super-rare
649 // in practice, both because of how healthy channels look like, and how we pick
650 // channels in add_entry.
651 // Also, this can't be exploited more heavily than *announce a free path and fail
653 cur_hop_transferred_amount_msat += extra_fees_msat;
654 total_fee_paid_msat += extra_fees_msat;
655 cur_hop_fees_msat += extra_fees_msat;
659 // Final hop is a special case: it usually has just value_msat (by design), but also
660 // it still could overpay for the htlc_minimum_msat.
661 cur_hop.fee_msat = cur_hop_transferred_amount_msat;
663 // Propagate updated fees for the use of the channels to one hop back, where they
664 // will be actually paid (fee_msat). The last hop is handled above separately.
665 cur_hop.fee_msat = cur_hop_fees_msat;
668 // Fee for the use of the current hop which will be deducted on the previous hop.
669 // Irrelevant for the first hop, as it doesn't have the previous hop, and the use of
670 // this channel is free for us.
672 if let Some(new_fee) = compute_fees(cur_hop_transferred_amount_msat, cur_hop.candidate.fees()) {
673 cur_hop.hop_use_fee_msat = new_fee;
674 total_fee_paid_msat += new_fee;
676 // It should not be possible because this function is called only to reduce the
677 // value. In that case, compute_fee was already called with the same fees for
678 // larger amount and there was no overflow.
686 fn compute_fees(amount_msat: u64, channel_fees: RoutingFees) -> Option<u64> {
687 let proportional_fee_millions =
688 amount_msat.checked_mul(channel_fees.proportional_millionths as u64);
689 if let Some(new_fee) = proportional_fee_millions.and_then(|part| {
690 (channel_fees.base_msat as u64).checked_add(part / 1_000_000) }) {
694 // This function may be (indirectly) called without any verification,
695 // with channel_fees provided by a caller. We should handle it gracefully.
700 /// The default `features` we assume for a node in a route, when no `features` are known about that
703 /// Default features are:
704 /// * variable_length_onion_optional
705 fn default_node_features() -> NodeFeatures {
706 let mut features = NodeFeatures::empty();
707 features.set_variable_length_onion_optional();
711 /// Finds a route from us (payer) to the given target node (payee).
713 /// If the payee provided features in their invoice, they should be provided via `params.payee`.
714 /// Without this, MPP will only be used if the payee's features are available in the network graph.
716 /// Private routing paths between a public node and the target may be included in `params.payee`.
718 /// If some channels aren't announced, it may be useful to fill in `first_hops` with the results
719 /// from [`ChannelManager::list_usable_channels`]. If it is filled in, the view of these channels
720 /// from `network_graph` will be ignored, and only those in `first_hops` will be used.
722 /// The fees on channels from us to the next hop are ignored as they are assumed to all be equal.
723 /// However, the enabled/disabled bit on such channels as well as the `htlc_minimum_msat` /
724 /// `htlc_maximum_msat` *are* checked as they may change based on the receiving node.
728 /// May be used to re-compute a [`Route`] when handling a [`Event::PaymentPathFailed`]. Any
729 /// adjustments to the [`NetworkGraph`] and channel scores should be made prior to calling this
734 /// Panics if first_hops contains channels without short_channel_ids;
735 /// [`ChannelManager::list_usable_channels`] will never include such channels.
737 /// [`ChannelManager::list_usable_channels`]: crate::ln::channelmanager::ChannelManager::list_usable_channels
738 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
739 /// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
740 pub fn find_route<L: Deref, GL: Deref, S: Score>(
741 our_node_pubkey: &PublicKey, route_params: &RouteParameters,
742 network_graph: &NetworkGraph<GL>, first_hops: Option<&[&ChannelDetails]>, logger: L,
743 scorer: &S, random_seed_bytes: &[u8; 32]
744 ) -> Result<Route, LightningError>
745 where L::Target: Logger, GL::Target: Logger {
746 let graph_lock = network_graph.read_only();
747 let mut route = get_route(our_node_pubkey, &route_params.payment_params, &graph_lock, first_hops,
748 route_params.final_value_msat, route_params.final_cltv_expiry_delta, logger, scorer,
750 add_random_cltv_offset(&mut route, &route_params.payment_params, &graph_lock, random_seed_bytes);
754 pub(crate) fn get_route<L: Deref, S: Score>(
755 our_node_pubkey: &PublicKey, payment_params: &PaymentParameters, network_graph: &ReadOnlyNetworkGraph,
756 first_hops: Option<&[&ChannelDetails]>, final_value_msat: u64, final_cltv_expiry_delta: u32,
757 logger: L, scorer: &S, random_seed_bytes: &[u8; 32]
758 ) -> Result<Route, LightningError>
759 where L::Target: Logger {
760 let payee_node_id = NodeId::from_pubkey(&payment_params.payee_pubkey);
761 let our_node_id = NodeId::from_pubkey(&our_node_pubkey);
763 if payee_node_id == our_node_id {
764 return Err(LightningError{err: "Cannot generate a route to ourselves".to_owned(), action: ErrorAction::IgnoreError});
767 if final_value_msat > MAX_VALUE_MSAT {
768 return Err(LightningError{err: "Cannot generate a route of more value than all existing satoshis".to_owned(), action: ErrorAction::IgnoreError});
771 if final_value_msat == 0 {
772 return Err(LightningError{err: "Cannot send a payment of 0 msat".to_owned(), action: ErrorAction::IgnoreError});
775 for route in payment_params.route_hints.iter() {
776 for hop in &route.0 {
777 if hop.src_node_id == payment_params.payee_pubkey {
778 return Err(LightningError{err: "Route hint cannot have the payee as the source.".to_owned(), action: ErrorAction::IgnoreError});
782 if payment_params.max_total_cltv_expiry_delta <= final_cltv_expiry_delta {
783 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});
786 // The general routing idea is the following:
787 // 1. Fill first/last hops communicated by the caller.
788 // 2. Attempt to construct a path from payer to payee for transferring
789 // any ~sufficient (described later) value.
790 // If succeed, remember which channels were used and how much liquidity they have available,
791 // so that future paths don't rely on the same liquidity.
792 // 3. Proceed to the next step if:
793 // - we hit the recommended target value;
794 // - OR if we could not construct a new path. Any next attempt will fail too.
795 // Otherwise, repeat step 2.
796 // 4. See if we managed to collect paths which aggregately are able to transfer target value
797 // (not recommended value).
798 // 5. If yes, proceed. If not, fail routing.
799 // 6. Randomly combine paths into routes having enough to fulfill the payment. (TODO: knapsack)
800 // 7. Of all the found paths, select only those with the lowest total fee.
801 // 8. The last path in every selected route is likely to be more than we need.
802 // Reduce its value-to-transfer and recompute fees.
803 // 9. Choose the best route by the lowest total fee.
805 // As for the actual search algorithm,
806 // we do a payee-to-payer pseudo-Dijkstra's sorting by each node's distance from the payee
807 // plus the minimum per-HTLC fee to get from it to another node (aka "shitty pseudo-A*").
809 // We are not a faithful Dijkstra's implementation because we can change values which impact
810 // earlier nodes while processing later nodes. Specifically, if we reach a channel with a lower
811 // liquidity limit (via htlc_maximum_msat, on-chain capacity or assumed liquidity limits) than
812 // the value we are currently attempting to send over a path, we simply reduce the value being
813 // sent along the path for any hops after that channel. This may imply that later fees (which
814 // we've already tabulated) are lower because a smaller value is passing through the channels
815 // (and the proportional fee is thus lower). There isn't a trivial way to recalculate the
816 // channels which were selected earlier (and which may still be used for other paths without a
817 // lower liquidity limit), so we simply accept that some liquidity-limited paths may be
820 // One potentially problematic case for this algorithm would be if there are many
821 // liquidity-limited paths which are liquidity-limited near the destination (ie early in our
822 // graph walking), we may never find a path which is not liquidity-limited and has lower
823 // proportional fee (and only lower absolute fee when considering the ultimate value sent).
824 // Because we only consider paths with at least 5% of the total value being sent, the damage
825 // from such a case should be limited, however this could be further reduced in the future by
826 // calculating fees on the amount we wish to route over a path, ie ignoring the liquidity
827 // limits for the purposes of fee calculation.
829 // Alternatively, we could store more detailed path information in the heap (targets, below)
830 // and index the best-path map (dist, below) by node *and* HTLC limits, however that would blow
831 // up the runtime significantly both algorithmically (as we'd traverse nodes multiple times)
832 // and practically (as we would need to store dynamically-allocated path information in heap
833 // objects, increasing malloc traffic and indirect memory access significantly). Further, the
834 // results of such an algorithm would likely be biased towards lower-value paths.
836 // Further, we could return to a faithful Dijkstra's algorithm by rejecting paths with limits
837 // outside of our current search value, running a path search more times to gather candidate
838 // paths at different values. While this may be acceptable, further path searches may increase
839 // runtime for little gain. Specifically, the current algorithm rather efficiently explores the
840 // graph for candidate paths, calculating the maximum value which can realistically be sent at
841 // the same time, remaining generic across different payment values.
843 // TODO: There are a few tweaks we could do, including possibly pre-calculating more stuff
844 // to use as the A* heuristic beyond just the cost to get one node further than the current
847 let network_channels = network_graph.channels();
848 let network_nodes = network_graph.nodes();
850 if payment_params.max_path_count == 0 {
851 return Err(LightningError{err: "Can't find a route with no paths allowed.".to_owned(), action: ErrorAction::IgnoreError});
854 // Allow MPP only if we have a features set from somewhere that indicates the payee supports
855 // it. If the payee supports it they're supposed to include it in the invoice, so that should
857 let allow_mpp = if payment_params.max_path_count == 1 {
859 } else if let Some(features) = &payment_params.features {
860 features.supports_basic_mpp()
861 } else if let Some(node) = network_nodes.get(&payee_node_id) {
862 if let Some(node_info) = node.announcement_info.as_ref() {
863 node_info.features.supports_basic_mpp()
867 log_trace!(logger, "Searching for a route from payer {} to payee {} {} MPP and {} first hops {}overriding the network graph", our_node_pubkey,
868 payment_params.payee_pubkey, if allow_mpp { "with" } else { "without" },
869 first_hops.map(|hops| hops.len()).unwrap_or(0), if first_hops.is_some() { "" } else { "not " });
872 // Prepare the data we'll use for payee-to-payer search by
873 // inserting first hops suggested by the caller as targets.
874 // Our search will then attempt to reach them while traversing from the payee node.
875 let mut first_hop_targets: HashMap<_, Vec<&ChannelDetails>> =
876 HashMap::with_capacity(if first_hops.is_some() { first_hops.as_ref().unwrap().len() } else { 0 });
877 if let Some(hops) = first_hops {
879 if chan.get_outbound_payment_scid().is_none() {
880 panic!("first_hops should be filled in with usable channels, not pending ones");
882 if chan.counterparty.node_id == *our_node_pubkey {
883 return Err(LightningError{err: "First hop cannot have our_node_pubkey as a destination.".to_owned(), action: ErrorAction::IgnoreError});
886 .entry(NodeId::from_pubkey(&chan.counterparty.node_id))
887 .or_insert(Vec::new())
890 if first_hop_targets.is_empty() {
891 return Err(LightningError{err: "Cannot route when there are no outbound routes away from us".to_owned(), action: ErrorAction::IgnoreError});
895 // The main heap containing all candidate next-hops sorted by their score (max(A* fee,
896 // htlc_minimum)). Ideally this would be a heap which allowed cheap score reduction instead of
897 // adding duplicate entries when we find a better path to a given node.
898 let mut targets: BinaryHeap<RouteGraphNode> = BinaryHeap::new();
900 // Map from node_id to information about the best current path to that node, including feerate
902 let mut dist: HashMap<NodeId, PathBuildingHop> = HashMap::with_capacity(network_nodes.len());
904 // During routing, if we ignore a path due to an htlc_minimum_msat limit, we set this,
905 // indicating that we may wish to try again with a higher value, potentially paying to meet an
906 // htlc_minimum with extra fees while still finding a cheaper path.
907 let mut hit_minimum_limit;
909 // When arranging a route, we select multiple paths so that we can make a multi-path payment.
910 // We start with a path_value of the exact amount we want, and if that generates a route we may
911 // return it immediately. Otherwise, we don't stop searching for paths until we have 3x the
912 // amount we want in total across paths, selecting the best subset at the end.
913 const ROUTE_CAPACITY_PROVISION_FACTOR: u64 = 3;
914 let recommended_value_msat = final_value_msat * ROUTE_CAPACITY_PROVISION_FACTOR as u64;
915 let mut path_value_msat = final_value_msat;
917 // Routing Fragmentation Mitigation heuristic:
919 // Routing fragmentation across many payment paths increases the overall routing
920 // fees as you have irreducible routing fees per-link used (`fee_base_msat`).
921 // Taking too many smaller paths also increases the chance of payment failure.
922 // Thus to avoid this effect, we require from our collected links to provide
923 // at least a minimal contribution to the recommended value yet-to-be-fulfilled.
924 // This requirement is currently set to be 1/max_path_count of the payment
925 // value to ensure we only ever return routes that do not violate this limit.
926 let minimal_value_contribution_msat: u64 = if allow_mpp {
927 (final_value_msat + (payment_params.max_path_count as u64 - 1)) / payment_params.max_path_count as u64
932 // When we start collecting routes we enforce the max_channel_saturation_power_of_half
933 // requirement strictly. After we've collected enough (or if we fail to find new routes) we
934 // drop the requirement by setting this to 0.
935 let mut channel_saturation_pow_half = payment_params.max_channel_saturation_power_of_half;
937 // Keep track of how much liquidity has been used in selected channels. Used to determine
938 // if the channel can be used by additional MPP paths or to inform path finding decisions. It is
939 // aware of direction *only* to ensure that the correct htlc_maximum_msat value is used. Hence,
940 // liquidity used in one direction will not offset any used in the opposite direction.
941 let mut used_channel_liquidities: HashMap<(u64, bool), u64> =
942 HashMap::with_capacity(network_nodes.len());
944 // Keeping track of how much value we already collected across other paths. Helps to decide
945 // when we want to stop looking for new paths.
946 let mut already_collected_value_msat = 0;
948 for (_, channels) in first_hop_targets.iter_mut() {
949 // Sort the first_hops channels to the same node(s) in priority order of which channel we'd
952 // First, if channels are below `recommended_value_msat`, sort them in descending order,
953 // preferring larger channels to avoid splitting the payment into more MPP parts than is
956 // Second, because simply always sorting in descending order would always use our largest
957 // available outbound capacity, needlessly fragmenting our available channel capacities,
958 // sort channels above `recommended_value_msat` in ascending order, preferring channels
959 // which have enough, but not too much, capacity for the payment.
960 channels.sort_unstable_by(|chan_a, chan_b| {
961 if chan_b.next_outbound_htlc_limit_msat < recommended_value_msat || chan_a.next_outbound_htlc_limit_msat < recommended_value_msat {
962 // Sort in descending order
963 chan_b.next_outbound_htlc_limit_msat.cmp(&chan_a.next_outbound_htlc_limit_msat)
965 // Sort in ascending order
966 chan_a.next_outbound_htlc_limit_msat.cmp(&chan_b.next_outbound_htlc_limit_msat)
971 log_trace!(logger, "Building path from {} (payee) to {} (us/payer) for value {} msat.", payment_params.payee_pubkey, our_node_pubkey, final_value_msat);
973 macro_rules! add_entry {
974 // Adds entry which goes from $src_node_id to $dest_node_id over the $candidate hop.
975 // $next_hops_fee_msat represents the fees paid for using all the channels *after* this one,
976 // since that value has to be transferred over this channel.
977 // Returns whether this channel caused an update to `targets`.
978 ( $candidate: expr, $src_node_id: expr, $dest_node_id: expr, $next_hops_fee_msat: expr,
979 $next_hops_value_contribution: expr, $next_hops_path_htlc_minimum_msat: expr,
980 $next_hops_path_penalty_msat: expr, $next_hops_cltv_delta: expr, $next_hops_path_length: expr ) => { {
981 // We "return" whether we updated the path at the end, via this:
982 let mut did_add_update_path_to_src_node = false;
983 // Channels to self should not be used. This is more of belt-and-suspenders, because in
984 // practice these cases should be caught earlier:
985 // - for regular channels at channel announcement (TODO)
986 // - for first and last hops early in get_route
987 if $src_node_id != $dest_node_id {
988 let short_channel_id = $candidate.short_channel_id();
989 let effective_capacity = $candidate.effective_capacity();
990 let htlc_maximum_msat = max_htlc_from_capacity(effective_capacity, channel_saturation_pow_half);
992 // It is tricky to subtract $next_hops_fee_msat from available liquidity here.
993 // It may be misleading because we might later choose to reduce the value transferred
994 // over these channels, and the channel which was insufficient might become sufficient.
995 // Worst case: we drop a good channel here because it can't cover the high following
996 // fees caused by one expensive channel, but then this channel could have been used
997 // if the amount being transferred over this path is lower.
998 // We do this for now, but this is a subject for removal.
999 if let Some(mut available_value_contribution_msat) = htlc_maximum_msat.checked_sub($next_hops_fee_msat) {
1000 let used_liquidity_msat = used_channel_liquidities
1001 .get(&(short_channel_id, $src_node_id < $dest_node_id))
1002 .map_or(0, |used_liquidity_msat| {
1003 available_value_contribution_msat = available_value_contribution_msat
1004 .saturating_sub(*used_liquidity_msat);
1005 *used_liquidity_msat
1008 // Verify the liquidity offered by this channel complies to the minimal contribution.
1009 let contributes_sufficient_value = available_value_contribution_msat >= minimal_value_contribution_msat;
1010 // Do not consider candidate hops that would exceed the maximum path length.
1011 let path_length_to_node = $next_hops_path_length + 1;
1012 let exceeds_max_path_length = path_length_to_node > MAX_PATH_LENGTH_ESTIMATE;
1014 // Do not consider candidates that exceed the maximum total cltv expiry limit.
1015 // In order to already account for some of the privacy enhancing random CLTV
1016 // expiry delta offset we add on top later, we subtract a rough estimate
1017 // (2*MEDIAN_HOP_CLTV_EXPIRY_DELTA) here.
1018 let max_total_cltv_expiry_delta = (payment_params.max_total_cltv_expiry_delta - final_cltv_expiry_delta)
1019 .checked_sub(2*MEDIAN_HOP_CLTV_EXPIRY_DELTA)
1020 .unwrap_or(payment_params.max_total_cltv_expiry_delta - final_cltv_expiry_delta);
1021 let hop_total_cltv_delta = ($next_hops_cltv_delta as u32)
1022 .saturating_add($candidate.cltv_expiry_delta());
1023 let exceeds_cltv_delta_limit = hop_total_cltv_delta > max_total_cltv_expiry_delta;
1025 let value_contribution_msat = cmp::min(available_value_contribution_msat, $next_hops_value_contribution);
1026 // Includes paying fees for the use of the following channels.
1027 let amount_to_transfer_over_msat: u64 = match value_contribution_msat.checked_add($next_hops_fee_msat) {
1028 Some(result) => result,
1029 // Can't overflow due to how the values were computed right above.
1030 None => unreachable!(),
1032 #[allow(unused_comparisons)] // $next_hops_path_htlc_minimum_msat is 0 in some calls so rustc complains
1033 let over_path_minimum_msat = amount_to_transfer_over_msat >= $candidate.htlc_minimum_msat() &&
1034 amount_to_transfer_over_msat >= $next_hops_path_htlc_minimum_msat;
1036 #[allow(unused_comparisons)] // $next_hops_path_htlc_minimum_msat is 0 in some calls so rustc complains
1037 let may_overpay_to_meet_path_minimum_msat =
1038 ((amount_to_transfer_over_msat < $candidate.htlc_minimum_msat() &&
1039 recommended_value_msat > $candidate.htlc_minimum_msat()) ||
1040 (amount_to_transfer_over_msat < $next_hops_path_htlc_minimum_msat &&
1041 recommended_value_msat > $next_hops_path_htlc_minimum_msat));
1043 let payment_failed_on_this_channel =
1044 payment_params.previously_failed_channels.contains(&short_channel_id);
1046 // If HTLC minimum is larger than the amount we're going to transfer, we shouldn't
1047 // bother considering this channel. If retrying with recommended_value_msat may
1048 // allow us to hit the HTLC minimum limit, set htlc_minimum_limit so that we go
1049 // around again with a higher amount.
1050 if !contributes_sufficient_value || exceeds_max_path_length ||
1051 exceeds_cltv_delta_limit || payment_failed_on_this_channel {
1052 // Path isn't useful, ignore it and move on.
1053 } else if may_overpay_to_meet_path_minimum_msat {
1054 hit_minimum_limit = true;
1055 } else if over_path_minimum_msat {
1056 // Note that low contribution here (limited by available_liquidity_msat)
1057 // might violate htlc_minimum_msat on the hops which are next along the
1058 // payment path (upstream to the payee). To avoid that, we recompute
1059 // path fees knowing the final path contribution after constructing it.
1060 let path_htlc_minimum_msat = compute_fees($next_hops_path_htlc_minimum_msat, $candidate.fees())
1061 .and_then(|fee_msat| fee_msat.checked_add($next_hops_path_htlc_minimum_msat))
1062 .map(|fee_msat| cmp::max(fee_msat, $candidate.htlc_minimum_msat()))
1063 .unwrap_or_else(|| u64::max_value());
1064 let hm_entry = dist.entry($src_node_id);
1065 let old_entry = hm_entry.or_insert_with(|| {
1066 // If there was previously no known way to access the source node
1067 // (recall it goes payee-to-payer) of short_channel_id, first add a
1068 // semi-dummy record just to compute the fees to reach the source node.
1069 // This will affect our decision on selecting short_channel_id
1070 // as a way to reach the $dest_node_id.
1071 let mut fee_base_msat = 0;
1072 let mut fee_proportional_millionths = 0;
1073 if let Some(Some(fees)) = network_nodes.get(&$src_node_id).map(|node| node.lowest_inbound_channel_fees) {
1074 fee_base_msat = fees.base_msat;
1075 fee_proportional_millionths = fees.proportional_millionths;
1078 node_id: $dest_node_id.clone(),
1079 candidate: $candidate.clone(),
1081 src_lowest_inbound_fees: RoutingFees {
1082 base_msat: fee_base_msat,
1083 proportional_millionths: fee_proportional_millionths,
1085 next_hops_fee_msat: u64::max_value(),
1086 hop_use_fee_msat: u64::max_value(),
1087 total_fee_msat: u64::max_value(),
1088 path_htlc_minimum_msat,
1089 path_penalty_msat: u64::max_value(),
1090 was_processed: false,
1091 #[cfg(all(not(feature = "_bench_unstable"), any(test, fuzzing)))]
1092 value_contribution_msat,
1096 #[allow(unused_mut)] // We only use the mut in cfg(test)
1097 let mut should_process = !old_entry.was_processed;
1098 #[cfg(all(not(feature = "_bench_unstable"), any(test, fuzzing)))]
1100 // In test/fuzzing builds, we do extra checks to make sure the skipping
1101 // of already-seen nodes only happens in cases we expect (see below).
1102 if !should_process { should_process = true; }
1106 let mut hop_use_fee_msat = 0;
1107 let mut total_fee_msat = $next_hops_fee_msat;
1109 // Ignore hop_use_fee_msat for channel-from-us as we assume all channels-from-us
1110 // will have the same effective-fee
1111 if $src_node_id != our_node_id {
1112 match compute_fees(amount_to_transfer_over_msat, $candidate.fees()) {
1113 // max_value means we'll always fail
1114 // the old_entry.total_fee_msat > total_fee_msat check
1115 None => total_fee_msat = u64::max_value(),
1117 hop_use_fee_msat = fee_msat;
1118 total_fee_msat += hop_use_fee_msat;
1119 // When calculating the lowest inbound fees to a node, we
1120 // calculate fees here not based on the actual value we think
1121 // will flow over this channel, but on the minimum value that
1122 // we'll accept flowing over it. The minimum accepted value
1123 // is a constant through each path collection run, ensuring
1124 // consistent basis. Otherwise we may later find a
1125 // different path to the source node that is more expensive,
1126 // but which we consider to be cheaper because we are capacity
1127 // constrained and the relative fee becomes lower.
1128 match compute_fees(minimal_value_contribution_msat, old_entry.src_lowest_inbound_fees)
1129 .map(|a| a.checked_add(total_fee_msat)) {
1134 total_fee_msat = u64::max_value();
1141 let channel_usage = ChannelUsage {
1142 amount_msat: amount_to_transfer_over_msat,
1143 inflight_htlc_msat: used_liquidity_msat,
1146 let channel_penalty_msat = scorer.channel_penalty_msat(
1147 short_channel_id, &$src_node_id, &$dest_node_id, channel_usage
1149 let path_penalty_msat = $next_hops_path_penalty_msat
1150 .saturating_add(channel_penalty_msat);
1151 let new_graph_node = RouteGraphNode {
1152 node_id: $src_node_id,
1153 lowest_fee_to_peer_through_node: total_fee_msat,
1154 lowest_fee_to_node: $next_hops_fee_msat as u64 + hop_use_fee_msat,
1155 total_cltv_delta: hop_total_cltv_delta,
1156 value_contribution_msat: value_contribution_msat,
1157 path_htlc_minimum_msat,
1159 path_length_to_node,
1162 // Update the way of reaching $src_node_id with the given short_channel_id (from $dest_node_id),
1163 // if this way is cheaper than the already known
1164 // (considering the cost to "reach" this channel from the route destination,
1165 // the cost of using this channel,
1166 // and the cost of routing to the source node of this channel).
1167 // Also, consider that htlc_minimum_msat_difference, because we might end up
1168 // paying it. Consider the following exploit:
1169 // we use 2 paths to transfer 1.5 BTC. One of them is 0-fee normal 1 BTC path,
1170 // and for the other one we picked a 1sat-fee path with htlc_minimum_msat of
1171 // 1 BTC. Now, since the latter is more expensive, we gonna try to cut it
1172 // by 0.5 BTC, but then match htlc_minimum_msat by paying a fee of 0.5 BTC
1174 // Ideally the scoring could be smarter (e.g. 0.5*htlc_minimum_msat here),
1175 // but it may require additional tracking - we don't want to double-count
1176 // the fees included in $next_hops_path_htlc_minimum_msat, but also
1177 // can't use something that may decrease on future hops.
1178 let old_cost = cmp::max(old_entry.total_fee_msat, old_entry.path_htlc_minimum_msat)
1179 .saturating_add(old_entry.path_penalty_msat);
1180 let new_cost = cmp::max(total_fee_msat, path_htlc_minimum_msat)
1181 .saturating_add(path_penalty_msat);
1183 if !old_entry.was_processed && new_cost < old_cost {
1184 targets.push(new_graph_node);
1185 old_entry.next_hops_fee_msat = $next_hops_fee_msat;
1186 old_entry.hop_use_fee_msat = hop_use_fee_msat;
1187 old_entry.total_fee_msat = total_fee_msat;
1188 old_entry.node_id = $dest_node_id.clone();
1189 old_entry.candidate = $candidate.clone();
1190 old_entry.fee_msat = 0; // This value will be later filled with hop_use_fee_msat of the following channel
1191 old_entry.path_htlc_minimum_msat = path_htlc_minimum_msat;
1192 old_entry.path_penalty_msat = path_penalty_msat;
1193 #[cfg(all(not(feature = "_bench_unstable"), any(test, fuzzing)))]
1195 old_entry.value_contribution_msat = value_contribution_msat;
1197 did_add_update_path_to_src_node = true;
1198 } else if old_entry.was_processed && new_cost < old_cost {
1199 #[cfg(all(not(feature = "_bench_unstable"), any(test, fuzzing)))]
1201 // If we're skipping processing a node which was previously
1202 // processed even though we found another path to it with a
1203 // cheaper fee, check that it was because the second path we
1204 // found (which we are processing now) has a lower value
1205 // contribution due to an HTLC minimum limit.
1207 // e.g. take a graph with two paths from node 1 to node 2, one
1208 // through channel A, and one through channel B. Channel A and
1209 // B are both in the to-process heap, with their scores set by
1210 // a higher htlc_minimum than fee.
1211 // Channel A is processed first, and the channels onwards from
1212 // node 1 are added to the to-process heap. Thereafter, we pop
1213 // Channel B off of the heap, note that it has a much more
1214 // restrictive htlc_maximum_msat, and recalculate the fees for
1215 // all of node 1's channels using the new, reduced, amount.
1217 // This would be bogus - we'd be selecting a higher-fee path
1218 // with a lower htlc_maximum_msat instead of the one we'd
1219 // already decided to use.
1220 debug_assert!(path_htlc_minimum_msat < old_entry.path_htlc_minimum_msat);
1222 value_contribution_msat + path_penalty_msat <
1223 old_entry.value_contribution_msat + old_entry.path_penalty_msat
1231 did_add_update_path_to_src_node
1235 let default_node_features = default_node_features();
1237 // Find ways (channels with destination) to reach a given node and store them
1238 // in the corresponding data structures (routing graph etc).
1239 // $fee_to_target_msat represents how much it costs to reach to this node from the payee,
1240 // meaning how much will be paid in fees after this node (to the best of our knowledge).
1241 // This data can later be helpful to optimize routing (pay lower fees).
1242 macro_rules! add_entries_to_cheapest_to_target_node {
1243 ( $node: expr, $node_id: expr, $fee_to_target_msat: expr, $next_hops_value_contribution: expr,
1244 $next_hops_path_htlc_minimum_msat: expr, $next_hops_path_penalty_msat: expr,
1245 $next_hops_cltv_delta: expr, $next_hops_path_length: expr ) => {
1246 let skip_node = if let Some(elem) = dist.get_mut(&$node_id) {
1247 let was_processed = elem.was_processed;
1248 elem.was_processed = true;
1251 // Entries are added to dist in add_entry!() when there is a channel from a node.
1252 // Because there are no channels from payee, it will not have a dist entry at this point.
1253 // If we're processing any other node, it is always be the result of a channel from it.
1254 assert_eq!($node_id, payee_node_id);
1259 if let Some(first_channels) = first_hop_targets.get(&$node_id) {
1260 for details in first_channels {
1261 let candidate = CandidateRouteHop::FirstHop { details };
1262 add_entry!(candidate, our_node_id, $node_id, $fee_to_target_msat,
1263 $next_hops_value_contribution,
1264 $next_hops_path_htlc_minimum_msat, $next_hops_path_penalty_msat,
1265 $next_hops_cltv_delta, $next_hops_path_length);
1269 let features = if let Some(node_info) = $node.announcement_info.as_ref() {
1272 &default_node_features
1275 if !features.requires_unknown_bits() {
1276 for chan_id in $node.channels.iter() {
1277 let chan = network_channels.get(chan_id).unwrap();
1278 if !chan.features.requires_unknown_bits() {
1279 let (directed_channel, source) =
1280 chan.as_directed_to(&$node_id).expect("inconsistent NetworkGraph");
1281 if first_hops.is_none() || *source != our_node_id {
1282 if let Some(direction) = directed_channel.direction() {
1283 if direction.enabled {
1284 let candidate = CandidateRouteHop::PublicHop {
1285 info: directed_channel.with_update().unwrap(),
1286 short_channel_id: *chan_id,
1288 add_entry!(candidate, *source, $node_id,
1289 $fee_to_target_msat,
1290 $next_hops_value_contribution,
1291 $next_hops_path_htlc_minimum_msat,
1292 $next_hops_path_penalty_msat,
1293 $next_hops_cltv_delta, $next_hops_path_length);
1304 let mut payment_paths = Vec::<PaymentPath>::new();
1306 // TODO: diversify by nodes (so that all paths aren't doomed if one node is offline).
1307 'paths_collection: loop {
1308 // For every new path, start from scratch, except for used_channel_liquidities, which
1309 // helps to avoid reusing previously selected paths in future iterations.
1312 hit_minimum_limit = false;
1314 // If first hop is a private channel and the only way to reach the payee, this is the only
1315 // place where it could be added.
1316 if let Some(first_channels) = first_hop_targets.get(&payee_node_id) {
1317 for details in first_channels {
1318 let candidate = CandidateRouteHop::FirstHop { details };
1319 let added = add_entry!(candidate, our_node_id, payee_node_id, 0, path_value_msat,
1321 log_trace!(logger, "{} direct route to payee via SCID {}",
1322 if added { "Added" } else { "Skipped" }, candidate.short_channel_id());
1326 // Add the payee as a target, so that the payee-to-payer
1327 // search algorithm knows what to start with.
1328 match network_nodes.get(&payee_node_id) {
1329 // The payee is not in our network graph, so nothing to add here.
1330 // There is still a chance of reaching them via last_hops though,
1331 // so don't yet fail the payment here.
1332 // If not, targets.pop() will not even let us enter the loop in step 2.
1335 add_entries_to_cheapest_to_target_node!(node, payee_node_id, 0, path_value_msat, 0, 0u64, 0, 0);
1340 // If a caller provided us with last hops, add them to routing targets. Since this happens
1341 // earlier than general path finding, they will be somewhat prioritized, although currently
1342 // it matters only if the fees are exactly the same.
1343 for route in payment_params.route_hints.iter().filter(|route| !route.0.is_empty()) {
1344 let first_hop_in_route = &(route.0)[0];
1345 let have_hop_src_in_graph =
1346 // Only add the hops in this route to our candidate set if either
1347 // we have a direct channel to the first hop or the first hop is
1348 // in the regular network graph.
1349 first_hop_targets.get(&NodeId::from_pubkey(&first_hop_in_route.src_node_id)).is_some() ||
1350 network_nodes.get(&NodeId::from_pubkey(&first_hop_in_route.src_node_id)).is_some();
1351 if have_hop_src_in_graph {
1352 // We start building the path from reverse, i.e., from payee
1353 // to the first RouteHintHop in the path.
1354 let hop_iter = route.0.iter().rev();
1355 let prev_hop_iter = core::iter::once(&payment_params.payee_pubkey).chain(
1356 route.0.iter().skip(1).rev().map(|hop| &hop.src_node_id));
1357 let mut hop_used = true;
1358 let mut aggregate_next_hops_fee_msat: u64 = 0;
1359 let mut aggregate_next_hops_path_htlc_minimum_msat: u64 = 0;
1360 let mut aggregate_next_hops_path_penalty_msat: u64 = 0;
1361 let mut aggregate_next_hops_cltv_delta: u32 = 0;
1362 let mut aggregate_next_hops_path_length: u8 = 0;
1364 for (idx, (hop, prev_hop_id)) in hop_iter.zip(prev_hop_iter).enumerate() {
1365 let source = NodeId::from_pubkey(&hop.src_node_id);
1366 let target = NodeId::from_pubkey(&prev_hop_id);
1367 let candidate = network_channels
1368 .get(&hop.short_channel_id)
1369 .and_then(|channel| channel.as_directed_to(&target))
1370 .and_then(|(channel, _)| channel.with_update())
1371 .map(|info| CandidateRouteHop::PublicHop {
1373 short_channel_id: hop.short_channel_id,
1375 .unwrap_or_else(|| CandidateRouteHop::PrivateHop { hint: hop });
1377 if !add_entry!(candidate, source, target, aggregate_next_hops_fee_msat,
1378 path_value_msat, aggregate_next_hops_path_htlc_minimum_msat,
1379 aggregate_next_hops_path_penalty_msat,
1380 aggregate_next_hops_cltv_delta, aggregate_next_hops_path_length) {
1381 // If this hop was not used then there is no use checking the preceding
1382 // hops in the RouteHint. We can break by just searching for a direct
1383 // channel between last checked hop and first_hop_targets.
1387 let used_liquidity_msat = used_channel_liquidities
1388 .get(&(hop.short_channel_id, source < target)).copied().unwrap_or(0);
1389 let channel_usage = ChannelUsage {
1390 amount_msat: final_value_msat + aggregate_next_hops_fee_msat,
1391 inflight_htlc_msat: used_liquidity_msat,
1392 effective_capacity: candidate.effective_capacity(),
1394 let channel_penalty_msat = scorer.channel_penalty_msat(
1395 hop.short_channel_id, &source, &target, channel_usage
1397 aggregate_next_hops_path_penalty_msat = aggregate_next_hops_path_penalty_msat
1398 .saturating_add(channel_penalty_msat);
1400 aggregate_next_hops_cltv_delta = aggregate_next_hops_cltv_delta
1401 .saturating_add(hop.cltv_expiry_delta as u32);
1403 aggregate_next_hops_path_length = aggregate_next_hops_path_length
1406 // Searching for a direct channel between last checked hop and first_hop_targets
1407 if let Some(first_channels) = first_hop_targets.get(&NodeId::from_pubkey(&prev_hop_id)) {
1408 for details in first_channels {
1409 let candidate = CandidateRouteHop::FirstHop { details };
1410 add_entry!(candidate, our_node_id, NodeId::from_pubkey(&prev_hop_id),
1411 aggregate_next_hops_fee_msat, path_value_msat,
1412 aggregate_next_hops_path_htlc_minimum_msat,
1413 aggregate_next_hops_path_penalty_msat, aggregate_next_hops_cltv_delta,
1414 aggregate_next_hops_path_length);
1422 // In the next values of the iterator, the aggregate fees already reflects
1423 // the sum of value sent from payer (final_value_msat) and routing fees
1424 // for the last node in the RouteHint. We need to just add the fees to
1425 // route through the current node so that the preceding node (next iteration)
1427 let hops_fee = compute_fees(aggregate_next_hops_fee_msat + final_value_msat, hop.fees)
1428 .map_or(None, |inc| inc.checked_add(aggregate_next_hops_fee_msat));
1429 aggregate_next_hops_fee_msat = if let Some(val) = hops_fee { val } else { break; };
1431 let hop_htlc_minimum_msat = candidate.htlc_minimum_msat();
1432 let hop_htlc_minimum_msat_inc = if let Some(val) = compute_fees(aggregate_next_hops_path_htlc_minimum_msat, hop.fees) { val } else { break; };
1433 let hops_path_htlc_minimum = aggregate_next_hops_path_htlc_minimum_msat
1434 .checked_add(hop_htlc_minimum_msat_inc);
1435 aggregate_next_hops_path_htlc_minimum_msat = if let Some(val) = hops_path_htlc_minimum { cmp::max(hop_htlc_minimum_msat, val) } else { break; };
1437 if idx == route.0.len() - 1 {
1438 // The last hop in this iterator is the first hop in
1439 // overall RouteHint.
1440 // If this hop connects to a node with which we have a direct channel,
1441 // ignore the network graph and, if the last hop was added, add our
1442 // direct channel to the candidate set.
1444 // Note that we *must* check if the last hop was added as `add_entry`
1445 // always assumes that the third argument is a node to which we have a
1447 if let Some(first_channels) = first_hop_targets.get(&NodeId::from_pubkey(&hop.src_node_id)) {
1448 for details in first_channels {
1449 let candidate = CandidateRouteHop::FirstHop { details };
1450 add_entry!(candidate, our_node_id,
1451 NodeId::from_pubkey(&hop.src_node_id),
1452 aggregate_next_hops_fee_msat, path_value_msat,
1453 aggregate_next_hops_path_htlc_minimum_msat,
1454 aggregate_next_hops_path_penalty_msat,
1455 aggregate_next_hops_cltv_delta,
1456 aggregate_next_hops_path_length);
1464 log_trace!(logger, "Starting main path collection loop with {} nodes pre-filled from first/last hops.", targets.len());
1466 // At this point, targets are filled with the data from first and
1467 // last hops communicated by the caller, and the payment receiver.
1468 let mut found_new_path = false;
1471 // If this loop terminates due the exhaustion of targets, two situations are possible:
1472 // - not enough outgoing liquidity:
1473 // 0 < already_collected_value_msat < final_value_msat
1474 // - enough outgoing liquidity:
1475 // final_value_msat <= already_collected_value_msat < recommended_value_msat
1476 // Both these cases (and other cases except reaching recommended_value_msat) mean that
1477 // paths_collection will be stopped because found_new_path==false.
1478 // This is not necessarily a routing failure.
1479 'path_construction: while let Some(RouteGraphNode { node_id, lowest_fee_to_node, total_cltv_delta, value_contribution_msat, path_htlc_minimum_msat, path_penalty_msat, path_length_to_node, .. }) = targets.pop() {
1481 // Since we're going payee-to-payer, hitting our node as a target means we should stop
1482 // traversing the graph and arrange the path out of what we found.
1483 if node_id == our_node_id {
1484 let mut new_entry = dist.remove(&our_node_id).unwrap();
1485 let mut ordered_hops: Vec<(PathBuildingHop, NodeFeatures)> = vec!((new_entry.clone(), default_node_features.clone()));
1488 let mut features_set = false;
1489 if let Some(first_channels) = first_hop_targets.get(&ordered_hops.last().unwrap().0.node_id) {
1490 for details in first_channels {
1491 if details.get_outbound_payment_scid().unwrap() == ordered_hops.last().unwrap().0.candidate.short_channel_id() {
1492 ordered_hops.last_mut().unwrap().1 = details.counterparty.features.to_context();
1493 features_set = true;
1499 if let Some(node) = network_nodes.get(&ordered_hops.last().unwrap().0.node_id) {
1500 if let Some(node_info) = node.announcement_info.as_ref() {
1501 ordered_hops.last_mut().unwrap().1 = node_info.features.clone();
1503 ordered_hops.last_mut().unwrap().1 = default_node_features.clone();
1506 // We can fill in features for everything except hops which were
1507 // provided via the invoice we're paying. We could guess based on the
1508 // recipient's features but for now we simply avoid guessing at all.
1512 // Means we succesfully traversed from the payer to the payee, now
1513 // save this path for the payment route. Also, update the liquidity
1514 // remaining on the used hops, so that we take them into account
1515 // while looking for more paths.
1516 if ordered_hops.last().unwrap().0.node_id == payee_node_id {
1520 new_entry = match dist.remove(&ordered_hops.last().unwrap().0.node_id) {
1521 Some(payment_hop) => payment_hop,
1522 // We can't arrive at None because, if we ever add an entry to targets,
1523 // we also fill in the entry in dist (see add_entry!).
1524 None => unreachable!(),
1526 // We "propagate" the fees one hop backward (topologically) here,
1527 // so that fees paid for a HTLC forwarding on the current channel are
1528 // associated with the previous channel (where they will be subtracted).
1529 ordered_hops.last_mut().unwrap().0.fee_msat = new_entry.hop_use_fee_msat;
1530 ordered_hops.push((new_entry.clone(), default_node_features.clone()));
1532 ordered_hops.last_mut().unwrap().0.fee_msat = value_contribution_msat;
1533 ordered_hops.last_mut().unwrap().0.hop_use_fee_msat = 0;
1535 log_trace!(logger, "Found a path back to us from the target with {} hops contributing up to {} msat: \n {:#?}",
1536 ordered_hops.len(), value_contribution_msat, ordered_hops.iter().map(|h| &(h.0)).collect::<Vec<&PathBuildingHop>>());
1538 let mut payment_path = PaymentPath {hops: ordered_hops};
1540 // We could have possibly constructed a slightly inconsistent path: since we reduce
1541 // value being transferred along the way, we could have violated htlc_minimum_msat
1542 // on some channels we already passed (assuming dest->source direction). Here, we
1543 // recompute the fees again, so that if that's the case, we match the currently
1544 // underpaid htlc_minimum_msat with fees.
1545 payment_path.update_value_and_recompute_fees(cmp::min(value_contribution_msat, final_value_msat));
1547 // Since a path allows to transfer as much value as
1548 // the smallest channel it has ("bottleneck"), we should recompute
1549 // the fees so sender HTLC don't overpay fees when traversing
1550 // larger channels than the bottleneck. This may happen because
1551 // when we were selecting those channels we were not aware how much value
1552 // this path will transfer, and the relative fee for them
1553 // might have been computed considering a larger value.
1554 // Remember that we used these channels so that we don't rely
1555 // on the same liquidity in future paths.
1556 let mut prevented_redundant_path_selection = false;
1557 let prev_hop_iter = core::iter::once(&our_node_id)
1558 .chain(payment_path.hops.iter().map(|(hop, _)| &hop.node_id));
1559 for (prev_hop, (hop, _)) in prev_hop_iter.zip(payment_path.hops.iter()) {
1560 let spent_on_hop_msat = value_contribution_msat + hop.next_hops_fee_msat;
1561 let used_liquidity_msat = used_channel_liquidities
1562 .entry((hop.candidate.short_channel_id(), *prev_hop < hop.node_id))
1563 .and_modify(|used_liquidity_msat| *used_liquidity_msat += spent_on_hop_msat)
1564 .or_insert(spent_on_hop_msat);
1565 let hop_capacity = hop.candidate.effective_capacity();
1566 let hop_max_msat = max_htlc_from_capacity(hop_capacity, channel_saturation_pow_half);
1567 if *used_liquidity_msat == hop_max_msat {
1568 // If this path used all of this channel's available liquidity, we know
1569 // this path will not be selected again in the next loop iteration.
1570 prevented_redundant_path_selection = true;
1572 debug_assert!(*used_liquidity_msat <= hop_max_msat);
1574 if !prevented_redundant_path_selection {
1575 // If we weren't capped by hitting a liquidity limit on a channel in the path,
1576 // we'll probably end up picking the same path again on the next iteration.
1577 // Decrease the available liquidity of a hop in the middle of the path.
1578 let victim_scid = payment_path.hops[(payment_path.hops.len()) / 2].0.candidate.short_channel_id();
1579 let exhausted = u64::max_value();
1580 log_trace!(logger, "Disabling channel {} for future path building iterations to avoid duplicates.", victim_scid);
1581 *used_channel_liquidities.entry((victim_scid, false)).or_default() = exhausted;
1582 *used_channel_liquidities.entry((victim_scid, true)).or_default() = exhausted;
1585 // Track the total amount all our collected paths allow to send so that we know
1586 // when to stop looking for more paths
1587 already_collected_value_msat += value_contribution_msat;
1589 payment_paths.push(payment_path);
1590 found_new_path = true;
1591 break 'path_construction;
1594 // If we found a path back to the payee, we shouldn't try to process it again. This is
1595 // the equivalent of the `elem.was_processed` check in
1596 // add_entries_to_cheapest_to_target_node!() (see comment there for more info).
1597 if node_id == payee_node_id { continue 'path_construction; }
1599 // Otherwise, since the current target node is not us,
1600 // keep "unrolling" the payment graph from payee to payer by
1601 // finding a way to reach the current target from the payer side.
1602 match network_nodes.get(&node_id) {
1605 add_entries_to_cheapest_to_target_node!(node, node_id, lowest_fee_to_node,
1606 value_contribution_msat, path_htlc_minimum_msat, path_penalty_msat,
1607 total_cltv_delta, path_length_to_node);
1613 if !found_new_path && channel_saturation_pow_half != 0 {
1614 channel_saturation_pow_half = 0;
1615 continue 'paths_collection;
1617 // If we don't support MPP, no use trying to gather more value ever.
1618 break 'paths_collection;
1622 // Stop either when the recommended value is reached or if no new path was found in this
1624 // In the latter case, making another path finding attempt won't help,
1625 // because we deterministically terminated the search due to low liquidity.
1626 if !found_new_path && channel_saturation_pow_half != 0 {
1627 channel_saturation_pow_half = 0;
1628 } else if already_collected_value_msat >= recommended_value_msat || !found_new_path {
1629 log_trace!(logger, "Have now collected {} msat (seeking {} msat) in paths. Last path loop {} a new path.",
1630 already_collected_value_msat, recommended_value_msat, if found_new_path { "found" } else { "did not find" });
1631 break 'paths_collection;
1632 } else if found_new_path && already_collected_value_msat == final_value_msat && payment_paths.len() == 1 {
1633 // Further, if this was our first walk of the graph, and we weren't limited by an
1634 // htlc_minimum_msat, return immediately because this path should suffice. If we were
1635 // limited by an htlc_minimum_msat value, find another path with a higher value,
1636 // potentially allowing us to pay fees to meet the htlc_minimum on the new path while
1637 // still keeping a lower total fee than this path.
1638 if !hit_minimum_limit {
1639 log_trace!(logger, "Collected exactly our payment amount on the first pass, without hitting an htlc_minimum_msat limit, exiting.");
1640 break 'paths_collection;
1642 log_trace!(logger, "Collected our payment amount on the first pass, but running again to collect extra paths with a potentially higher limit.");
1643 path_value_msat = recommended_value_msat;
1648 if payment_paths.len() == 0 {
1649 return Err(LightningError{err: "Failed to find a path to the given destination".to_owned(), action: ErrorAction::IgnoreError});
1652 if already_collected_value_msat < final_value_msat {
1653 return Err(LightningError{err: "Failed to find a sufficient route to the given destination".to_owned(), action: ErrorAction::IgnoreError});
1656 // Sort by total fees and take the best paths.
1657 payment_paths.sort_unstable_by_key(|path| path.get_total_fee_paid_msat());
1658 if payment_paths.len() > 50 {
1659 payment_paths.truncate(50);
1662 // Draw multiple sufficient routes by randomly combining the selected paths.
1663 let mut drawn_routes = Vec::new();
1664 let mut prng = ChaCha20::new(random_seed_bytes, &[0u8; 12]);
1665 let mut random_index_bytes = [0u8; ::core::mem::size_of::<usize>()];
1667 let num_permutations = payment_paths.len();
1668 for _ in 0..num_permutations {
1669 let mut cur_route = Vec::<PaymentPath>::new();
1670 let mut aggregate_route_value_msat = 0;
1673 // Do a Fisher-Yates shuffle to create a random permutation of the payment paths
1674 for cur_index in (1..payment_paths.len()).rev() {
1675 prng.process_in_place(&mut random_index_bytes);
1676 let random_index = usize::from_be_bytes(random_index_bytes).wrapping_rem(cur_index+1);
1677 payment_paths.swap(cur_index, random_index);
1681 for payment_path in &payment_paths {
1682 cur_route.push(payment_path.clone());
1683 aggregate_route_value_msat += payment_path.get_value_msat();
1684 if aggregate_route_value_msat > final_value_msat {
1685 // Last path likely overpaid. Substract it from the most expensive
1686 // (in terms of proportional fee) path in this route and recompute fees.
1687 // This might be not the most economically efficient way, but fewer paths
1688 // also makes routing more reliable.
1689 let mut overpaid_value_msat = aggregate_route_value_msat - final_value_msat;
1691 // First, we drop some expensive low-value paths entirely if possible, since fewer
1692 // paths is better: the payment is less likely to fail. In order to do so, we sort
1693 // by value and fall back to total fees paid, i.e., in case of equal values we
1694 // prefer lower cost paths.
1695 cur_route.sort_unstable_by(|a, b| {
1696 a.get_value_msat().cmp(&b.get_value_msat())
1697 // Reverse ordering for cost, so we drop higher-cost paths first
1698 .then_with(|| b.get_cost_msat().cmp(&a.get_cost_msat()))
1701 // We should make sure that at least 1 path left.
1702 let mut paths_left = cur_route.len();
1703 cur_route.retain(|path| {
1704 if paths_left == 1 {
1707 let mut keep = true;
1708 let path_value_msat = path.get_value_msat();
1709 if path_value_msat <= overpaid_value_msat {
1711 overpaid_value_msat -= path_value_msat;
1717 if overpaid_value_msat == 0 {
1721 assert!(cur_route.len() > 0);
1724 // Now, subtract the overpaid value from the most-expensive path.
1725 // TODO: this could also be optimized by also sorting by feerate_per_sat_routed,
1726 // so that the sender pays less fees overall. And also htlc_minimum_msat.
1727 cur_route.sort_unstable_by_key(|path| { path.hops.iter().map(|hop| hop.0.candidate.fees().proportional_millionths as u64).sum::<u64>() });
1728 let expensive_payment_path = cur_route.first_mut().unwrap();
1730 // We already dropped all the small value paths above, meaning all the
1731 // remaining paths are larger than remaining overpaid_value_msat.
1732 // Thus, this can't be negative.
1733 let expensive_path_new_value_msat = expensive_payment_path.get_value_msat() - overpaid_value_msat;
1734 expensive_payment_path.update_value_and_recompute_fees(expensive_path_new_value_msat);
1738 drawn_routes.push(cur_route);
1742 // Select the best route by lowest total cost.
1743 drawn_routes.sort_unstable_by_key(|paths| paths.iter().map(|path| path.get_cost_msat()).sum::<u64>());
1744 let selected_route = drawn_routes.first_mut().unwrap();
1746 // Sort by the path itself and combine redundant paths.
1747 // Note that we sort by SCIDs alone as its simpler but when combining we have to ensure we
1748 // compare both SCIDs and NodeIds as individual nodes may use random aliases causing collisions
1750 selected_route.sort_unstable_by_key(|path| {
1751 let mut key = [0u64; MAX_PATH_LENGTH_ESTIMATE as usize];
1752 debug_assert!(path.hops.len() <= key.len());
1753 for (scid, key) in path.hops.iter().map(|h| h.0.candidate.short_channel_id()).zip(key.iter_mut()) {
1758 for idx in 0..(selected_route.len() - 1) {
1759 if idx + 1 >= selected_route.len() { break; }
1760 if iter_equal(selected_route[idx ].hops.iter().map(|h| (h.0.candidate.short_channel_id(), h.0.node_id)),
1761 selected_route[idx + 1].hops.iter().map(|h| (h.0.candidate.short_channel_id(), h.0.node_id))) {
1762 let new_value = selected_route[idx].get_value_msat() + selected_route[idx + 1].get_value_msat();
1763 selected_route[idx].update_value_and_recompute_fees(new_value);
1764 selected_route.remove(idx + 1);
1768 let mut selected_paths = Vec::<Vec<Result<RouteHop, LightningError>>>::new();
1769 for payment_path in selected_route {
1770 let mut path = payment_path.hops.iter().map(|(payment_hop, node_features)| {
1772 pubkey: PublicKey::from_slice(payment_hop.node_id.as_slice()).map_err(|_| LightningError{err: format!("Public key {:?} is invalid", &payment_hop.node_id), action: ErrorAction::IgnoreAndLog(Level::Trace)})?,
1773 node_features: node_features.clone(),
1774 short_channel_id: payment_hop.candidate.short_channel_id(),
1775 channel_features: payment_hop.candidate.features(),
1776 fee_msat: payment_hop.fee_msat,
1777 cltv_expiry_delta: payment_hop.candidate.cltv_expiry_delta(),
1779 }).collect::<Vec<_>>();
1780 // Propagate the cltv_expiry_delta one hop backwards since the delta from the current hop is
1781 // applicable for the previous hop.
1782 path.iter_mut().rev().fold(final_cltv_expiry_delta, |prev_cltv_expiry_delta, hop| {
1783 core::mem::replace(&mut hop.as_mut().unwrap().cltv_expiry_delta, prev_cltv_expiry_delta)
1785 selected_paths.push(path);
1787 // Make sure we would never create a route with more paths than we allow.
1788 debug_assert!(selected_paths.len() <= payment_params.max_path_count.into());
1790 if let Some(features) = &payment_params.features {
1791 for path in selected_paths.iter_mut() {
1792 if let Ok(route_hop) = path.last_mut().unwrap() {
1793 route_hop.node_features = features.to_context();
1799 paths: selected_paths.into_iter().map(|path| path.into_iter().collect()).collect::<Result<Vec<_>, _>>()?,
1800 payment_params: Some(payment_params.clone()),
1802 log_info!(logger, "Got route to {}: {}", payment_params.payee_pubkey, log_route!(route));
1806 // When an adversarial intermediary node observes a payment, it may be able to infer its
1807 // destination, if the remaining CLTV expiry delta exactly matches a feasible path in the network
1808 // graph. In order to improve privacy, this method obfuscates the CLTV expiry deltas along the
1809 // payment path by adding a randomized 'shadow route' offset to the final hop.
1810 fn add_random_cltv_offset(route: &mut Route, payment_params: &PaymentParameters,
1811 network_graph: &ReadOnlyNetworkGraph, random_seed_bytes: &[u8; 32]
1813 let network_channels = network_graph.channels();
1814 let network_nodes = network_graph.nodes();
1816 for path in route.paths.iter_mut() {
1817 let mut shadow_ctlv_expiry_delta_offset: u32 = 0;
1819 // Remember the last three nodes of the random walk and avoid looping back on them.
1820 // Init with the last three nodes from the actual path, if possible.
1821 let mut nodes_to_avoid: [NodeId; 3] = [NodeId::from_pubkey(&path.last().unwrap().pubkey),
1822 NodeId::from_pubkey(&path.get(path.len().saturating_sub(2)).unwrap().pubkey),
1823 NodeId::from_pubkey(&path.get(path.len().saturating_sub(3)).unwrap().pubkey)];
1825 // Choose the last publicly known node as the starting point for the random walk.
1826 let mut cur_hop: Option<NodeId> = None;
1827 let mut path_nonce = [0u8; 12];
1828 if let Some(starting_hop) = path.iter().rev()
1829 .find(|h| network_nodes.contains_key(&NodeId::from_pubkey(&h.pubkey))) {
1830 cur_hop = Some(NodeId::from_pubkey(&starting_hop.pubkey));
1831 path_nonce.copy_from_slice(&cur_hop.unwrap().as_slice()[..12]);
1834 // Init PRNG with the path-dependant nonce, which is static for private paths.
1835 let mut prng = ChaCha20::new(random_seed_bytes, &path_nonce);
1836 let mut random_path_bytes = [0u8; ::core::mem::size_of::<usize>()];
1838 // Pick a random path length in [1 .. 3]
1839 prng.process_in_place(&mut random_path_bytes);
1840 let random_walk_length = usize::from_be_bytes(random_path_bytes).wrapping_rem(3).wrapping_add(1);
1842 for random_hop in 0..random_walk_length {
1843 // If we don't find a suitable offset in the public network graph, we default to
1844 // MEDIAN_HOP_CLTV_EXPIRY_DELTA.
1845 let mut random_hop_offset = MEDIAN_HOP_CLTV_EXPIRY_DELTA;
1847 if let Some(cur_node_id) = cur_hop {
1848 if let Some(cur_node) = network_nodes.get(&cur_node_id) {
1849 // Randomly choose the next unvisited hop.
1850 prng.process_in_place(&mut random_path_bytes);
1851 if let Some(random_channel) = usize::from_be_bytes(random_path_bytes)
1852 .checked_rem(cur_node.channels.len())
1853 .and_then(|index| cur_node.channels.get(index))
1854 .and_then(|id| network_channels.get(id)) {
1855 random_channel.as_directed_from(&cur_node_id).map(|(dir_info, next_id)| {
1856 if !nodes_to_avoid.iter().any(|x| x == next_id) {
1857 nodes_to_avoid[random_hop] = *next_id;
1858 dir_info.direction().map(|channel_update_info| {
1859 random_hop_offset = channel_update_info.cltv_expiry_delta.into();
1860 cur_hop = Some(*next_id);
1868 shadow_ctlv_expiry_delta_offset = shadow_ctlv_expiry_delta_offset
1869 .checked_add(random_hop_offset)
1870 .unwrap_or(shadow_ctlv_expiry_delta_offset);
1873 // Limit the total offset to reduce the worst-case locked liquidity timevalue
1874 const MAX_SHADOW_CLTV_EXPIRY_DELTA_OFFSET: u32 = 3*144;
1875 shadow_ctlv_expiry_delta_offset = cmp::min(shadow_ctlv_expiry_delta_offset, MAX_SHADOW_CLTV_EXPIRY_DELTA_OFFSET);
1877 // Limit the offset so we never exceed the max_total_cltv_expiry_delta. To improve plausibility,
1878 // we choose the limit to be the largest possible multiple of MEDIAN_HOP_CLTV_EXPIRY_DELTA.
1879 let path_total_cltv_expiry_delta: u32 = path.iter().map(|h| h.cltv_expiry_delta).sum();
1880 let mut max_path_offset = payment_params.max_total_cltv_expiry_delta - path_total_cltv_expiry_delta;
1881 max_path_offset = cmp::max(
1882 max_path_offset - (max_path_offset % MEDIAN_HOP_CLTV_EXPIRY_DELTA),
1883 max_path_offset % MEDIAN_HOP_CLTV_EXPIRY_DELTA);
1884 shadow_ctlv_expiry_delta_offset = cmp::min(shadow_ctlv_expiry_delta_offset, max_path_offset);
1886 // Add 'shadow' CLTV offset to the final hop
1887 if let Some(last_hop) = path.last_mut() {
1888 last_hop.cltv_expiry_delta = last_hop.cltv_expiry_delta
1889 .checked_add(shadow_ctlv_expiry_delta_offset).unwrap_or(last_hop.cltv_expiry_delta);
1894 /// Construct a route from us (payer) to the target node (payee) via the given hops (which should
1895 /// exclude the payer, but include the payee). This may be useful, e.g., for probing the chosen path.
1897 /// Re-uses logic from `find_route`, so the restrictions described there also apply here.
1898 pub fn build_route_from_hops<L: Deref, GL: Deref>(
1899 our_node_pubkey: &PublicKey, hops: &[PublicKey], route_params: &RouteParameters,
1900 network_graph: &NetworkGraph<GL>, logger: L, random_seed_bytes: &[u8; 32]
1901 ) -> Result<Route, LightningError>
1902 where L::Target: Logger, GL::Target: Logger {
1903 let graph_lock = network_graph.read_only();
1904 let mut route = build_route_from_hops_internal(
1905 our_node_pubkey, hops, &route_params.payment_params, &graph_lock,
1906 route_params.final_value_msat, route_params.final_cltv_expiry_delta, logger, random_seed_bytes)?;
1907 add_random_cltv_offset(&mut route, &route_params.payment_params, &graph_lock, random_seed_bytes);
1911 fn build_route_from_hops_internal<L: Deref>(
1912 our_node_pubkey: &PublicKey, hops: &[PublicKey], payment_params: &PaymentParameters,
1913 network_graph: &ReadOnlyNetworkGraph, final_value_msat: u64, final_cltv_expiry_delta: u32,
1914 logger: L, random_seed_bytes: &[u8; 32]
1915 ) -> Result<Route, LightningError> where L::Target: Logger {
1918 our_node_id: NodeId,
1919 hop_ids: [Option<NodeId>; MAX_PATH_LENGTH_ESTIMATE as usize],
1922 impl Score for HopScorer {
1923 fn channel_penalty_msat(&self, _short_channel_id: u64, source: &NodeId, target: &NodeId,
1924 _usage: ChannelUsage) -> u64
1926 let mut cur_id = self.our_node_id;
1927 for i in 0..self.hop_ids.len() {
1928 if let Some(next_id) = self.hop_ids[i] {
1929 if cur_id == *source && next_id == *target {
1940 fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) {}
1942 fn payment_path_successful(&mut self, _path: &[&RouteHop]) {}
1944 fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) {}
1946 fn probe_successful(&mut self, _path: &[&RouteHop]) {}
1949 impl<'a> Writeable for HopScorer {
1951 fn write<W: Writer>(&self, _w: &mut W) -> Result<(), io::Error> {
1956 if hops.len() > MAX_PATH_LENGTH_ESTIMATE.into() {
1957 return Err(LightningError{err: "Cannot build a route exceeding the maximum path length.".to_owned(), action: ErrorAction::IgnoreError});
1960 let our_node_id = NodeId::from_pubkey(our_node_pubkey);
1961 let mut hop_ids = [None; MAX_PATH_LENGTH_ESTIMATE as usize];
1962 for i in 0..hops.len() {
1963 hop_ids[i] = Some(NodeId::from_pubkey(&hops[i]));
1966 let scorer = HopScorer { our_node_id, hop_ids };
1968 get_route(our_node_pubkey, payment_params, network_graph, None, final_value_msat,
1969 final_cltv_expiry_delta, logger, &scorer, random_seed_bytes)
1974 use routing::gossip::{NetworkGraph, P2PGossipSync, NodeId, EffectiveCapacity};
1975 use routing::router::{get_route, build_route_from_hops_internal, add_random_cltv_offset, default_node_features,
1976 PaymentParameters, Route, RouteHint, RouteHintHop, RouteHop, RoutingFees,
1977 DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA, MAX_PATH_LENGTH_ESTIMATE};
1978 use routing::scoring::{ChannelUsage, Score, ProbabilisticScorer, ProbabilisticScoringParameters};
1979 use chain::transaction::OutPoint;
1980 use chain::keysinterface::KeysInterface;
1981 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
1982 use ln::msgs::{ErrorAction, LightningError, OptionalField, UnsignedChannelAnnouncement, ChannelAnnouncement, RoutingMessageHandler,
1983 NodeAnnouncement, UnsignedNodeAnnouncement, ChannelUpdate, UnsignedChannelUpdate};
1984 use ln::channelmanager;
1985 use util::test_utils;
1986 use util::chacha20::ChaCha20;
1987 use util::ser::Writeable;
1989 use util::ser::Writer;
1991 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
1992 use bitcoin::hashes::Hash;
1993 use bitcoin::network::constants::Network;
1994 use bitcoin::blockdata::constants::genesis_block;
1995 use bitcoin::blockdata::script::Builder;
1996 use bitcoin::blockdata::opcodes;
1997 use bitcoin::blockdata::transaction::TxOut;
2001 use bitcoin::secp256k1::{PublicKey,SecretKey};
2002 use bitcoin::secp256k1::{Secp256k1, All};
2005 use sync::{self, Arc};
2007 use core::convert::TryInto;
2009 fn get_channel_details(short_channel_id: Option<u64>, node_id: PublicKey,
2010 features: InitFeatures, outbound_capacity_msat: u64) -> channelmanager::ChannelDetails {
2011 channelmanager::ChannelDetails {
2012 channel_id: [0; 32],
2013 counterparty: channelmanager::ChannelCounterparty {
2016 unspendable_punishment_reserve: 0,
2017 forwarding_info: None,
2018 outbound_htlc_minimum_msat: None,
2019 outbound_htlc_maximum_msat: None,
2021 funding_txo: Some(OutPoint { txid: bitcoin::Txid::from_slice(&[0; 32]).unwrap(), index: 0 }),
2024 outbound_scid_alias: None,
2025 inbound_scid_alias: None,
2026 channel_value_satoshis: 0,
2029 outbound_capacity_msat,
2030 next_outbound_htlc_limit_msat: outbound_capacity_msat,
2031 inbound_capacity_msat: 42,
2032 unspendable_punishment_reserve: None,
2033 confirmations_required: None,
2034 force_close_spend_delay: None,
2035 is_outbound: true, is_channel_ready: true,
2036 is_usable: true, is_public: true,
2037 inbound_htlc_minimum_msat: None,
2038 inbound_htlc_maximum_msat: None,
2043 // Using the same keys for LN and BTC ids
2045 gossip_sync: &P2PGossipSync<Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>,
2046 secp_ctx: &Secp256k1<All>, node_1_privkey: &SecretKey, node_2_privkey: &SecretKey, features: ChannelFeatures, short_channel_id: u64
2048 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
2049 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
2051 let unsigned_announcement = UnsignedChannelAnnouncement {
2053 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2057 bitcoin_key_1: node_id_1,
2058 bitcoin_key_2: node_id_2,
2059 excess_data: Vec::new(),
2062 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
2063 let valid_announcement = ChannelAnnouncement {
2064 node_signature_1: secp_ctx.sign_ecdsa(&msghash, node_1_privkey),
2065 node_signature_2: secp_ctx.sign_ecdsa(&msghash, node_2_privkey),
2066 bitcoin_signature_1: secp_ctx.sign_ecdsa(&msghash, node_1_privkey),
2067 bitcoin_signature_2: secp_ctx.sign_ecdsa(&msghash, node_2_privkey),
2068 contents: unsigned_announcement.clone(),
2070 match gossip_sync.handle_channel_announcement(&valid_announcement) {
2071 Ok(res) => assert!(res),
2077 gossip_sync: &P2PGossipSync<Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>,
2078 secp_ctx: &Secp256k1<All>, node_privkey: &SecretKey, update: UnsignedChannelUpdate
2080 let msghash = hash_to_message!(&Sha256dHash::hash(&update.encode()[..])[..]);
2081 let valid_channel_update = ChannelUpdate {
2082 signature: secp_ctx.sign_ecdsa(&msghash, node_privkey),
2083 contents: update.clone()
2086 match gossip_sync.handle_channel_update(&valid_channel_update) {
2087 Ok(res) => assert!(res),
2092 fn add_or_update_node(
2093 gossip_sync: &P2PGossipSync<Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>,
2094 secp_ctx: &Secp256k1<All>, node_privkey: &SecretKey, features: NodeFeatures, timestamp: u32
2096 let node_id = PublicKey::from_secret_key(&secp_ctx, node_privkey);
2097 let unsigned_announcement = UnsignedNodeAnnouncement {
2103 addresses: Vec::new(),
2104 excess_address_data: Vec::new(),
2105 excess_data: Vec::new(),
2107 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
2108 let valid_announcement = NodeAnnouncement {
2109 signature: secp_ctx.sign_ecdsa(&msghash, node_privkey),
2110 contents: unsigned_announcement.clone()
2113 match gossip_sync.handle_node_announcement(&valid_announcement) {
2119 fn get_nodes(secp_ctx: &Secp256k1<All>) -> (SecretKey, PublicKey, Vec<SecretKey>, Vec<PublicKey>) {
2120 let privkeys: Vec<SecretKey> = (2..22).map(|i| {
2121 SecretKey::from_slice(&hex::decode(format!("{:02x}", i).repeat(32)).unwrap()[..]).unwrap()
2124 let pubkeys = privkeys.iter().map(|secret| PublicKey::from_secret_key(&secp_ctx, secret)).collect();
2126 let our_privkey = SecretKey::from_slice(&hex::decode("01".repeat(32)).unwrap()[..]).unwrap();
2127 let our_id = PublicKey::from_secret_key(&secp_ctx, &our_privkey);
2129 (our_privkey, our_id, privkeys, pubkeys)
2132 fn id_to_feature_flags(id: u8) -> Vec<u8> {
2133 // Set the feature flags to the id'th odd (ie non-required) feature bit so that we can
2134 // test for it later.
2135 let idx = (id - 1) * 2 + 1;
2137 vec![1 << (idx - 8*3), 0, 0, 0]
2138 } else if idx > 8*2 {
2139 vec![1 << (idx - 8*2), 0, 0]
2140 } else if idx > 8*1 {
2141 vec![1 << (idx - 8*1), 0]
2147 fn build_line_graph() -> (
2148 Secp256k1<All>, sync::Arc<NetworkGraph<Arc<test_utils::TestLogger>>>,
2149 P2PGossipSync<sync::Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, sync::Arc<test_utils::TestChainSource>, sync::Arc<test_utils::TestLogger>>,
2150 sync::Arc<test_utils::TestChainSource>, sync::Arc<test_utils::TestLogger>,
2152 let secp_ctx = Secp256k1::new();
2153 let logger = Arc::new(test_utils::TestLogger::new());
2154 let chain_monitor = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
2155 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
2156 let network_graph = Arc::new(NetworkGraph::new(genesis_hash, Arc::clone(&logger)));
2157 let gossip_sync = P2PGossipSync::new(Arc::clone(&network_graph), None, Arc::clone(&logger));
2159 // Build network from our_id to node 19:
2160 // our_id -1(1)2- node0 -1(2)2- node1 - ... - node19
2161 let (our_privkey, _, privkeys, _) = get_nodes(&secp_ctx);
2163 for (idx, (cur_privkey, next_privkey)) in core::iter::once(&our_privkey)
2164 .chain(privkeys.iter()).zip(privkeys.iter()).enumerate() {
2165 let cur_short_channel_id = (idx as u64) + 1;
2166 add_channel(&gossip_sync, &secp_ctx, &cur_privkey, &next_privkey,
2167 ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), cur_short_channel_id);
2168 update_channel(&gossip_sync, &secp_ctx, &cur_privkey, UnsignedChannelUpdate {
2169 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2170 short_channel_id: cur_short_channel_id,
2171 timestamp: idx as u32,
2173 cltv_expiry_delta: 0,
2174 htlc_minimum_msat: 0,
2175 htlc_maximum_msat: OptionalField::Absent,
2177 fee_proportional_millionths: 0,
2178 excess_data: Vec::new()
2180 update_channel(&gossip_sync, &secp_ctx, &next_privkey, UnsignedChannelUpdate {
2181 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2182 short_channel_id: cur_short_channel_id,
2183 timestamp: (idx as u32)+1,
2185 cltv_expiry_delta: 0,
2186 htlc_minimum_msat: 0,
2187 htlc_maximum_msat: OptionalField::Absent,
2189 fee_proportional_millionths: 0,
2190 excess_data: Vec::new()
2192 add_or_update_node(&gossip_sync, &secp_ctx, next_privkey,
2193 NodeFeatures::from_le_bytes(id_to_feature_flags(1)), 0);
2196 (secp_ctx, network_graph, gossip_sync, chain_monitor, logger)
2199 fn build_graph() -> (
2201 sync::Arc<NetworkGraph<Arc<test_utils::TestLogger>>>,
2202 P2PGossipSync<sync::Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, sync::Arc<test_utils::TestChainSource>, sync::Arc<test_utils::TestLogger>>,
2203 sync::Arc<test_utils::TestChainSource>,
2204 sync::Arc<test_utils::TestLogger>,
2206 let secp_ctx = Secp256k1::new();
2207 let logger = Arc::new(test_utils::TestLogger::new());
2208 let chain_monitor = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
2209 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
2210 let network_graph = Arc::new(NetworkGraph::new(genesis_hash, Arc::clone(&logger)));
2211 let gossip_sync = P2PGossipSync::new(Arc::clone(&network_graph), None, Arc::clone(&logger));
2212 // Build network from our_id to node6:
2214 // -1(1)2- node0 -1(3)2-
2216 // our_id -1(12)2- node7 -1(13)2--- node2
2218 // -1(2)2- node1 -1(4)2-
2221 // chan1 1-to-2: disabled
2222 // chan1 2-to-1: enabled, 0 fee
2224 // chan2 1-to-2: enabled, ignored fee
2225 // chan2 2-to-1: enabled, 0 fee
2227 // chan3 1-to-2: enabled, 0 fee
2228 // chan3 2-to-1: enabled, 100 msat fee
2230 // chan4 1-to-2: enabled, 100% fee
2231 // chan4 2-to-1: enabled, 0 fee
2233 // chan12 1-to-2: enabled, ignored fee
2234 // chan12 2-to-1: enabled, 0 fee
2236 // chan13 1-to-2: enabled, 200% fee
2237 // chan13 2-to-1: enabled, 0 fee
2240 // -1(5)2- node3 -1(8)2--
2244 // node2--1(6)2- node4 -1(9)2--- node6 (not in global route map)
2246 // -1(7)2- node5 -1(10)2-
2248 // Channels 5, 8, 9 and 10 are private channels.
2250 // chan5 1-to-2: enabled, 100 msat fee
2251 // chan5 2-to-1: enabled, 0 fee
2253 // chan6 1-to-2: enabled, 0 fee
2254 // chan6 2-to-1: enabled, 0 fee
2256 // chan7 1-to-2: enabled, 100% fee
2257 // chan7 2-to-1: enabled, 0 fee
2259 // chan8 1-to-2: enabled, variable fee (0 then 1000 msat)
2260 // chan8 2-to-1: enabled, 0 fee
2262 // chan9 1-to-2: enabled, 1001 msat fee
2263 // chan9 2-to-1: enabled, 0 fee
2265 // chan10 1-to-2: enabled, 0 fee
2266 // chan10 2-to-1: enabled, 0 fee
2268 // chan11 1-to-2: enabled, 0 fee
2269 // chan11 2-to-1: enabled, 0 fee
2271 let (our_privkey, _, privkeys, _) = get_nodes(&secp_ctx);
2273 add_channel(&gossip_sync, &secp_ctx, &our_privkey, &privkeys[0], ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 1);
2274 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
2275 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2276 short_channel_id: 1,
2279 cltv_expiry_delta: 0,
2280 htlc_minimum_msat: 0,
2281 htlc_maximum_msat: OptionalField::Absent,
2283 fee_proportional_millionths: 0,
2284 excess_data: Vec::new()
2287 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[0], NodeFeatures::from_le_bytes(id_to_feature_flags(1)), 0);
2289 add_channel(&gossip_sync, &secp_ctx, &our_privkey, &privkeys[1], ChannelFeatures::from_le_bytes(id_to_feature_flags(2)), 2);
2290 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2291 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2292 short_channel_id: 2,
2295 cltv_expiry_delta: (5 << 4) | 3,
2296 htlc_minimum_msat: 0,
2297 htlc_maximum_msat: OptionalField::Absent,
2298 fee_base_msat: u32::max_value(),
2299 fee_proportional_millionths: u32::max_value(),
2300 excess_data: Vec::new()
2302 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
2303 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2304 short_channel_id: 2,
2307 cltv_expiry_delta: 0,
2308 htlc_minimum_msat: 0,
2309 htlc_maximum_msat: OptionalField::Absent,
2311 fee_proportional_millionths: 0,
2312 excess_data: Vec::new()
2315 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[1], NodeFeatures::from_le_bytes(id_to_feature_flags(2)), 0);
2317 add_channel(&gossip_sync, &secp_ctx, &our_privkey, &privkeys[7], ChannelFeatures::from_le_bytes(id_to_feature_flags(12)), 12);
2318 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2319 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2320 short_channel_id: 12,
2323 cltv_expiry_delta: (5 << 4) | 3,
2324 htlc_minimum_msat: 0,
2325 htlc_maximum_msat: OptionalField::Absent,
2326 fee_base_msat: u32::max_value(),
2327 fee_proportional_millionths: u32::max_value(),
2328 excess_data: Vec::new()
2330 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
2331 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2332 short_channel_id: 12,
2335 cltv_expiry_delta: 0,
2336 htlc_minimum_msat: 0,
2337 htlc_maximum_msat: OptionalField::Absent,
2339 fee_proportional_millionths: 0,
2340 excess_data: Vec::new()
2343 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[7], NodeFeatures::from_le_bytes(id_to_feature_flags(8)), 0);
2345 add_channel(&gossip_sync, &secp_ctx, &privkeys[0], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(3)), 3);
2346 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
2347 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2348 short_channel_id: 3,
2351 cltv_expiry_delta: (3 << 4) | 1,
2352 htlc_minimum_msat: 0,
2353 htlc_maximum_msat: OptionalField::Absent,
2355 fee_proportional_millionths: 0,
2356 excess_data: Vec::new()
2358 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
2359 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2360 short_channel_id: 3,
2363 cltv_expiry_delta: (3 << 4) | 2,
2364 htlc_minimum_msat: 0,
2365 htlc_maximum_msat: OptionalField::Absent,
2367 fee_proportional_millionths: 0,
2368 excess_data: Vec::new()
2371 add_channel(&gossip_sync, &secp_ctx, &privkeys[1], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(4)), 4);
2372 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
2373 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2374 short_channel_id: 4,
2377 cltv_expiry_delta: (4 << 4) | 1,
2378 htlc_minimum_msat: 0,
2379 htlc_maximum_msat: OptionalField::Absent,
2381 fee_proportional_millionths: 1000000,
2382 excess_data: Vec::new()
2384 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
2385 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2386 short_channel_id: 4,
2389 cltv_expiry_delta: (4 << 4) | 2,
2390 htlc_minimum_msat: 0,
2391 htlc_maximum_msat: OptionalField::Absent,
2393 fee_proportional_millionths: 0,
2394 excess_data: Vec::new()
2397 add_channel(&gossip_sync, &secp_ctx, &privkeys[7], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(13)), 13);
2398 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
2399 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2400 short_channel_id: 13,
2403 cltv_expiry_delta: (13 << 4) | 1,
2404 htlc_minimum_msat: 0,
2405 htlc_maximum_msat: OptionalField::Absent,
2407 fee_proportional_millionths: 2000000,
2408 excess_data: Vec::new()
2410 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
2411 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2412 short_channel_id: 13,
2415 cltv_expiry_delta: (13 << 4) | 2,
2416 htlc_minimum_msat: 0,
2417 htlc_maximum_msat: OptionalField::Absent,
2419 fee_proportional_millionths: 0,
2420 excess_data: Vec::new()
2423 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[2], NodeFeatures::from_le_bytes(id_to_feature_flags(3)), 0);
2425 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[4], ChannelFeatures::from_le_bytes(id_to_feature_flags(6)), 6);
2426 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
2427 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2428 short_channel_id: 6,
2431 cltv_expiry_delta: (6 << 4) | 1,
2432 htlc_minimum_msat: 0,
2433 htlc_maximum_msat: OptionalField::Absent,
2435 fee_proportional_millionths: 0,
2436 excess_data: Vec::new()
2438 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
2439 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2440 short_channel_id: 6,
2443 cltv_expiry_delta: (6 << 4) | 2,
2444 htlc_minimum_msat: 0,
2445 htlc_maximum_msat: OptionalField::Absent,
2447 fee_proportional_millionths: 0,
2448 excess_data: Vec::new(),
2451 add_channel(&gossip_sync, &secp_ctx, &privkeys[4], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(11)), 11);
2452 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
2453 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2454 short_channel_id: 11,
2457 cltv_expiry_delta: (11 << 4) | 1,
2458 htlc_minimum_msat: 0,
2459 htlc_maximum_msat: OptionalField::Absent,
2461 fee_proportional_millionths: 0,
2462 excess_data: Vec::new()
2464 update_channel(&gossip_sync, &secp_ctx, &privkeys[3], UnsignedChannelUpdate {
2465 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2466 short_channel_id: 11,
2469 cltv_expiry_delta: (11 << 4) | 2,
2470 htlc_minimum_msat: 0,
2471 htlc_maximum_msat: OptionalField::Absent,
2473 fee_proportional_millionths: 0,
2474 excess_data: Vec::new()
2477 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[4], NodeFeatures::from_le_bytes(id_to_feature_flags(5)), 0);
2479 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[3], NodeFeatures::from_le_bytes(id_to_feature_flags(4)), 0);
2481 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[5], ChannelFeatures::from_le_bytes(id_to_feature_flags(7)), 7);
2482 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
2483 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2484 short_channel_id: 7,
2487 cltv_expiry_delta: (7 << 4) | 1,
2488 htlc_minimum_msat: 0,
2489 htlc_maximum_msat: OptionalField::Absent,
2491 fee_proportional_millionths: 1000000,
2492 excess_data: Vec::new()
2494 update_channel(&gossip_sync, &secp_ctx, &privkeys[5], UnsignedChannelUpdate {
2495 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2496 short_channel_id: 7,
2499 cltv_expiry_delta: (7 << 4) | 2,
2500 htlc_minimum_msat: 0,
2501 htlc_maximum_msat: OptionalField::Absent,
2503 fee_proportional_millionths: 0,
2504 excess_data: Vec::new()
2507 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[5], NodeFeatures::from_le_bytes(id_to_feature_flags(6)), 0);
2509 (secp_ctx, network_graph, gossip_sync, chain_monitor, logger)
2513 fn simple_route_test() {
2514 let (secp_ctx, network_graph, _, _, logger) = build_graph();
2515 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
2516 let payment_params = PaymentParameters::from_node_id(nodes[2]);
2517 let scorer = test_utils::TestScorer::with_penalty(0);
2518 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
2519 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2521 // Simple route to 2 via 1
2523 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 0, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
2524 assert_eq!(err, "Cannot send a payment of 0 msat");
2525 } else { panic!(); }
2527 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
2528 assert_eq!(route.paths[0].len(), 2);
2530 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
2531 assert_eq!(route.paths[0][0].short_channel_id, 2);
2532 assert_eq!(route.paths[0][0].fee_msat, 100);
2533 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1);
2534 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
2535 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
2537 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
2538 assert_eq!(route.paths[0][1].short_channel_id, 4);
2539 assert_eq!(route.paths[0][1].fee_msat, 100);
2540 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
2541 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
2542 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
2546 fn invalid_first_hop_test() {
2547 let (secp_ctx, network_graph, _, _, logger) = build_graph();
2548 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
2549 let payment_params = PaymentParameters::from_node_id(nodes[2]);
2550 let scorer = test_utils::TestScorer::with_penalty(0);
2551 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
2552 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2554 // Simple route to 2 via 1
2556 let our_chans = vec![get_channel_details(Some(2), our_id, InitFeatures::from_le_bytes(vec![0b11]), 100000)];
2558 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) =
2559 get_route(&our_id, &payment_params, &network_graph.read_only(), Some(&our_chans.iter().collect::<Vec<_>>()), 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
2560 assert_eq!(err, "First hop cannot have our_node_pubkey as a destination.");
2561 } else { panic!(); }
2563 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
2564 assert_eq!(route.paths[0].len(), 2);
2568 fn htlc_minimum_test() {
2569 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
2570 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
2571 let payment_params = PaymentParameters::from_node_id(nodes[2]);
2572 let scorer = test_utils::TestScorer::with_penalty(0);
2573 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
2574 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2576 // Simple route to 2 via 1
2578 // Disable other paths
2579 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2580 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2581 short_channel_id: 12,
2583 flags: 2, // to disable
2584 cltv_expiry_delta: 0,
2585 htlc_minimum_msat: 0,
2586 htlc_maximum_msat: OptionalField::Absent,
2588 fee_proportional_millionths: 0,
2589 excess_data: Vec::new()
2591 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
2592 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2593 short_channel_id: 3,
2595 flags: 2, // to disable
2596 cltv_expiry_delta: 0,
2597 htlc_minimum_msat: 0,
2598 htlc_maximum_msat: OptionalField::Absent,
2600 fee_proportional_millionths: 0,
2601 excess_data: Vec::new()
2603 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
2604 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2605 short_channel_id: 13,
2607 flags: 2, // to disable
2608 cltv_expiry_delta: 0,
2609 htlc_minimum_msat: 0,
2610 htlc_maximum_msat: OptionalField::Absent,
2612 fee_proportional_millionths: 0,
2613 excess_data: Vec::new()
2615 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
2616 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2617 short_channel_id: 6,
2619 flags: 2, // to disable
2620 cltv_expiry_delta: 0,
2621 htlc_minimum_msat: 0,
2622 htlc_maximum_msat: OptionalField::Absent,
2624 fee_proportional_millionths: 0,
2625 excess_data: Vec::new()
2627 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
2628 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2629 short_channel_id: 7,
2631 flags: 2, // to disable
2632 cltv_expiry_delta: 0,
2633 htlc_minimum_msat: 0,
2634 htlc_maximum_msat: OptionalField::Absent,
2636 fee_proportional_millionths: 0,
2637 excess_data: Vec::new()
2640 // Check against amount_to_transfer_over_msat.
2641 // Set minimal HTLC of 200_000_000 msat.
2642 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2643 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2644 short_channel_id: 2,
2647 cltv_expiry_delta: 0,
2648 htlc_minimum_msat: 200_000_000,
2649 htlc_maximum_msat: OptionalField::Absent,
2651 fee_proportional_millionths: 0,
2652 excess_data: Vec::new()
2655 // Second hop only allows to forward 199_999_999 at most, thus not allowing the first hop to
2657 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
2658 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2659 short_channel_id: 4,
2662 cltv_expiry_delta: 0,
2663 htlc_minimum_msat: 0,
2664 htlc_maximum_msat: OptionalField::Present(199_999_999),
2666 fee_proportional_millionths: 0,
2667 excess_data: Vec::new()
2670 // Not possible to send 199_999_999, because the minimum on channel=2 is 200_000_000.
2671 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 199_999_999, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
2672 assert_eq!(err, "Failed to find a path to the given destination");
2673 } else { panic!(); }
2675 // Lift the restriction on the first hop.
2676 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2677 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2678 short_channel_id: 2,
2681 cltv_expiry_delta: 0,
2682 htlc_minimum_msat: 0,
2683 htlc_maximum_msat: OptionalField::Absent,
2685 fee_proportional_millionths: 0,
2686 excess_data: Vec::new()
2689 // A payment above the minimum should pass
2690 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 199_999_999, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
2691 assert_eq!(route.paths[0].len(), 2);
2695 fn htlc_minimum_overpay_test() {
2696 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
2697 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
2698 let payment_params = PaymentParameters::from_node_id(nodes[2]).with_features(InvoiceFeatures::known());
2699 let scorer = test_utils::TestScorer::with_penalty(0);
2700 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
2701 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2703 // A route to node#2 via two paths.
2704 // One path allows transferring 35-40 sats, another one also allows 35-40 sats.
2705 // Thus, they can't send 60 without overpaying.
2706 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2707 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2708 short_channel_id: 2,
2711 cltv_expiry_delta: 0,
2712 htlc_minimum_msat: 35_000,
2713 htlc_maximum_msat: OptionalField::Present(40_000),
2715 fee_proportional_millionths: 0,
2716 excess_data: Vec::new()
2718 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2719 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2720 short_channel_id: 12,
2723 cltv_expiry_delta: 0,
2724 htlc_minimum_msat: 35_000,
2725 htlc_maximum_msat: OptionalField::Present(40_000),
2727 fee_proportional_millionths: 0,
2728 excess_data: Vec::new()
2732 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
2733 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2734 short_channel_id: 13,
2737 cltv_expiry_delta: 0,
2738 htlc_minimum_msat: 0,
2739 htlc_maximum_msat: OptionalField::Absent,
2741 fee_proportional_millionths: 0,
2742 excess_data: Vec::new()
2744 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
2745 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2746 short_channel_id: 4,
2749 cltv_expiry_delta: 0,
2750 htlc_minimum_msat: 0,
2751 htlc_maximum_msat: OptionalField::Absent,
2753 fee_proportional_millionths: 0,
2754 excess_data: Vec::new()
2757 // Disable other paths
2758 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2759 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2760 short_channel_id: 1,
2762 flags: 2, // to disable
2763 cltv_expiry_delta: 0,
2764 htlc_minimum_msat: 0,
2765 htlc_maximum_msat: OptionalField::Absent,
2767 fee_proportional_millionths: 0,
2768 excess_data: Vec::new()
2771 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 60_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
2772 // Overpay fees to hit htlc_minimum_msat.
2773 let overpaid_fees = route.paths[0][0].fee_msat + route.paths[1][0].fee_msat;
2774 // TODO: this could be better balanced to overpay 10k and not 15k.
2775 assert_eq!(overpaid_fees, 15_000);
2777 // Now, test that if there are 2 paths, a "cheaper" by fee path wouldn't be prioritized
2778 // while taking even more fee to match htlc_minimum_msat.
2779 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2780 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2781 short_channel_id: 12,
2784 cltv_expiry_delta: 0,
2785 htlc_minimum_msat: 65_000,
2786 htlc_maximum_msat: OptionalField::Present(80_000),
2788 fee_proportional_millionths: 0,
2789 excess_data: Vec::new()
2791 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2792 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2793 short_channel_id: 2,
2796 cltv_expiry_delta: 0,
2797 htlc_minimum_msat: 0,
2798 htlc_maximum_msat: OptionalField::Absent,
2800 fee_proportional_millionths: 0,
2801 excess_data: Vec::new()
2803 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
2804 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2805 short_channel_id: 4,
2808 cltv_expiry_delta: 0,
2809 htlc_minimum_msat: 0,
2810 htlc_maximum_msat: OptionalField::Absent,
2812 fee_proportional_millionths: 100_000,
2813 excess_data: Vec::new()
2816 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 60_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
2817 // Fine to overpay for htlc_minimum_msat if it allows us to save fee.
2818 assert_eq!(route.paths.len(), 1);
2819 assert_eq!(route.paths[0][0].short_channel_id, 12);
2820 let fees = route.paths[0][0].fee_msat;
2821 assert_eq!(fees, 5_000);
2823 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 50_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
2824 // Not fine to overpay for htlc_minimum_msat if it requires paying more than fee on
2825 // the other channel.
2826 assert_eq!(route.paths.len(), 1);
2827 assert_eq!(route.paths[0][0].short_channel_id, 2);
2828 let fees = route.paths[0][0].fee_msat;
2829 assert_eq!(fees, 5_000);
2833 fn disable_channels_test() {
2834 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
2835 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
2836 let payment_params = PaymentParameters::from_node_id(nodes[2]);
2837 let scorer = test_utils::TestScorer::with_penalty(0);
2838 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
2839 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2841 // // Disable channels 4 and 12 by flags=2
2842 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
2843 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2844 short_channel_id: 4,
2846 flags: 2, // to disable
2847 cltv_expiry_delta: 0,
2848 htlc_minimum_msat: 0,
2849 htlc_maximum_msat: OptionalField::Absent,
2851 fee_proportional_millionths: 0,
2852 excess_data: Vec::new()
2854 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2855 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2856 short_channel_id: 12,
2858 flags: 2, // to disable
2859 cltv_expiry_delta: 0,
2860 htlc_minimum_msat: 0,
2861 htlc_maximum_msat: OptionalField::Absent,
2863 fee_proportional_millionths: 0,
2864 excess_data: Vec::new()
2867 // If all the channels require some features we don't understand, route should fail
2868 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
2869 assert_eq!(err, "Failed to find a path to the given destination");
2870 } else { panic!(); }
2872 // If we specify a channel to node7, that overrides our local channel view and that gets used
2873 let our_chans = vec![get_channel_details(Some(42), nodes[7].clone(), InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)];
2874 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), Some(&our_chans.iter().collect::<Vec<_>>()), 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
2875 assert_eq!(route.paths[0].len(), 2);
2877 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
2878 assert_eq!(route.paths[0][0].short_channel_id, 42);
2879 assert_eq!(route.paths[0][0].fee_msat, 200);
2880 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 4) | 1);
2881 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
2882 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
2884 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
2885 assert_eq!(route.paths[0][1].short_channel_id, 13);
2886 assert_eq!(route.paths[0][1].fee_msat, 100);
2887 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
2888 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
2889 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
2893 fn disable_node_test() {
2894 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
2895 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
2896 let payment_params = PaymentParameters::from_node_id(nodes[2]);
2897 let scorer = test_utils::TestScorer::with_penalty(0);
2898 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
2899 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2901 // Disable nodes 1, 2, and 8 by requiring unknown feature bits
2902 let mut unknown_features = NodeFeatures::known();
2903 unknown_features.set_unknown_feature_required();
2904 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[0], unknown_features.clone(), 1);
2905 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[1], unknown_features.clone(), 1);
2906 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[7], unknown_features.clone(), 1);
2908 // If all nodes require some features we don't understand, route should fail
2909 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
2910 assert_eq!(err, "Failed to find a path to the given destination");
2911 } else { panic!(); }
2913 // If we specify a channel to node7, that overrides our local channel view and that gets used
2914 let our_chans = vec![get_channel_details(Some(42), nodes[7].clone(), InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)];
2915 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), Some(&our_chans.iter().collect::<Vec<_>>()), 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
2916 assert_eq!(route.paths[0].len(), 2);
2918 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
2919 assert_eq!(route.paths[0][0].short_channel_id, 42);
2920 assert_eq!(route.paths[0][0].fee_msat, 200);
2921 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 4) | 1);
2922 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
2923 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
2925 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
2926 assert_eq!(route.paths[0][1].short_channel_id, 13);
2927 assert_eq!(route.paths[0][1].fee_msat, 100);
2928 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
2929 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
2930 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
2932 // Note that we don't test disabling node 3 and failing to route to it, as we (somewhat
2933 // naively) assume that the user checked the feature bits on the invoice, which override
2934 // the node_announcement.
2938 fn our_chans_test() {
2939 let (secp_ctx, network_graph, _, _, logger) = build_graph();
2940 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
2941 let scorer = test_utils::TestScorer::with_penalty(0);
2942 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
2943 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2945 // Route to 1 via 2 and 3 because our channel to 1 is disabled
2946 let payment_params = PaymentParameters::from_node_id(nodes[0]);
2947 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
2948 assert_eq!(route.paths[0].len(), 3);
2950 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
2951 assert_eq!(route.paths[0][0].short_channel_id, 2);
2952 assert_eq!(route.paths[0][0].fee_msat, 200);
2953 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1);
2954 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
2955 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
2957 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
2958 assert_eq!(route.paths[0][1].short_channel_id, 4);
2959 assert_eq!(route.paths[0][1].fee_msat, 100);
2960 assert_eq!(route.paths[0][1].cltv_expiry_delta, (3 << 4) | 2);
2961 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
2962 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
2964 assert_eq!(route.paths[0][2].pubkey, nodes[0]);
2965 assert_eq!(route.paths[0][2].short_channel_id, 3);
2966 assert_eq!(route.paths[0][2].fee_msat, 100);
2967 assert_eq!(route.paths[0][2].cltv_expiry_delta, 42);
2968 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(1));
2969 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(3));
2971 // If we specify a channel to node7, that overrides our local channel view and that gets used
2972 let payment_params = PaymentParameters::from_node_id(nodes[2]);
2973 let our_chans = vec![get_channel_details(Some(42), nodes[7].clone(), InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)];
2974 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), Some(&our_chans.iter().collect::<Vec<_>>()), 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
2975 assert_eq!(route.paths[0].len(), 2);
2977 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
2978 assert_eq!(route.paths[0][0].short_channel_id, 42);
2979 assert_eq!(route.paths[0][0].fee_msat, 200);
2980 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 4) | 1);
2981 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]);
2982 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
2984 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
2985 assert_eq!(route.paths[0][1].short_channel_id, 13);
2986 assert_eq!(route.paths[0][1].fee_msat, 100);
2987 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
2988 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
2989 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
2992 fn last_hops(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
2993 let zero_fees = RoutingFees {
2995 proportional_millionths: 0,
2997 vec![RouteHint(vec![RouteHintHop {
2998 src_node_id: nodes[3],
2999 short_channel_id: 8,
3001 cltv_expiry_delta: (8 << 4) | 1,
3002 htlc_minimum_msat: None,
3003 htlc_maximum_msat: None,
3005 ]), RouteHint(vec![RouteHintHop {
3006 src_node_id: nodes[4],
3007 short_channel_id: 9,
3010 proportional_millionths: 0,
3012 cltv_expiry_delta: (9 << 4) | 1,
3013 htlc_minimum_msat: None,
3014 htlc_maximum_msat: None,
3015 }]), RouteHint(vec![RouteHintHop {
3016 src_node_id: nodes[5],
3017 short_channel_id: 10,
3019 cltv_expiry_delta: (10 << 4) | 1,
3020 htlc_minimum_msat: None,
3021 htlc_maximum_msat: None,
3025 fn last_hops_multi_private_channels(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
3026 let zero_fees = RoutingFees {
3028 proportional_millionths: 0,
3030 vec![RouteHint(vec![RouteHintHop {
3031 src_node_id: nodes[2],
3032 short_channel_id: 5,
3035 proportional_millionths: 0,
3037 cltv_expiry_delta: (5 << 4) | 1,
3038 htlc_minimum_msat: None,
3039 htlc_maximum_msat: None,
3041 src_node_id: nodes[3],
3042 short_channel_id: 8,
3044 cltv_expiry_delta: (8 << 4) | 1,
3045 htlc_minimum_msat: None,
3046 htlc_maximum_msat: None,
3048 ]), RouteHint(vec![RouteHintHop {
3049 src_node_id: nodes[4],
3050 short_channel_id: 9,
3053 proportional_millionths: 0,
3055 cltv_expiry_delta: (9 << 4) | 1,
3056 htlc_minimum_msat: None,
3057 htlc_maximum_msat: None,
3058 }]), RouteHint(vec![RouteHintHop {
3059 src_node_id: nodes[5],
3060 short_channel_id: 10,
3062 cltv_expiry_delta: (10 << 4) | 1,
3063 htlc_minimum_msat: None,
3064 htlc_maximum_msat: None,
3069 fn partial_route_hint_test() {
3070 let (secp_ctx, network_graph, _, _, logger) = build_graph();
3071 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
3072 let scorer = test_utils::TestScorer::with_penalty(0);
3073 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3074 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3076 // Simple test across 2, 3, 5, and 4 via a last_hop channel
3077 // Tests the behaviour when the RouteHint contains a suboptimal hop.
3078 // RouteHint may be partially used by the algo to build the best path.
3080 // First check that last hop can't have its source as the payee.
3081 let invalid_last_hop = RouteHint(vec![RouteHintHop {
3082 src_node_id: nodes[6],
3083 short_channel_id: 8,
3086 proportional_millionths: 0,
3088 cltv_expiry_delta: (8 << 4) | 1,
3089 htlc_minimum_msat: None,
3090 htlc_maximum_msat: None,
3093 let mut invalid_last_hops = last_hops_multi_private_channels(&nodes);
3094 invalid_last_hops.push(invalid_last_hop);
3096 let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(invalid_last_hops);
3097 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
3098 assert_eq!(err, "Route hint cannot have the payee as the source.");
3099 } else { panic!(); }
3102 let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops_multi_private_channels(&nodes));
3103 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
3104 assert_eq!(route.paths[0].len(), 5);
3106 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
3107 assert_eq!(route.paths[0][0].short_channel_id, 2);
3108 assert_eq!(route.paths[0][0].fee_msat, 100);
3109 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1);
3110 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
3111 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
3113 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
3114 assert_eq!(route.paths[0][1].short_channel_id, 4);
3115 assert_eq!(route.paths[0][1].fee_msat, 0);
3116 assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 4) | 1);
3117 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
3118 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
3120 assert_eq!(route.paths[0][2].pubkey, nodes[4]);
3121 assert_eq!(route.paths[0][2].short_channel_id, 6);
3122 assert_eq!(route.paths[0][2].fee_msat, 0);
3123 assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 4) | 1);
3124 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5));
3125 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6));
3127 assert_eq!(route.paths[0][3].pubkey, nodes[3]);
3128 assert_eq!(route.paths[0][3].short_channel_id, 11);
3129 assert_eq!(route.paths[0][3].fee_msat, 0);
3130 assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 4) | 1);
3131 // If we have a peer in the node map, we'll use their features here since we don't have
3132 // a way of figuring out their features from the invoice:
3133 assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4));
3134 assert_eq!(route.paths[0][3].channel_features.le_flags(), &id_to_feature_flags(11));
3136 assert_eq!(route.paths[0][4].pubkey, nodes[6]);
3137 assert_eq!(route.paths[0][4].short_channel_id, 8);
3138 assert_eq!(route.paths[0][4].fee_msat, 100);
3139 assert_eq!(route.paths[0][4].cltv_expiry_delta, 42);
3140 assert_eq!(route.paths[0][4].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
3141 assert_eq!(route.paths[0][4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
3144 fn empty_last_hop(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
3145 let zero_fees = RoutingFees {
3147 proportional_millionths: 0,
3149 vec![RouteHint(vec![RouteHintHop {
3150 src_node_id: nodes[3],
3151 short_channel_id: 8,
3153 cltv_expiry_delta: (8 << 4) | 1,
3154 htlc_minimum_msat: None,
3155 htlc_maximum_msat: None,
3156 }]), RouteHint(vec![
3158 ]), RouteHint(vec![RouteHintHop {
3159 src_node_id: nodes[5],
3160 short_channel_id: 10,
3162 cltv_expiry_delta: (10 << 4) | 1,
3163 htlc_minimum_msat: None,
3164 htlc_maximum_msat: None,
3169 fn ignores_empty_last_hops_test() {
3170 let (secp_ctx, network_graph, _, _, logger) = build_graph();
3171 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
3172 let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(empty_last_hop(&nodes));
3173 let scorer = test_utils::TestScorer::with_penalty(0);
3174 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3175 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3177 // Test handling of an empty RouteHint passed in Invoice.
3179 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
3180 assert_eq!(route.paths[0].len(), 5);
3182 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
3183 assert_eq!(route.paths[0][0].short_channel_id, 2);
3184 assert_eq!(route.paths[0][0].fee_msat, 100);
3185 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1);
3186 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
3187 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
3189 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
3190 assert_eq!(route.paths[0][1].short_channel_id, 4);
3191 assert_eq!(route.paths[0][1].fee_msat, 0);
3192 assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 4) | 1);
3193 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
3194 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
3196 assert_eq!(route.paths[0][2].pubkey, nodes[4]);
3197 assert_eq!(route.paths[0][2].short_channel_id, 6);
3198 assert_eq!(route.paths[0][2].fee_msat, 0);
3199 assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 4) | 1);
3200 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5));
3201 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6));
3203 assert_eq!(route.paths[0][3].pubkey, nodes[3]);
3204 assert_eq!(route.paths[0][3].short_channel_id, 11);
3205 assert_eq!(route.paths[0][3].fee_msat, 0);
3206 assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 4) | 1);
3207 // If we have a peer in the node map, we'll use their features here since we don't have
3208 // a way of figuring out their features from the invoice:
3209 assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4));
3210 assert_eq!(route.paths[0][3].channel_features.le_flags(), &id_to_feature_flags(11));
3212 assert_eq!(route.paths[0][4].pubkey, nodes[6]);
3213 assert_eq!(route.paths[0][4].short_channel_id, 8);
3214 assert_eq!(route.paths[0][4].fee_msat, 100);
3215 assert_eq!(route.paths[0][4].cltv_expiry_delta, 42);
3216 assert_eq!(route.paths[0][4].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
3217 assert_eq!(route.paths[0][4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
3220 /// Builds a trivial last-hop hint that passes through the two nodes given, with channel 0xff00
3222 fn multi_hop_last_hops_hint(hint_hops: [PublicKey; 2]) -> Vec<RouteHint> {
3223 let zero_fees = RoutingFees {
3225 proportional_millionths: 0,
3227 vec![RouteHint(vec![RouteHintHop {
3228 src_node_id: hint_hops[0],
3229 short_channel_id: 0xff00,
3232 proportional_millionths: 0,
3234 cltv_expiry_delta: (5 << 4) | 1,
3235 htlc_minimum_msat: None,
3236 htlc_maximum_msat: None,
3238 src_node_id: hint_hops[1],
3239 short_channel_id: 0xff01,
3241 cltv_expiry_delta: (8 << 4) | 1,
3242 htlc_minimum_msat: None,
3243 htlc_maximum_msat: None,
3248 fn multi_hint_last_hops_test() {
3249 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
3250 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3251 let last_hops = multi_hop_last_hops_hint([nodes[2], nodes[3]]);
3252 let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops.clone());
3253 let scorer = test_utils::TestScorer::with_penalty(0);
3254 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3255 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3256 // Test through channels 2, 3, 0xff00, 0xff01.
3257 // Test shows that multiple hop hints are considered.
3259 // Disabling channels 6 & 7 by flags=2
3260 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3261 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3262 short_channel_id: 6,
3264 flags: 2, // to disable
3265 cltv_expiry_delta: 0,
3266 htlc_minimum_msat: 0,
3267 htlc_maximum_msat: OptionalField::Absent,
3269 fee_proportional_millionths: 0,
3270 excess_data: Vec::new()
3272 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3273 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3274 short_channel_id: 7,
3276 flags: 2, // to disable
3277 cltv_expiry_delta: 0,
3278 htlc_minimum_msat: 0,
3279 htlc_maximum_msat: OptionalField::Absent,
3281 fee_proportional_millionths: 0,
3282 excess_data: Vec::new()
3285 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
3286 assert_eq!(route.paths[0].len(), 4);
3288 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
3289 assert_eq!(route.paths[0][0].short_channel_id, 2);
3290 assert_eq!(route.paths[0][0].fee_msat, 200);
3291 assert_eq!(route.paths[0][0].cltv_expiry_delta, 65);
3292 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
3293 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
3295 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
3296 assert_eq!(route.paths[0][1].short_channel_id, 4);
3297 assert_eq!(route.paths[0][1].fee_msat, 100);
3298 assert_eq!(route.paths[0][1].cltv_expiry_delta, 81);
3299 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
3300 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
3302 assert_eq!(route.paths[0][2].pubkey, nodes[3]);
3303 assert_eq!(route.paths[0][2].short_channel_id, last_hops[0].0[0].short_channel_id);
3304 assert_eq!(route.paths[0][2].fee_msat, 0);
3305 assert_eq!(route.paths[0][2].cltv_expiry_delta, 129);
3306 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(4));
3307 assert_eq!(route.paths[0][2].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
3309 assert_eq!(route.paths[0][3].pubkey, nodes[6]);
3310 assert_eq!(route.paths[0][3].short_channel_id, last_hops[0].0[1].short_channel_id);
3311 assert_eq!(route.paths[0][3].fee_msat, 100);
3312 assert_eq!(route.paths[0][3].cltv_expiry_delta, 42);
3313 assert_eq!(route.paths[0][3].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
3314 assert_eq!(route.paths[0][3].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
3318 fn private_multi_hint_last_hops_test() {
3319 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
3320 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3322 let non_announced_privkey = SecretKey::from_slice(&hex::decode(format!("{:02x}", 0xf0).repeat(32)).unwrap()[..]).unwrap();
3323 let non_announced_pubkey = PublicKey::from_secret_key(&secp_ctx, &non_announced_privkey);
3325 let last_hops = multi_hop_last_hops_hint([nodes[2], non_announced_pubkey]);
3326 let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops.clone());
3327 let scorer = test_utils::TestScorer::with_penalty(0);
3328 // Test through channels 2, 3, 0xff00, 0xff01.
3329 // Test shows that multiple hop hints are considered.
3331 // Disabling channels 6 & 7 by flags=2
3332 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3333 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3334 short_channel_id: 6,
3336 flags: 2, // to disable
3337 cltv_expiry_delta: 0,
3338 htlc_minimum_msat: 0,
3339 htlc_maximum_msat: OptionalField::Absent,
3341 fee_proportional_millionths: 0,
3342 excess_data: Vec::new()
3344 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3345 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3346 short_channel_id: 7,
3348 flags: 2, // to disable
3349 cltv_expiry_delta: 0,
3350 htlc_minimum_msat: 0,
3351 htlc_maximum_msat: OptionalField::Absent,
3353 fee_proportional_millionths: 0,
3354 excess_data: Vec::new()
3357 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &[42u8; 32]).unwrap();
3358 assert_eq!(route.paths[0].len(), 4);
3360 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
3361 assert_eq!(route.paths[0][0].short_channel_id, 2);
3362 assert_eq!(route.paths[0][0].fee_msat, 200);
3363 assert_eq!(route.paths[0][0].cltv_expiry_delta, 65);
3364 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
3365 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
3367 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
3368 assert_eq!(route.paths[0][1].short_channel_id, 4);
3369 assert_eq!(route.paths[0][1].fee_msat, 100);
3370 assert_eq!(route.paths[0][1].cltv_expiry_delta, 81);
3371 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
3372 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
3374 assert_eq!(route.paths[0][2].pubkey, non_announced_pubkey);
3375 assert_eq!(route.paths[0][2].short_channel_id, last_hops[0].0[0].short_channel_id);
3376 assert_eq!(route.paths[0][2].fee_msat, 0);
3377 assert_eq!(route.paths[0][2].cltv_expiry_delta, 129);
3378 assert_eq!(route.paths[0][2].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
3379 assert_eq!(route.paths[0][2].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
3381 assert_eq!(route.paths[0][3].pubkey, nodes[6]);
3382 assert_eq!(route.paths[0][3].short_channel_id, last_hops[0].0[1].short_channel_id);
3383 assert_eq!(route.paths[0][3].fee_msat, 100);
3384 assert_eq!(route.paths[0][3].cltv_expiry_delta, 42);
3385 assert_eq!(route.paths[0][3].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
3386 assert_eq!(route.paths[0][3].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
3389 fn last_hops_with_public_channel(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
3390 let zero_fees = RoutingFees {
3392 proportional_millionths: 0,
3394 vec![RouteHint(vec![RouteHintHop {
3395 src_node_id: nodes[4],
3396 short_channel_id: 11,
3398 cltv_expiry_delta: (11 << 4) | 1,
3399 htlc_minimum_msat: None,
3400 htlc_maximum_msat: None,
3402 src_node_id: nodes[3],
3403 short_channel_id: 8,
3405 cltv_expiry_delta: (8 << 4) | 1,
3406 htlc_minimum_msat: None,
3407 htlc_maximum_msat: None,
3408 }]), RouteHint(vec![RouteHintHop {
3409 src_node_id: nodes[4],
3410 short_channel_id: 9,
3413 proportional_millionths: 0,
3415 cltv_expiry_delta: (9 << 4) | 1,
3416 htlc_minimum_msat: None,
3417 htlc_maximum_msat: None,
3418 }]), RouteHint(vec![RouteHintHop {
3419 src_node_id: nodes[5],
3420 short_channel_id: 10,
3422 cltv_expiry_delta: (10 << 4) | 1,
3423 htlc_minimum_msat: None,
3424 htlc_maximum_msat: None,
3429 fn last_hops_with_public_channel_test() {
3430 let (secp_ctx, network_graph, _, _, logger) = build_graph();
3431 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
3432 let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops_with_public_channel(&nodes));
3433 let scorer = test_utils::TestScorer::with_penalty(0);
3434 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3435 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3436 // This test shows that public routes can be present in the invoice
3437 // which would be handled in the same manner.
3439 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
3440 assert_eq!(route.paths[0].len(), 5);
3442 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
3443 assert_eq!(route.paths[0][0].short_channel_id, 2);
3444 assert_eq!(route.paths[0][0].fee_msat, 100);
3445 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1);
3446 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
3447 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
3449 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
3450 assert_eq!(route.paths[0][1].short_channel_id, 4);
3451 assert_eq!(route.paths[0][1].fee_msat, 0);
3452 assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 4) | 1);
3453 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
3454 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
3456 assert_eq!(route.paths[0][2].pubkey, nodes[4]);
3457 assert_eq!(route.paths[0][2].short_channel_id, 6);
3458 assert_eq!(route.paths[0][2].fee_msat, 0);
3459 assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 4) | 1);
3460 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5));
3461 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6));
3463 assert_eq!(route.paths[0][3].pubkey, nodes[3]);
3464 assert_eq!(route.paths[0][3].short_channel_id, 11);
3465 assert_eq!(route.paths[0][3].fee_msat, 0);
3466 assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 4) | 1);
3467 // If we have a peer in the node map, we'll use their features here since we don't have
3468 // a way of figuring out their features from the invoice:
3469 assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4));
3470 assert_eq!(route.paths[0][3].channel_features.le_flags(), &id_to_feature_flags(11));
3472 assert_eq!(route.paths[0][4].pubkey, nodes[6]);
3473 assert_eq!(route.paths[0][4].short_channel_id, 8);
3474 assert_eq!(route.paths[0][4].fee_msat, 100);
3475 assert_eq!(route.paths[0][4].cltv_expiry_delta, 42);
3476 assert_eq!(route.paths[0][4].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
3477 assert_eq!(route.paths[0][4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
3481 fn our_chans_last_hop_connect_test() {
3482 let (secp_ctx, network_graph, _, _, logger) = build_graph();
3483 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
3484 let scorer = test_utils::TestScorer::with_penalty(0);
3485 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3486 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3488 // Simple test with outbound channel to 4 to test that last_hops and first_hops connect
3489 let our_chans = vec![get_channel_details(Some(42), nodes[3].clone(), InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)];
3490 let mut last_hops = last_hops(&nodes);
3491 let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops.clone());
3492 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), Some(&our_chans.iter().collect::<Vec<_>>()), 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
3493 assert_eq!(route.paths[0].len(), 2);
3495 assert_eq!(route.paths[0][0].pubkey, nodes[3]);
3496 assert_eq!(route.paths[0][0].short_channel_id, 42);
3497 assert_eq!(route.paths[0][0].fee_msat, 0);
3498 assert_eq!(route.paths[0][0].cltv_expiry_delta, (8 << 4) | 1);
3499 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]);
3500 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
3502 assert_eq!(route.paths[0][1].pubkey, nodes[6]);
3503 assert_eq!(route.paths[0][1].short_channel_id, 8);
3504 assert_eq!(route.paths[0][1].fee_msat, 100);
3505 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
3506 assert_eq!(route.paths[0][1].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
3507 assert_eq!(route.paths[0][1].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
3509 last_hops[0].0[0].fees.base_msat = 1000;
3511 // Revert to via 6 as the fee on 8 goes up
3512 let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops);
3513 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
3514 assert_eq!(route.paths[0].len(), 4);
3516 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
3517 assert_eq!(route.paths[0][0].short_channel_id, 2);
3518 assert_eq!(route.paths[0][0].fee_msat, 200); // fee increased as its % of value transferred across node
3519 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1);
3520 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
3521 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
3523 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
3524 assert_eq!(route.paths[0][1].short_channel_id, 4);
3525 assert_eq!(route.paths[0][1].fee_msat, 100);
3526 assert_eq!(route.paths[0][1].cltv_expiry_delta, (7 << 4) | 1);
3527 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
3528 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
3530 assert_eq!(route.paths[0][2].pubkey, nodes[5]);
3531 assert_eq!(route.paths[0][2].short_channel_id, 7);
3532 assert_eq!(route.paths[0][2].fee_msat, 0);
3533 assert_eq!(route.paths[0][2].cltv_expiry_delta, (10 << 4) | 1);
3534 // If we have a peer in the node map, we'll use their features here since we don't have
3535 // a way of figuring out their features from the invoice:
3536 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(6));
3537 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(7));
3539 assert_eq!(route.paths[0][3].pubkey, nodes[6]);
3540 assert_eq!(route.paths[0][3].short_channel_id, 10);
3541 assert_eq!(route.paths[0][3].fee_msat, 100);
3542 assert_eq!(route.paths[0][3].cltv_expiry_delta, 42);
3543 assert_eq!(route.paths[0][3].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
3544 assert_eq!(route.paths[0][3].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
3546 // ...but still use 8 for larger payments as 6 has a variable feerate
3547 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 2000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
3548 assert_eq!(route.paths[0].len(), 5);
3550 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
3551 assert_eq!(route.paths[0][0].short_channel_id, 2);
3552 assert_eq!(route.paths[0][0].fee_msat, 3000);
3553 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1);
3554 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
3555 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
3557 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
3558 assert_eq!(route.paths[0][1].short_channel_id, 4);
3559 assert_eq!(route.paths[0][1].fee_msat, 0);
3560 assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 4) | 1);
3561 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
3562 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
3564 assert_eq!(route.paths[0][2].pubkey, nodes[4]);
3565 assert_eq!(route.paths[0][2].short_channel_id, 6);
3566 assert_eq!(route.paths[0][2].fee_msat, 0);
3567 assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 4) | 1);
3568 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5));
3569 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6));
3571 assert_eq!(route.paths[0][3].pubkey, nodes[3]);
3572 assert_eq!(route.paths[0][3].short_channel_id, 11);
3573 assert_eq!(route.paths[0][3].fee_msat, 1000);
3574 assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 4) | 1);
3575 // If we have a peer in the node map, we'll use their features here since we don't have
3576 // a way of figuring out their features from the invoice:
3577 assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4));
3578 assert_eq!(route.paths[0][3].channel_features.le_flags(), &id_to_feature_flags(11));
3580 assert_eq!(route.paths[0][4].pubkey, nodes[6]);
3581 assert_eq!(route.paths[0][4].short_channel_id, 8);
3582 assert_eq!(route.paths[0][4].fee_msat, 2000);
3583 assert_eq!(route.paths[0][4].cltv_expiry_delta, 42);
3584 assert_eq!(route.paths[0][4].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
3585 assert_eq!(route.paths[0][4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
3588 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> {
3589 let source_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&hex::decode(format!("{:02}", 41).repeat(32)).unwrap()[..]).unwrap());
3590 let middle_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&hex::decode(format!("{:02}", 42).repeat(32)).unwrap()[..]).unwrap());
3591 let target_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&hex::decode(format!("{:02}", 43).repeat(32)).unwrap()[..]).unwrap());
3593 // If we specify a channel to a middle hop, that overrides our local channel view and that gets used
3594 let last_hops = RouteHint(vec![RouteHintHop {
3595 src_node_id: middle_node_id,
3596 short_channel_id: 8,
3599 proportional_millionths: last_hop_fee_prop,
3601 cltv_expiry_delta: (8 << 4) | 1,
3602 htlc_minimum_msat: None,
3603 htlc_maximum_msat: last_hop_htlc_max,
3605 let payment_params = PaymentParameters::from_node_id(target_node_id).with_route_hints(vec![last_hops]);
3606 let our_chans = vec![get_channel_details(Some(42), middle_node_id, InitFeatures::from_le_bytes(vec![0b11]), outbound_capacity_msat)];
3607 let scorer = test_utils::TestScorer::with_penalty(0);
3608 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3609 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3610 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
3611 let logger = test_utils::TestLogger::new();
3612 let network_graph = NetworkGraph::new(genesis_hash, &logger);
3613 let route = get_route(&source_node_id, &payment_params, &network_graph.read_only(),
3614 Some(&our_chans.iter().collect::<Vec<_>>()), route_val, 42, &logger, &scorer, &random_seed_bytes);
3619 fn unannounced_path_test() {
3620 // We should be able to send a payment to a destination without any help of a routing graph
3621 // if we have a channel with a common counterparty that appears in the first and last hop
3623 let route = do_unannounced_path_test(None, 1, 2000000, 1000000).unwrap();
3625 let middle_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&hex::decode(format!("{:02}", 42).repeat(32)).unwrap()[..]).unwrap());
3626 let target_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&hex::decode(format!("{:02}", 43).repeat(32)).unwrap()[..]).unwrap());
3627 assert_eq!(route.paths[0].len(), 2);
3629 assert_eq!(route.paths[0][0].pubkey, middle_node_id);
3630 assert_eq!(route.paths[0][0].short_channel_id, 42);
3631 assert_eq!(route.paths[0][0].fee_msat, 1001);
3632 assert_eq!(route.paths[0][0].cltv_expiry_delta, (8 << 4) | 1);
3633 assert_eq!(route.paths[0][0].node_features.le_flags(), &[0b11]);
3634 assert_eq!(route.paths[0][0].channel_features.le_flags(), &[0; 0]); // We can't learn any flags from invoices, sadly
3636 assert_eq!(route.paths[0][1].pubkey, target_node_id);
3637 assert_eq!(route.paths[0][1].short_channel_id, 8);
3638 assert_eq!(route.paths[0][1].fee_msat, 1000000);
3639 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
3640 assert_eq!(route.paths[0][1].node_features.le_flags(), default_node_features().le_flags()); // We dont pass flags in from invoices yet
3641 assert_eq!(route.paths[0][1].channel_features.le_flags(), &[0; 0]); // We can't learn any flags from invoices, sadly
3645 fn overflow_unannounced_path_test_liquidity_underflow() {
3646 // Previously, when we had a last-hop hint connected directly to a first-hop channel, where
3647 // the last-hop had a fee which overflowed a u64, we'd panic.
3648 // This was due to us adding the first-hop from us unconditionally, causing us to think
3649 // we'd built a path (as our node is in the "best candidate" set), when we had not.
3650 // In this test, we previously hit a subtraction underflow due to having less available
3651 // liquidity at the last hop than 0.
3652 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());
3656 fn overflow_unannounced_path_test_feerate_overflow() {
3657 // This tests for the same case as above, except instead of hitting a subtraction
3658 // underflow, we hit a case where the fee charged at a hop overflowed.
3659 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());
3663 fn available_amount_while_routing_test() {
3664 // Tests whether we choose the correct available channel amount while routing.
3666 let (secp_ctx, network_graph, mut gossip_sync, chain_monitor, logger) = build_graph();
3667 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3668 let scorer = test_utils::TestScorer::with_penalty(0);
3669 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3670 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3671 let payment_params = PaymentParameters::from_node_id(nodes[2]).with_features(InvoiceFeatures::known());
3673 // We will use a simple single-path route from
3674 // our node to node2 via node0: channels {1, 3}.
3676 // First disable all other paths.
3677 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3678 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3679 short_channel_id: 2,
3682 cltv_expiry_delta: 0,
3683 htlc_minimum_msat: 0,
3684 htlc_maximum_msat: OptionalField::Present(100_000),
3686 fee_proportional_millionths: 0,
3687 excess_data: Vec::new()
3689 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3690 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3691 short_channel_id: 12,
3694 cltv_expiry_delta: 0,
3695 htlc_minimum_msat: 0,
3696 htlc_maximum_msat: OptionalField::Present(100_000),
3698 fee_proportional_millionths: 0,
3699 excess_data: Vec::new()
3702 // Make the first channel (#1) very permissive,
3703 // and we will be testing all limits on the second channel.
3704 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3705 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3706 short_channel_id: 1,
3709 cltv_expiry_delta: 0,
3710 htlc_minimum_msat: 0,
3711 htlc_maximum_msat: OptionalField::Present(1_000_000_000),
3713 fee_proportional_millionths: 0,
3714 excess_data: Vec::new()
3717 // First, let's see if routing works if we have absolutely no idea about the available amount.
3718 // In this case, it should be set to 250_000 sats.
3719 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
3720 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3721 short_channel_id: 3,
3724 cltv_expiry_delta: 0,
3725 htlc_minimum_msat: 0,
3726 htlc_maximum_msat: OptionalField::Absent,
3728 fee_proportional_millionths: 0,
3729 excess_data: Vec::new()
3733 // Attempt to route more than available results in a failure.
3734 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
3735 &our_id, &payment_params, &network_graph.read_only(), None, 250_000_001, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
3736 assert_eq!(err, "Failed to find a sufficient route to the given destination");
3737 } else { panic!(); }
3741 // Now, attempt to route an exact amount we have should be fine.
3742 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 250_000_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
3743 assert_eq!(route.paths.len(), 1);
3744 let path = route.paths.last().unwrap();
3745 assert_eq!(path.len(), 2);
3746 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
3747 assert_eq!(path.last().unwrap().fee_msat, 250_000_000);
3750 // Check that setting next_outbound_htlc_limit_msat in first_hops limits the channels.
3751 // Disable channel #1 and use another first hop.
3752 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3753 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3754 short_channel_id: 1,
3757 cltv_expiry_delta: 0,
3758 htlc_minimum_msat: 0,
3759 htlc_maximum_msat: OptionalField::Present(1_000_000_000),
3761 fee_proportional_millionths: 0,
3762 excess_data: Vec::new()
3765 // Now, limit the first_hop by the next_outbound_htlc_limit_msat of 200_000 sats.
3766 let our_chans = vec![get_channel_details(Some(42), nodes[0].clone(), InitFeatures::from_le_bytes(vec![0b11]), 200_000_000)];
3769 // Attempt to route more than available results in a failure.
3770 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
3771 &our_id, &payment_params, &network_graph.read_only(), Some(&our_chans.iter().collect::<Vec<_>>()), 200_000_001, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
3772 assert_eq!(err, "Failed to find a sufficient route to the given destination");
3773 } else { panic!(); }
3777 // Now, attempt to route an exact amount we have should be fine.
3778 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), Some(&our_chans.iter().collect::<Vec<_>>()), 200_000_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
3779 assert_eq!(route.paths.len(), 1);
3780 let path = route.paths.last().unwrap();
3781 assert_eq!(path.len(), 2);
3782 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
3783 assert_eq!(path.last().unwrap().fee_msat, 200_000_000);
3786 // Enable channel #1 back.
3787 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3788 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3789 short_channel_id: 1,
3792 cltv_expiry_delta: 0,
3793 htlc_minimum_msat: 0,
3794 htlc_maximum_msat: OptionalField::Present(1_000_000_000),
3796 fee_proportional_millionths: 0,
3797 excess_data: Vec::new()
3801 // Now let's see if routing works if we know only htlc_maximum_msat.
3802 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
3803 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3804 short_channel_id: 3,
3807 cltv_expiry_delta: 0,
3808 htlc_minimum_msat: 0,
3809 htlc_maximum_msat: OptionalField::Present(15_000),
3811 fee_proportional_millionths: 0,
3812 excess_data: Vec::new()
3816 // Attempt to route more than available results in a failure.
3817 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
3818 &our_id, &payment_params, &network_graph.read_only(), None, 15_001, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
3819 assert_eq!(err, "Failed to find a sufficient route to the given destination");
3820 } else { panic!(); }
3824 // Now, attempt to route an exact amount we have should be fine.
3825 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 15_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
3826 assert_eq!(route.paths.len(), 1);
3827 let path = route.paths.last().unwrap();
3828 assert_eq!(path.len(), 2);
3829 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
3830 assert_eq!(path.last().unwrap().fee_msat, 15_000);
3833 // Now let's see if routing works if we know only capacity from the UTXO.
3835 // We can't change UTXO capacity on the fly, so we'll disable
3836 // the existing channel and add another one with the capacity we need.
3837 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
3838 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3839 short_channel_id: 3,
3842 cltv_expiry_delta: 0,
3843 htlc_minimum_msat: 0,
3844 htlc_maximum_msat: OptionalField::Absent,
3846 fee_proportional_millionths: 0,
3847 excess_data: Vec::new()
3850 let good_script = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2)
3851 .push_slice(&PublicKey::from_secret_key(&secp_ctx, &privkeys[0]).serialize())
3852 .push_slice(&PublicKey::from_secret_key(&secp_ctx, &privkeys[2]).serialize())
3853 .push_opcode(opcodes::all::OP_PUSHNUM_2)
3854 .push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script().to_v0_p2wsh();
3856 *chain_monitor.utxo_ret.lock().unwrap() = Ok(TxOut { value: 15, script_pubkey: good_script.clone() });
3857 gossip_sync.add_chain_access(Some(chain_monitor));
3859 add_channel(&gossip_sync, &secp_ctx, &privkeys[0], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(3)), 333);
3860 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
3861 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3862 short_channel_id: 333,
3865 cltv_expiry_delta: (3 << 4) | 1,
3866 htlc_minimum_msat: 0,
3867 htlc_maximum_msat: OptionalField::Absent,
3869 fee_proportional_millionths: 0,
3870 excess_data: Vec::new()
3872 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3873 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3874 short_channel_id: 333,
3877 cltv_expiry_delta: (3 << 4) | 2,
3878 htlc_minimum_msat: 0,
3879 htlc_maximum_msat: OptionalField::Absent,
3881 fee_proportional_millionths: 0,
3882 excess_data: Vec::new()
3886 // Attempt to route more than available results in a failure.
3887 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
3888 &our_id, &payment_params, &network_graph.read_only(), None, 15_001, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
3889 assert_eq!(err, "Failed to find a sufficient route to the given destination");
3890 } else { panic!(); }
3894 // Now, attempt to route an exact amount we have should be fine.
3895 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 15_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
3896 assert_eq!(route.paths.len(), 1);
3897 let path = route.paths.last().unwrap();
3898 assert_eq!(path.len(), 2);
3899 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
3900 assert_eq!(path.last().unwrap().fee_msat, 15_000);
3903 // Now let's see if routing chooses htlc_maximum_msat over UTXO capacity.
3904 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
3905 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3906 short_channel_id: 333,
3909 cltv_expiry_delta: 0,
3910 htlc_minimum_msat: 0,
3911 htlc_maximum_msat: OptionalField::Present(10_000),
3913 fee_proportional_millionths: 0,
3914 excess_data: Vec::new()
3918 // Attempt to route more than available results in a failure.
3919 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
3920 &our_id, &payment_params, &network_graph.read_only(), None, 10_001, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
3921 assert_eq!(err, "Failed to find a sufficient route to the given destination");
3922 } else { panic!(); }
3926 // Now, attempt to route an exact amount we have should be fine.
3927 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 10_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
3928 assert_eq!(route.paths.len(), 1);
3929 let path = route.paths.last().unwrap();
3930 assert_eq!(path.len(), 2);
3931 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
3932 assert_eq!(path.last().unwrap().fee_msat, 10_000);
3937 fn available_liquidity_last_hop_test() {
3938 // Check that available liquidity properly limits the path even when only
3939 // one of the latter hops is limited.
3940 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
3941 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3942 let scorer = test_utils::TestScorer::with_penalty(0);
3943 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
3944 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3945 let payment_params = PaymentParameters::from_node_id(nodes[3]).with_features(InvoiceFeatures::known());
3947 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
3948 // {12, 13, 11} have the capacities of 100, {6} has a capacity of 50.
3949 // Total capacity: 50 sats.
3951 // Disable other potential paths.
3952 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3953 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3954 short_channel_id: 2,
3957 cltv_expiry_delta: 0,
3958 htlc_minimum_msat: 0,
3959 htlc_maximum_msat: OptionalField::Present(100_000),
3961 fee_proportional_millionths: 0,
3962 excess_data: Vec::new()
3964 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3965 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3966 short_channel_id: 7,
3969 cltv_expiry_delta: 0,
3970 htlc_minimum_msat: 0,
3971 htlc_maximum_msat: OptionalField::Present(100_000),
3973 fee_proportional_millionths: 0,
3974 excess_data: Vec::new()
3979 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3980 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3981 short_channel_id: 12,
3984 cltv_expiry_delta: 0,
3985 htlc_minimum_msat: 0,
3986 htlc_maximum_msat: OptionalField::Present(100_000),
3988 fee_proportional_millionths: 0,
3989 excess_data: Vec::new()
3991 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
3992 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3993 short_channel_id: 13,
3996 cltv_expiry_delta: 0,
3997 htlc_minimum_msat: 0,
3998 htlc_maximum_msat: OptionalField::Present(100_000),
4000 fee_proportional_millionths: 0,
4001 excess_data: Vec::new()
4004 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4005 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4006 short_channel_id: 6,
4009 cltv_expiry_delta: 0,
4010 htlc_minimum_msat: 0,
4011 htlc_maximum_msat: OptionalField::Present(50_000),
4013 fee_proportional_millionths: 0,
4014 excess_data: Vec::new()
4016 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
4017 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4018 short_channel_id: 11,
4021 cltv_expiry_delta: 0,
4022 htlc_minimum_msat: 0,
4023 htlc_maximum_msat: OptionalField::Present(100_000),
4025 fee_proportional_millionths: 0,
4026 excess_data: Vec::new()
4029 // Attempt to route more than available results in a failure.
4030 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4031 &our_id, &payment_params, &network_graph.read_only(), None, 60_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
4032 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4033 } else { panic!(); }
4037 // Now, attempt to route 49 sats (just a bit below the capacity).
4038 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 49_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
4039 assert_eq!(route.paths.len(), 1);
4040 let mut total_amount_paid_msat = 0;
4041 for path in &route.paths {
4042 assert_eq!(path.len(), 4);
4043 assert_eq!(path.last().unwrap().pubkey, nodes[3]);
4044 total_amount_paid_msat += path.last().unwrap().fee_msat;
4046 assert_eq!(total_amount_paid_msat, 49_000);
4050 // Attempt to route an exact amount is also fine
4051 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 50_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
4052 assert_eq!(route.paths.len(), 1);
4053 let mut total_amount_paid_msat = 0;
4054 for path in &route.paths {
4055 assert_eq!(path.len(), 4);
4056 assert_eq!(path.last().unwrap().pubkey, nodes[3]);
4057 total_amount_paid_msat += path.last().unwrap().fee_msat;
4059 assert_eq!(total_amount_paid_msat, 50_000);
4064 fn ignore_fee_first_hop_test() {
4065 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
4066 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4067 let scorer = test_utils::TestScorer::with_penalty(0);
4068 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4069 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4070 let payment_params = PaymentParameters::from_node_id(nodes[2]);
4072 // Path via node0 is channels {1, 3}. Limit them to 100 and 50 sats (total limit 50).
4073 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4074 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4075 short_channel_id: 1,
4078 cltv_expiry_delta: 0,
4079 htlc_minimum_msat: 0,
4080 htlc_maximum_msat: OptionalField::Present(100_000),
4081 fee_base_msat: 1_000_000,
4082 fee_proportional_millionths: 0,
4083 excess_data: Vec::new()
4085 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4086 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4087 short_channel_id: 3,
4090 cltv_expiry_delta: 0,
4091 htlc_minimum_msat: 0,
4092 htlc_maximum_msat: OptionalField::Present(50_000),
4094 fee_proportional_millionths: 0,
4095 excess_data: Vec::new()
4099 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 50_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
4100 assert_eq!(route.paths.len(), 1);
4101 let mut total_amount_paid_msat = 0;
4102 for path in &route.paths {
4103 assert_eq!(path.len(), 2);
4104 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
4105 total_amount_paid_msat += path.last().unwrap().fee_msat;
4107 assert_eq!(total_amount_paid_msat, 50_000);
4112 fn simple_mpp_route_test() {
4113 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
4114 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4115 let scorer = test_utils::TestScorer::with_penalty(0);
4116 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4117 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4118 let payment_params = PaymentParameters::from_node_id(nodes[2])
4119 .with_features(InvoiceFeatures::known());
4121 // We need a route consisting of 3 paths:
4122 // From our node to node2 via node0, node7, node1 (three paths one hop each).
4123 // To achieve this, the amount being transferred should be around
4124 // the total capacity of these 3 paths.
4126 // First, we set limits on these (previously unlimited) channels.
4127 // Their aggregate capacity will be 50 + 60 + 180 = 290 sats.
4129 // Path via node0 is channels {1, 3}. Limit them to 100 and 50 sats (total limit 50).
4130 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4131 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4132 short_channel_id: 1,
4135 cltv_expiry_delta: 0,
4136 htlc_minimum_msat: 0,
4137 htlc_maximum_msat: OptionalField::Present(100_000),
4139 fee_proportional_millionths: 0,
4140 excess_data: Vec::new()
4142 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4143 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4144 short_channel_id: 3,
4147 cltv_expiry_delta: 0,
4148 htlc_minimum_msat: 0,
4149 htlc_maximum_msat: OptionalField::Present(50_000),
4151 fee_proportional_millionths: 0,
4152 excess_data: Vec::new()
4155 // Path via node7 is channels {12, 13}. Limit them to 60 and 60 sats
4156 // (total limit 60).
4157 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4158 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4159 short_channel_id: 12,
4162 cltv_expiry_delta: 0,
4163 htlc_minimum_msat: 0,
4164 htlc_maximum_msat: OptionalField::Present(60_000),
4166 fee_proportional_millionths: 0,
4167 excess_data: Vec::new()
4169 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
4170 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4171 short_channel_id: 13,
4174 cltv_expiry_delta: 0,
4175 htlc_minimum_msat: 0,
4176 htlc_maximum_msat: OptionalField::Present(60_000),
4178 fee_proportional_millionths: 0,
4179 excess_data: Vec::new()
4182 // Path via node1 is channels {2, 4}. Limit them to 200 and 180 sats
4183 // (total capacity 180 sats).
4184 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4185 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4186 short_channel_id: 2,
4189 cltv_expiry_delta: 0,
4190 htlc_minimum_msat: 0,
4191 htlc_maximum_msat: OptionalField::Present(200_000),
4193 fee_proportional_millionths: 0,
4194 excess_data: Vec::new()
4196 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
4197 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4198 short_channel_id: 4,
4201 cltv_expiry_delta: 0,
4202 htlc_minimum_msat: 0,
4203 htlc_maximum_msat: OptionalField::Present(180_000),
4205 fee_proportional_millionths: 0,
4206 excess_data: Vec::new()
4210 // Attempt to route more than available results in a failure.
4211 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4212 &our_id, &payment_params, &network_graph.read_only(), None, 300_000, 42,
4213 Arc::clone(&logger), &scorer, &random_seed_bytes) {
4214 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4215 } else { panic!(); }
4219 // Attempt to route while setting max_path_count to 0 results in a failure.
4220 let zero_payment_params = payment_params.clone().with_max_path_count(0);
4221 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4222 &our_id, &zero_payment_params, &network_graph.read_only(), None, 100, 42,
4223 Arc::clone(&logger), &scorer, &random_seed_bytes) {
4224 assert_eq!(err, "Can't find a route with no paths allowed.");
4225 } else { panic!(); }
4229 // Attempt to route while setting max_path_count to 3 results in a failure.
4230 // This is the case because the minimal_value_contribution_msat would require each path
4231 // to account for 1/3 of the total value, which is violated by 2 out of 3 paths.
4232 let fail_payment_params = payment_params.clone().with_max_path_count(3);
4233 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4234 &our_id, &fail_payment_params, &network_graph.read_only(), None, 250_000, 42,
4235 Arc::clone(&logger), &scorer, &random_seed_bytes) {
4236 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4237 } else { panic!(); }
4241 // Now, attempt to route 250 sats (just a bit below the capacity).
4242 // Our algorithm should provide us with these 3 paths.
4243 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None,
4244 250_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
4245 assert_eq!(route.paths.len(), 3);
4246 let mut total_amount_paid_msat = 0;
4247 for path in &route.paths {
4248 assert_eq!(path.len(), 2);
4249 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
4250 total_amount_paid_msat += path.last().unwrap().fee_msat;
4252 assert_eq!(total_amount_paid_msat, 250_000);
4256 // Attempt to route an exact amount is also fine
4257 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None,
4258 290_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
4259 assert_eq!(route.paths.len(), 3);
4260 let mut total_amount_paid_msat = 0;
4261 for path in &route.paths {
4262 assert_eq!(path.len(), 2);
4263 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
4264 total_amount_paid_msat += path.last().unwrap().fee_msat;
4266 assert_eq!(total_amount_paid_msat, 290_000);
4271 fn long_mpp_route_test() {
4272 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
4273 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4274 let scorer = test_utils::TestScorer::with_penalty(0);
4275 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4276 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4277 let payment_params = PaymentParameters::from_node_id(nodes[3]).with_features(InvoiceFeatures::known());
4279 // We need a route consisting of 3 paths:
4280 // From our node to node3 via {node0, node2}, {node7, node2, node4} and {node7, node2}.
4281 // Note that these paths overlap (channels 5, 12, 13).
4282 // We will route 300 sats.
4283 // Each path will have 100 sats capacity, those channels which
4284 // are used twice will have 200 sats capacity.
4286 // Disable other potential paths.
4287 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4288 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4289 short_channel_id: 2,
4292 cltv_expiry_delta: 0,
4293 htlc_minimum_msat: 0,
4294 htlc_maximum_msat: OptionalField::Present(100_000),
4296 fee_proportional_millionths: 0,
4297 excess_data: Vec::new()
4299 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4300 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4301 short_channel_id: 7,
4304 cltv_expiry_delta: 0,
4305 htlc_minimum_msat: 0,
4306 htlc_maximum_msat: OptionalField::Present(100_000),
4308 fee_proportional_millionths: 0,
4309 excess_data: Vec::new()
4312 // Path via {node0, node2} is channels {1, 3, 5}.
4313 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4314 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4315 short_channel_id: 1,
4318 cltv_expiry_delta: 0,
4319 htlc_minimum_msat: 0,
4320 htlc_maximum_msat: OptionalField::Present(100_000),
4322 fee_proportional_millionths: 0,
4323 excess_data: Vec::new()
4325 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4326 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4327 short_channel_id: 3,
4330 cltv_expiry_delta: 0,
4331 htlc_minimum_msat: 0,
4332 htlc_maximum_msat: OptionalField::Present(100_000),
4334 fee_proportional_millionths: 0,
4335 excess_data: Vec::new()
4338 // Capacity of 200 sats because this channel will be used by 3rd path as well.
4339 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
4340 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4341 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4342 short_channel_id: 5,
4345 cltv_expiry_delta: 0,
4346 htlc_minimum_msat: 0,
4347 htlc_maximum_msat: OptionalField::Present(200_000),
4349 fee_proportional_millionths: 0,
4350 excess_data: Vec::new()
4353 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
4354 // Add 100 sats to the capacities of {12, 13}, because these channels
4355 // are also used for 3rd path. 100 sats for the rest. Total capacity: 100 sats.
4356 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4357 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4358 short_channel_id: 12,
4361 cltv_expiry_delta: 0,
4362 htlc_minimum_msat: 0,
4363 htlc_maximum_msat: OptionalField::Present(200_000),
4365 fee_proportional_millionths: 0,
4366 excess_data: Vec::new()
4368 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
4369 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4370 short_channel_id: 13,
4373 cltv_expiry_delta: 0,
4374 htlc_minimum_msat: 0,
4375 htlc_maximum_msat: OptionalField::Present(200_000),
4377 fee_proportional_millionths: 0,
4378 excess_data: Vec::new()
4381 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4382 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4383 short_channel_id: 6,
4386 cltv_expiry_delta: 0,
4387 htlc_minimum_msat: 0,
4388 htlc_maximum_msat: OptionalField::Present(100_000),
4390 fee_proportional_millionths: 0,
4391 excess_data: Vec::new()
4393 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
4394 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4395 short_channel_id: 11,
4398 cltv_expiry_delta: 0,
4399 htlc_minimum_msat: 0,
4400 htlc_maximum_msat: OptionalField::Present(100_000),
4402 fee_proportional_millionths: 0,
4403 excess_data: Vec::new()
4406 // Path via {node7, node2} is channels {12, 13, 5}.
4407 // We already limited them to 200 sats (they are used twice for 100 sats).
4408 // Nothing to do here.
4411 // Attempt to route more than available results in a failure.
4412 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4413 &our_id, &payment_params, &network_graph.read_only(), None, 350_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
4414 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4415 } else { panic!(); }
4419 // Now, attempt to route 300 sats (exact amount we can route).
4420 // Our algorithm should provide us with these 3 paths, 100 sats each.
4421 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 300_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
4422 assert_eq!(route.paths.len(), 3);
4424 let mut total_amount_paid_msat = 0;
4425 for path in &route.paths {
4426 assert_eq!(path.last().unwrap().pubkey, nodes[3]);
4427 total_amount_paid_msat += path.last().unwrap().fee_msat;
4429 assert_eq!(total_amount_paid_msat, 300_000);
4435 fn mpp_cheaper_route_test() {
4436 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
4437 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4438 let scorer = test_utils::TestScorer::with_penalty(0);
4439 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4440 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4441 let payment_params = PaymentParameters::from_node_id(nodes[3]).with_features(InvoiceFeatures::known());
4443 // This test checks that if we have two cheaper paths and one more expensive path,
4444 // so that liquidity-wise any 2 of 3 combination is sufficient,
4445 // two cheaper paths will be taken.
4446 // These paths have equal available liquidity.
4448 // We need a combination of 3 paths:
4449 // From our node to node3 via {node0, node2}, {node7, node2, node4} and {node7, node2}.
4450 // Note that these paths overlap (channels 5, 12, 13).
4451 // Each path will have 100 sats capacity, those channels which
4452 // are used twice will have 200 sats capacity.
4454 // Disable other potential paths.
4455 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4456 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4457 short_channel_id: 2,
4460 cltv_expiry_delta: 0,
4461 htlc_minimum_msat: 0,
4462 htlc_maximum_msat: OptionalField::Present(100_000),
4464 fee_proportional_millionths: 0,
4465 excess_data: Vec::new()
4467 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4468 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4469 short_channel_id: 7,
4472 cltv_expiry_delta: 0,
4473 htlc_minimum_msat: 0,
4474 htlc_maximum_msat: OptionalField::Present(100_000),
4476 fee_proportional_millionths: 0,
4477 excess_data: Vec::new()
4480 // Path via {node0, node2} is channels {1, 3, 5}.
4481 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4482 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4483 short_channel_id: 1,
4486 cltv_expiry_delta: 0,
4487 htlc_minimum_msat: 0,
4488 htlc_maximum_msat: OptionalField::Present(100_000),
4490 fee_proportional_millionths: 0,
4491 excess_data: Vec::new()
4493 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4494 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4495 short_channel_id: 3,
4498 cltv_expiry_delta: 0,
4499 htlc_minimum_msat: 0,
4500 htlc_maximum_msat: OptionalField::Present(100_000),
4502 fee_proportional_millionths: 0,
4503 excess_data: Vec::new()
4506 // Capacity of 200 sats because this channel will be used by 3rd path as well.
4507 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
4508 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4509 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4510 short_channel_id: 5,
4513 cltv_expiry_delta: 0,
4514 htlc_minimum_msat: 0,
4515 htlc_maximum_msat: OptionalField::Present(200_000),
4517 fee_proportional_millionths: 0,
4518 excess_data: Vec::new()
4521 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
4522 // Add 100 sats to the capacities of {12, 13}, because these channels
4523 // are also used for 3rd path. 100 sats for the rest. Total capacity: 100 sats.
4524 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4525 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4526 short_channel_id: 12,
4529 cltv_expiry_delta: 0,
4530 htlc_minimum_msat: 0,
4531 htlc_maximum_msat: OptionalField::Present(200_000),
4533 fee_proportional_millionths: 0,
4534 excess_data: Vec::new()
4536 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
4537 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4538 short_channel_id: 13,
4541 cltv_expiry_delta: 0,
4542 htlc_minimum_msat: 0,
4543 htlc_maximum_msat: OptionalField::Present(200_000),
4545 fee_proportional_millionths: 0,
4546 excess_data: Vec::new()
4549 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4550 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4551 short_channel_id: 6,
4554 cltv_expiry_delta: 0,
4555 htlc_minimum_msat: 0,
4556 htlc_maximum_msat: OptionalField::Present(100_000),
4557 fee_base_msat: 1_000,
4558 fee_proportional_millionths: 0,
4559 excess_data: Vec::new()
4561 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
4562 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4563 short_channel_id: 11,
4566 cltv_expiry_delta: 0,
4567 htlc_minimum_msat: 0,
4568 htlc_maximum_msat: OptionalField::Present(100_000),
4570 fee_proportional_millionths: 0,
4571 excess_data: Vec::new()
4574 // Path via {node7, node2} is channels {12, 13, 5}.
4575 // We already limited them to 200 sats (they are used twice for 100 sats).
4576 // Nothing to do here.
4579 // Now, attempt to route 180 sats.
4580 // Our algorithm should provide us with these 2 paths.
4581 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 180_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
4582 assert_eq!(route.paths.len(), 2);
4584 let mut total_value_transferred_msat = 0;
4585 let mut total_paid_msat = 0;
4586 for path in &route.paths {
4587 assert_eq!(path.last().unwrap().pubkey, nodes[3]);
4588 total_value_transferred_msat += path.last().unwrap().fee_msat;
4590 total_paid_msat += hop.fee_msat;
4593 // If we paid fee, this would be higher.
4594 assert_eq!(total_value_transferred_msat, 180_000);
4595 let total_fees_paid = total_paid_msat - total_value_transferred_msat;
4596 assert_eq!(total_fees_paid, 0);
4601 fn fees_on_mpp_route_test() {
4602 // This test makes sure that MPP algorithm properly takes into account
4603 // fees charged on the channels, by making the fees impactful:
4604 // if the fee is not properly accounted for, the behavior is different.
4605 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
4606 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4607 let scorer = test_utils::TestScorer::with_penalty(0);
4608 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4609 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4610 let payment_params = PaymentParameters::from_node_id(nodes[3]).with_features(InvoiceFeatures::known());
4612 // We need a route consisting of 2 paths:
4613 // From our node to node3 via {node0, node2} and {node7, node2, node4}.
4614 // We will route 200 sats, Each path will have 100 sats capacity.
4616 // This test is not particularly stable: e.g.,
4617 // there's a way to route via {node0, node2, node4}.
4618 // It works while pathfinding is deterministic, but can be broken otherwise.
4619 // It's fine to ignore this concern for now.
4621 // Disable other potential paths.
4622 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4623 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4624 short_channel_id: 2,
4627 cltv_expiry_delta: 0,
4628 htlc_minimum_msat: 0,
4629 htlc_maximum_msat: OptionalField::Present(100_000),
4631 fee_proportional_millionths: 0,
4632 excess_data: Vec::new()
4635 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4636 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4637 short_channel_id: 7,
4640 cltv_expiry_delta: 0,
4641 htlc_minimum_msat: 0,
4642 htlc_maximum_msat: OptionalField::Present(100_000),
4644 fee_proportional_millionths: 0,
4645 excess_data: Vec::new()
4648 // Path via {node0, node2} is channels {1, 3, 5}.
4649 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4650 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4651 short_channel_id: 1,
4654 cltv_expiry_delta: 0,
4655 htlc_minimum_msat: 0,
4656 htlc_maximum_msat: OptionalField::Present(100_000),
4658 fee_proportional_millionths: 0,
4659 excess_data: Vec::new()
4661 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4662 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4663 short_channel_id: 3,
4666 cltv_expiry_delta: 0,
4667 htlc_minimum_msat: 0,
4668 htlc_maximum_msat: OptionalField::Present(100_000),
4670 fee_proportional_millionths: 0,
4671 excess_data: Vec::new()
4674 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
4675 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4676 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4677 short_channel_id: 5,
4680 cltv_expiry_delta: 0,
4681 htlc_minimum_msat: 0,
4682 htlc_maximum_msat: OptionalField::Present(100_000),
4684 fee_proportional_millionths: 0,
4685 excess_data: Vec::new()
4688 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
4689 // All channels should be 100 sats capacity. But for the fee experiment,
4690 // we'll add absolute fee of 150 sats paid for the use channel 6 (paid to node2 on channel 13).
4691 // Since channel 12 allows to deliver only 250 sats to channel 13, channel 13 can transfer only
4692 // 100 sats (and pay 150 sats in fees for the use of channel 6),
4693 // so no matter how large are other channels,
4694 // the whole path will be limited by 100 sats with just these 2 conditions:
4695 // - channel 12 capacity is 250 sats
4696 // - fee for channel 6 is 150 sats
4697 // Let's test this by enforcing these 2 conditions and removing other limits.
4698 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4699 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4700 short_channel_id: 12,
4703 cltv_expiry_delta: 0,
4704 htlc_minimum_msat: 0,
4705 htlc_maximum_msat: OptionalField::Present(250_000),
4707 fee_proportional_millionths: 0,
4708 excess_data: Vec::new()
4710 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
4711 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4712 short_channel_id: 13,
4715 cltv_expiry_delta: 0,
4716 htlc_minimum_msat: 0,
4717 htlc_maximum_msat: OptionalField::Absent,
4719 fee_proportional_millionths: 0,
4720 excess_data: Vec::new()
4723 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
4724 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4725 short_channel_id: 6,
4728 cltv_expiry_delta: 0,
4729 htlc_minimum_msat: 0,
4730 htlc_maximum_msat: OptionalField::Absent,
4731 fee_base_msat: 150_000,
4732 fee_proportional_millionths: 0,
4733 excess_data: Vec::new()
4735 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
4736 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4737 short_channel_id: 11,
4740 cltv_expiry_delta: 0,
4741 htlc_minimum_msat: 0,
4742 htlc_maximum_msat: OptionalField::Absent,
4744 fee_proportional_millionths: 0,
4745 excess_data: Vec::new()
4749 // Attempt to route more than available results in a failure.
4750 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4751 &our_id, &payment_params, &network_graph.read_only(), None, 210_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
4752 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4753 } else { panic!(); }
4757 // Now, attempt to route 200 sats (exact amount we can route).
4758 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 200_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
4759 assert_eq!(route.paths.len(), 2);
4761 let mut total_amount_paid_msat = 0;
4762 for path in &route.paths {
4763 assert_eq!(path.last().unwrap().pubkey, nodes[3]);
4764 total_amount_paid_msat += path.last().unwrap().fee_msat;
4766 assert_eq!(total_amount_paid_msat, 200_000);
4767 assert_eq!(route.get_total_fees(), 150_000);
4772 fn mpp_with_last_hops() {
4773 // Previously, if we tried to send an MPP payment to a destination which was only reachable
4774 // via a single last-hop route hint, we'd fail to route if we first collected routes
4775 // totaling close but not quite enough to fund the full payment.
4777 // This was because we considered last-hop hints to have exactly the sought payment amount
4778 // instead of the amount we were trying to collect, needlessly limiting our path searching
4779 // at the very first hop.
4781 // Specifically, this interacted with our "all paths must fund at least 5% of total target"
4782 // criterion to cause us to refuse all routes at the last hop hint which would be considered
4783 // to only have the remaining to-collect amount in available liquidity.
4785 // This bug appeared in production in some specific channel configurations.
4786 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
4787 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4788 let scorer = test_utils::TestScorer::with_penalty(0);
4789 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4790 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4791 let payment_params = PaymentParameters::from_node_id(PublicKey::from_slice(&[02; 33]).unwrap()).with_features(InvoiceFeatures::known())
4792 .with_route_hints(vec![RouteHint(vec![RouteHintHop {
4793 src_node_id: nodes[2],
4794 short_channel_id: 42,
4795 fees: RoutingFees { base_msat: 0, proportional_millionths: 0 },
4796 cltv_expiry_delta: 42,
4797 htlc_minimum_msat: None,
4798 htlc_maximum_msat: None,
4801 // Keep only two paths from us to nodes[2], both with a 99sat HTLC maximum, with one with
4802 // no fee and one with a 1msat fee. Previously, trying to route 100 sats to nodes[2] here
4803 // would first use the no-fee route and then fail to find a path along the second route as
4804 // we think we can only send up to 1 additional sat over the last-hop but refuse to as its
4805 // under 5% of our payment amount.
4806 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4807 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4808 short_channel_id: 1,
4811 cltv_expiry_delta: (5 << 4) | 5,
4812 htlc_minimum_msat: 0,
4813 htlc_maximum_msat: OptionalField::Present(99_000),
4814 fee_base_msat: u32::max_value(),
4815 fee_proportional_millionths: u32::max_value(),
4816 excess_data: Vec::new()
4818 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4819 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4820 short_channel_id: 2,
4823 cltv_expiry_delta: (5 << 4) | 3,
4824 htlc_minimum_msat: 0,
4825 htlc_maximum_msat: OptionalField::Present(99_000),
4826 fee_base_msat: u32::max_value(),
4827 fee_proportional_millionths: u32::max_value(),
4828 excess_data: Vec::new()
4830 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
4831 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4832 short_channel_id: 4,
4835 cltv_expiry_delta: (4 << 4) | 1,
4836 htlc_minimum_msat: 0,
4837 htlc_maximum_msat: OptionalField::Absent,
4839 fee_proportional_millionths: 0,
4840 excess_data: Vec::new()
4842 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
4843 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4844 short_channel_id: 13,
4846 flags: 0|2, // Channel disabled
4847 cltv_expiry_delta: (13 << 4) | 1,
4848 htlc_minimum_msat: 0,
4849 htlc_maximum_msat: OptionalField::Absent,
4851 fee_proportional_millionths: 2000000,
4852 excess_data: Vec::new()
4855 // Get a route for 100 sats and check that we found the MPP route no problem and didn't
4857 let mut route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
4858 assert_eq!(route.paths.len(), 2);
4859 route.paths.sort_by_key(|path| path[0].short_channel_id);
4860 // Paths are manually ordered ordered by SCID, so:
4861 // * the first is channel 1 (0 fee, but 99 sat maximum) -> channel 3 -> channel 42
4862 // * the second is channel 2 (1 msat fee) -> channel 4 -> channel 42
4863 assert_eq!(route.paths[0][0].short_channel_id, 1);
4864 assert_eq!(route.paths[0][0].fee_msat, 0);
4865 assert_eq!(route.paths[0][2].fee_msat, 99_000);
4866 assert_eq!(route.paths[1][0].short_channel_id, 2);
4867 assert_eq!(route.paths[1][0].fee_msat, 1);
4868 assert_eq!(route.paths[1][2].fee_msat, 1_000);
4869 assert_eq!(route.get_total_fees(), 1);
4870 assert_eq!(route.get_total_amount(), 100_000);
4874 fn drop_lowest_channel_mpp_route_test() {
4875 // This test checks that low-capacity channel is dropped when after
4876 // path finding we realize that we found more capacity than we need.
4877 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
4878 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
4879 let scorer = test_utils::TestScorer::with_penalty(0);
4880 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
4881 let random_seed_bytes = keys_manager.get_secure_random_bytes();
4882 let payment_params = PaymentParameters::from_node_id(nodes[2]).with_features(InvoiceFeatures::known())
4883 .with_max_channel_saturation_power_of_half(0);
4885 // We need a route consisting of 3 paths:
4886 // From our node to node2 via node0, node7, node1 (three paths one hop each).
4888 // The first and the second paths should be sufficient, but the third should be
4889 // cheaper, so that we select it but drop later.
4891 // First, we set limits on these (previously unlimited) channels.
4892 // Their aggregate capacity will be 50 + 60 + 20 = 130 sats.
4894 // Path via node0 is channels {1, 3}. Limit them to 100 and 50 sats (total limit 50);
4895 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4896 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4897 short_channel_id: 1,
4900 cltv_expiry_delta: 0,
4901 htlc_minimum_msat: 0,
4902 htlc_maximum_msat: OptionalField::Present(100_000),
4904 fee_proportional_millionths: 0,
4905 excess_data: Vec::new()
4907 update_channel(&gossip_sync, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
4908 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4909 short_channel_id: 3,
4912 cltv_expiry_delta: 0,
4913 htlc_minimum_msat: 0,
4914 htlc_maximum_msat: OptionalField::Present(50_000),
4916 fee_proportional_millionths: 0,
4917 excess_data: Vec::new()
4920 // Path via node7 is channels {12, 13}. Limit them to 60 and 60 sats (total limit 60);
4921 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4922 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4923 short_channel_id: 12,
4926 cltv_expiry_delta: 0,
4927 htlc_minimum_msat: 0,
4928 htlc_maximum_msat: OptionalField::Present(60_000),
4930 fee_proportional_millionths: 0,
4931 excess_data: Vec::new()
4933 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
4934 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4935 short_channel_id: 13,
4938 cltv_expiry_delta: 0,
4939 htlc_minimum_msat: 0,
4940 htlc_maximum_msat: OptionalField::Present(60_000),
4942 fee_proportional_millionths: 0,
4943 excess_data: Vec::new()
4946 // Path via node1 is channels {2, 4}. Limit them to 20 and 20 sats (total capacity 20 sats).
4947 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
4948 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4949 short_channel_id: 2,
4952 cltv_expiry_delta: 0,
4953 htlc_minimum_msat: 0,
4954 htlc_maximum_msat: OptionalField::Present(20_000),
4956 fee_proportional_millionths: 0,
4957 excess_data: Vec::new()
4959 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
4960 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4961 short_channel_id: 4,
4964 cltv_expiry_delta: 0,
4965 htlc_minimum_msat: 0,
4966 htlc_maximum_msat: OptionalField::Present(20_000),
4968 fee_proportional_millionths: 0,
4969 excess_data: Vec::new()
4973 // Attempt to route more than available results in a failure.
4974 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(
4975 &our_id, &payment_params, &network_graph.read_only(), None, 150_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes) {
4976 assert_eq!(err, "Failed to find a sufficient route to the given destination");
4977 } else { panic!(); }
4981 // Now, attempt to route 125 sats (just a bit below the capacity of 3 channels).
4982 // Our algorithm should provide us with these 3 paths.
4983 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 125_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
4984 assert_eq!(route.paths.len(), 3);
4985 let mut total_amount_paid_msat = 0;
4986 for path in &route.paths {
4987 assert_eq!(path.len(), 2);
4988 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
4989 total_amount_paid_msat += path.last().unwrap().fee_msat;
4991 assert_eq!(total_amount_paid_msat, 125_000);
4995 // Attempt to route without the last small cheap channel
4996 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 90_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
4997 assert_eq!(route.paths.len(), 2);
4998 let mut total_amount_paid_msat = 0;
4999 for path in &route.paths {
5000 assert_eq!(path.len(), 2);
5001 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
5002 total_amount_paid_msat += path.last().unwrap().fee_msat;
5004 assert_eq!(total_amount_paid_msat, 90_000);
5009 fn min_criteria_consistency() {
5010 // Test that we don't use an inconsistent metric between updating and walking nodes during
5011 // our Dijkstra's pass. In the initial version of MPP, the "best source" for a given node
5012 // was updated with a different criterion from the heap sorting, resulting in loops in
5013 // calculated paths. We test for that specific case here.
5015 // We construct a network that looks like this:
5017 // node2 -1(3)2- node3
5021 // node1 -1(5)2- node4 -1(1)2- node6
5027 // We create a loop on the side of our real path - our destination is node 6, with a
5028 // previous hop of node 4. From 4, the cheapest previous path is channel 2 from node 2,
5029 // followed by node 3 over channel 3. Thereafter, the cheapest next-hop is back to node 4
5030 // (this time over channel 4). Channel 4 has 0 htlc_minimum_msat whereas channel 1 (the
5031 // other channel with a previous-hop of node 4) has a high (but irrelevant to the overall
5032 // payment) htlc_minimum_msat. In the original algorithm, this resulted in node4's
5033 // "previous hop" being set to node 3, creating a loop in the path.
5034 let secp_ctx = Secp256k1::new();
5035 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
5036 let logger = Arc::new(test_utils::TestLogger::new());
5037 let network = Arc::new(NetworkGraph::new(genesis_hash, Arc::clone(&logger)));
5038 let gossip_sync = P2PGossipSync::new(Arc::clone(&network), None, Arc::clone(&logger));
5039 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5040 let scorer = test_utils::TestScorer::with_penalty(0);
5041 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5042 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5043 let payment_params = PaymentParameters::from_node_id(nodes[6]);
5045 add_channel(&gossip_sync, &secp_ctx, &our_privkey, &privkeys[1], ChannelFeatures::from_le_bytes(id_to_feature_flags(6)), 6);
5046 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5047 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
5048 short_channel_id: 6,
5051 cltv_expiry_delta: (6 << 4) | 0,
5052 htlc_minimum_msat: 0,
5053 htlc_maximum_msat: OptionalField::Absent,
5055 fee_proportional_millionths: 0,
5056 excess_data: Vec::new()
5058 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[1], NodeFeatures::from_le_bytes(id_to_feature_flags(1)), 0);
5060 add_channel(&gossip_sync, &secp_ctx, &privkeys[1], &privkeys[4], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
5061 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
5062 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
5063 short_channel_id: 5,
5066 cltv_expiry_delta: (5 << 4) | 0,
5067 htlc_minimum_msat: 0,
5068 htlc_maximum_msat: OptionalField::Absent,
5070 fee_proportional_millionths: 0,
5071 excess_data: Vec::new()
5073 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[4], NodeFeatures::from_le_bytes(id_to_feature_flags(4)), 0);
5075 add_channel(&gossip_sync, &secp_ctx, &privkeys[4], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(4)), 4);
5076 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
5077 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
5078 short_channel_id: 4,
5081 cltv_expiry_delta: (4 << 4) | 0,
5082 htlc_minimum_msat: 0,
5083 htlc_maximum_msat: OptionalField::Absent,
5085 fee_proportional_millionths: 0,
5086 excess_data: Vec::new()
5088 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[3], NodeFeatures::from_le_bytes(id_to_feature_flags(3)), 0);
5090 add_channel(&gossip_sync, &secp_ctx, &privkeys[3], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(3)), 3);
5091 update_channel(&gossip_sync, &secp_ctx, &privkeys[3], UnsignedChannelUpdate {
5092 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
5093 short_channel_id: 3,
5096 cltv_expiry_delta: (3 << 4) | 0,
5097 htlc_minimum_msat: 0,
5098 htlc_maximum_msat: OptionalField::Absent,
5100 fee_proportional_millionths: 0,
5101 excess_data: Vec::new()
5103 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[2], NodeFeatures::from_le_bytes(id_to_feature_flags(2)), 0);
5105 add_channel(&gossip_sync, &secp_ctx, &privkeys[2], &privkeys[4], ChannelFeatures::from_le_bytes(id_to_feature_flags(2)), 2);
5106 update_channel(&gossip_sync, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
5107 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
5108 short_channel_id: 2,
5111 cltv_expiry_delta: (2 << 4) | 0,
5112 htlc_minimum_msat: 0,
5113 htlc_maximum_msat: OptionalField::Absent,
5115 fee_proportional_millionths: 0,
5116 excess_data: Vec::new()
5119 add_channel(&gossip_sync, &secp_ctx, &privkeys[4], &privkeys[6], ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 1);
5120 update_channel(&gossip_sync, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
5121 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
5122 short_channel_id: 1,
5125 cltv_expiry_delta: (1 << 4) | 0,
5126 htlc_minimum_msat: 100,
5127 htlc_maximum_msat: OptionalField::Absent,
5129 fee_proportional_millionths: 0,
5130 excess_data: Vec::new()
5132 add_or_update_node(&gossip_sync, &secp_ctx, &privkeys[6], NodeFeatures::from_le_bytes(id_to_feature_flags(6)), 0);
5135 // Now ensure the route flows simply over nodes 1 and 4 to 6.
5136 let route = get_route(&our_id, &payment_params, &network.read_only(), None, 10_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
5137 assert_eq!(route.paths.len(), 1);
5138 assert_eq!(route.paths[0].len(), 3);
5140 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
5141 assert_eq!(route.paths[0][0].short_channel_id, 6);
5142 assert_eq!(route.paths[0][0].fee_msat, 100);
5143 assert_eq!(route.paths[0][0].cltv_expiry_delta, (5 << 4) | 0);
5144 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(1));
5145 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(6));
5147 assert_eq!(route.paths[0][1].pubkey, nodes[4]);
5148 assert_eq!(route.paths[0][1].short_channel_id, 5);
5149 assert_eq!(route.paths[0][1].fee_msat, 0);
5150 assert_eq!(route.paths[0][1].cltv_expiry_delta, (1 << 4) | 0);
5151 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(4));
5152 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(5));
5154 assert_eq!(route.paths[0][2].pubkey, nodes[6]);
5155 assert_eq!(route.paths[0][2].short_channel_id, 1);
5156 assert_eq!(route.paths[0][2].fee_msat, 10_000);
5157 assert_eq!(route.paths[0][2].cltv_expiry_delta, 42);
5158 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(6));
5159 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(1));
5165 fn exact_fee_liquidity_limit() {
5166 // Test that if, while walking the graph, we find a hop that has exactly enough liquidity
5167 // for us, including later hop fees, we take it. In the first version of our MPP algorithm
5168 // we calculated fees on a higher value, resulting in us ignoring such paths.
5169 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5170 let (our_privkey, our_id, _, nodes) = get_nodes(&secp_ctx);
5171 let scorer = test_utils::TestScorer::with_penalty(0);
5172 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5173 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5174 let payment_params = PaymentParameters::from_node_id(nodes[2]);
5176 // We modify the graph to set the htlc_maximum of channel 2 to below the value we wish to
5178 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5179 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
5180 short_channel_id: 2,
5183 cltv_expiry_delta: 0,
5184 htlc_minimum_msat: 0,
5185 htlc_maximum_msat: OptionalField::Present(85_000),
5187 fee_proportional_millionths: 0,
5188 excess_data: Vec::new()
5191 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5192 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
5193 short_channel_id: 12,
5196 cltv_expiry_delta: (4 << 4) | 1,
5197 htlc_minimum_msat: 0,
5198 htlc_maximum_msat: OptionalField::Present(270_000),
5200 fee_proportional_millionths: 1000000,
5201 excess_data: Vec::new()
5205 // Now, attempt to route 90 sats, which is exactly 90 sats at the last hop, plus the
5206 // 200% fee charged channel 13 in the 1-to-2 direction.
5207 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 90_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
5208 assert_eq!(route.paths.len(), 1);
5209 assert_eq!(route.paths[0].len(), 2);
5211 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
5212 assert_eq!(route.paths[0][0].short_channel_id, 12);
5213 assert_eq!(route.paths[0][0].fee_msat, 90_000*2);
5214 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 4) | 1);
5215 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(8));
5216 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(12));
5218 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
5219 assert_eq!(route.paths[0][1].short_channel_id, 13);
5220 assert_eq!(route.paths[0][1].fee_msat, 90_000);
5221 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
5222 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
5223 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
5228 fn htlc_max_reduction_below_min() {
5229 // Test that if, while walking the graph, we reduce the value being sent to meet an
5230 // htlc_maximum_msat, we don't end up undershooting a later htlc_minimum_msat. In the
5231 // initial version of MPP we'd accept such routes but reject them while recalculating fees,
5232 // resulting in us thinking there is no possible path, even if other paths exist.
5233 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5234 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5235 let scorer = test_utils::TestScorer::with_penalty(0);
5236 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5237 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5238 let payment_params = PaymentParameters::from_node_id(nodes[2]).with_features(InvoiceFeatures::known());
5240 // We modify the graph to set the htlc_minimum of channel 2 and 4 as needed - channel 2
5241 // gets an htlc_maximum_msat of 80_000 and channel 4 an htlc_minimum_msat of 90_000. We
5242 // then try to send 90_000.
5243 update_channel(&gossip_sync, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
5244 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
5245 short_channel_id: 2,
5248 cltv_expiry_delta: 0,
5249 htlc_minimum_msat: 0,
5250 htlc_maximum_msat: OptionalField::Present(80_000),
5252 fee_proportional_millionths: 0,
5253 excess_data: Vec::new()
5255 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
5256 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
5257 short_channel_id: 4,
5260 cltv_expiry_delta: (4 << 4) | 1,
5261 htlc_minimum_msat: 90_000,
5262 htlc_maximum_msat: OptionalField::Absent,
5264 fee_proportional_millionths: 0,
5265 excess_data: Vec::new()
5269 // Now, attempt to route 90 sats, hitting the htlc_minimum on channel 4, but
5270 // overshooting the htlc_maximum on channel 2. Thus, we should pick the (absurdly
5271 // expensive) channels 12-13 path.
5272 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 90_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
5273 assert_eq!(route.paths.len(), 1);
5274 assert_eq!(route.paths[0].len(), 2);
5276 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
5277 assert_eq!(route.paths[0][0].short_channel_id, 12);
5278 assert_eq!(route.paths[0][0].fee_msat, 90_000*2);
5279 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 4) | 1);
5280 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(8));
5281 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(12));
5283 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
5284 assert_eq!(route.paths[0][1].short_channel_id, 13);
5285 assert_eq!(route.paths[0][1].fee_msat, 90_000);
5286 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
5287 assert_eq!(route.paths[0][1].node_features.le_flags(), InvoiceFeatures::known().le_flags());
5288 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
5293 fn multiple_direct_first_hops() {
5294 // Previously we'd only ever considered one first hop path per counterparty.
5295 // However, as we don't restrict users to one channel per peer, we really need to support
5296 // looking at all first hop paths.
5297 // Here we test that we do not ignore all-but-the-last first hop paths per counterparty (as
5298 // we used to do by overwriting the `first_hop_targets` hashmap entry) and that we can MPP
5299 // route over multiple channels with the same first hop.
5300 let secp_ctx = Secp256k1::new();
5301 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
5302 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
5303 let logger = Arc::new(test_utils::TestLogger::new());
5304 let network_graph = NetworkGraph::new(genesis_hash, Arc::clone(&logger));
5305 let scorer = test_utils::TestScorer::with_penalty(0);
5306 let payment_params = PaymentParameters::from_node_id(nodes[0]).with_features(InvoiceFeatures::known());
5307 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5308 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5311 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), Some(&[
5312 &get_channel_details(Some(3), nodes[0], InitFeatures::known(), 200_000),
5313 &get_channel_details(Some(2), nodes[0], InitFeatures::known(), 10_000),
5314 ]), 100_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
5315 assert_eq!(route.paths.len(), 1);
5316 assert_eq!(route.paths[0].len(), 1);
5318 assert_eq!(route.paths[0][0].pubkey, nodes[0]);
5319 assert_eq!(route.paths[0][0].short_channel_id, 3);
5320 assert_eq!(route.paths[0][0].fee_msat, 100_000);
5323 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), Some(&[
5324 &get_channel_details(Some(3), nodes[0], InitFeatures::known(), 50_000),
5325 &get_channel_details(Some(2), nodes[0], InitFeatures::known(), 50_000),
5326 ]), 100_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
5327 assert_eq!(route.paths.len(), 2);
5328 assert_eq!(route.paths[0].len(), 1);
5329 assert_eq!(route.paths[1].len(), 1);
5331 assert!((route.paths[0][0].short_channel_id == 3 && route.paths[1][0].short_channel_id == 2) ||
5332 (route.paths[0][0].short_channel_id == 2 && route.paths[1][0].short_channel_id == 3));
5334 assert_eq!(route.paths[0][0].pubkey, nodes[0]);
5335 assert_eq!(route.paths[0][0].fee_msat, 50_000);
5337 assert_eq!(route.paths[1][0].pubkey, nodes[0]);
5338 assert_eq!(route.paths[1][0].fee_msat, 50_000);
5342 // If we have a bunch of outbound channels to the same node, where most are not
5343 // sufficient to pay the full payment, but one is, we should default to just using the
5344 // one single channel that has sufficient balance, avoiding MPP.
5346 // If we have several options above the 3xpayment value threshold, we should pick the
5347 // smallest of them, avoiding further fragmenting our available outbound balance to
5349 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), Some(&[
5350 &get_channel_details(Some(2), nodes[0], InitFeatures::known(), 50_000),
5351 &get_channel_details(Some(3), nodes[0], InitFeatures::known(), 50_000),
5352 &get_channel_details(Some(5), nodes[0], InitFeatures::known(), 50_000),
5353 &get_channel_details(Some(6), nodes[0], InitFeatures::known(), 300_000),
5354 &get_channel_details(Some(7), nodes[0], InitFeatures::known(), 50_000),
5355 &get_channel_details(Some(8), nodes[0], InitFeatures::known(), 50_000),
5356 &get_channel_details(Some(9), nodes[0], InitFeatures::known(), 50_000),
5357 &get_channel_details(Some(4), nodes[0], InitFeatures::known(), 1_000_000),
5358 ]), 100_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
5359 assert_eq!(route.paths.len(), 1);
5360 assert_eq!(route.paths[0].len(), 1);
5362 assert_eq!(route.paths[0][0].pubkey, nodes[0]);
5363 assert_eq!(route.paths[0][0].short_channel_id, 6);
5364 assert_eq!(route.paths[0][0].fee_msat, 100_000);
5369 fn prefers_shorter_route_with_higher_fees() {
5370 let (secp_ctx, network_graph, _, _, logger) = build_graph();
5371 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
5372 let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops(&nodes));
5374 // Without penalizing each hop 100 msats, a longer path with lower fees is chosen.
5375 let scorer = test_utils::TestScorer::with_penalty(0);
5376 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5377 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5378 let route = get_route(
5379 &our_id, &payment_params, &network_graph.read_only(), None, 100, 42,
5380 Arc::clone(&logger), &scorer, &random_seed_bytes
5382 let path = route.paths[0].iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
5384 assert_eq!(route.get_total_fees(), 100);
5385 assert_eq!(route.get_total_amount(), 100);
5386 assert_eq!(path, vec![2, 4, 6, 11, 8]);
5388 // Applying a 100 msat penalty to each hop results in taking channels 7 and 10 to nodes[6]
5389 // from nodes[2] rather than channel 6, 11, and 8, even though the longer path is cheaper.
5390 let scorer = test_utils::TestScorer::with_penalty(100);
5391 let route = get_route(
5392 &our_id, &payment_params, &network_graph.read_only(), None, 100, 42,
5393 Arc::clone(&logger), &scorer, &random_seed_bytes
5395 let path = route.paths[0].iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
5397 assert_eq!(route.get_total_fees(), 300);
5398 assert_eq!(route.get_total_amount(), 100);
5399 assert_eq!(path, vec![2, 4, 7, 10]);
5402 struct BadChannelScorer {
5403 short_channel_id: u64,
5407 impl Writeable for BadChannelScorer {
5408 fn write<W: Writer>(&self, _w: &mut W) -> Result<(), ::io::Error> { unimplemented!() }
5410 impl Score for BadChannelScorer {
5411 fn channel_penalty_msat(&self, short_channel_id: u64, _: &NodeId, _: &NodeId, _: ChannelUsage) -> u64 {
5412 if short_channel_id == self.short_channel_id { u64::max_value() } else { 0 }
5415 fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) {}
5416 fn payment_path_successful(&mut self, _path: &[&RouteHop]) {}
5417 fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) {}
5418 fn probe_successful(&mut self, _path: &[&RouteHop]) {}
5421 struct BadNodeScorer {
5426 impl Writeable for BadNodeScorer {
5427 fn write<W: Writer>(&self, _w: &mut W) -> Result<(), ::io::Error> { unimplemented!() }
5430 impl Score for BadNodeScorer {
5431 fn channel_penalty_msat(&self, _: u64, _: &NodeId, target: &NodeId, _: ChannelUsage) -> u64 {
5432 if *target == self.node_id { u64::max_value() } else { 0 }
5435 fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) {}
5436 fn payment_path_successful(&mut self, _path: &[&RouteHop]) {}
5437 fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) {}
5438 fn probe_successful(&mut self, _path: &[&RouteHop]) {}
5442 fn avoids_routing_through_bad_channels_and_nodes() {
5443 let (secp_ctx, network, _, _, logger) = build_graph();
5444 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
5445 let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops(&nodes));
5446 let network_graph = network.read_only();
5448 // A path to nodes[6] exists when no penalties are applied to any channel.
5449 let scorer = test_utils::TestScorer::with_penalty(0);
5450 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5451 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5452 let route = get_route(
5453 &our_id, &payment_params, &network_graph, None, 100, 42,
5454 Arc::clone(&logger), &scorer, &random_seed_bytes
5456 let path = route.paths[0].iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
5458 assert_eq!(route.get_total_fees(), 100);
5459 assert_eq!(route.get_total_amount(), 100);
5460 assert_eq!(path, vec![2, 4, 6, 11, 8]);
5462 // A different path to nodes[6] exists if channel 6 cannot be routed over.
5463 let scorer = BadChannelScorer { short_channel_id: 6 };
5464 let route = get_route(
5465 &our_id, &payment_params, &network_graph, None, 100, 42,
5466 Arc::clone(&logger), &scorer, &random_seed_bytes
5468 let path = route.paths[0].iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
5470 assert_eq!(route.get_total_fees(), 300);
5471 assert_eq!(route.get_total_amount(), 100);
5472 assert_eq!(path, vec![2, 4, 7, 10]);
5474 // A path to nodes[6] does not exist if nodes[2] cannot be routed through.
5475 let scorer = BadNodeScorer { node_id: NodeId::from_pubkey(&nodes[2]) };
5477 &our_id, &payment_params, &network_graph, None, 100, 42,
5478 Arc::clone(&logger), &scorer, &random_seed_bytes
5480 Err(LightningError { err, .. } ) => {
5481 assert_eq!(err, "Failed to find a path to the given destination");
5483 Ok(_) => panic!("Expected error"),
5488 fn total_fees_single_path() {
5492 pubkey: PublicKey::from_slice(&hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
5493 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
5494 short_channel_id: 0, fee_msat: 100, cltv_expiry_delta: 0
5497 pubkey: PublicKey::from_slice(&hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
5498 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
5499 short_channel_id: 0, fee_msat: 150, cltv_expiry_delta: 0
5502 pubkey: PublicKey::from_slice(&hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
5503 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
5504 short_channel_id: 0, fee_msat: 225, cltv_expiry_delta: 0
5507 payment_params: None,
5510 assert_eq!(route.get_total_fees(), 250);
5511 assert_eq!(route.get_total_amount(), 225);
5515 fn total_fees_multi_path() {
5519 pubkey: PublicKey::from_slice(&hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
5520 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
5521 short_channel_id: 0, fee_msat: 100, cltv_expiry_delta: 0
5524 pubkey: PublicKey::from_slice(&hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
5525 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
5526 short_channel_id: 0, fee_msat: 150, cltv_expiry_delta: 0
5530 pubkey: PublicKey::from_slice(&hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
5531 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
5532 short_channel_id: 0, fee_msat: 100, cltv_expiry_delta: 0
5535 pubkey: PublicKey::from_slice(&hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
5536 channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
5537 short_channel_id: 0, fee_msat: 150, cltv_expiry_delta: 0
5540 payment_params: None,
5543 assert_eq!(route.get_total_fees(), 200);
5544 assert_eq!(route.get_total_amount(), 300);
5548 fn total_empty_route_no_panic() {
5549 // In an earlier version of `Route::get_total_fees` and `Route::get_total_amount`, they
5550 // would both panic if the route was completely empty. We test to ensure they return 0
5551 // here, even though its somewhat nonsensical as a route.
5552 let route = Route { paths: Vec::new(), payment_params: None };
5554 assert_eq!(route.get_total_fees(), 0);
5555 assert_eq!(route.get_total_amount(), 0);
5559 fn limits_total_cltv_delta() {
5560 let (secp_ctx, network, _, _, logger) = build_graph();
5561 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
5562 let network_graph = network.read_only();
5564 let scorer = test_utils::TestScorer::with_penalty(0);
5566 // Make sure that generally there is at least one route available
5567 let feasible_max_total_cltv_delta = 1008;
5568 let feasible_payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops(&nodes))
5569 .with_max_total_cltv_expiry_delta(feasible_max_total_cltv_delta);
5570 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5571 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5572 let route = get_route(&our_id, &feasible_payment_params, &network_graph, None, 100, 0, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
5573 let path = route.paths[0].iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
5574 assert_ne!(path.len(), 0);
5576 // But not if we exclude all paths on the basis of their accumulated CLTV delta
5577 let fail_max_total_cltv_delta = 23;
5578 let fail_payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops(&nodes))
5579 .with_max_total_cltv_expiry_delta(fail_max_total_cltv_delta);
5580 match get_route(&our_id, &fail_payment_params, &network_graph, None, 100, 0, Arc::clone(&logger), &scorer, &random_seed_bytes)
5582 Err(LightningError { err, .. } ) => {
5583 assert_eq!(err, "Failed to find a path to the given destination");
5585 Ok(_) => panic!("Expected error"),
5590 fn avoids_recently_failed_paths() {
5591 // Ensure that the router always avoids all of the `previously_failed_channels` channels by
5592 // randomly inserting channels into it until we can't find a route anymore.
5593 let (secp_ctx, network, _, _, logger) = build_graph();
5594 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
5595 let network_graph = network.read_only();
5597 let scorer = test_utils::TestScorer::with_penalty(0);
5598 let mut payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops(&nodes))
5599 .with_max_path_count(1);
5600 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5601 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5603 // We should be able to find a route initially, and then after we fail a few random
5604 // channels eventually we won't be able to any longer.
5605 assert!(get_route(&our_id, &payment_params, &network_graph, None, 100, 0, Arc::clone(&logger), &scorer, &random_seed_bytes).is_ok());
5607 if let Ok(route) = get_route(&our_id, &payment_params, &network_graph, None, 100, 0, Arc::clone(&logger), &scorer, &random_seed_bytes) {
5608 for chan in route.paths[0].iter() {
5609 assert!(!payment_params.previously_failed_channels.contains(&chan.short_channel_id));
5611 let victim = (u64::from_ne_bytes(random_seed_bytes[0..8].try_into().unwrap()) as usize)
5612 % route.paths[0].len();
5613 payment_params.previously_failed_channels.push(route.paths[0][victim].short_channel_id);
5619 fn limits_path_length() {
5620 let (secp_ctx, network, _, _, logger) = build_line_graph();
5621 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
5622 let network_graph = network.read_only();
5624 let scorer = test_utils::TestScorer::with_penalty(0);
5625 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5626 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5628 // First check we can actually create a long route on this graph.
5629 let feasible_payment_params = PaymentParameters::from_node_id(nodes[18]);
5630 let route = get_route(&our_id, &feasible_payment_params, &network_graph, None, 100, 0,
5631 Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
5632 let path = route.paths[0].iter().map(|hop| hop.short_channel_id).collect::<Vec<_>>();
5633 assert!(path.len() == MAX_PATH_LENGTH_ESTIMATE.into());
5635 // But we can't create a path surpassing the MAX_PATH_LENGTH_ESTIMATE limit.
5636 let fail_payment_params = PaymentParameters::from_node_id(nodes[19]);
5637 match get_route(&our_id, &fail_payment_params, &network_graph, None, 100, 0,
5638 Arc::clone(&logger), &scorer, &random_seed_bytes)
5640 Err(LightningError { err, .. } ) => {
5641 assert_eq!(err, "Failed to find a path to the given destination");
5643 Ok(_) => panic!("Expected error"),
5648 fn adds_and_limits_cltv_offset() {
5649 let (secp_ctx, network_graph, _, _, logger) = build_graph();
5650 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
5652 let scorer = test_utils::TestScorer::with_penalty(0);
5654 let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops(&nodes));
5655 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5656 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5657 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
5658 assert_eq!(route.paths.len(), 1);
5660 let cltv_expiry_deltas_before = route.paths[0].iter().map(|h| h.cltv_expiry_delta).collect::<Vec<u32>>();
5662 // Check whether the offset added to the last hop by default is in [1 .. DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA]
5663 let mut route_default = route.clone();
5664 add_random_cltv_offset(&mut route_default, &payment_params, &network_graph.read_only(), &random_seed_bytes);
5665 let cltv_expiry_deltas_default = route_default.paths[0].iter().map(|h| h.cltv_expiry_delta).collect::<Vec<u32>>();
5666 assert_eq!(cltv_expiry_deltas_before.split_last().unwrap().1, cltv_expiry_deltas_default.split_last().unwrap().1);
5667 assert!(cltv_expiry_deltas_default.last() > cltv_expiry_deltas_before.last());
5668 assert!(cltv_expiry_deltas_default.last().unwrap() <= &DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA);
5670 // Check that no offset is added when we restrict the max_total_cltv_expiry_delta
5671 let mut route_limited = route.clone();
5672 let limited_max_total_cltv_expiry_delta = cltv_expiry_deltas_before.iter().sum();
5673 let limited_payment_params = payment_params.with_max_total_cltv_expiry_delta(limited_max_total_cltv_expiry_delta);
5674 add_random_cltv_offset(&mut route_limited, &limited_payment_params, &network_graph.read_only(), &random_seed_bytes);
5675 let cltv_expiry_deltas_limited = route_limited.paths[0].iter().map(|h| h.cltv_expiry_delta).collect::<Vec<u32>>();
5676 assert_eq!(cltv_expiry_deltas_before, cltv_expiry_deltas_limited);
5680 fn adds_plausible_cltv_offset() {
5681 let (secp_ctx, network, _, _, logger) = build_graph();
5682 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
5683 let network_graph = network.read_only();
5684 let network_nodes = network_graph.nodes();
5685 let network_channels = network_graph.channels();
5686 let scorer = test_utils::TestScorer::with_penalty(0);
5687 let payment_params = PaymentParameters::from_node_id(nodes[3]);
5688 let keys_manager = test_utils::TestKeysInterface::new(&[4u8; 32], Network::Testnet);
5689 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5691 let mut route = get_route(&our_id, &payment_params, &network_graph, None, 100, 0,
5692 Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
5693 add_random_cltv_offset(&mut route, &payment_params, &network_graph, &random_seed_bytes);
5695 let mut path_plausibility = vec![];
5697 for p in route.paths {
5698 // 1. Select random observation point
5699 let mut prng = ChaCha20::new(&random_seed_bytes, &[0u8; 12]);
5700 let mut random_bytes = [0u8; ::core::mem::size_of::<usize>()];
5702 prng.process_in_place(&mut random_bytes);
5703 let random_path_index = usize::from_be_bytes(random_bytes).wrapping_rem(p.len());
5704 let observation_point = NodeId::from_pubkey(&p.get(random_path_index).unwrap().pubkey);
5706 // 2. Calculate what CLTV expiry delta we would observe there
5707 let observed_cltv_expiry_delta: u32 = p[random_path_index..].iter().map(|h| h.cltv_expiry_delta).sum();
5709 // 3. Starting from the observation point, find candidate paths
5710 let mut candidates: VecDeque<(NodeId, Vec<u32>)> = VecDeque::new();
5711 candidates.push_back((observation_point, vec![]));
5713 let mut found_plausible_candidate = false;
5715 'candidate_loop: while let Some((cur_node_id, cur_path_cltv_deltas)) = candidates.pop_front() {
5716 if let Some(remaining) = observed_cltv_expiry_delta.checked_sub(cur_path_cltv_deltas.iter().sum::<u32>()) {
5717 if remaining == 0 || remaining.wrapping_rem(40) == 0 || remaining.wrapping_rem(144) == 0 {
5718 found_plausible_candidate = true;
5719 break 'candidate_loop;
5723 if let Some(cur_node) = network_nodes.get(&cur_node_id) {
5724 for channel_id in &cur_node.channels {
5725 if let Some(channel_info) = network_channels.get(&channel_id) {
5726 if let Some((dir_info, next_id)) = channel_info.as_directed_from(&cur_node_id) {
5727 if let Some(channel_update_info) = dir_info.direction() {
5728 let next_cltv_expiry_delta = channel_update_info.cltv_expiry_delta as u32;
5729 if cur_path_cltv_deltas.iter().sum::<u32>()
5730 .saturating_add(next_cltv_expiry_delta) <= observed_cltv_expiry_delta {
5731 let mut new_path_cltv_deltas = cur_path_cltv_deltas.clone();
5732 new_path_cltv_deltas.push(next_cltv_expiry_delta);
5733 candidates.push_back((*next_id, new_path_cltv_deltas));
5742 path_plausibility.push(found_plausible_candidate);
5744 assert!(path_plausibility.iter().all(|x| *x));
5748 fn builds_correct_path_from_hops() {
5749 let (secp_ctx, network, _, _, logger) = build_graph();
5750 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
5751 let network_graph = network.read_only();
5753 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5754 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5756 let payment_params = PaymentParameters::from_node_id(nodes[3]);
5757 let hops = [nodes[1], nodes[2], nodes[4], nodes[3]];
5758 let route = build_route_from_hops_internal(&our_id, &hops, &payment_params,
5759 &network_graph, 100, 0, Arc::clone(&logger), &random_seed_bytes).unwrap();
5760 let route_hop_pubkeys = route.paths[0].iter().map(|hop| hop.pubkey).collect::<Vec<_>>();
5761 assert_eq!(hops.len(), route.paths[0].len());
5762 for (idx, hop_pubkey) in hops.iter().enumerate() {
5763 assert!(*hop_pubkey == route_hop_pubkeys[idx]);
5768 fn avoids_saturating_channels() {
5769 let (secp_ctx, network_graph, gossip_sync, _, logger) = build_graph();
5770 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
5772 let scorer = ProbabilisticScorer::new(Default::default(), &*network_graph, Arc::clone(&logger));
5774 // Set the fee on channel 13 to 100% to match channel 4 giving us two equivalent paths (us
5775 // -> node 7 -> node2 and us -> node 1 -> node 2) which we should balance over.
5776 update_channel(&gossip_sync, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
5777 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
5778 short_channel_id: 4,
5781 cltv_expiry_delta: (4 << 4) | 1,
5782 htlc_minimum_msat: 0,
5783 htlc_maximum_msat: OptionalField::Present(200_000_000),
5785 fee_proportional_millionths: 0,
5786 excess_data: Vec::new()
5788 update_channel(&gossip_sync, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
5789 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
5790 short_channel_id: 13,
5793 cltv_expiry_delta: (13 << 4) | 1,
5794 htlc_minimum_msat: 0,
5795 htlc_maximum_msat: OptionalField::Present(200_000_000),
5797 fee_proportional_millionths: 0,
5798 excess_data: Vec::new()
5801 let payment_params = PaymentParameters::from_node_id(nodes[2]).with_features(InvoiceFeatures::known());
5802 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5803 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5804 // 150,000 sat is less than the available liquidity on each channel, set above.
5805 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 150_000_000, 42, Arc::clone(&logger), &scorer, &random_seed_bytes).unwrap();
5806 assert_eq!(route.paths.len(), 2);
5807 assert!((route.paths[0][1].short_channel_id == 4 && route.paths[1][1].short_channel_id == 13) ||
5808 (route.paths[1][1].short_channel_id == 4 && route.paths[0][1].short_channel_id == 13));
5811 #[cfg(not(feature = "no-std"))]
5812 pub(super) fn random_init_seed() -> u64 {
5813 // Because the default HashMap in std pulls OS randomness, we can use it as a (bad) RNG.
5814 use core::hash::{BuildHasher, Hasher};
5815 let seed = std::collections::hash_map::RandomState::new().build_hasher().finish();
5816 println!("Using seed of {}", seed);
5819 #[cfg(not(feature = "no-std"))]
5820 use util::ser::ReadableArgs;
5823 #[cfg(not(feature = "no-std"))]
5824 fn generate_routes() {
5825 use routing::scoring::{ProbabilisticScorer, ProbabilisticScoringParameters};
5827 let mut d = match super::test_utils::get_route_file() {
5834 let logger = test_utils::TestLogger::new();
5835 let graph = NetworkGraph::read(&mut d, &logger).unwrap();
5836 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5837 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5839 // First, get 100 (source, destination) pairs for which route-getting actually succeeds...
5840 let mut seed = random_init_seed() as usize;
5841 let nodes = graph.read_only().nodes().clone();
5842 'load_endpoints: for _ in 0..10 {
5844 seed = seed.overflowing_mul(0xdeadbeef).0;
5845 let src = &PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap();
5846 seed = seed.overflowing_mul(0xdeadbeef).0;
5847 let dst = PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap();
5848 let payment_params = PaymentParameters::from_node_id(dst);
5849 let amt = seed as u64 % 200_000_000;
5850 let params = ProbabilisticScoringParameters::default();
5851 let scorer = ProbabilisticScorer::new(params, &graph, &logger);
5852 if get_route(src, &payment_params, &graph.read_only(), None, amt, 42, &logger, &scorer, &random_seed_bytes).is_ok() {
5853 continue 'load_endpoints;
5860 #[cfg(not(feature = "no-std"))]
5861 fn generate_routes_mpp() {
5862 use routing::scoring::{ProbabilisticScorer, ProbabilisticScoringParameters};
5864 let mut d = match super::test_utils::get_route_file() {
5871 let logger = test_utils::TestLogger::new();
5872 let graph = NetworkGraph::read(&mut d, &logger).unwrap();
5873 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5874 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5876 // First, get 100 (source, destination) pairs for which route-getting actually succeeds...
5877 let mut seed = random_init_seed() as usize;
5878 let nodes = graph.read_only().nodes().clone();
5879 'load_endpoints: for _ in 0..10 {
5881 seed = seed.overflowing_mul(0xdeadbeef).0;
5882 let src = &PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap();
5883 seed = seed.overflowing_mul(0xdeadbeef).0;
5884 let dst = PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap();
5885 let payment_params = PaymentParameters::from_node_id(dst).with_features(InvoiceFeatures::known());
5886 let amt = seed as u64 % 200_000_000;
5887 let params = ProbabilisticScoringParameters::default();
5888 let scorer = ProbabilisticScorer::new(params, &graph, &logger);
5889 if get_route(src, &payment_params, &graph.read_only(), None, amt, 42, &logger, &scorer, &random_seed_bytes).is_ok() {
5890 continue 'load_endpoints;
5897 fn honors_manual_penalties() {
5898 let (secp_ctx, network_graph, _, _, logger) = build_line_graph();
5899 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
5901 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
5902 let random_seed_bytes = keys_manager.get_secure_random_bytes();
5904 let scorer_params = ProbabilisticScoringParameters::default();
5905 let mut scorer = ProbabilisticScorer::new(scorer_params, Arc::clone(&network_graph), Arc::clone(&logger));
5907 // First check set manual penalties are returned by the scorer.
5908 let usage = ChannelUsage {
5910 inflight_htlc_msat: 0,
5911 effective_capacity: EffectiveCapacity::Total { capacity_msat: 1_024_000, htlc_maximum_msat: Some(1_000) },
5913 scorer.set_manual_penalty(&NodeId::from_pubkey(&nodes[3]), 123);
5914 scorer.set_manual_penalty(&NodeId::from_pubkey(&nodes[4]), 456);
5915 assert_eq!(scorer.channel_penalty_msat(42, &NodeId::from_pubkey(&nodes[3]), &NodeId::from_pubkey(&nodes[4]), usage), 456);
5917 // Then check we can get a normal route
5918 let payment_params = PaymentParameters::from_node_id(nodes[10]);
5919 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes);
5920 assert!(route.is_ok());
5922 // Then check that we can't get a route if we ban an intermediate node.
5923 scorer.add_banned(&NodeId::from_pubkey(&nodes[3]));
5924 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes);
5925 assert!(route.is_err());
5927 // Finally make sure we can route again, when we remove the ban.
5928 scorer.remove_banned(&NodeId::from_pubkey(&nodes[3]));
5929 let route = get_route(&our_id, &payment_params, &network_graph.read_only(), None, 100, 42, Arc::clone(&logger), &scorer, &random_seed_bytes);
5930 assert!(route.is_ok());
5934 #[cfg(all(test, not(feature = "no-std")))]
5935 pub(crate) mod test_utils {
5937 /// Tries to open a network graph file, or panics with a URL to fetch it.
5938 pub(crate) fn get_route_file() -> Result<std::fs::File, &'static str> {
5939 let res = File::open("net_graph-2021-05-31.bin") // By default we're run in RL/lightning
5940 .or_else(|_| File::open("lightning/net_graph-2021-05-31.bin")) // We may be run manually in RL/
5941 .or_else(|_| { // Fall back to guessing based on the binary location
5942 // path is likely something like .../rust-lightning/target/debug/deps/lightning-...
5943 let mut path = std::env::current_exe().unwrap();
5944 path.pop(); // lightning-...
5946 path.pop(); // debug
5947 path.pop(); // target
5948 path.push("lightning");
5949 path.push("net_graph-2021-05-31.bin");
5950 eprintln!("{}", path.to_str().unwrap());
5953 .map_err(|_| "Please fetch https://bitcoin.ninja/ldk-net_graph-v0.0.15-2021-05-31.bin and place it at lightning/net_graph-2021-05-31.bin");
5954 #[cfg(require_route_graph_test)]
5955 return Ok(res.unwrap());
5956 #[cfg(not(require_route_graph_test))]
5961 #[cfg(all(test, feature = "_bench_unstable", not(feature = "no-std")))]
5964 use bitcoin::hashes::Hash;
5965 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
5966 use chain::transaction::OutPoint;
5967 use chain::keysinterface::{KeysManager,KeysInterface};
5968 use ln::channelmanager::{ChannelCounterparty, ChannelDetails};
5969 use ln::features::{InitFeatures, InvoiceFeatures};
5970 use routing::gossip::NetworkGraph;
5971 use routing::scoring::{FixedPenaltyScorer, ProbabilisticScorer, ProbabilisticScoringParameters};
5972 use util::logger::{Logger, Record};
5973 use util::ser::ReadableArgs;
5977 struct DummyLogger {}
5978 impl Logger for DummyLogger {
5979 fn log(&self, _record: &Record) {}
5982 fn read_network_graph(logger: &DummyLogger) -> NetworkGraph<&DummyLogger> {
5983 let mut d = test_utils::get_route_file().unwrap();
5984 NetworkGraph::read(&mut d, logger).unwrap()
5987 fn payer_pubkey() -> PublicKey {
5988 let secp_ctx = Secp256k1::new();
5989 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap())
5993 fn first_hop(node_id: PublicKey) -> ChannelDetails {
5995 channel_id: [0; 32],
5996 counterparty: ChannelCounterparty {
5997 features: InitFeatures::known(),
5999 unspendable_punishment_reserve: 0,
6000 forwarding_info: None,
6001 outbound_htlc_minimum_msat: None,
6002 outbound_htlc_maximum_msat: None,
6004 funding_txo: Some(OutPoint {
6005 txid: bitcoin::Txid::from_slice(&[0; 32]).unwrap(), index: 0
6008 short_channel_id: Some(1),
6009 inbound_scid_alias: None,
6010 outbound_scid_alias: None,
6011 channel_value_satoshis: 10_000_000,
6013 balance_msat: 10_000_000,
6014 outbound_capacity_msat: 10_000_000,
6015 next_outbound_htlc_limit_msat: 10_000_000,
6016 inbound_capacity_msat: 0,
6017 unspendable_punishment_reserve: None,
6018 confirmations_required: None,
6019 force_close_spend_delay: None,
6021 is_channel_ready: true,
6024 inbound_htlc_minimum_msat: None,
6025 inbound_htlc_maximum_msat: None,
6031 fn generate_routes_with_zero_penalty_scorer(bench: &mut Bencher) {
6032 let logger = DummyLogger {};
6033 let network_graph = read_network_graph(&logger);
6034 let scorer = FixedPenaltyScorer::with_penalty(0);
6035 generate_routes(bench, &network_graph, scorer, InvoiceFeatures::empty());
6039 fn generate_mpp_routes_with_zero_penalty_scorer(bench: &mut Bencher) {
6040 let logger = DummyLogger {};
6041 let network_graph = read_network_graph(&logger);
6042 let scorer = FixedPenaltyScorer::with_penalty(0);
6043 generate_routes(bench, &network_graph, scorer, InvoiceFeatures::known());
6047 fn generate_routes_with_probabilistic_scorer(bench: &mut Bencher) {
6048 let logger = DummyLogger {};
6049 let network_graph = read_network_graph(&logger);
6050 let params = ProbabilisticScoringParameters::default();
6051 let scorer = ProbabilisticScorer::new(params, &network_graph, &logger);
6052 generate_routes(bench, &network_graph, scorer, InvoiceFeatures::empty());
6056 fn generate_mpp_routes_with_probabilistic_scorer(bench: &mut Bencher) {
6057 let logger = DummyLogger {};
6058 let network_graph = read_network_graph(&logger);
6059 let params = ProbabilisticScoringParameters::default();
6060 let scorer = ProbabilisticScorer::new(params, &network_graph, &logger);
6061 generate_routes(bench, &network_graph, scorer, InvoiceFeatures::known());
6064 fn generate_routes<S: Score>(
6065 bench: &mut Bencher, graph: &NetworkGraph<&DummyLogger>, mut scorer: S,
6066 features: InvoiceFeatures
6068 let nodes = graph.read_only().nodes().clone();
6069 let payer = payer_pubkey();
6070 let keys_manager = KeysManager::new(&[0u8; 32], 42, 42);
6071 let random_seed_bytes = keys_manager.get_secure_random_bytes();
6073 // First, get 100 (source, destination) pairs for which route-getting actually succeeds...
6074 let mut routes = Vec::new();
6075 let mut route_endpoints = Vec::new();
6076 let mut seed: usize = 0xdeadbeef;
6077 'load_endpoints: for _ in 0..150 {
6080 let src = PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap();
6082 let dst = PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap();
6083 let params = PaymentParameters::from_node_id(dst).with_features(features.clone());
6084 let first_hop = first_hop(src);
6085 let amt = seed as u64 % 1_000_000;
6086 if let Ok(route) = get_route(&payer, ¶ms, &graph.read_only(), Some(&[&first_hop]), amt, 42, &DummyLogger{}, &scorer, &random_seed_bytes) {
6088 route_endpoints.push((first_hop, params, amt));
6089 continue 'load_endpoints;
6094 // ...and seed the scorer with success and failure data...
6095 for route in routes {
6096 let amount = route.get_total_amount();
6097 if amount < 250_000 {
6098 for path in route.paths {
6099 scorer.payment_path_successful(&path.iter().collect::<Vec<_>>());
6101 } else if amount > 750_000 {
6102 for path in route.paths {
6103 let short_channel_id = path[path.len() / 2].short_channel_id;
6104 scorer.payment_path_failed(&path.iter().collect::<Vec<_>>(), short_channel_id);
6109 // Because we've changed channel scores, its possible we'll take different routes to the
6110 // selected destinations, possibly causing us to fail because, eg, the newly-selected path
6111 // requires a too-high CLTV delta.
6112 route_endpoints.retain(|(first_hop, params, amt)| {
6113 get_route(&payer, params, &graph.read_only(), Some(&[first_hop]), *amt, 42, &DummyLogger{}, &scorer, &random_seed_bytes).is_ok()
6115 route_endpoints.truncate(100);
6116 assert_eq!(route_endpoints.len(), 100);
6118 // ...then benchmark finding paths between the nodes we learned.
6121 let (first_hop, params, amt) = &route_endpoints[idx % route_endpoints.len()];
6122 assert!(get_route(&payer, params, &graph.read_only(), Some(&[first_hop]), *amt, 42, &DummyLogger{}, &scorer, &random_seed_bytes).is_ok());