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 NetGraphMsgHandler and use that as your RoutingMessageHandler and then
13 //! interrogate it to get routes for your own payments.
15 use bitcoin::secp256k1::key::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::network_graph::{NetworkGraph, RoutingFees};
21 use util::ser::{Writeable, Readable};
22 use util::logger::Logger;
25 use std::collections::{HashMap, BinaryHeap};
29 #[derive(Clone, PartialEq)]
31 /// The node_id of the node at this hop.
32 pub pubkey: PublicKey,
33 /// The node_announcement features of the node at this hop. For the last hop, these may be
34 /// amended to match the features present in the invoice this node generated.
35 pub node_features: NodeFeatures,
36 /// The channel that should be used from the previous hop to reach this node.
37 pub short_channel_id: u64,
38 /// The channel_announcement features of the channel that should be used from the previous hop
39 /// to reach this node.
40 pub channel_features: ChannelFeatures,
41 /// The fee taken on this hop (for paying for the use of the *next* channel in the path).
42 /// For the last hop, this should be the full value of the payment (might be more than
43 /// requested if we had to match htlc_minimum_msat).
45 /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
46 /// expected at the destination, in excess of the current block height.
47 pub cltv_expiry_delta: u32,
51 impl Writeable for Vec<RouteHop> {
52 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
53 (self.len() as u8).write(writer)?;
54 for hop in self.iter() {
55 hop.pubkey.write(writer)?;
56 hop.node_features.write(writer)?;
57 hop.short_channel_id.write(writer)?;
58 hop.channel_features.write(writer)?;
59 hop.fee_msat.write(writer)?;
60 hop.cltv_expiry_delta.write(writer)?;
67 impl Readable for Vec<RouteHop> {
68 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Vec<RouteHop>, DecodeError> {
69 let hops_count: u8 = Readable::read(reader)?;
70 let mut hops = Vec::with_capacity(hops_count as usize);
71 for _ in 0..hops_count {
73 pubkey: Readable::read(reader)?,
74 node_features: Readable::read(reader)?,
75 short_channel_id: Readable::read(reader)?,
76 channel_features: Readable::read(reader)?,
77 fee_msat: Readable::read(reader)?,
78 cltv_expiry_delta: Readable::read(reader)?,
85 /// A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
86 /// it can take multiple paths. Each path is composed of one or more hops through the network.
87 #[derive(Clone, PartialEq)]
89 /// The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
90 /// last RouteHop in each path must be the same.
91 /// Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
92 /// destination. Thus, this must always be at least length one. While the maximum length of any
93 /// given path is variable, keeping the length of any path to less than 20 should currently
94 /// ensure it is viable.
95 pub paths: Vec<Vec<RouteHop>>,
98 impl Writeable for Route {
99 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
100 (self.paths.len() as u64).write(writer)?;
101 for hops in self.paths.iter() {
108 impl Readable for Route {
109 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Route, DecodeError> {
110 let path_count: u64 = Readable::read(reader)?;
111 let mut paths = Vec::with_capacity(cmp::min(path_count, 128) as usize);
112 for _ in 0..path_count {
113 paths.push(Readable::read(reader)?);
119 /// A channel descriptor which provides a last-hop route to get_route
121 pub struct RouteHint {
122 /// The node_id of the non-target end of the route
123 pub src_node_id: PublicKey,
124 /// The short_channel_id of this channel
125 pub short_channel_id: u64,
126 /// The fees which must be paid to use this channel
127 pub fees: RoutingFees,
128 /// The difference in CLTV values between this node and the next node.
129 pub cltv_expiry_delta: u16,
130 /// The minimum value, in msat, which must be relayed to the next hop.
131 pub htlc_minimum_msat: Option<u64>,
132 /// The maximum value in msat available for routing with a single HTLC.
133 pub htlc_maximum_msat: Option<u64>,
136 #[derive(Eq, PartialEq)]
137 struct RouteGraphNode {
139 lowest_fee_to_peer_through_node: u64,
140 lowest_fee_to_node: u64,
141 // The maximum value a yet-to-be-constructed payment path might flow through this node.
142 // This value is upper-bounded by us by:
143 // - how much is needed for a path being constructed
144 // - how much value can channels following this node (up to the destination) can contribute,
145 // considering their capacity and fees
146 value_contribution_msat: u64,
147 /// The effective htlc_minimum_msat at this hop. If a later hop on the path had a higher HTLC
148 /// minimum, we use it, plus the fees required at each earlier hop to meet it.
149 path_htlc_minimum_msat: u64,
152 impl cmp::Ord for RouteGraphNode {
153 fn cmp(&self, other: &RouteGraphNode) -> cmp::Ordering {
154 let other_score = cmp::max(other.lowest_fee_to_peer_through_node, other.path_htlc_minimum_msat);
155 let self_score = cmp::max(self.lowest_fee_to_peer_through_node, self.path_htlc_minimum_msat);
156 other_score.cmp(&self_score).then_with(|| other.pubkey.serialize().cmp(&self.pubkey.serialize()))
160 impl cmp::PartialOrd for RouteGraphNode {
161 fn partial_cmp(&self, other: &RouteGraphNode) -> Option<cmp::Ordering> {
162 Some(self.cmp(other))
166 struct DummyDirectionalChannelInfo {
167 cltv_expiry_delta: u32,
168 htlc_minimum_msat: u64,
169 htlc_maximum_msat: Option<u64>,
173 /// It's useful to keep track of the hops associated with the fees required to use them,
174 /// so that we can choose cheaper paths (as per Dijkstra's algorithm).
175 /// Fee values should be updated only in the context of the whole path, see update_value_and_recompute_fees.
176 /// These fee values are useful to choose hops as we traverse the graph "payee-to-payer".
178 struct PathBuildingHop {
179 /// Hop-specific details unrelated to the path during the routing phase,
180 /// but rather relevant to the LN graph.
182 /// Minimal fees required to route to the source node of the current hop via any of its inbound channels.
183 src_lowest_inbound_fees: RoutingFees,
184 /// Fees of the channel used in this hop.
185 channel_fees: RoutingFees,
186 /// All the fees paid *after* this channel on the way to the destination
187 next_hops_fee_msat: u64,
188 /// Fee paid for the use of the current channel (see channel_fees).
189 /// The value will be actually deducted from the counterparty balance on the previous link.
190 hop_use_fee_msat: u64,
191 /// Used to compare channels when choosing the for routing.
192 /// Includes paying for the use of a hop and the following hops, as well as
193 /// an estimated cost of reaching this hop.
194 /// Might get stale when fees are recomputed. Primarily for internal use.
196 /// This is useful for update_value_and_recompute_fees to make sure
197 /// we don't fall below the minimum. Should not be updated manually and
198 /// generally should not be accessed.
199 htlc_minimum_msat: u64,
200 /// A mirror of the same field in RouteGraphNode. Note that this is only used during the graph
201 /// walk and may be invalid thereafter.
202 path_htlc_minimum_msat: u64,
205 // Instantiated with a list of hops with correct data in them collected during path finding,
206 // an instance of this struct should be further modified only via given methods.
209 hops: Vec<PathBuildingHop>,
214 // TODO: Add a value_msat field to PaymentPath and use it instead of this function.
215 fn get_value_msat(&self) -> u64 {
216 self.hops.last().unwrap().route_hop.fee_msat
219 fn get_total_fee_paid_msat(&self) -> u64 {
220 if self.hops.len() < 1 {
224 // Can't use next_hops_fee_msat because it gets outdated.
225 for (i, hop) in self.hops.iter().enumerate() {
226 if i != self.hops.len() - 1 {
227 result += hop.route_hop.fee_msat;
233 // If the amount transferred by the path is updated, the fees should be adjusted. Any other way
234 // to change fees may result in an inconsistency.
236 // Sometimes we call this function right after constructing a path which has inconsistent
237 // (in terms of reaching htlc_minimum_msat), so that this function puts the fees in order.
238 // In that case we call it on the "same" amount we initially allocated for this path, and which
239 // could have been reduced on the way. In that case, there is also a risk of exceeding
240 // available_liquidity inside this function, because the function is unaware of this bound.
241 // In our specific recomputation cases where we never increase the value the risk is pretty low.
242 // This function, however, does not support arbitrarily increasing the value being transferred,
243 // and the exception will be triggered.
244 fn update_value_and_recompute_fees(&mut self, value_msat: u64) {
245 assert!(value_msat <= self.hops.last().unwrap().route_hop.fee_msat);
247 let mut total_fee_paid_msat = 0 as u64;
248 for i in (0..self.hops.len()).rev() {
249 let last_hop = i == self.hops.len() - 1;
251 // For non-last-hop, this value will represent the fees paid on the current hop. It
252 // will consist of the fees for the use of the next hop, and extra fees to match
253 // htlc_minimum_msat of the current channel. Last hop is handled separately.
254 let mut cur_hop_fees_msat = 0;
256 cur_hop_fees_msat = self.hops.get(i + 1).unwrap().hop_use_fee_msat;
259 let mut cur_hop = self.hops.get_mut(i).unwrap();
260 cur_hop.next_hops_fee_msat = total_fee_paid_msat;
261 // Overpay in fees if we can't save these funds due to htlc_minimum_msat.
262 // We try to account for htlc_minimum_msat in scoring (add_entry!), so that nodes don't
263 // set it too high just to maliciously take more fees by exploiting this
264 // match htlc_minimum_msat logic.
265 let mut cur_hop_transferred_amount_msat = total_fee_paid_msat + value_msat;
266 if let Some(extra_fees_msat) = cur_hop.htlc_minimum_msat.checked_sub(cur_hop_transferred_amount_msat) {
267 // Note that there is a risk that *previous hops* (those closer to us, as we go
268 // payee->our_node here) would exceed their htlc_maximum_msat or available balance.
270 // This might make us end up with a broken route, although this should be super-rare
271 // in practice, both because of how healthy channels look like, and how we pick
272 // channels in add_entry.
273 // Also, this can't be exploited more heavily than *announce a free path and fail
275 cur_hop_transferred_amount_msat += extra_fees_msat;
276 total_fee_paid_msat += extra_fees_msat;
277 cur_hop_fees_msat += extra_fees_msat;
281 // Final hop is a special case: it usually has just value_msat (by design), but also
282 // it still could overpay for the htlc_minimum_msat.
283 cur_hop.route_hop.fee_msat = cur_hop_transferred_amount_msat;
285 // Propagate updated fees for the use of the channels to one hop back, where they
286 // will be actually paid (fee_msat). The last hop is handled above separately.
287 cur_hop.route_hop.fee_msat = cur_hop_fees_msat;
290 // Fee for the use of the current hop which will be deducted on the previous hop.
291 // Irrelevant for the first hop, as it doesn't have the previous hop, and the use of
292 // this channel is free for us.
294 if let Some(new_fee) = compute_fees(cur_hop_transferred_amount_msat, cur_hop.channel_fees) {
295 cur_hop.hop_use_fee_msat = new_fee;
296 total_fee_paid_msat += new_fee;
298 // It should not be possible because this function is called only to reduce the
299 // value. In that case, compute_fee was already called with the same fees for
300 // larger amount and there was no overflow.
308 fn compute_fees(amount_msat: u64, channel_fees: RoutingFees) -> Option<u64> {
309 let proportional_fee_millions =
310 amount_msat.checked_mul(channel_fees.proportional_millionths as u64);
311 if let Some(new_fee) = proportional_fee_millions.and_then(|part| {
312 (channel_fees.base_msat as u64).checked_add(part / 1_000_000) }) {
316 // This function may be (indirectly) called without any verification,
317 // with channel_fees provided by a caller. We should handle it gracefully.
322 /// Gets a route from us (payer) to the given target node (payee).
324 /// If the payee provided features in their invoice, they should be provided via payee_features.
325 /// Without this, MPP will only be used if the payee's features are available in the network graph.
327 /// Extra routing hops between known nodes and the target will be used if they are included in
330 /// If some channels aren't announced, it may be useful to fill in a first_hops with the
331 /// results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
332 /// view of our local channels (from net_graph_msg_handler) will be ignored, and only those
333 /// in first_hops will be used.
335 /// Panics if first_hops contains channels without short_channel_ids
336 /// (ChannelManager::list_usable_channels will never include such channels).
338 /// The fees on channels from us to next-hops are ignored (as they are assumed to all be
339 /// equal), however the enabled/disabled bit on such channels as well as the
340 /// htlc_minimum_msat/htlc_maximum_msat *are* checked as they may change based on the receiving node.
341 pub fn get_route<L: Deref>(our_node_id: &PublicKey, network: &NetworkGraph, payee: &PublicKey, payee_features: Option<InvoiceFeatures>, first_hops: Option<&[&ChannelDetails]>,
342 last_hops: &[&RouteHint], final_value_msat: u64, final_cltv: u32, logger: L) -> Result<Route, LightningError> where L::Target: Logger {
343 // TODO: Obviously *only* using total fee cost sucks. We should consider weighting by
344 // uptime/success in using a node in the past.
345 if *payee == *our_node_id {
346 return Err(LightningError{err: "Cannot generate a route to ourselves".to_owned(), action: ErrorAction::IgnoreError});
349 if final_value_msat > MAX_VALUE_MSAT {
350 return Err(LightningError{err: "Cannot generate a route of more value than all existing satoshis".to_owned(), action: ErrorAction::IgnoreError});
353 if final_value_msat == 0 {
354 return Err(LightningError{err: "Cannot send a payment of 0 msat".to_owned(), action: ErrorAction::IgnoreError});
357 for last_hop in last_hops {
358 if last_hop.src_node_id == *payee {
359 return Err(LightningError{err: "Last hop cannot have a payee as a source.".to_owned(), action: ErrorAction::IgnoreError});
363 // The general routing idea is the following:
364 // 1. Fill first/last hops communicated by the caller.
365 // 2. Attempt to construct a path from payer to payee for transferring
366 // any ~sufficient (described later) value.
367 // If succeed, remember which channels were used and how much liquidity they have available,
368 // so that future paths don't rely on the same liquidity.
369 // 3. Prooceed to the next step if:
370 // - we hit the recommended target value;
371 // - OR if we could not construct a new path. Any next attempt will fail too.
372 // Otherwise, repeat step 2.
373 // 4. See if we managed to collect paths which aggregately are able to transfer target value
374 // (not recommended value). If yes, proceed. If not, fail routing.
375 // 5. Randomly combine paths into routes having enough to fulfill the payment. (TODO: knapsack)
376 // 6. Of all the found paths, select only those with the lowest total fee.
377 // 7. The last path in every selected route is likely to be more than we need.
378 // Reduce its value-to-transfer and recompute fees.
379 // 8. Choose the best route by the lowest total fee.
381 // As for the actual search algorithm,
382 // we do a payee-to-payer pseudo-Dijkstra's sorting by each node's distance from the payee
383 // plus the minimum per-HTLC fee to get from it to another node (aka "shitty pseudo-A*").
385 // We are not a faithful Dijkstra's implementation because we can change values which impact
386 // earlier nodes while processing later nodes. Specifically, if we reach a channel with a lower
387 // liquidity limit (via htlc_maximum_msat, on-chain capacity or assumed liquidity limits) then
388 // the value we are currently attempting to send over a path, we simply reduce the value being
389 // sent along the path for any hops after that channel. This may imply that later fees (which
390 // we've already tabulated) are lower because a smaller value is passing through the channels
391 // (and the proportional fee is thus lower). There isn't a trivial way to recalculate the
392 // channels which were selected earlier (and which may still be used for other paths without a
393 // lower liquidity limit), so we simply accept that some liquidity-limited paths may be
396 // One potentially problematic case for this algorithm would be if there are many
397 // liquidity-limited paths which are liquidity-limited near the destination (ie early in our
398 // graph walking), we may never find a path which is not liquidity-limited and has lower
399 // proportional fee (and only lower absolute fee when considering the ultimate value sent).
400 // Because we only consider paths with at least 5% of the total value being sent, the damage
401 // from such a case should be limited, however this could be further reduced in the future by
402 // calculating fees on the amount we wish to route over a path, ie ignoring the liquidity
403 // limits for the purposes of fee calculation.
405 // Alternatively, we could store more detailed path information in the heap (targets, below)
406 // and index the best-path map (dist, below) by node *and* HTLC limits, however that would blow
407 // up the runtime significantly both algorithmically (as we'd traverse nodes multiple times)
408 // and practically (as we would need to store dynamically-allocated path information in heap
409 // objects, increasing malloc traffic and indirect memory access significantly). Further, the
410 // results of such an algorithm would likely be biased towards lower-value paths.
412 // Further, we could return to a faithful Dijkstra's algorithm by rejecting paths with limits
413 // outside of our current search value, running a path search more times to gather candidate
414 // paths at different values. While this may be acceptable, further path searches may increase
415 // runtime for little gain. Specifically, the current algorithm rather efficiently explores the
416 // graph for candidate paths, calculating the maximum value which can realistically be sent at
417 // the same time, remaining generic across different payment values.
419 // TODO: There are a few tweaks we could do, including possibly pre-calculating more stuff
420 // to use as the A* heuristic beyond just the cost to get one node further than the current
423 let dummy_directional_info = DummyDirectionalChannelInfo { // used for first_hops routes
424 cltv_expiry_delta: 0,
425 htlc_minimum_msat: 0,
426 htlc_maximum_msat: None,
429 proportional_millionths: 0,
433 let mut targets = BinaryHeap::new(); //TODO: Do we care about switching to eg Fibbonaci heap?
434 let mut dist = HashMap::with_capacity(network.get_nodes().len());
436 // During routing, if we ignore a path due to an htlc_minimum_msat limit, we set this,
437 // indicating that we may wish to try again with a higher value, potentially paying to meet an
438 // htlc_minimum with extra fees while still finding a cheaper path.
439 let mut hit_minimum_limit;
441 // When arranging a route, we select multiple paths so that we can make a multi-path payment.
442 // We start with a path_value of the exact amount we want, and if that generates a route we may
443 // return it immediately. Otherwise, we don't stop searching for paths until we have 3x the
444 // amount we want in total across paths, selecting the best subset at the end.
445 const ROUTE_CAPACITY_PROVISION_FACTOR: u64 = 3;
446 let recommended_value_msat = final_value_msat * ROUTE_CAPACITY_PROVISION_FACTOR as u64;
447 let mut path_value_msat = final_value_msat;
449 // Allow MPP only if we have a features set from somewhere that indicates the payee supports
450 // it. If the payee supports it they're supposed to include it in the invoice, so that should
452 let allow_mpp = if let Some(features) = &payee_features {
453 features.supports_basic_mpp()
454 } else if let Some(node) = network.get_nodes().get(&payee) {
455 if let Some(node_info) = node.announcement_info.as_ref() {
456 node_info.features.supports_basic_mpp()
461 // Prepare the data we'll use for payee-to-payer search by
462 // inserting first hops suggested by the caller as targets.
463 // Our search will then attempt to reach them while traversing from the payee node.
464 let mut first_hop_targets = HashMap::with_capacity(if first_hops.is_some() { first_hops.as_ref().unwrap().len() } else { 0 });
465 if let Some(hops) = first_hops {
467 let short_channel_id = chan.short_channel_id.expect("first_hops should be filled in with usable channels, not pending ones");
468 if chan.remote_network_id == *our_node_id {
469 return Err(LightningError{err: "First hop cannot have our_node_id as a destination.".to_owned(), action: ErrorAction::IgnoreError});
471 first_hop_targets.insert(chan.remote_network_id, (short_channel_id, chan.counterparty_features.clone(), chan.outbound_capacity_msat));
473 if first_hop_targets.is_empty() {
474 return Err(LightningError{err: "Cannot route when there are no outbound routes away from us".to_owned(), action: ErrorAction::IgnoreError});
478 // We don't want multiple paths (as per MPP) share liquidity of the same channels.
479 // This map allows paths to be aware of the channel use by other paths in the same call.
480 // This would help to make a better path finding decisions and not "overbook" channels.
481 // It is unaware of the directions (except for `outbound_capacity_msat` in `first_hops`).
482 let mut bookkeeped_channels_liquidity_available_msat = HashMap::new();
484 // Keeping track of how much value we already collected across other paths. Helps to decide:
485 // - how much a new path should be transferring (upper bound);
486 // - whether a channel should be disregarded because
487 // it's available liquidity is too small comparing to how much more we need to collect;
488 // - when we want to stop looking for new paths.
489 let mut already_collected_value_msat = 0;
491 macro_rules! add_entry {
492 // Adds entry which goes from $src_node_id to $dest_node_id
493 // over the channel with id $chan_id with fees described in
494 // $directional_info.
495 // $next_hops_fee_msat represents the fees paid for using all the channel *after* this one,
496 // since that value has to be transferred over this channel.
497 ( $chan_id: expr, $src_node_id: expr, $dest_node_id: expr, $directional_info: expr, $capacity_sats: expr, $chan_features: expr, $next_hops_fee_msat: expr,
498 $next_hops_value_contribution: expr, $next_hops_path_htlc_minimum_msat: expr ) => {
499 // Channels to self should not be used. This is more of belt-and-suspenders, because in
500 // practice these cases should be caught earlier:
501 // - for regular channels at channel announcement (TODO)
502 // - for first and last hops early in get_route
503 if $src_node_id != $dest_node_id.clone() {
504 let available_liquidity_msat = bookkeeped_channels_liquidity_available_msat.entry($chan_id.clone()).or_insert_with(|| {
505 let mut initial_liquidity_available_msat = None;
506 if let Some(capacity_sats) = $capacity_sats {
507 initial_liquidity_available_msat = Some(capacity_sats * 1000);
510 if let Some(htlc_maximum_msat) = $directional_info.htlc_maximum_msat {
511 if let Some(available_msat) = initial_liquidity_available_msat {
512 initial_liquidity_available_msat = Some(cmp::min(available_msat, htlc_maximum_msat));
514 initial_liquidity_available_msat = Some(htlc_maximum_msat);
518 match initial_liquidity_available_msat {
519 Some(available_msat) => available_msat,
520 // We assume channels with unknown balance have
521 // a capacity of 0.0025 BTC (or 250_000 sats).
522 None => 250_000 * 1000
526 // It is tricky to substract $next_hops_fee_msat from available liquidity here.
527 // It may be misleading because we might later choose to reduce the value transferred
528 // over these channels, and the channel which was insufficient might become sufficient.
529 // Worst case: we drop a good channel here because it can't cover the high following
530 // fees caused by one expensive channel, but then this channel could have been used
531 // if the amount being transferred over this path is lower.
532 // We do this for now, but this is a subject for removal.
533 if let Some(available_value_contribution_msat) = available_liquidity_msat.checked_sub($next_hops_fee_msat) {
535 // Routing Fragmentation Mitigation heuristic:
537 // Routing fragmentation across many payment paths increases the overall routing
538 // fees as you have irreducible routing fees per-link used (`fee_base_msat`).
539 // Taking too many smaller paths also increases the chance of payment failure.
540 // Thus to avoid this effect, we require from our collected links to provide
541 // at least a minimal contribution to the recommended value yet-to-be-fulfilled.
543 // This requirement is currently 5% of the remaining-to-be-collected value.
544 // This means as we successfully advance in our collection,
545 // the absolute liquidity contribution is lowered,
546 // thus increasing the number of potential channels to be selected.
548 // Derive the minimal liquidity contribution with a ratio of 20 (5%, rounded up)
549 // or 100% if we're not allowed to do multipath payments.
550 let minimal_value_contribution_msat: u64 = if allow_mpp {
551 (recommended_value_msat - already_collected_value_msat + 19) / 20
555 // Verify the liquidity offered by this channel complies to the minimal contribution.
556 let contributes_sufficient_value = available_value_contribution_msat >= minimal_value_contribution_msat;
558 let value_contribution_msat = cmp::min(available_value_contribution_msat, $next_hops_value_contribution);
559 // Includes paying fees for the use of the following channels.
560 let amount_to_transfer_over_msat: u64 = match value_contribution_msat.checked_add($next_hops_fee_msat) {
561 Some(result) => result,
562 // Can't overflow due to how the values were computed right above.
563 None => unreachable!(),
565 #[allow(unused_comparisons)] // $next_hops_path_htlc_minimum_msat is 0 in some calls so rustc complains
566 let over_path_minimum_msat = amount_to_transfer_over_msat >= $directional_info.htlc_minimum_msat &&
567 amount_to_transfer_over_msat >= $next_hops_path_htlc_minimum_msat;
569 // If HTLC minimum is larger than the amount we're going to transfer, we shouldn't
570 // bother considering this channel.
571 // Since we're choosing amount_to_transfer_over_msat as maximum possible, it can
572 // be only reduced later (not increased), so this channel should just be skipped
573 // as not sufficient.
574 if !over_path_minimum_msat {
575 hit_minimum_limit = true;
576 } else if contributes_sufficient_value {
577 // Note that low contribution here (limited by available_liquidity_msat)
578 // might violate htlc_minimum_msat on the hops which are next along the
579 // payment path (upstream to the payee). To avoid that, we recompute path
580 // path fees knowing the final path contribution after constructing it.
581 let path_htlc_minimum_msat = match compute_fees($next_hops_path_htlc_minimum_msat, $directional_info.fees)
582 .map(|fee_msat| fee_msat.checked_add($next_hops_path_htlc_minimum_msat)) {
583 Some(Some(value_msat)) => cmp::max(value_msat, $directional_info.htlc_minimum_msat),
584 _ => u64::max_value()
586 let hm_entry = dist.entry(&$src_node_id);
587 let old_entry = hm_entry.or_insert_with(|| {
588 // If there was previously no known way to access
589 // the source node (recall it goes payee-to-payer) of $chan_id, first add
590 // a semi-dummy record just to compute the fees to reach the source node.
591 // This will affect our decision on selecting $chan_id
592 // as a way to reach the $dest_node_id.
593 let mut fee_base_msat = u32::max_value();
594 let mut fee_proportional_millionths = u32::max_value();
595 if let Some(Some(fees)) = network.get_nodes().get(&$src_node_id).map(|node| node.lowest_inbound_channel_fees) {
596 fee_base_msat = fees.base_msat;
597 fee_proportional_millionths = fees.proportional_millionths;
600 route_hop: RouteHop {
601 pubkey: $dest_node_id.clone(),
602 node_features: NodeFeatures::empty(),
604 channel_features: $chan_features.clone(),
606 cltv_expiry_delta: 0,
608 src_lowest_inbound_fees: RoutingFees {
609 base_msat: fee_base_msat,
610 proportional_millionths: fee_proportional_millionths,
612 channel_fees: $directional_info.fees,
613 next_hops_fee_msat: u64::max_value(),
614 hop_use_fee_msat: u64::max_value(),
615 total_fee_msat: u64::max_value(),
616 htlc_minimum_msat: $directional_info.htlc_minimum_msat,
617 path_htlc_minimum_msat,
621 let mut hop_use_fee_msat = 0;
622 let mut total_fee_msat = $next_hops_fee_msat;
624 // Ignore hop_use_fee_msat for channel-from-us as we assume all channels-from-us
625 // will have the same effective-fee
626 if $src_node_id != *our_node_id {
627 match compute_fees(amount_to_transfer_over_msat, $directional_info.fees) {
628 // max_value means we'll always fail
629 // the old_entry.total_fee_msat > total_fee_msat check
630 None => total_fee_msat = u64::max_value(),
632 hop_use_fee_msat = fee_msat;
633 total_fee_msat += hop_use_fee_msat;
634 // When calculating the lowest inbound fees to a node, we
635 // calculate fees here not based on the actual value we think
636 // will flow over this channel, but on the minimum value that
637 // we'll accept flowing over it. The minimum accepted value
638 // is a constant through each path collection run, ensuring
639 // consistent basis. Otherwise we may later find a
640 // different path to the source node that is more expensive,
641 // but which we consider to be cheaper because we are capacity
642 // constrained and the relative fee becomes lower.
643 match compute_fees(minimal_value_contribution_msat, old_entry.src_lowest_inbound_fees)
644 .map(|a| a.checked_add(total_fee_msat)) {
649 total_fee_msat = u64::max_value();
656 let new_graph_node = RouteGraphNode {
657 pubkey: $src_node_id,
658 lowest_fee_to_peer_through_node: total_fee_msat,
659 lowest_fee_to_node: $next_hops_fee_msat as u64 + hop_use_fee_msat,
660 value_contribution_msat: value_contribution_msat,
661 path_htlc_minimum_msat,
664 // Update the way of reaching $src_node_id with the given $chan_id (from $dest_node_id),
665 // if this way is cheaper than the already known
666 // (considering the cost to "reach" this channel from the route destination,
667 // the cost of using this channel,
668 // and the cost of routing to the source node of this channel).
669 // Also, consider that htlc_minimum_msat_difference, because we might end up
670 // paying it. Consider the following exploit:
671 // we use 2 paths to transfer 1.5 BTC. One of them is 0-fee normal 1 BTC path,
672 // and for the other one we picked a 1sat-fee path with htlc_minimum_msat of
673 // 1 BTC. Now, since the latter is more expensive, we gonna try to cut it
674 // by 0.5 BTC, but then match htlc_minimum_msat by paying a fee of 0.5 BTC
676 // Ideally the scoring could be smarter (e.g. 0.5*htlc_minimum_msat here),
677 // but it may require additional tracking - we don't want to double-count
678 // the fees included in $next_hops_path_htlc_minimum_msat, but also
679 // can't use something that may decrease on future hops.
680 let old_cost = cmp::max(old_entry.total_fee_msat, old_entry.path_htlc_minimum_msat);
681 let new_cost = cmp::max(total_fee_msat, path_htlc_minimum_msat);
683 if new_cost < old_cost {
684 targets.push(new_graph_node);
685 old_entry.next_hops_fee_msat = $next_hops_fee_msat;
686 old_entry.hop_use_fee_msat = hop_use_fee_msat;
687 old_entry.total_fee_msat = total_fee_msat;
688 old_entry.route_hop = RouteHop {
689 pubkey: $dest_node_id.clone(),
690 node_features: NodeFeatures::empty(),
691 short_channel_id: $chan_id.clone(),
692 channel_features: $chan_features.clone(),
693 fee_msat: 0, // This value will be later filled with hop_use_fee_msat of the following channel
694 cltv_expiry_delta: $directional_info.cltv_expiry_delta as u32,
696 old_entry.channel_fees = $directional_info.fees;
697 old_entry.htlc_minimum_msat = $directional_info.htlc_minimum_msat;
698 old_entry.path_htlc_minimum_msat = path_htlc_minimum_msat;
706 // Find ways (channels with destination) to reach a given node and store them
707 // in the corresponding data structures (routing graph etc).
708 // $fee_to_target_msat represents how much it costs to reach to this node from the payee,
709 // meaning how much will be paid in fees after this node (to the best of our knowledge).
710 // This data can later be helpful to optimize routing (pay lower fees).
711 macro_rules! add_entries_to_cheapest_to_target_node {
712 ( $node: expr, $node_id: expr, $fee_to_target_msat: expr, $next_hops_value_contribution: expr, $next_hops_path_htlc_minimum_msat: expr ) => {
713 if first_hops.is_some() {
714 if let Some(&(ref first_hop, ref features, ref outbound_capacity_msat)) = first_hop_targets.get(&$node_id) {
715 add_entry!(first_hop, *our_node_id, $node_id, dummy_directional_info, Some(outbound_capacity_msat / 1000), features.to_context(), $fee_to_target_msat, $next_hops_value_contribution, $next_hops_path_htlc_minimum_msat);
720 if let Some(node_info) = $node.announcement_info.as_ref() {
721 features = node_info.features.clone();
723 features = NodeFeatures::empty();
726 if !features.requires_unknown_bits() {
727 for chan_id in $node.channels.iter() {
728 let chan = network.get_channels().get(chan_id).unwrap();
729 if !chan.features.requires_unknown_bits() {
730 if chan.node_one == *$node_id {
731 // ie $node is one, ie next hop in A* is two, via the two_to_one channel
732 if first_hops.is_none() || chan.node_two != *our_node_id {
733 if let Some(two_to_one) = chan.two_to_one.as_ref() {
734 if two_to_one.enabled {
735 add_entry!(chan_id, chan.node_two, chan.node_one, two_to_one, chan.capacity_sats, chan.features, $fee_to_target_msat, $next_hops_value_contribution, $next_hops_path_htlc_minimum_msat);
740 if first_hops.is_none() || chan.node_one != *our_node_id {
741 if let Some(one_to_two) = chan.one_to_two.as_ref() {
742 if one_to_two.enabled {
743 add_entry!(chan_id, chan.node_one, chan.node_two, one_to_two, chan.capacity_sats, chan.features, $fee_to_target_msat, $next_hops_value_contribution, $next_hops_path_htlc_minimum_msat);
755 let mut payment_paths = Vec::<PaymentPath>::new();
757 // TODO: diversify by nodes (so that all paths aren't doomed if one node is offline).
758 'paths_collection: loop {
759 // For every new path, start from scratch, except
760 // bookkeeped_channels_liquidity_available_msat, which will improve
761 // the further iterations of path finding. Also don't erase first_hop_targets.
764 hit_minimum_limit = false;
766 // If first hop is a private channel and the only way to reach the payee, this is the only
767 // place where it could be added.
768 if first_hops.is_some() {
769 if let Some(&(ref first_hop, ref features, ref outbound_capacity_msat)) = first_hop_targets.get(&payee) {
770 add_entry!(first_hop, *our_node_id, payee, dummy_directional_info, Some(outbound_capacity_msat / 1000), features.to_context(), 0, path_value_msat, 0);
774 // Add the payee as a target, so that the payee-to-payer
775 // search algorithm knows what to start with.
776 match network.get_nodes().get(payee) {
777 // The payee is not in our network graph, so nothing to add here.
778 // There is still a chance of reaching them via last_hops though,
779 // so don't yet fail the payment here.
780 // If not, targets.pop() will not even let us enter the loop in step 2.
783 add_entries_to_cheapest_to_target_node!(node, payee, 0, path_value_msat, 0);
788 // If a caller provided us with last hops, add them to routing targets. Since this happens
789 // earlier than general path finding, they will be somewhat prioritized, although currently
790 // it matters only if the fees are exactly the same.
791 for hop in last_hops.iter() {
792 let have_hop_src_in_graph =
793 if let Some(&(ref first_hop, ref features, ref outbound_capacity_msat)) = first_hop_targets.get(&hop.src_node_id) {
794 // If this hop connects to a node with which we have a direct channel, ignore
795 // the network graph and add both the hop and our direct channel to
796 // the candidate set.
798 // Currently there are no channel-context features defined, so we are a
799 // bit lazy here. In the future, we should pull them out via our
800 // ChannelManager, but there's no reason to waste the space until we
802 add_entry!(first_hop, *our_node_id , hop.src_node_id, dummy_directional_info, Some(outbound_capacity_msat / 1000), features.to_context(), 0, path_value_msat, 0);
805 // In any other case, only add the hop if the source is in the regular network
807 network.get_nodes().get(&hop.src_node_id).is_some()
809 if have_hop_src_in_graph {
810 // BOLT 11 doesn't allow inclusion of features for the last hop hints, which
811 // really sucks, cause we're gonna need that eventually.
812 let last_hop_htlc_minimum_msat: u64 = match hop.htlc_minimum_msat {
813 Some(htlc_minimum_msat) => htlc_minimum_msat,
816 let directional_info = DummyDirectionalChannelInfo {
817 cltv_expiry_delta: hop.cltv_expiry_delta as u32,
818 htlc_minimum_msat: last_hop_htlc_minimum_msat,
819 htlc_maximum_msat: hop.htlc_maximum_msat,
822 add_entry!(hop.short_channel_id, hop.src_node_id, payee, directional_info, None::<u64>, ChannelFeatures::empty(), 0, path_value_msat, 0);
826 // At this point, targets are filled with the data from first and
827 // last hops communicated by the caller, and the payment receiver.
828 let mut found_new_path = false;
831 // If this loop terminates due the exhaustion of targets, two situations are possible:
832 // - not enough outgoing liquidity:
833 // 0 < already_collected_value_msat < final_value_msat
834 // - enough outgoing liquidity:
835 // final_value_msat <= already_collected_value_msat < recommended_value_msat
836 // Both these cases (and other cases except reaching recommended_value_msat) mean that
837 // paths_collection will be stopped because found_new_path==false.
838 // This is not necessarily a routing failure.
839 'path_construction: while let Some(RouteGraphNode { pubkey, lowest_fee_to_node, value_contribution_msat, path_htlc_minimum_msat, .. }) = targets.pop() {
841 // Since we're going payee-to-payer, hitting our node as a target means we should stop
842 // traversing the graph and arrange the path out of what we found.
843 if pubkey == *our_node_id {
844 let mut new_entry = dist.remove(&our_node_id).unwrap();
845 let mut ordered_hops = vec!(new_entry.clone());
848 if let Some(&(_, ref features, _)) = first_hop_targets.get(&ordered_hops.last().unwrap().route_hop.pubkey) {
849 ordered_hops.last_mut().unwrap().route_hop.node_features = features.to_context();
850 } else if let Some(node) = network.get_nodes().get(&ordered_hops.last().unwrap().route_hop.pubkey) {
851 if let Some(node_info) = node.announcement_info.as_ref() {
852 ordered_hops.last_mut().unwrap().route_hop.node_features = node_info.features.clone();
854 ordered_hops.last_mut().unwrap().route_hop.node_features = NodeFeatures::empty();
857 // We should be able to fill in features for everything except the last
858 // hop, if the last hop was provided via a BOLT 11 invoice (though we
859 // should be able to extend it further as BOLT 11 does have feature
860 // flags for the last hop node itself).
861 assert!(ordered_hops.last().unwrap().route_hop.pubkey == *payee);
864 // Means we succesfully traversed from the payer to the payee, now
865 // save this path for the payment route. Also, update the liquidity
866 // remaining on the used hops, so that we take them into account
867 // while looking for more paths.
868 if ordered_hops.last().unwrap().route_hop.pubkey == *payee {
872 new_entry = match dist.remove(&ordered_hops.last().unwrap().route_hop.pubkey) {
873 Some(payment_hop) => payment_hop,
874 // We can't arrive at None because, if we ever add an entry to targets,
875 // we also fill in the entry in dist (see add_entry!).
876 None => unreachable!(),
878 // We "propagate" the fees one hop backward (topologically) here,
879 // so that fees paid for a HTLC forwarding on the current channel are
880 // associated with the previous channel (where they will be subtracted).
881 ordered_hops.last_mut().unwrap().route_hop.fee_msat = new_entry.hop_use_fee_msat;
882 ordered_hops.last_mut().unwrap().route_hop.cltv_expiry_delta = new_entry.route_hop.cltv_expiry_delta;
883 ordered_hops.push(new_entry.clone());
885 ordered_hops.last_mut().unwrap().route_hop.fee_msat = value_contribution_msat;
886 ordered_hops.last_mut().unwrap().hop_use_fee_msat = 0;
887 ordered_hops.last_mut().unwrap().route_hop.cltv_expiry_delta = final_cltv;
889 let mut payment_path = PaymentPath {hops: ordered_hops};
891 // We could have possibly constructed a slightly inconsistent path: since we reduce
892 // value being transferred along the way, we could have violated htlc_minimum_msat
893 // on some channels we already passed (assuming dest->source direction). Here, we
894 // recompute the fees again, so that if that's the case, we match the currently
895 // underpaid htlc_minimum_msat with fees.
896 payment_path.update_value_and_recompute_fees(cmp::min(value_contribution_msat, final_value_msat));
898 // Since a path allows to transfer as much value as
899 // the smallest channel it has ("bottleneck"), we should recompute
900 // the fees so sender HTLC don't overpay fees when traversing
901 // larger channels than the bottleneck. This may happen because
902 // when we were selecting those channels we were not aware how much value
903 // this path will transfer, and the relative fee for them
904 // might have been computed considering a larger value.
905 // Remember that we used these channels so that we don't rely
906 // on the same liquidity in future paths.
907 let mut prevented_redundant_path_selection = false;
908 for payment_hop in payment_path.hops.iter() {
909 let channel_liquidity_available_msat = bookkeeped_channels_liquidity_available_msat.get_mut(&payment_hop.route_hop.short_channel_id).unwrap();
910 let mut spent_on_hop_msat = value_contribution_msat;
911 let next_hops_fee_msat = payment_hop.next_hops_fee_msat;
912 spent_on_hop_msat += next_hops_fee_msat;
913 if *channel_liquidity_available_msat < spent_on_hop_msat {
914 // This should not happen because we do recompute fees right before,
915 // trying to avoid cases when a hop is not usable due to the fee situation.
916 break 'path_construction;
918 if spent_on_hop_msat == *channel_liquidity_available_msat {
919 // If this path used all of this channel's available liquidity, we know
920 // this path will not be selected again in the next loop iteration.
921 prevented_redundant_path_selection = true;
923 *channel_liquidity_available_msat -= spent_on_hop_msat;
925 if !prevented_redundant_path_selection {
926 // If we weren't capped by hitting a liquidity limit on a channel in the path,
927 // we'll probably end up picking the same path again on the next iteration.
928 // Decrease the available liquidity of a hop in the middle of the path.
929 let victim_liquidity = bookkeeped_channels_liquidity_available_msat.get_mut(
930 &payment_path.hops[(payment_path.hops.len() - 1) / 2].route_hop.short_channel_id).unwrap();
931 *victim_liquidity = 0;
934 // Track the total amount all our collected paths allow to send so that we:
935 // - know when to stop looking for more paths
936 // - know which of the hops are useless considering how much more sats we need
937 // (contributes_sufficient_value)
938 already_collected_value_msat += value_contribution_msat;
940 payment_paths.push(payment_path);
941 found_new_path = true;
942 break 'path_construction;
945 // Otherwise, since the current target node is not us,
946 // keep "unrolling" the payment graph from payee to payer by
947 // finding a way to reach the current target from the payer side.
948 match network.get_nodes().get(&pubkey) {
951 add_entries_to_cheapest_to_target_node!(node, &pubkey, lowest_fee_to_node, value_contribution_msat, path_htlc_minimum_msat);
957 // If we don't support MPP, no use trying to gather more value ever.
958 break 'paths_collection;
962 // Stop either when the recommended value is reached or if no new path was found in this
964 // In the latter case, making another path finding attempt won't help,
965 // because we deterministically terminated the search due to low liquidity.
966 if already_collected_value_msat >= recommended_value_msat || !found_new_path {
967 break 'paths_collection;
968 } else if found_new_path && already_collected_value_msat == final_value_msat && payment_paths.len() == 1 {
969 // Further, if this was our first walk of the graph, and we weren't limited by an
970 // htlc_minimum_msat, return immediately because this path should suffice. If we were
971 // limited by an htlc_minimum_msat value, find another path with a higher value,
972 // potentially allowing us to pay fees to meet the htlc_minimum on the new path while
973 // still keeping a lower total fee than this path.
974 if !hit_minimum_limit {
975 break 'paths_collection;
977 path_value_msat = recommended_value_msat;
982 if payment_paths.len() == 0 {
983 return Err(LightningError{err: "Failed to find a path to the given destination".to_owned(), action: ErrorAction::IgnoreError});
986 if already_collected_value_msat < final_value_msat {
987 return Err(LightningError{err: "Failed to find a sufficient route to the given destination".to_owned(), action: ErrorAction::IgnoreError});
990 // Sort by total fees and take the best paths.
991 payment_paths.sort_by_key(|path| path.get_total_fee_paid_msat());
992 if payment_paths.len() > 50 {
993 payment_paths.truncate(50);
996 // Draw multiple sufficient routes by randomly combining the selected paths.
997 let mut drawn_routes = Vec::new();
998 for i in 0..payment_paths.len() {
999 let mut cur_route = Vec::<PaymentPath>::new();
1000 let mut aggregate_route_value_msat = 0;
1003 // TODO: real random shuffle
1004 // Currently just starts with i_th and goes up to i-1_th in a looped way.
1005 let cur_payment_paths = [&payment_paths[i..], &payment_paths[..i]].concat();
1008 for payment_path in cur_payment_paths {
1009 cur_route.push(payment_path.clone());
1010 aggregate_route_value_msat += payment_path.get_value_msat();
1011 if aggregate_route_value_msat > final_value_msat {
1012 // Last path likely overpaid. Substract it from the most expensive
1013 // (in terms of proportional fee) path in this route and recompute fees.
1014 // This might be not the most economically efficient way, but fewer paths
1015 // also makes routing more reliable.
1016 let mut overpaid_value_msat = aggregate_route_value_msat - final_value_msat;
1018 // First, drop some expensive low-value paths entirely if possible.
1019 // Sort by value so that we drop many really-low values first, since
1020 // fewer paths is better: the payment is less likely to fail.
1021 // TODO: this could also be optimized by also sorting by feerate_per_sat_routed,
1022 // so that the sender pays less fees overall. And also htlc_minimum_msat.
1023 cur_route.sort_by_key(|path| path.get_value_msat());
1024 // We should make sure that at least 1 path left.
1025 let mut paths_left = cur_route.len();
1026 cur_route.retain(|path| {
1027 if paths_left == 1 {
1030 let mut keep = true;
1031 let path_value_msat = path.get_value_msat();
1032 if path_value_msat <= overpaid_value_msat {
1034 overpaid_value_msat -= path_value_msat;
1040 if overpaid_value_msat == 0 {
1044 assert!(cur_route.len() > 0);
1047 // Now, substract the overpaid value from the most-expensive path.
1048 // TODO: this could also be optimized by also sorting by feerate_per_sat_routed,
1049 // so that the sender pays less fees overall. And also htlc_minimum_msat.
1050 cur_route.sort_by_key(|path| { path.hops.iter().map(|hop| hop.channel_fees.proportional_millionths as u64).sum::<u64>() });
1051 let expensive_payment_path = cur_route.first_mut().unwrap();
1052 // We already dropped all the small channels above, meaning all the
1053 // remaining channels are larger than remaining overpaid_value_msat.
1054 // Thus, this can't be negative.
1055 let expensive_path_new_value_msat = expensive_payment_path.get_value_msat() - overpaid_value_msat;
1056 expensive_payment_path.update_value_and_recompute_fees(expensive_path_new_value_msat);
1060 drawn_routes.push(cur_route);
1064 // Select the best route by lowest total fee.
1065 drawn_routes.sort_by_key(|paths| paths.iter().map(|path| path.get_total_fee_paid_msat()).sum::<u64>());
1066 let mut selected_paths = Vec::<Vec<RouteHop>>::new();
1067 for payment_path in drawn_routes.first().unwrap() {
1068 selected_paths.push(payment_path.hops.iter().map(|payment_hop| payment_hop.route_hop.clone()).collect());
1071 if let Some(features) = &payee_features {
1072 for path in selected_paths.iter_mut() {
1073 path.last_mut().unwrap().node_features = features.to_context();
1077 let route = Route { paths: selected_paths };
1078 log_trace!(logger, "Got route: {}", log_route!(route));
1084 use routing::router::{get_route, RouteHint, RoutingFees};
1085 use routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
1086 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
1087 use ln::msgs::{ErrorAction, LightningError, OptionalField, UnsignedChannelAnnouncement, ChannelAnnouncement, RoutingMessageHandler,
1088 NodeAnnouncement, UnsignedNodeAnnouncement, ChannelUpdate, UnsignedChannelUpdate};
1089 use ln::channelmanager;
1090 use util::test_utils;
1091 use util::ser::Writeable;
1093 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
1094 use bitcoin::hashes::Hash;
1095 use bitcoin::network::constants::Network;
1096 use bitcoin::blockdata::constants::genesis_block;
1097 use bitcoin::blockdata::script::Builder;
1098 use bitcoin::blockdata::opcodes;
1099 use bitcoin::blockdata::transaction::TxOut;
1103 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1104 use bitcoin::secp256k1::{Secp256k1, All};
1108 // Using the same keys for LN and BTC ids
1109 fn add_channel(net_graph_msg_handler: &NetGraphMsgHandler<Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>, secp_ctx: &Secp256k1<All>, node_1_privkey: &SecretKey,
1110 node_2_privkey: &SecretKey, features: ChannelFeatures, short_channel_id: u64) {
1111 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
1112 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
1114 let unsigned_announcement = UnsignedChannelAnnouncement {
1116 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1120 bitcoin_key_1: node_id_1,
1121 bitcoin_key_2: node_id_2,
1122 excess_data: Vec::new(),
1125 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1126 let valid_announcement = ChannelAnnouncement {
1127 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
1128 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1129 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
1130 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1131 contents: unsigned_announcement.clone(),
1133 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
1134 Ok(res) => assert!(res),
1139 fn update_channel(net_graph_msg_handler: &NetGraphMsgHandler<Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>, secp_ctx: &Secp256k1<All>, node_privkey: &SecretKey, update: UnsignedChannelUpdate) {
1140 let msghash = hash_to_message!(&Sha256dHash::hash(&update.encode()[..])[..]);
1141 let valid_channel_update = ChannelUpdate {
1142 signature: secp_ctx.sign(&msghash, node_privkey),
1143 contents: update.clone()
1146 match net_graph_msg_handler.handle_channel_update(&valid_channel_update) {
1147 Ok(res) => assert!(res),
1152 fn add_or_update_node(net_graph_msg_handler: &NetGraphMsgHandler<Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>, secp_ctx: &Secp256k1<All>, node_privkey: &SecretKey,
1153 features: NodeFeatures, timestamp: u32) {
1154 let node_id = PublicKey::from_secret_key(&secp_ctx, node_privkey);
1155 let unsigned_announcement = UnsignedNodeAnnouncement {
1161 addresses: Vec::new(),
1162 excess_address_data: Vec::new(),
1163 excess_data: Vec::new(),
1165 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1166 let valid_announcement = NodeAnnouncement {
1167 signature: secp_ctx.sign(&msghash, node_privkey),
1168 contents: unsigned_announcement.clone()
1171 match net_graph_msg_handler.handle_node_announcement(&valid_announcement) {
1177 fn get_nodes(secp_ctx: &Secp256k1<All>) -> (SecretKey, PublicKey, Vec<SecretKey>, Vec<PublicKey>) {
1178 let privkeys: Vec<SecretKey> = (2..10).map(|i| {
1179 SecretKey::from_slice(&hex::decode(format!("{:02}", i).repeat(32)).unwrap()[..]).unwrap()
1182 let pubkeys = privkeys.iter().map(|secret| PublicKey::from_secret_key(&secp_ctx, secret)).collect();
1184 let our_privkey = SecretKey::from_slice(&hex::decode("01".repeat(32)).unwrap()[..]).unwrap();
1185 let our_id = PublicKey::from_secret_key(&secp_ctx, &our_privkey);
1187 (our_privkey, our_id, privkeys, pubkeys)
1190 fn id_to_feature_flags(id: u8) -> Vec<u8> {
1191 // Set the feature flags to the id'th odd (ie non-required) feature bit so that we can
1192 // test for it later.
1193 let idx = (id - 1) * 2 + 1;
1195 vec![1 << (idx - 8*3), 0, 0, 0]
1196 } else if idx > 8*2 {
1197 vec![1 << (idx - 8*2), 0, 0]
1198 } else if idx > 8*1 {
1199 vec![1 << (idx - 8*1), 0]
1205 fn build_graph() -> (Secp256k1<All>, NetGraphMsgHandler<std::sync::Arc<test_utils::TestChainSource>, std::sync::Arc<crate::util::test_utils::TestLogger>>, std::sync::Arc<test_utils::TestChainSource>, std::sync::Arc<test_utils::TestLogger>) {
1206 let secp_ctx = Secp256k1::new();
1207 let logger = Arc::new(test_utils::TestLogger::new());
1208 let chain_monitor = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
1209 let net_graph_msg_handler = NetGraphMsgHandler::new(genesis_block(Network::Testnet).header.block_hash(), None, Arc::clone(&logger));
1210 // Build network from our_id to node7:
1212 // -1(1)2- node0 -1(3)2-
1214 // our_id -1(12)2- node7 -1(13)2--- node2
1216 // -1(2)2- node1 -1(4)2-
1219 // chan1 1-to-2: disabled
1220 // chan1 2-to-1: enabled, 0 fee
1222 // chan2 1-to-2: enabled, ignored fee
1223 // chan2 2-to-1: enabled, 0 fee
1225 // chan3 1-to-2: enabled, 0 fee
1226 // chan3 2-to-1: enabled, 100 msat fee
1228 // chan4 1-to-2: enabled, 100% fee
1229 // chan4 2-to-1: enabled, 0 fee
1231 // chan12 1-to-2: enabled, ignored fee
1232 // chan12 2-to-1: enabled, 0 fee
1234 // chan13 1-to-2: enabled, 200% fee
1235 // chan13 2-to-1: enabled, 0 fee
1238 // -1(5)2- node3 -1(8)2--
1242 // node2--1(6)2- node4 -1(9)2--- node6 (not in global route map)
1244 // -1(7)2- node5 -1(10)2-
1246 // chan5 1-to-2: enabled, 100 msat fee
1247 // chan5 2-to-1: enabled, 0 fee
1249 // chan6 1-to-2: enabled, 0 fee
1250 // chan6 2-to-1: enabled, 0 fee
1252 // chan7 1-to-2: enabled, 100% fee
1253 // chan7 2-to-1: enabled, 0 fee
1255 // chan8 1-to-2: enabled, variable fee (0 then 1000 msat)
1256 // chan8 2-to-1: enabled, 0 fee
1258 // chan9 1-to-2: enabled, 1001 msat fee
1259 // chan9 2-to-1: enabled, 0 fee
1261 // chan10 1-to-2: enabled, 0 fee
1262 // chan10 2-to-1: enabled, 0 fee
1264 // chan11 1-to-2: enabled, 0 fee
1265 // chan11 2-to-1: enabled, 0 fee
1267 let (our_privkey, _, privkeys, _) = get_nodes(&secp_ctx);
1269 add_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, &privkeys[0], ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 1);
1270 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
1271 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1272 short_channel_id: 1,
1275 cltv_expiry_delta: 0,
1276 htlc_minimum_msat: 0,
1277 htlc_maximum_msat: OptionalField::Absent,
1279 fee_proportional_millionths: 0,
1280 excess_data: Vec::new()
1283 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[0], NodeFeatures::from_le_bytes(id_to_feature_flags(1)), 0);
1285 add_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, &privkeys[1], ChannelFeatures::from_le_bytes(id_to_feature_flags(2)), 2);
1286 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
1287 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1288 short_channel_id: 2,
1291 cltv_expiry_delta: u16::max_value(),
1292 htlc_minimum_msat: 0,
1293 htlc_maximum_msat: OptionalField::Absent,
1294 fee_base_msat: u32::max_value(),
1295 fee_proportional_millionths: u32::max_value(),
1296 excess_data: Vec::new()
1298 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
1299 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1300 short_channel_id: 2,
1303 cltv_expiry_delta: 0,
1304 htlc_minimum_msat: 0,
1305 htlc_maximum_msat: OptionalField::Absent,
1307 fee_proportional_millionths: 0,
1308 excess_data: Vec::new()
1311 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[1], NodeFeatures::from_le_bytes(id_to_feature_flags(2)), 0);
1313 add_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, &privkeys[7], ChannelFeatures::from_le_bytes(id_to_feature_flags(12)), 12);
1314 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
1315 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1316 short_channel_id: 12,
1319 cltv_expiry_delta: u16::max_value(),
1320 htlc_minimum_msat: 0,
1321 htlc_maximum_msat: OptionalField::Absent,
1322 fee_base_msat: u32::max_value(),
1323 fee_proportional_millionths: u32::max_value(),
1324 excess_data: Vec::new()
1326 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
1327 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1328 short_channel_id: 12,
1331 cltv_expiry_delta: 0,
1332 htlc_minimum_msat: 0,
1333 htlc_maximum_msat: OptionalField::Absent,
1335 fee_proportional_millionths: 0,
1336 excess_data: Vec::new()
1339 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[7], NodeFeatures::from_le_bytes(id_to_feature_flags(8)), 0);
1341 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(3)), 3);
1342 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
1343 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1344 short_channel_id: 3,
1347 cltv_expiry_delta: (3 << 8) | 1,
1348 htlc_minimum_msat: 0,
1349 htlc_maximum_msat: OptionalField::Absent,
1351 fee_proportional_millionths: 0,
1352 excess_data: Vec::new()
1354 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
1355 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1356 short_channel_id: 3,
1359 cltv_expiry_delta: (3 << 8) | 2,
1360 htlc_minimum_msat: 0,
1361 htlc_maximum_msat: OptionalField::Absent,
1363 fee_proportional_millionths: 0,
1364 excess_data: Vec::new()
1367 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(4)), 4);
1368 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
1369 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1370 short_channel_id: 4,
1373 cltv_expiry_delta: (4 << 8) | 1,
1374 htlc_minimum_msat: 0,
1375 htlc_maximum_msat: OptionalField::Absent,
1377 fee_proportional_millionths: 1000000,
1378 excess_data: Vec::new()
1380 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
1381 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1382 short_channel_id: 4,
1385 cltv_expiry_delta: (4 << 8) | 2,
1386 htlc_minimum_msat: 0,
1387 htlc_maximum_msat: OptionalField::Absent,
1389 fee_proportional_millionths: 0,
1390 excess_data: Vec::new()
1393 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(13)), 13);
1394 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
1395 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1396 short_channel_id: 13,
1399 cltv_expiry_delta: (13 << 8) | 1,
1400 htlc_minimum_msat: 0,
1401 htlc_maximum_msat: OptionalField::Absent,
1403 fee_proportional_millionths: 2000000,
1404 excess_data: Vec::new()
1406 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
1407 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1408 short_channel_id: 13,
1411 cltv_expiry_delta: (13 << 8) | 2,
1412 htlc_minimum_msat: 0,
1413 htlc_maximum_msat: OptionalField::Absent,
1415 fee_proportional_millionths: 0,
1416 excess_data: Vec::new()
1419 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[2], NodeFeatures::from_le_bytes(id_to_feature_flags(3)), 0);
1421 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], &privkeys[4], ChannelFeatures::from_le_bytes(id_to_feature_flags(6)), 6);
1422 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
1423 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1424 short_channel_id: 6,
1427 cltv_expiry_delta: (6 << 8) | 1,
1428 htlc_minimum_msat: 0,
1429 htlc_maximum_msat: OptionalField::Absent,
1431 fee_proportional_millionths: 0,
1432 excess_data: Vec::new()
1434 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
1435 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1436 short_channel_id: 6,
1439 cltv_expiry_delta: (6 << 8) | 2,
1440 htlc_minimum_msat: 0,
1441 htlc_maximum_msat: OptionalField::Absent,
1443 fee_proportional_millionths: 0,
1444 excess_data: Vec::new(),
1447 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(11)), 11);
1448 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
1449 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1450 short_channel_id: 11,
1453 cltv_expiry_delta: (11 << 8) | 1,
1454 htlc_minimum_msat: 0,
1455 htlc_maximum_msat: OptionalField::Absent,
1457 fee_proportional_millionths: 0,
1458 excess_data: Vec::new()
1460 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[3], UnsignedChannelUpdate {
1461 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1462 short_channel_id: 11,
1465 cltv_expiry_delta: (11 << 8) | 2,
1466 htlc_minimum_msat: 0,
1467 htlc_maximum_msat: OptionalField::Absent,
1469 fee_proportional_millionths: 0,
1470 excess_data: Vec::new()
1473 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[4], NodeFeatures::from_le_bytes(id_to_feature_flags(5)), 0);
1475 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[3], NodeFeatures::from_le_bytes(id_to_feature_flags(4)), 0);
1477 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], &privkeys[5], ChannelFeatures::from_le_bytes(id_to_feature_flags(7)), 7);
1478 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
1479 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1480 short_channel_id: 7,
1483 cltv_expiry_delta: (7 << 8) | 1,
1484 htlc_minimum_msat: 0,
1485 htlc_maximum_msat: OptionalField::Absent,
1487 fee_proportional_millionths: 1000000,
1488 excess_data: Vec::new()
1490 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[5], UnsignedChannelUpdate {
1491 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1492 short_channel_id: 7,
1495 cltv_expiry_delta: (7 << 8) | 2,
1496 htlc_minimum_msat: 0,
1497 htlc_maximum_msat: OptionalField::Absent,
1499 fee_proportional_millionths: 0,
1500 excess_data: Vec::new()
1503 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[5], NodeFeatures::from_le_bytes(id_to_feature_flags(6)), 0);
1505 (secp_ctx, net_graph_msg_handler, chain_monitor, logger)
1509 fn simple_route_test() {
1510 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
1511 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
1513 // Simple route to 2 via 1
1515 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, None, &Vec::new(), 0, 42, Arc::clone(&logger)) {
1516 assert_eq!(err, "Cannot send a payment of 0 msat");
1517 } else { panic!(); }
1519 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, None, &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
1520 assert_eq!(route.paths[0].len(), 2);
1522 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
1523 assert_eq!(route.paths[0][0].short_channel_id, 2);
1524 assert_eq!(route.paths[0][0].fee_msat, 100);
1525 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
1526 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
1527 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
1529 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
1530 assert_eq!(route.paths[0][1].short_channel_id, 4);
1531 assert_eq!(route.paths[0][1].fee_msat, 100);
1532 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
1533 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
1534 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
1538 fn invalid_first_hop_test() {
1539 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
1540 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
1542 // Simple route to 2 via 1
1544 let our_chans = vec![channelmanager::ChannelDetails {
1545 channel_id: [0; 32],
1546 short_channel_id: Some(2),
1547 remote_network_id: our_id,
1548 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
1549 channel_value_satoshis: 100000,
1551 outbound_capacity_msat: 100000,
1552 inbound_capacity_msat: 100000,
1554 counterparty_forwarding_info: None,
1557 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 100, 42, Arc::clone(&logger)) {
1558 assert_eq!(err, "First hop cannot have our_node_id as a destination.");
1559 } else { panic!(); }
1561 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, None, &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
1562 assert_eq!(route.paths[0].len(), 2);
1566 fn htlc_minimum_test() {
1567 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
1568 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
1570 // Simple route to 2 via 1
1572 // Disable other paths
1573 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
1574 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1575 short_channel_id: 12,
1577 flags: 2, // to disable
1578 cltv_expiry_delta: 0,
1579 htlc_minimum_msat: 0,
1580 htlc_maximum_msat: OptionalField::Absent,
1582 fee_proportional_millionths: 0,
1583 excess_data: Vec::new()
1585 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
1586 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1587 short_channel_id: 3,
1589 flags: 2, // to disable
1590 cltv_expiry_delta: 0,
1591 htlc_minimum_msat: 0,
1592 htlc_maximum_msat: OptionalField::Absent,
1594 fee_proportional_millionths: 0,
1595 excess_data: Vec::new()
1597 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
1598 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1599 short_channel_id: 13,
1601 flags: 2, // to disable
1602 cltv_expiry_delta: 0,
1603 htlc_minimum_msat: 0,
1604 htlc_maximum_msat: OptionalField::Absent,
1606 fee_proportional_millionths: 0,
1607 excess_data: Vec::new()
1609 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
1610 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1611 short_channel_id: 6,
1613 flags: 2, // to disable
1614 cltv_expiry_delta: 0,
1615 htlc_minimum_msat: 0,
1616 htlc_maximum_msat: OptionalField::Absent,
1618 fee_proportional_millionths: 0,
1619 excess_data: Vec::new()
1621 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
1622 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1623 short_channel_id: 7,
1625 flags: 2, // to disable
1626 cltv_expiry_delta: 0,
1627 htlc_minimum_msat: 0,
1628 htlc_maximum_msat: OptionalField::Absent,
1630 fee_proportional_millionths: 0,
1631 excess_data: Vec::new()
1634 // Check against amount_to_transfer_over_msat.
1635 // Set minimal HTLC of 200_000_000 msat.
1636 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
1637 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1638 short_channel_id: 2,
1641 cltv_expiry_delta: 0,
1642 htlc_minimum_msat: 200_000_000,
1643 htlc_maximum_msat: OptionalField::Absent,
1645 fee_proportional_millionths: 0,
1646 excess_data: Vec::new()
1649 // Second hop only allows to forward 199_999_999 at most, thus not allowing the first hop to
1651 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
1652 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1653 short_channel_id: 4,
1656 cltv_expiry_delta: 0,
1657 htlc_minimum_msat: 0,
1658 htlc_maximum_msat: OptionalField::Present(199_999_999),
1660 fee_proportional_millionths: 0,
1661 excess_data: Vec::new()
1664 // Not possible to send 199_999_999, because the minimum on channel=2 is 200_000_000.
1665 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, None, &Vec::new(), 199_999_999, 42, Arc::clone(&logger)) {
1666 assert_eq!(err, "Failed to find a path to the given destination");
1667 } else { panic!(); }
1669 // Lift the restriction on the first hop.
1670 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
1671 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1672 short_channel_id: 2,
1675 cltv_expiry_delta: 0,
1676 htlc_minimum_msat: 0,
1677 htlc_maximum_msat: OptionalField::Absent,
1679 fee_proportional_millionths: 0,
1680 excess_data: Vec::new()
1683 // A payment above the minimum should pass
1684 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, None, &Vec::new(), 199_999_999, 42, Arc::clone(&logger)).unwrap();
1685 assert_eq!(route.paths[0].len(), 2);
1689 fn htlc_minimum_overpay_test() {
1690 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
1691 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
1693 // A route to node#2 via two paths.
1694 // One path allows transferring 35-40 sats, another one also allows 35-40 sats.
1695 // Thus, they can't send 60 without overpaying.
1696 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
1697 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1698 short_channel_id: 2,
1701 cltv_expiry_delta: 0,
1702 htlc_minimum_msat: 35_000,
1703 htlc_maximum_msat: OptionalField::Present(40_000),
1705 fee_proportional_millionths: 0,
1706 excess_data: Vec::new()
1708 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
1709 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1710 short_channel_id: 12,
1713 cltv_expiry_delta: 0,
1714 htlc_minimum_msat: 35_000,
1715 htlc_maximum_msat: OptionalField::Present(40_000),
1717 fee_proportional_millionths: 0,
1718 excess_data: Vec::new()
1722 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
1723 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1724 short_channel_id: 13,
1727 cltv_expiry_delta: 0,
1728 htlc_minimum_msat: 0,
1729 htlc_maximum_msat: OptionalField::Absent,
1731 fee_proportional_millionths: 0,
1732 excess_data: Vec::new()
1734 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
1735 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1736 short_channel_id: 4,
1739 cltv_expiry_delta: 0,
1740 htlc_minimum_msat: 0,
1741 htlc_maximum_msat: OptionalField::Absent,
1743 fee_proportional_millionths: 0,
1744 excess_data: Vec::new()
1747 // Disable other paths
1748 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
1749 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1750 short_channel_id: 1,
1752 flags: 2, // to disable
1753 cltv_expiry_delta: 0,
1754 htlc_minimum_msat: 0,
1755 htlc_maximum_msat: OptionalField::Absent,
1757 fee_proportional_millionths: 0,
1758 excess_data: Vec::new()
1761 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
1762 Some(InvoiceFeatures::known()), None, &Vec::new(), 60_000, 42, Arc::clone(&logger)).unwrap();
1763 // Overpay fees to hit htlc_minimum_msat.
1764 let overpaid_fees = route.paths[0][0].fee_msat + route.paths[1][0].fee_msat;
1765 // TODO: this could be better balanced to overpay 10k and not 15k.
1766 assert_eq!(overpaid_fees, 15_000);
1768 // Now, test that if there are 2 paths, a "cheaper" by fee path wouldn't be prioritized
1769 // while taking even more fee to match htlc_minimum_msat.
1770 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
1771 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1772 short_channel_id: 12,
1775 cltv_expiry_delta: 0,
1776 htlc_minimum_msat: 65_000,
1777 htlc_maximum_msat: OptionalField::Present(80_000),
1779 fee_proportional_millionths: 0,
1780 excess_data: Vec::new()
1782 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
1783 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1784 short_channel_id: 2,
1787 cltv_expiry_delta: 0,
1788 htlc_minimum_msat: 0,
1789 htlc_maximum_msat: OptionalField::Absent,
1791 fee_proportional_millionths: 0,
1792 excess_data: Vec::new()
1794 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
1795 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1796 short_channel_id: 4,
1799 cltv_expiry_delta: 0,
1800 htlc_minimum_msat: 0,
1801 htlc_maximum_msat: OptionalField::Absent,
1803 fee_proportional_millionths: 100_000,
1804 excess_data: Vec::new()
1807 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
1808 Some(InvoiceFeatures::known()), None, &Vec::new(), 60_000, 42, Arc::clone(&logger)).unwrap();
1809 // Fine to overpay for htlc_minimum_msat if it allows us to save fee.
1810 assert_eq!(route.paths.len(), 1);
1811 assert_eq!(route.paths[0][0].short_channel_id, 12);
1812 let fees = route.paths[0][0].fee_msat;
1813 assert_eq!(fees, 5_000);
1815 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
1816 Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, 42, Arc::clone(&logger)).unwrap();
1817 // Not fine to overpay for htlc_minimum_msat if it requires paying more than fee on
1818 // the other channel.
1819 assert_eq!(route.paths.len(), 1);
1820 assert_eq!(route.paths[0][0].short_channel_id, 2);
1821 let fees = route.paths[0][0].fee_msat;
1822 assert_eq!(fees, 5_000);
1826 fn disable_channels_test() {
1827 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
1828 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
1830 // // Disable channels 4 and 12 by flags=2
1831 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
1832 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1833 short_channel_id: 4,
1835 flags: 2, // to disable
1836 cltv_expiry_delta: 0,
1837 htlc_minimum_msat: 0,
1838 htlc_maximum_msat: OptionalField::Absent,
1840 fee_proportional_millionths: 0,
1841 excess_data: Vec::new()
1843 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
1844 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1845 short_channel_id: 12,
1847 flags: 2, // to disable
1848 cltv_expiry_delta: 0,
1849 htlc_minimum_msat: 0,
1850 htlc_maximum_msat: OptionalField::Absent,
1852 fee_proportional_millionths: 0,
1853 excess_data: Vec::new()
1856 // If all the channels require some features we don't understand, route should fail
1857 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, None, &Vec::new(), 100, 42, Arc::clone(&logger)) {
1858 assert_eq!(err, "Failed to find a path to the given destination");
1859 } else { panic!(); }
1861 // If we specify a channel to node7, that overrides our local channel view and that gets used
1862 let our_chans = vec![channelmanager::ChannelDetails {
1863 channel_id: [0; 32],
1864 short_channel_id: Some(42),
1865 remote_network_id: nodes[7].clone(),
1866 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
1867 channel_value_satoshis: 0,
1869 outbound_capacity_msat: 250_000_000,
1870 inbound_capacity_msat: 0,
1872 counterparty_forwarding_info: None,
1874 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
1875 assert_eq!(route.paths[0].len(), 2);
1877 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
1878 assert_eq!(route.paths[0][0].short_channel_id, 42);
1879 assert_eq!(route.paths[0][0].fee_msat, 200);
1880 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
1881 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
1882 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
1884 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
1885 assert_eq!(route.paths[0][1].short_channel_id, 13);
1886 assert_eq!(route.paths[0][1].fee_msat, 100);
1887 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
1888 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
1889 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
1893 fn disable_node_test() {
1894 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
1895 let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
1897 // Disable nodes 1, 2, and 8 by requiring unknown feature bits
1898 let mut unknown_features = NodeFeatures::known();
1899 unknown_features.set_required_unknown_bits();
1900 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[0], unknown_features.clone(), 1);
1901 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[1], unknown_features.clone(), 1);
1902 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[7], unknown_features.clone(), 1);
1904 // If all nodes require some features we don't understand, route should fail
1905 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, None, &Vec::new(), 100, 42, Arc::clone(&logger)) {
1906 assert_eq!(err, "Failed to find a path to the given destination");
1907 } else { panic!(); }
1909 // If we specify a channel to node7, that overrides our local channel view and that gets used
1910 let our_chans = vec![channelmanager::ChannelDetails {
1911 channel_id: [0; 32],
1912 short_channel_id: Some(42),
1913 remote_network_id: nodes[7].clone(),
1914 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
1915 channel_value_satoshis: 0,
1917 outbound_capacity_msat: 250_000_000,
1918 inbound_capacity_msat: 0,
1920 counterparty_forwarding_info: None,
1922 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
1923 assert_eq!(route.paths[0].len(), 2);
1925 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
1926 assert_eq!(route.paths[0][0].short_channel_id, 42);
1927 assert_eq!(route.paths[0][0].fee_msat, 200);
1928 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
1929 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features
1930 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
1932 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
1933 assert_eq!(route.paths[0][1].short_channel_id, 13);
1934 assert_eq!(route.paths[0][1].fee_msat, 100);
1935 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
1936 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
1937 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
1939 // Note that we don't test disabling node 3 and failing to route to it, as we (somewhat
1940 // naively) assume that the user checked the feature bits on the invoice, which override
1941 // the node_announcement.
1945 fn our_chans_test() {
1946 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
1947 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
1949 // Route to 1 via 2 and 3 because our channel to 1 is disabled
1950 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0], None, None, &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
1951 assert_eq!(route.paths[0].len(), 3);
1953 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
1954 assert_eq!(route.paths[0][0].short_channel_id, 2);
1955 assert_eq!(route.paths[0][0].fee_msat, 200);
1956 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
1957 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
1958 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
1960 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
1961 assert_eq!(route.paths[0][1].short_channel_id, 4);
1962 assert_eq!(route.paths[0][1].fee_msat, 100);
1963 assert_eq!(route.paths[0][1].cltv_expiry_delta, (3 << 8) | 2);
1964 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
1965 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
1967 assert_eq!(route.paths[0][2].pubkey, nodes[0]);
1968 assert_eq!(route.paths[0][2].short_channel_id, 3);
1969 assert_eq!(route.paths[0][2].fee_msat, 100);
1970 assert_eq!(route.paths[0][2].cltv_expiry_delta, 42);
1971 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(1));
1972 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(3));
1974 // If we specify a channel to node7, that overrides our local channel view and that gets used
1975 let our_chans = vec![channelmanager::ChannelDetails {
1976 channel_id: [0; 32],
1977 short_channel_id: Some(42),
1978 remote_network_id: nodes[7].clone(),
1979 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
1980 channel_value_satoshis: 0,
1982 outbound_capacity_msat: 250_000_000,
1983 inbound_capacity_msat: 0,
1985 counterparty_forwarding_info: None,
1987 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
1988 assert_eq!(route.paths[0].len(), 2);
1990 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
1991 assert_eq!(route.paths[0][0].short_channel_id, 42);
1992 assert_eq!(route.paths[0][0].fee_msat, 200);
1993 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
1994 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]);
1995 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
1997 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
1998 assert_eq!(route.paths[0][1].short_channel_id, 13);
1999 assert_eq!(route.paths[0][1].fee_msat, 100);
2000 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
2001 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
2002 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
2005 fn last_hops(nodes: &Vec<PublicKey>) -> Vec<RouteHint> {
2006 let zero_fees = RoutingFees {
2008 proportional_millionths: 0,
2011 src_node_id: nodes[3].clone(),
2012 short_channel_id: 8,
2014 cltv_expiry_delta: (8 << 8) | 1,
2015 htlc_minimum_msat: None,
2016 htlc_maximum_msat: None,
2018 src_node_id: nodes[4].clone(),
2019 short_channel_id: 9,
2022 proportional_millionths: 0,
2024 cltv_expiry_delta: (9 << 8) | 1,
2025 htlc_minimum_msat: None,
2026 htlc_maximum_msat: None,
2028 src_node_id: nodes[5].clone(),
2029 short_channel_id: 10,
2031 cltv_expiry_delta: (10 << 8) | 1,
2032 htlc_minimum_msat: None,
2033 htlc_maximum_msat: None,
2038 fn last_hops_test() {
2039 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
2040 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
2042 // Simple test across 2, 3, 5, and 4 via a last_hop channel
2044 // First check that lst hop can't have its source as the payee.
2045 let invalid_last_hop = RouteHint {
2046 src_node_id: nodes[6],
2047 short_channel_id: 8,
2050 proportional_millionths: 0,
2052 cltv_expiry_delta: (8 << 8) | 1,
2053 htlc_minimum_msat: None,
2054 htlc_maximum_msat: None,
2057 let mut invalid_last_hops = last_hops(&nodes);
2058 invalid_last_hops.push(invalid_last_hop);
2060 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], None, None, &invalid_last_hops.iter().collect::<Vec<_>>(), 100, 42, Arc::clone(&logger)) {
2061 assert_eq!(err, "Last hop cannot have a payee as a source.");
2062 } else { panic!(); }
2065 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], None, None, &last_hops(&nodes).iter().collect::<Vec<_>>(), 100, 42, Arc::clone(&logger)).unwrap();
2066 assert_eq!(route.paths[0].len(), 5);
2068 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
2069 assert_eq!(route.paths[0][0].short_channel_id, 2);
2070 assert_eq!(route.paths[0][0].fee_msat, 100);
2071 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
2072 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
2073 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
2075 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
2076 assert_eq!(route.paths[0][1].short_channel_id, 4);
2077 assert_eq!(route.paths[0][1].fee_msat, 0);
2078 assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 8) | 1);
2079 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
2080 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
2082 assert_eq!(route.paths[0][2].pubkey, nodes[4]);
2083 assert_eq!(route.paths[0][2].short_channel_id, 6);
2084 assert_eq!(route.paths[0][2].fee_msat, 0);
2085 assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 8) | 1);
2086 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5));
2087 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6));
2089 assert_eq!(route.paths[0][3].pubkey, nodes[3]);
2090 assert_eq!(route.paths[0][3].short_channel_id, 11);
2091 assert_eq!(route.paths[0][3].fee_msat, 0);
2092 assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 8) | 1);
2093 // If we have a peer in the node map, we'll use their features here since we don't have
2094 // a way of figuring out their features from the invoice:
2095 assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4));
2096 assert_eq!(route.paths[0][3].channel_features.le_flags(), &id_to_feature_flags(11));
2098 assert_eq!(route.paths[0][4].pubkey, nodes[6]);
2099 assert_eq!(route.paths[0][4].short_channel_id, 8);
2100 assert_eq!(route.paths[0][4].fee_msat, 100);
2101 assert_eq!(route.paths[0][4].cltv_expiry_delta, 42);
2102 assert_eq!(route.paths[0][4].node_features.le_flags(), &Vec::<u8>::new()); // We dont pass flags in from invoices yet
2103 assert_eq!(route.paths[0][4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
2107 fn our_chans_last_hop_connect_test() {
2108 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
2109 let (_, our_id, _, nodes) = get_nodes(&secp_ctx);
2111 // Simple test with outbound channel to 4 to test that last_hops and first_hops connect
2112 let our_chans = vec![channelmanager::ChannelDetails {
2113 channel_id: [0; 32],
2114 short_channel_id: Some(42),
2115 remote_network_id: nodes[3].clone(),
2116 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
2117 channel_value_satoshis: 0,
2119 outbound_capacity_msat: 250_000_000,
2120 inbound_capacity_msat: 0,
2122 counterparty_forwarding_info: None,
2124 let mut last_hops = last_hops(&nodes);
2125 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], None, Some(&our_chans.iter().collect::<Vec<_>>()), &last_hops.iter().collect::<Vec<_>>(), 100, 42, Arc::clone(&logger)).unwrap();
2126 assert_eq!(route.paths[0].len(), 2);
2128 assert_eq!(route.paths[0][0].pubkey, nodes[3]);
2129 assert_eq!(route.paths[0][0].short_channel_id, 42);
2130 assert_eq!(route.paths[0][0].fee_msat, 0);
2131 assert_eq!(route.paths[0][0].cltv_expiry_delta, (8 << 8) | 1);
2132 assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]);
2133 assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::<u8>::new()); // No feature flags will meet the relevant-to-channel conversion
2135 assert_eq!(route.paths[0][1].pubkey, nodes[6]);
2136 assert_eq!(route.paths[0][1].short_channel_id, 8);
2137 assert_eq!(route.paths[0][1].fee_msat, 100);
2138 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
2139 assert_eq!(route.paths[0][1].node_features.le_flags(), &Vec::<u8>::new()); // We dont pass flags in from invoices yet
2140 assert_eq!(route.paths[0][1].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
2142 last_hops[0].fees.base_msat = 1000;
2144 // Revert to via 6 as the fee on 8 goes up
2145 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], None, None, &last_hops.iter().collect::<Vec<_>>(), 100, 42, Arc::clone(&logger)).unwrap();
2146 assert_eq!(route.paths[0].len(), 4);
2148 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
2149 assert_eq!(route.paths[0][0].short_channel_id, 2);
2150 assert_eq!(route.paths[0][0].fee_msat, 200); // fee increased as its % of value transferred across node
2151 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
2152 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
2153 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
2155 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
2156 assert_eq!(route.paths[0][1].short_channel_id, 4);
2157 assert_eq!(route.paths[0][1].fee_msat, 100);
2158 assert_eq!(route.paths[0][1].cltv_expiry_delta, (7 << 8) | 1);
2159 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
2160 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
2162 assert_eq!(route.paths[0][2].pubkey, nodes[5]);
2163 assert_eq!(route.paths[0][2].short_channel_id, 7);
2164 assert_eq!(route.paths[0][2].fee_msat, 0);
2165 assert_eq!(route.paths[0][2].cltv_expiry_delta, (10 << 8) | 1);
2166 // If we have a peer in the node map, we'll use their features here since we don't have
2167 // a way of figuring out their features from the invoice:
2168 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(6));
2169 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(7));
2171 assert_eq!(route.paths[0][3].pubkey, nodes[6]);
2172 assert_eq!(route.paths[0][3].short_channel_id, 10);
2173 assert_eq!(route.paths[0][3].fee_msat, 100);
2174 assert_eq!(route.paths[0][3].cltv_expiry_delta, 42);
2175 assert_eq!(route.paths[0][3].node_features.le_flags(), &Vec::<u8>::new()); // We dont pass flags in from invoices yet
2176 assert_eq!(route.paths[0][3].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
2178 // ...but still use 8 for larger payments as 6 has a variable feerate
2179 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], None, None, &last_hops.iter().collect::<Vec<_>>(), 2000, 42, Arc::clone(&logger)).unwrap();
2180 assert_eq!(route.paths[0].len(), 5);
2182 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
2183 assert_eq!(route.paths[0][0].short_channel_id, 2);
2184 assert_eq!(route.paths[0][0].fee_msat, 3000);
2185 assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1);
2186 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2));
2187 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2));
2189 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
2190 assert_eq!(route.paths[0][1].short_channel_id, 4);
2191 assert_eq!(route.paths[0][1].fee_msat, 0);
2192 assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 8) | 1);
2193 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
2194 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4));
2196 assert_eq!(route.paths[0][2].pubkey, nodes[4]);
2197 assert_eq!(route.paths[0][2].short_channel_id, 6);
2198 assert_eq!(route.paths[0][2].fee_msat, 0);
2199 assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 8) | 1);
2200 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5));
2201 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6));
2203 assert_eq!(route.paths[0][3].pubkey, nodes[3]);
2204 assert_eq!(route.paths[0][3].short_channel_id, 11);
2205 assert_eq!(route.paths[0][3].fee_msat, 1000);
2206 assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 8) | 1);
2207 // If we have a peer in the node map, we'll use their features here since we don't have
2208 // a way of figuring out their features from the invoice:
2209 assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4));
2210 assert_eq!(route.paths[0][3].channel_features.le_flags(), &id_to_feature_flags(11));
2212 assert_eq!(route.paths[0][4].pubkey, nodes[6]);
2213 assert_eq!(route.paths[0][4].short_channel_id, 8);
2214 assert_eq!(route.paths[0][4].fee_msat, 2000);
2215 assert_eq!(route.paths[0][4].cltv_expiry_delta, 42);
2216 assert_eq!(route.paths[0][4].node_features.le_flags(), &Vec::<u8>::new()); // We dont pass flags in from invoices yet
2217 assert_eq!(route.paths[0][4].channel_features.le_flags(), &Vec::<u8>::new()); // We can't learn any flags from invoices, sadly
2221 fn unannounced_path_test() {
2222 // We should be able to send a payment to a destination without any help of a routing graph
2223 // if we have a channel with a common counterparty that appears in the first and last hop
2225 let source_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&hex::decode(format!("{:02}", 41).repeat(32)).unwrap()[..]).unwrap());
2226 let middle_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&hex::decode(format!("{:02}", 42).repeat(32)).unwrap()[..]).unwrap());
2227 let target_node_id = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&hex::decode(format!("{:02}", 43).repeat(32)).unwrap()[..]).unwrap());
2229 // If we specify a channel to a middle hop, that overrides our local channel view and that gets used
2230 let last_hops = vec![RouteHint {
2231 src_node_id: middle_node_id,
2232 short_channel_id: 8,
2235 proportional_millionths: 0,
2237 cltv_expiry_delta: (8 << 8) | 1,
2238 htlc_minimum_msat: None,
2239 htlc_maximum_msat: None,
2241 let our_chans = vec![channelmanager::ChannelDetails {
2242 channel_id: [0; 32],
2243 short_channel_id: Some(42),
2244 remote_network_id: middle_node_id,
2245 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
2246 channel_value_satoshis: 100000,
2248 outbound_capacity_msat: 100000,
2249 inbound_capacity_msat: 100000,
2251 counterparty_forwarding_info: None,
2253 let route = get_route(&source_node_id, &NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash()), &target_node_id, None, Some(&our_chans.iter().collect::<Vec<_>>()), &last_hops.iter().collect::<Vec<_>>(), 100, 42, Arc::new(test_utils::TestLogger::new())).unwrap();
2255 assert_eq!(route.paths[0].len(), 2);
2257 assert_eq!(route.paths[0][0].pubkey, middle_node_id);
2258 assert_eq!(route.paths[0][0].short_channel_id, 42);
2259 assert_eq!(route.paths[0][0].fee_msat, 1000);
2260 assert_eq!(route.paths[0][0].cltv_expiry_delta, (8 << 8) | 1);
2261 assert_eq!(route.paths[0][0].node_features.le_flags(), &[0b11]);
2262 assert_eq!(route.paths[0][0].channel_features.le_flags(), &[0; 0]); // We can't learn any flags from invoices, sadly
2264 assert_eq!(route.paths[0][1].pubkey, target_node_id);
2265 assert_eq!(route.paths[0][1].short_channel_id, 8);
2266 assert_eq!(route.paths[0][1].fee_msat, 100);
2267 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
2268 assert_eq!(route.paths[0][1].node_features.le_flags(), &[0; 0]); // We dont pass flags in from invoices yet
2269 assert_eq!(route.paths[0][1].channel_features.le_flags(), &[0; 0]); // We can't learn any flags from invoices, sadly
2273 fn available_amount_while_routing_test() {
2274 // Tests whether we choose the correct available channel amount while routing.
2276 let (secp_ctx, mut net_graph_msg_handler, chain_monitor, logger) = build_graph();
2277 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
2279 // We will use a simple single-path route from
2280 // our node to node2 via node0: channels {1, 3}.
2282 // First disable all other paths.
2283 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2284 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2285 short_channel_id: 2,
2288 cltv_expiry_delta: 0,
2289 htlc_minimum_msat: 0,
2290 htlc_maximum_msat: OptionalField::Present(100_000),
2292 fee_proportional_millionths: 0,
2293 excess_data: Vec::new()
2295 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2296 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2297 short_channel_id: 12,
2300 cltv_expiry_delta: 0,
2301 htlc_minimum_msat: 0,
2302 htlc_maximum_msat: OptionalField::Present(100_000),
2304 fee_proportional_millionths: 0,
2305 excess_data: Vec::new()
2308 // Make the first channel (#1) very permissive,
2309 // and we will be testing all limits on the second channel.
2310 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2311 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2312 short_channel_id: 1,
2315 cltv_expiry_delta: 0,
2316 htlc_minimum_msat: 0,
2317 htlc_maximum_msat: OptionalField::Present(1_000_000_000),
2319 fee_proportional_millionths: 0,
2320 excess_data: Vec::new()
2323 // First, let's see if routing works if we have absolutely no idea about the available amount.
2324 // In this case, it should be set to 250_000 sats.
2325 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
2326 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2327 short_channel_id: 3,
2330 cltv_expiry_delta: 0,
2331 htlc_minimum_msat: 0,
2332 htlc_maximum_msat: OptionalField::Absent,
2334 fee_proportional_millionths: 0,
2335 excess_data: Vec::new()
2339 // Attempt to route more than available results in a failure.
2340 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
2341 Some(InvoiceFeatures::known()), None, &Vec::new(), 250_000_001, 42, Arc::clone(&logger)) {
2342 assert_eq!(err, "Failed to find a sufficient route to the given destination");
2343 } else { panic!(); }
2347 // Now, attempt to route an exact amount we have should be fine.
2348 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
2349 Some(InvoiceFeatures::known()), None, &Vec::new(), 250_000_000, 42, Arc::clone(&logger)).unwrap();
2350 assert_eq!(route.paths.len(), 1);
2351 let path = route.paths.last().unwrap();
2352 assert_eq!(path.len(), 2);
2353 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
2354 assert_eq!(path.last().unwrap().fee_msat, 250_000_000);
2357 // Check that setting outbound_capacity_msat in first_hops limits the channels.
2358 // Disable channel #1 and use another first hop.
2359 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2360 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2361 short_channel_id: 1,
2364 cltv_expiry_delta: 0,
2365 htlc_minimum_msat: 0,
2366 htlc_maximum_msat: OptionalField::Present(1_000_000_000),
2368 fee_proportional_millionths: 0,
2369 excess_data: Vec::new()
2372 // Now, limit the first_hop by the outbound_capacity_msat of 200_000 sats.
2373 let our_chans = vec![channelmanager::ChannelDetails {
2374 channel_id: [0; 32],
2375 short_channel_id: Some(42),
2376 remote_network_id: nodes[0].clone(),
2377 counterparty_features: InitFeatures::from_le_bytes(vec![0b11]),
2378 channel_value_satoshis: 0,
2380 outbound_capacity_msat: 200_000_000,
2381 inbound_capacity_msat: 0,
2383 counterparty_forwarding_info: None,
2387 // Attempt to route more than available results in a failure.
2388 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
2389 Some(InvoiceFeatures::known()), Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 200_000_001, 42, Arc::clone(&logger)) {
2390 assert_eq!(err, "Failed to find a sufficient route to the given destination");
2391 } else { panic!(); }
2395 // Now, attempt to route an exact amount we have should be fine.
2396 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
2397 Some(InvoiceFeatures::known()), Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 200_000_000, 42, Arc::clone(&logger)).unwrap();
2398 assert_eq!(route.paths.len(), 1);
2399 let path = route.paths.last().unwrap();
2400 assert_eq!(path.len(), 2);
2401 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
2402 assert_eq!(path.last().unwrap().fee_msat, 200_000_000);
2405 // Enable channel #1 back.
2406 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2407 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2408 short_channel_id: 1,
2411 cltv_expiry_delta: 0,
2412 htlc_minimum_msat: 0,
2413 htlc_maximum_msat: OptionalField::Present(1_000_000_000),
2415 fee_proportional_millionths: 0,
2416 excess_data: Vec::new()
2420 // Now let's see if routing works if we know only htlc_maximum_msat.
2421 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
2422 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2423 short_channel_id: 3,
2426 cltv_expiry_delta: 0,
2427 htlc_minimum_msat: 0,
2428 htlc_maximum_msat: OptionalField::Present(15_000),
2430 fee_proportional_millionths: 0,
2431 excess_data: Vec::new()
2435 // Attempt to route more than available results in a failure.
2436 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
2437 Some(InvoiceFeatures::known()), None, &Vec::new(), 15_001, 42, Arc::clone(&logger)) {
2438 assert_eq!(err, "Failed to find a sufficient route to the given destination");
2439 } else { panic!(); }
2443 // Now, attempt to route an exact amount we have should be fine.
2444 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
2445 Some(InvoiceFeatures::known()), None, &Vec::new(), 15_000, 42, Arc::clone(&logger)).unwrap();
2446 assert_eq!(route.paths.len(), 1);
2447 let path = route.paths.last().unwrap();
2448 assert_eq!(path.len(), 2);
2449 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
2450 assert_eq!(path.last().unwrap().fee_msat, 15_000);
2453 // Now let's see if routing works if we know only capacity from the UTXO.
2455 // We can't change UTXO capacity on the fly, so we'll disable
2456 // the existing channel and add another one with the capacity we need.
2457 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
2458 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2459 short_channel_id: 3,
2462 cltv_expiry_delta: 0,
2463 htlc_minimum_msat: 0,
2464 htlc_maximum_msat: OptionalField::Absent,
2466 fee_proportional_millionths: 0,
2467 excess_data: Vec::new()
2470 let good_script = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2)
2471 .push_slice(&PublicKey::from_secret_key(&secp_ctx, &privkeys[0]).serialize())
2472 .push_slice(&PublicKey::from_secret_key(&secp_ctx, &privkeys[2]).serialize())
2473 .push_opcode(opcodes::all::OP_PUSHNUM_2)
2474 .push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script().to_v0_p2wsh();
2476 *chain_monitor.utxo_ret.lock().unwrap() = Ok(TxOut { value: 15, script_pubkey: good_script.clone() });
2477 net_graph_msg_handler.add_chain_access(Some(chain_monitor));
2479 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(3)), 333);
2480 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
2481 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2482 short_channel_id: 333,
2485 cltv_expiry_delta: (3 << 8) | 1,
2486 htlc_minimum_msat: 0,
2487 htlc_maximum_msat: OptionalField::Absent,
2489 fee_proportional_millionths: 0,
2490 excess_data: Vec::new()
2492 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
2493 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2494 short_channel_id: 333,
2497 cltv_expiry_delta: (3 << 8) | 2,
2498 htlc_minimum_msat: 0,
2499 htlc_maximum_msat: OptionalField::Absent,
2501 fee_proportional_millionths: 0,
2502 excess_data: Vec::new()
2506 // Attempt to route more than available results in a failure.
2507 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
2508 Some(InvoiceFeatures::known()), None, &Vec::new(), 15_001, 42, Arc::clone(&logger)) {
2509 assert_eq!(err, "Failed to find a sufficient route to the given destination");
2510 } else { panic!(); }
2514 // Now, attempt to route an exact amount we have should be fine.
2515 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
2516 Some(InvoiceFeatures::known()), None, &Vec::new(), 15_000, 42, Arc::clone(&logger)).unwrap();
2517 assert_eq!(route.paths.len(), 1);
2518 let path = route.paths.last().unwrap();
2519 assert_eq!(path.len(), 2);
2520 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
2521 assert_eq!(path.last().unwrap().fee_msat, 15_000);
2524 // Now let's see if routing chooses htlc_maximum_msat over UTXO capacity.
2525 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
2526 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2527 short_channel_id: 333,
2530 cltv_expiry_delta: 0,
2531 htlc_minimum_msat: 0,
2532 htlc_maximum_msat: OptionalField::Present(10_000),
2534 fee_proportional_millionths: 0,
2535 excess_data: Vec::new()
2539 // Attempt to route more than available results in a failure.
2540 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
2541 Some(InvoiceFeatures::known()), None, &Vec::new(), 10_001, 42, Arc::clone(&logger)) {
2542 assert_eq!(err, "Failed to find a sufficient route to the given destination");
2543 } else { panic!(); }
2547 // Now, attempt to route an exact amount we have should be fine.
2548 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
2549 Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, 42, Arc::clone(&logger)).unwrap();
2550 assert_eq!(route.paths.len(), 1);
2551 let path = route.paths.last().unwrap();
2552 assert_eq!(path.len(), 2);
2553 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
2554 assert_eq!(path.last().unwrap().fee_msat, 10_000);
2559 fn available_liquidity_last_hop_test() {
2560 // Check that available liquidity properly limits the path even when only
2561 // one of the latter hops is limited.
2562 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
2563 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
2565 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
2566 // {12, 13, 11} have the capacities of 100, {6} has a capacity of 50.
2567 // Total capacity: 50 sats.
2569 // Disable other potential paths.
2570 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2571 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2572 short_channel_id: 2,
2575 cltv_expiry_delta: 0,
2576 htlc_minimum_msat: 0,
2577 htlc_maximum_msat: OptionalField::Present(100_000),
2579 fee_proportional_millionths: 0,
2580 excess_data: Vec::new()
2582 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
2583 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2584 short_channel_id: 7,
2587 cltv_expiry_delta: 0,
2588 htlc_minimum_msat: 0,
2589 htlc_maximum_msat: OptionalField::Present(100_000),
2591 fee_proportional_millionths: 0,
2592 excess_data: Vec::new()
2597 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2598 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2599 short_channel_id: 12,
2602 cltv_expiry_delta: 0,
2603 htlc_minimum_msat: 0,
2604 htlc_maximum_msat: OptionalField::Present(100_000),
2606 fee_proportional_millionths: 0,
2607 excess_data: Vec::new()
2609 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
2610 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2611 short_channel_id: 13,
2614 cltv_expiry_delta: 0,
2615 htlc_minimum_msat: 0,
2616 htlc_maximum_msat: OptionalField::Present(100_000),
2618 fee_proportional_millionths: 0,
2619 excess_data: Vec::new()
2622 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
2623 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2624 short_channel_id: 6,
2627 cltv_expiry_delta: 0,
2628 htlc_minimum_msat: 0,
2629 htlc_maximum_msat: OptionalField::Present(50_000),
2631 fee_proportional_millionths: 0,
2632 excess_data: Vec::new()
2634 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
2635 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2636 short_channel_id: 11,
2639 cltv_expiry_delta: 0,
2640 htlc_minimum_msat: 0,
2641 htlc_maximum_msat: OptionalField::Present(100_000),
2643 fee_proportional_millionths: 0,
2644 excess_data: Vec::new()
2647 // Attempt to route more than available results in a failure.
2648 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3],
2649 Some(InvoiceFeatures::known()), None, &Vec::new(), 60_000, 42, Arc::clone(&logger)) {
2650 assert_eq!(err, "Failed to find a sufficient route to the given destination");
2651 } else { panic!(); }
2655 // Now, attempt to route 49 sats (just a bit below the capacity).
2656 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3],
2657 Some(InvoiceFeatures::known()), None, &Vec::new(), 49_000, 42, Arc::clone(&logger)).unwrap();
2658 assert_eq!(route.paths.len(), 1);
2659 let mut total_amount_paid_msat = 0;
2660 for path in &route.paths {
2661 assert_eq!(path.len(), 4);
2662 assert_eq!(path.last().unwrap().pubkey, nodes[3]);
2663 total_amount_paid_msat += path.last().unwrap().fee_msat;
2665 assert_eq!(total_amount_paid_msat, 49_000);
2669 // Attempt to route an exact amount is also fine
2670 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3],
2671 Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, 42, Arc::clone(&logger)).unwrap();
2672 assert_eq!(route.paths.len(), 1);
2673 let mut total_amount_paid_msat = 0;
2674 for path in &route.paths {
2675 assert_eq!(path.len(), 4);
2676 assert_eq!(path.last().unwrap().pubkey, nodes[3]);
2677 total_amount_paid_msat += path.last().unwrap().fee_msat;
2679 assert_eq!(total_amount_paid_msat, 50_000);
2684 fn ignore_fee_first_hop_test() {
2685 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
2686 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
2688 // Path via node0 is channels {1, 3}. Limit them to 100 and 50 sats (total limit 50).
2689 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2690 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2691 short_channel_id: 1,
2694 cltv_expiry_delta: 0,
2695 htlc_minimum_msat: 0,
2696 htlc_maximum_msat: OptionalField::Present(100_000),
2697 fee_base_msat: 1_000_000,
2698 fee_proportional_millionths: 0,
2699 excess_data: Vec::new()
2701 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
2702 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2703 short_channel_id: 3,
2706 cltv_expiry_delta: 0,
2707 htlc_minimum_msat: 0,
2708 htlc_maximum_msat: OptionalField::Present(50_000),
2710 fee_proportional_millionths: 0,
2711 excess_data: Vec::new()
2715 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, None, &Vec::new(), 50_000, 42, Arc::clone(&logger)).unwrap();
2716 assert_eq!(route.paths.len(), 1);
2717 let mut total_amount_paid_msat = 0;
2718 for path in &route.paths {
2719 assert_eq!(path.len(), 2);
2720 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
2721 total_amount_paid_msat += path.last().unwrap().fee_msat;
2723 assert_eq!(total_amount_paid_msat, 50_000);
2728 fn simple_mpp_route_test() {
2729 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
2730 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
2732 // We need a route consisting of 3 paths:
2733 // From our node to node2 via node0, node7, node1 (three paths one hop each).
2734 // To achieve this, the amount being transferred should be around
2735 // the total capacity of these 3 paths.
2737 // First, we set limits on these (previously unlimited) channels.
2738 // Their aggregate capacity will be 50 + 60 + 180 = 290 sats.
2740 // Path via node0 is channels {1, 3}. Limit them to 100 and 50 sats (total limit 50).
2741 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2742 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2743 short_channel_id: 1,
2746 cltv_expiry_delta: 0,
2747 htlc_minimum_msat: 0,
2748 htlc_maximum_msat: OptionalField::Present(100_000),
2750 fee_proportional_millionths: 0,
2751 excess_data: Vec::new()
2753 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
2754 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2755 short_channel_id: 3,
2758 cltv_expiry_delta: 0,
2759 htlc_minimum_msat: 0,
2760 htlc_maximum_msat: OptionalField::Present(50_000),
2762 fee_proportional_millionths: 0,
2763 excess_data: Vec::new()
2766 // Path via node7 is channels {12, 13}. Limit them to 60 and 60 sats
2767 // (total limit 60).
2768 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2769 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2770 short_channel_id: 12,
2773 cltv_expiry_delta: 0,
2774 htlc_minimum_msat: 0,
2775 htlc_maximum_msat: OptionalField::Present(60_000),
2777 fee_proportional_millionths: 0,
2778 excess_data: Vec::new()
2780 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
2781 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2782 short_channel_id: 13,
2785 cltv_expiry_delta: 0,
2786 htlc_minimum_msat: 0,
2787 htlc_maximum_msat: OptionalField::Present(60_000),
2789 fee_proportional_millionths: 0,
2790 excess_data: Vec::new()
2793 // Path via node1 is channels {2, 4}. Limit them to 200 and 180 sats
2794 // (total capacity 180 sats).
2795 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2796 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2797 short_channel_id: 2,
2800 cltv_expiry_delta: 0,
2801 htlc_minimum_msat: 0,
2802 htlc_maximum_msat: OptionalField::Present(200_000),
2804 fee_proportional_millionths: 0,
2805 excess_data: Vec::new()
2807 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
2808 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2809 short_channel_id: 4,
2812 cltv_expiry_delta: 0,
2813 htlc_minimum_msat: 0,
2814 htlc_maximum_msat: OptionalField::Present(180_000),
2816 fee_proportional_millionths: 0,
2817 excess_data: Vec::new()
2821 // Attempt to route more than available results in a failure.
2822 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(),
2823 &nodes[2], Some(InvoiceFeatures::known()), None, &Vec::new(), 300_000, 42, Arc::clone(&logger)) {
2824 assert_eq!(err, "Failed to find a sufficient route to the given destination");
2825 } else { panic!(); }
2829 // Now, attempt to route 250 sats (just a bit below the capacity).
2830 // Our algorithm should provide us with these 3 paths.
2831 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
2832 Some(InvoiceFeatures::known()), None, &Vec::new(), 250_000, 42, Arc::clone(&logger)).unwrap();
2833 assert_eq!(route.paths.len(), 3);
2834 let mut total_amount_paid_msat = 0;
2835 for path in &route.paths {
2836 assert_eq!(path.len(), 2);
2837 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
2838 total_amount_paid_msat += path.last().unwrap().fee_msat;
2840 assert_eq!(total_amount_paid_msat, 250_000);
2844 // Attempt to route an exact amount is also fine
2845 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
2846 Some(InvoiceFeatures::known()), None, &Vec::new(), 290_000, 42, Arc::clone(&logger)).unwrap();
2847 assert_eq!(route.paths.len(), 3);
2848 let mut total_amount_paid_msat = 0;
2849 for path in &route.paths {
2850 assert_eq!(path.len(), 2);
2851 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
2852 total_amount_paid_msat += path.last().unwrap().fee_msat;
2854 assert_eq!(total_amount_paid_msat, 290_000);
2859 fn long_mpp_route_test() {
2860 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
2861 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
2863 // We need a route consisting of 3 paths:
2864 // From our node to node3 via {node0, node2}, {node7, node2, node4} and {node7, node2}.
2865 // Note that these paths overlap (channels 5, 12, 13).
2866 // We will route 300 sats.
2867 // Each path will have 100 sats capacity, those channels which
2868 // are used twice will have 200 sats capacity.
2870 // Disable other potential paths.
2871 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2872 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2873 short_channel_id: 2,
2876 cltv_expiry_delta: 0,
2877 htlc_minimum_msat: 0,
2878 htlc_maximum_msat: OptionalField::Present(100_000),
2880 fee_proportional_millionths: 0,
2881 excess_data: Vec::new()
2883 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
2884 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2885 short_channel_id: 7,
2888 cltv_expiry_delta: 0,
2889 htlc_minimum_msat: 0,
2890 htlc_maximum_msat: OptionalField::Present(100_000),
2892 fee_proportional_millionths: 0,
2893 excess_data: Vec::new()
2896 // Path via {node0, node2} is channels {1, 3, 5}.
2897 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2898 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2899 short_channel_id: 1,
2902 cltv_expiry_delta: 0,
2903 htlc_minimum_msat: 0,
2904 htlc_maximum_msat: OptionalField::Present(100_000),
2906 fee_proportional_millionths: 0,
2907 excess_data: Vec::new()
2909 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
2910 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2911 short_channel_id: 3,
2914 cltv_expiry_delta: 0,
2915 htlc_minimum_msat: 0,
2916 htlc_maximum_msat: OptionalField::Present(100_000),
2918 fee_proportional_millionths: 0,
2919 excess_data: Vec::new()
2922 // Capacity of 200 sats because this channel will be used by 3rd path as well.
2923 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
2924 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
2925 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2926 short_channel_id: 5,
2929 cltv_expiry_delta: 0,
2930 htlc_minimum_msat: 0,
2931 htlc_maximum_msat: OptionalField::Present(200_000),
2933 fee_proportional_millionths: 0,
2934 excess_data: Vec::new()
2937 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
2938 // Add 100 sats to the capacities of {12, 13}, because these channels
2939 // are also used for 3rd path. 100 sats for the rest. Total capacity: 100 sats.
2940 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
2941 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2942 short_channel_id: 12,
2945 cltv_expiry_delta: 0,
2946 htlc_minimum_msat: 0,
2947 htlc_maximum_msat: OptionalField::Present(200_000),
2949 fee_proportional_millionths: 0,
2950 excess_data: Vec::new()
2952 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
2953 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2954 short_channel_id: 13,
2957 cltv_expiry_delta: 0,
2958 htlc_minimum_msat: 0,
2959 htlc_maximum_msat: OptionalField::Present(200_000),
2961 fee_proportional_millionths: 0,
2962 excess_data: Vec::new()
2965 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
2966 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2967 short_channel_id: 6,
2970 cltv_expiry_delta: 0,
2971 htlc_minimum_msat: 0,
2972 htlc_maximum_msat: OptionalField::Present(100_000),
2974 fee_proportional_millionths: 0,
2975 excess_data: Vec::new()
2977 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
2978 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2979 short_channel_id: 11,
2982 cltv_expiry_delta: 0,
2983 htlc_minimum_msat: 0,
2984 htlc_maximum_msat: OptionalField::Present(100_000),
2986 fee_proportional_millionths: 0,
2987 excess_data: Vec::new()
2990 // Path via {node7, node2} is channels {12, 13, 5}.
2991 // We already limited them to 200 sats (they are used twice for 100 sats).
2992 // Nothing to do here.
2995 // Attempt to route more than available results in a failure.
2996 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3],
2997 Some(InvoiceFeatures::known()), None, &Vec::new(), 350_000, 42, Arc::clone(&logger)) {
2998 assert_eq!(err, "Failed to find a sufficient route to the given destination");
2999 } else { panic!(); }
3003 // Now, attempt to route 300 sats (exact amount we can route).
3004 // Our algorithm should provide us with these 3 paths, 100 sats each.
3005 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3],
3006 Some(InvoiceFeatures::known()), None, &Vec::new(), 300_000, 42, Arc::clone(&logger)).unwrap();
3007 assert_eq!(route.paths.len(), 3);
3009 let mut total_amount_paid_msat = 0;
3010 for path in &route.paths {
3011 assert_eq!(path.last().unwrap().pubkey, nodes[3]);
3012 total_amount_paid_msat += path.last().unwrap().fee_msat;
3014 assert_eq!(total_amount_paid_msat, 300_000);
3020 fn mpp_cheaper_route_test() {
3021 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
3022 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3024 // This test checks that if we have two cheaper paths and one more expensive path,
3025 // so that liquidity-wise any 2 of 3 combination is sufficient,
3026 // two cheaper paths will be taken.
3027 // These paths have equal available liquidity.
3029 // We need a combination of 3 paths:
3030 // From our node to node3 via {node0, node2}, {node7, node2, node4} and {node7, node2}.
3031 // Note that these paths overlap (channels 5, 12, 13).
3032 // Each path will have 100 sats capacity, those channels which
3033 // are used twice will have 200 sats capacity.
3035 // Disable other potential paths.
3036 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3037 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3038 short_channel_id: 2,
3041 cltv_expiry_delta: 0,
3042 htlc_minimum_msat: 0,
3043 htlc_maximum_msat: OptionalField::Present(100_000),
3045 fee_proportional_millionths: 0,
3046 excess_data: Vec::new()
3048 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3049 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3050 short_channel_id: 7,
3053 cltv_expiry_delta: 0,
3054 htlc_minimum_msat: 0,
3055 htlc_maximum_msat: OptionalField::Present(100_000),
3057 fee_proportional_millionths: 0,
3058 excess_data: Vec::new()
3061 // Path via {node0, node2} is channels {1, 3, 5}.
3062 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3063 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3064 short_channel_id: 1,
3067 cltv_expiry_delta: 0,
3068 htlc_minimum_msat: 0,
3069 htlc_maximum_msat: OptionalField::Present(100_000),
3071 fee_proportional_millionths: 0,
3072 excess_data: Vec::new()
3074 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
3075 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3076 short_channel_id: 3,
3079 cltv_expiry_delta: 0,
3080 htlc_minimum_msat: 0,
3081 htlc_maximum_msat: OptionalField::Present(100_000),
3083 fee_proportional_millionths: 0,
3084 excess_data: Vec::new()
3087 // Capacity of 200 sats because this channel will be used by 3rd path as well.
3088 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
3089 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3090 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3091 short_channel_id: 5,
3094 cltv_expiry_delta: 0,
3095 htlc_minimum_msat: 0,
3096 htlc_maximum_msat: OptionalField::Present(200_000),
3098 fee_proportional_millionths: 0,
3099 excess_data: Vec::new()
3102 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
3103 // Add 100 sats to the capacities of {12, 13}, because these channels
3104 // are also used for 3rd path. 100 sats for the rest. Total capacity: 100 sats.
3105 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3106 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3107 short_channel_id: 12,
3110 cltv_expiry_delta: 0,
3111 htlc_minimum_msat: 0,
3112 htlc_maximum_msat: OptionalField::Present(200_000),
3114 fee_proportional_millionths: 0,
3115 excess_data: Vec::new()
3117 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
3118 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3119 short_channel_id: 13,
3122 cltv_expiry_delta: 0,
3123 htlc_minimum_msat: 0,
3124 htlc_maximum_msat: OptionalField::Present(200_000),
3126 fee_proportional_millionths: 0,
3127 excess_data: Vec::new()
3130 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3131 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3132 short_channel_id: 6,
3135 cltv_expiry_delta: 0,
3136 htlc_minimum_msat: 0,
3137 htlc_maximum_msat: OptionalField::Present(100_000),
3138 fee_base_msat: 1_000,
3139 fee_proportional_millionths: 0,
3140 excess_data: Vec::new()
3142 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
3143 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3144 short_channel_id: 11,
3147 cltv_expiry_delta: 0,
3148 htlc_minimum_msat: 0,
3149 htlc_maximum_msat: OptionalField::Present(100_000),
3151 fee_proportional_millionths: 0,
3152 excess_data: Vec::new()
3155 // Path via {node7, node2} is channels {12, 13, 5}.
3156 // We already limited them to 200 sats (they are used twice for 100 sats).
3157 // Nothing to do here.
3160 // Now, attempt to route 180 sats.
3161 // Our algorithm should provide us with these 2 paths.
3162 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3],
3163 Some(InvoiceFeatures::known()), None, &Vec::new(), 180_000, 42, Arc::clone(&logger)).unwrap();
3164 assert_eq!(route.paths.len(), 2);
3166 let mut total_value_transferred_msat = 0;
3167 let mut total_paid_msat = 0;
3168 for path in &route.paths {
3169 assert_eq!(path.last().unwrap().pubkey, nodes[3]);
3170 total_value_transferred_msat += path.last().unwrap().fee_msat;
3172 total_paid_msat += hop.fee_msat;
3175 // If we paid fee, this would be higher.
3176 assert_eq!(total_value_transferred_msat, 180_000);
3177 let total_fees_paid = total_paid_msat - total_value_transferred_msat;
3178 assert_eq!(total_fees_paid, 0);
3183 fn fees_on_mpp_route_test() {
3184 // This test makes sure that MPP algorithm properly takes into account
3185 // fees charged on the channels, by making the fees impactful:
3186 // if the fee is not properly accounted for, the behavior is different.
3187 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
3188 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3190 // We need a route consisting of 2 paths:
3191 // From our node to node3 via {node0, node2} and {node7, node2, node4}.
3192 // We will route 200 sats, Each path will have 100 sats capacity.
3194 // This test is not particularly stable: e.g.,
3195 // there's a way to route via {node0, node2, node4}.
3196 // It works while pathfinding is deterministic, but can be broken otherwise.
3197 // It's fine to ignore this concern for now.
3199 // Disable other potential paths.
3200 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3201 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3202 short_channel_id: 2,
3205 cltv_expiry_delta: 0,
3206 htlc_minimum_msat: 0,
3207 htlc_maximum_msat: OptionalField::Present(100_000),
3209 fee_proportional_millionths: 0,
3210 excess_data: Vec::new()
3213 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3214 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3215 short_channel_id: 7,
3218 cltv_expiry_delta: 0,
3219 htlc_minimum_msat: 0,
3220 htlc_maximum_msat: OptionalField::Present(100_000),
3222 fee_proportional_millionths: 0,
3223 excess_data: Vec::new()
3226 // Path via {node0, node2} is channels {1, 3, 5}.
3227 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3228 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3229 short_channel_id: 1,
3232 cltv_expiry_delta: 0,
3233 htlc_minimum_msat: 0,
3234 htlc_maximum_msat: OptionalField::Present(100_000),
3236 fee_proportional_millionths: 0,
3237 excess_data: Vec::new()
3239 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
3240 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3241 short_channel_id: 3,
3244 cltv_expiry_delta: 0,
3245 htlc_minimum_msat: 0,
3246 htlc_maximum_msat: OptionalField::Present(100_000),
3248 fee_proportional_millionths: 0,
3249 excess_data: Vec::new()
3252 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
3253 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3254 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3255 short_channel_id: 5,
3258 cltv_expiry_delta: 0,
3259 htlc_minimum_msat: 0,
3260 htlc_maximum_msat: OptionalField::Present(100_000),
3262 fee_proportional_millionths: 0,
3263 excess_data: Vec::new()
3266 // Path via {node7, node2, node4} is channels {12, 13, 6, 11}.
3267 // All channels should be 100 sats capacity. But for the fee experiment,
3268 // we'll add absolute fee of 150 sats paid for the use channel 6 (paid to node2 on channel 13).
3269 // Since channel 12 allows to deliver only 250 sats to channel 13, channel 13 can transfer only
3270 // 100 sats (and pay 150 sats in fees for the use of channel 6),
3271 // so no matter how large are other channels,
3272 // the whole path will be limited by 100 sats with just these 2 conditions:
3273 // - channel 12 capacity is 250 sats
3274 // - fee for channel 6 is 150 sats
3275 // Let's test this by enforcing these 2 conditions and removing other limits.
3276 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3277 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3278 short_channel_id: 12,
3281 cltv_expiry_delta: 0,
3282 htlc_minimum_msat: 0,
3283 htlc_maximum_msat: OptionalField::Present(250_000),
3285 fee_proportional_millionths: 0,
3286 excess_data: Vec::new()
3288 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
3289 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3290 short_channel_id: 13,
3293 cltv_expiry_delta: 0,
3294 htlc_minimum_msat: 0,
3295 htlc_maximum_msat: OptionalField::Absent,
3297 fee_proportional_millionths: 0,
3298 excess_data: Vec::new()
3301 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3302 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3303 short_channel_id: 6,
3306 cltv_expiry_delta: 0,
3307 htlc_minimum_msat: 0,
3308 htlc_maximum_msat: OptionalField::Absent,
3309 fee_base_msat: 150_000,
3310 fee_proportional_millionths: 0,
3311 excess_data: Vec::new()
3313 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
3314 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3315 short_channel_id: 11,
3318 cltv_expiry_delta: 0,
3319 htlc_minimum_msat: 0,
3320 htlc_maximum_msat: OptionalField::Absent,
3322 fee_proportional_millionths: 0,
3323 excess_data: Vec::new()
3327 // Attempt to route more than available results in a failure.
3328 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3],
3329 Some(InvoiceFeatures::known()), None, &Vec::new(), 210_000, 42, Arc::clone(&logger)) {
3330 assert_eq!(err, "Failed to find a sufficient route to the given destination");
3331 } else { panic!(); }
3335 // Now, attempt to route 200 sats (exact amount we can route).
3336 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3],
3337 Some(InvoiceFeatures::known()), None, &Vec::new(), 200_000, 42, Arc::clone(&logger)).unwrap();
3338 assert_eq!(route.paths.len(), 2);
3340 let mut total_amount_paid_msat = 0;
3341 for path in &route.paths {
3342 assert_eq!(path.last().unwrap().pubkey, nodes[3]);
3343 total_amount_paid_msat += path.last().unwrap().fee_msat;
3345 assert_eq!(total_amount_paid_msat, 200_000);
3351 fn drop_lowest_channel_mpp_route_test() {
3352 // This test checks that low-capacity channel is dropped when after
3353 // path finding we realize that we found more capacity than we need.
3354 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
3355 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3357 // We need a route consisting of 3 paths:
3358 // From our node to node2 via node0, node7, node1 (three paths one hop each).
3360 // The first and the second paths should be sufficient, but the third should be
3361 // cheaper, so that we select it but drop later.
3363 // First, we set limits on these (previously unlimited) channels.
3364 // Their aggregate capacity will be 50 + 60 + 20 = 130 sats.
3366 // Path via node0 is channels {1, 3}. Limit them to 100 and 50 sats (total limit 50);
3367 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3368 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3369 short_channel_id: 1,
3372 cltv_expiry_delta: 0,
3373 htlc_minimum_msat: 0,
3374 htlc_maximum_msat: OptionalField::Present(100_000),
3376 fee_proportional_millionths: 0,
3377 excess_data: Vec::new()
3379 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[0], UnsignedChannelUpdate {
3380 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3381 short_channel_id: 3,
3384 cltv_expiry_delta: 0,
3385 htlc_minimum_msat: 0,
3386 htlc_maximum_msat: OptionalField::Present(50_000),
3388 fee_proportional_millionths: 0,
3389 excess_data: Vec::new()
3392 // Path via node7 is channels {12, 13}. Limit them to 60 and 60 sats (total limit 60);
3393 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3394 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3395 short_channel_id: 12,
3398 cltv_expiry_delta: 0,
3399 htlc_minimum_msat: 0,
3400 htlc_maximum_msat: OptionalField::Present(60_000),
3402 fee_proportional_millionths: 0,
3403 excess_data: Vec::new()
3405 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate {
3406 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3407 short_channel_id: 13,
3410 cltv_expiry_delta: 0,
3411 htlc_minimum_msat: 0,
3412 htlc_maximum_msat: OptionalField::Present(60_000),
3414 fee_proportional_millionths: 0,
3415 excess_data: Vec::new()
3418 // Path via node1 is channels {2, 4}. Limit them to 20 and 20 sats (total capacity 20 sats).
3419 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3420 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3421 short_channel_id: 2,
3424 cltv_expiry_delta: 0,
3425 htlc_minimum_msat: 0,
3426 htlc_maximum_msat: OptionalField::Present(20_000),
3428 fee_proportional_millionths: 0,
3429 excess_data: Vec::new()
3431 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
3432 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3433 short_channel_id: 4,
3436 cltv_expiry_delta: 0,
3437 htlc_minimum_msat: 0,
3438 htlc_maximum_msat: OptionalField::Present(20_000),
3440 fee_proportional_millionths: 0,
3441 excess_data: Vec::new()
3445 // Attempt to route more than available results in a failure.
3446 if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
3447 Some(InvoiceFeatures::known()), None, &Vec::new(), 150_000, 42, Arc::clone(&logger)) {
3448 assert_eq!(err, "Failed to find a sufficient route to the given destination");
3449 } else { panic!(); }
3453 // Now, attempt to route 125 sats (just a bit below the capacity of 3 channels).
3454 // Our algorithm should provide us with these 3 paths.
3455 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
3456 Some(InvoiceFeatures::known()), None, &Vec::new(), 125_000, 42, Arc::clone(&logger)).unwrap();
3457 assert_eq!(route.paths.len(), 3);
3458 let mut total_amount_paid_msat = 0;
3459 for path in &route.paths {
3460 assert_eq!(path.len(), 2);
3461 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
3462 total_amount_paid_msat += path.last().unwrap().fee_msat;
3464 assert_eq!(total_amount_paid_msat, 125_000);
3468 // Attempt to route without the last small cheap channel
3469 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2],
3470 Some(InvoiceFeatures::known()), None, &Vec::new(), 90_000, 42, Arc::clone(&logger)).unwrap();
3471 assert_eq!(route.paths.len(), 2);
3472 let mut total_amount_paid_msat = 0;
3473 for path in &route.paths {
3474 assert_eq!(path.len(), 2);
3475 assert_eq!(path.last().unwrap().pubkey, nodes[2]);
3476 total_amount_paid_msat += path.last().unwrap().fee_msat;
3478 assert_eq!(total_amount_paid_msat, 90_000);
3483 fn min_criteria_consistency() {
3484 // Test that we don't use an inconsistent metric between updating and walking nodes during
3485 // our Dijkstra's pass. In the initial version of MPP, the "best source" for a given node
3486 // was updated with a different criterion from the heap sorting, resulting in loops in
3487 // calculated paths. We test for that specific case here.
3489 // We construct a network that looks like this:
3491 // node2 -1(3)2- node3
3495 // node1 -1(5)2- node4 -1(1)2- node6
3501 // We create a loop on the side of our real path - our destination is node 6, with a
3502 // previous hop of node 4. From 4, the cheapest previous path is channel 2 from node 2,
3503 // followed by node 3 over channel 3. Thereafter, the cheapest next-hop is back to node 4
3504 // (this time over channel 4). Channel 4 has 0 htlc_minimum_msat whereas channel 1 (the
3505 // other channel with a previous-hop of node 4) has a high (but irrelevant to the overall
3506 // payment) htlc_minimum_msat. In the original algorithm, this resulted in node4's
3507 // "previous hop" being set to node 3, creating a loop in the path.
3508 let secp_ctx = Secp256k1::new();
3509 let logger = Arc::new(test_utils::TestLogger::new());
3510 let net_graph_msg_handler = NetGraphMsgHandler::new(genesis_block(Network::Testnet).header.block_hash(), None, Arc::clone(&logger));
3511 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3513 add_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, &privkeys[1], ChannelFeatures::from_le_bytes(id_to_feature_flags(6)), 6);
3514 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3515 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3516 short_channel_id: 6,
3519 cltv_expiry_delta: (6 << 8) | 0,
3520 htlc_minimum_msat: 0,
3521 htlc_maximum_msat: OptionalField::Absent,
3523 fee_proportional_millionths: 0,
3524 excess_data: Vec::new()
3526 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[1], NodeFeatures::from_le_bytes(id_to_feature_flags(1)), 0);
3528 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], &privkeys[4], ChannelFeatures::from_le_bytes(id_to_feature_flags(5)), 5);
3529 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
3530 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3531 short_channel_id: 5,
3534 cltv_expiry_delta: (5 << 8) | 0,
3535 htlc_minimum_msat: 0,
3536 htlc_maximum_msat: OptionalField::Absent,
3538 fee_proportional_millionths: 0,
3539 excess_data: Vec::new()
3541 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[4], NodeFeatures::from_le_bytes(id_to_feature_flags(4)), 0);
3543 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], &privkeys[3], ChannelFeatures::from_le_bytes(id_to_feature_flags(4)), 4);
3544 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
3545 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3546 short_channel_id: 4,
3549 cltv_expiry_delta: (4 << 8) | 0,
3550 htlc_minimum_msat: 0,
3551 htlc_maximum_msat: OptionalField::Absent,
3553 fee_proportional_millionths: 0,
3554 excess_data: Vec::new()
3556 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[3], NodeFeatures::from_le_bytes(id_to_feature_flags(3)), 0);
3558 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[3], &privkeys[2], ChannelFeatures::from_le_bytes(id_to_feature_flags(3)), 3);
3559 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[3], UnsignedChannelUpdate {
3560 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3561 short_channel_id: 3,
3564 cltv_expiry_delta: (3 << 8) | 0,
3565 htlc_minimum_msat: 0,
3566 htlc_maximum_msat: OptionalField::Absent,
3568 fee_proportional_millionths: 0,
3569 excess_data: Vec::new()
3571 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[2], NodeFeatures::from_le_bytes(id_to_feature_flags(2)), 0);
3573 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], &privkeys[4], ChannelFeatures::from_le_bytes(id_to_feature_flags(2)), 2);
3574 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[2], UnsignedChannelUpdate {
3575 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3576 short_channel_id: 2,
3579 cltv_expiry_delta: (2 << 8) | 0,
3580 htlc_minimum_msat: 0,
3581 htlc_maximum_msat: OptionalField::Absent,
3583 fee_proportional_millionths: 0,
3584 excess_data: Vec::new()
3587 add_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], &privkeys[6], ChannelFeatures::from_le_bytes(id_to_feature_flags(1)), 1);
3588 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[4], UnsignedChannelUpdate {
3589 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3590 short_channel_id: 1,
3593 cltv_expiry_delta: (1 << 8) | 0,
3594 htlc_minimum_msat: 100,
3595 htlc_maximum_msat: OptionalField::Absent,
3597 fee_proportional_millionths: 0,
3598 excess_data: Vec::new()
3600 add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[6], NodeFeatures::from_le_bytes(id_to_feature_flags(6)), 0);
3603 // Now ensure the route flows simply over nodes 1 and 4 to 6.
3604 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[6], None, None, &Vec::new(), 10_000, 42, Arc::clone(&logger)).unwrap();
3605 assert_eq!(route.paths.len(), 1);
3606 assert_eq!(route.paths[0].len(), 3);
3608 assert_eq!(route.paths[0][0].pubkey, nodes[1]);
3609 assert_eq!(route.paths[0][0].short_channel_id, 6);
3610 assert_eq!(route.paths[0][0].fee_msat, 100);
3611 assert_eq!(route.paths[0][0].cltv_expiry_delta, (5 << 8) | 0);
3612 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(1));
3613 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(6));
3615 assert_eq!(route.paths[0][1].pubkey, nodes[4]);
3616 assert_eq!(route.paths[0][1].short_channel_id, 5);
3617 assert_eq!(route.paths[0][1].fee_msat, 0);
3618 assert_eq!(route.paths[0][1].cltv_expiry_delta, (1 << 8) | 0);
3619 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(4));
3620 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(5));
3622 assert_eq!(route.paths[0][2].pubkey, nodes[6]);
3623 assert_eq!(route.paths[0][2].short_channel_id, 1);
3624 assert_eq!(route.paths[0][2].fee_msat, 10_000);
3625 assert_eq!(route.paths[0][2].cltv_expiry_delta, 42);
3626 assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(6));
3627 assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(1));
3633 fn exact_fee_liquidity_limit() {
3634 // Test that if, while walking the graph, we find a hop that has exactly enough liquidity
3635 // for us, including later hop fees, we take it. In the first version of our MPP algorithm
3636 // we calculated fees on a higher value, resulting in us ignoring such paths.
3637 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
3638 let (our_privkey, our_id, _, nodes) = get_nodes(&secp_ctx);
3640 // We modify the graph to set the htlc_maximum of channel 2 to below the value we wish to
3642 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3643 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3644 short_channel_id: 2,
3647 cltv_expiry_delta: 0,
3648 htlc_minimum_msat: 0,
3649 htlc_maximum_msat: OptionalField::Present(85_000),
3651 fee_proportional_millionths: 0,
3652 excess_data: Vec::new()
3655 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3656 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3657 short_channel_id: 12,
3660 cltv_expiry_delta: (4 << 8) | 1,
3661 htlc_minimum_msat: 0,
3662 htlc_maximum_msat: OptionalField::Present(270_000),
3664 fee_proportional_millionths: 1000000,
3665 excess_data: Vec::new()
3669 // Now, attempt to route 90 sats, which is exactly 90 sats at the last hop, plus the
3670 // 200% fee charged channel 13 in the 1-to-2 direction.
3671 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, None, &Vec::new(), 90_000, 42, Arc::clone(&logger)).unwrap();
3672 assert_eq!(route.paths.len(), 1);
3673 assert_eq!(route.paths[0].len(), 2);
3675 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
3676 assert_eq!(route.paths[0][0].short_channel_id, 12);
3677 assert_eq!(route.paths[0][0].fee_msat, 90_000*2);
3678 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
3679 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(8));
3680 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(12));
3682 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
3683 assert_eq!(route.paths[0][1].short_channel_id, 13);
3684 assert_eq!(route.paths[0][1].fee_msat, 90_000);
3685 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
3686 assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3));
3687 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
3692 fn htlc_max_reduction_below_min() {
3693 // Test that if, while walking the graph, we reduce the value being sent to meet an
3694 // htlc_maximum_msat, we don't end up undershooting a later htlc_minimum_msat. In the
3695 // initial version of MPP we'd accept such routes but reject them while recalculating fees,
3696 // resulting in us thinking there is no possible path, even if other paths exist.
3697 let (secp_ctx, net_graph_msg_handler, _, logger) = build_graph();
3698 let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx);
3700 // We modify the graph to set the htlc_minimum of channel 2 and 4 as needed - channel 2
3701 // gets an htlc_maximum_msat of 80_000 and channel 4 an htlc_minimum_msat of 90_000. We
3702 // then try to send 90_000.
3703 update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate {
3704 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3705 short_channel_id: 2,
3708 cltv_expiry_delta: 0,
3709 htlc_minimum_msat: 0,
3710 htlc_maximum_msat: OptionalField::Present(80_000),
3712 fee_proportional_millionths: 0,
3713 excess_data: Vec::new()
3715 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate {
3716 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
3717 short_channel_id: 4,
3720 cltv_expiry_delta: (4 << 8) | 1,
3721 htlc_minimum_msat: 90_000,
3722 htlc_maximum_msat: OptionalField::Absent,
3724 fee_proportional_millionths: 0,
3725 excess_data: Vec::new()
3729 // Now, attempt to route 90 sats, hitting the htlc_minimum on channel 4, but
3730 // overshooting the htlc_maximum on channel 2. Thus, we should pick the (absurdly
3731 // expensive) channels 12-13 path.
3732 let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], Some(InvoiceFeatures::known()), None, &Vec::new(), 90_000, 42, Arc::clone(&logger)).unwrap();
3733 assert_eq!(route.paths.len(), 1);
3734 assert_eq!(route.paths[0].len(), 2);
3736 assert_eq!(route.paths[0][0].pubkey, nodes[7]);
3737 assert_eq!(route.paths[0][0].short_channel_id, 12);
3738 assert_eq!(route.paths[0][0].fee_msat, 90_000*2);
3739 assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1);
3740 assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(8));
3741 assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(12));
3743 assert_eq!(route.paths[0][1].pubkey, nodes[2]);
3744 assert_eq!(route.paths[0][1].short_channel_id, 13);
3745 assert_eq!(route.paths[0][1].fee_msat, 90_000);
3746 assert_eq!(route.paths[0][1].cltv_expiry_delta, 42);
3747 assert_eq!(route.paths[0][1].node_features.le_flags(), InvoiceFeatures::known().le_flags());
3748 assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(13));
3753 #[cfg(all(test, feature = "unstable"))]
3756 use util::logger::{Logger, Record};
3761 struct DummyLogger {}
3762 impl Logger for DummyLogger {
3763 fn log(&self, _record: &Record) {}
3767 fn generate_routes(bench: &mut Bencher) {
3768 let mut d = File::open("net_graph-2021-02-12.bin").expect("Please fetch https://bitcoin.ninja/ldk-net_graph-879e309c128-2020-02-12.bin and place it at lightning/net_graph-2021-02-12.bin");
3769 let graph = NetworkGraph::read(&mut d).unwrap();
3771 // First, get 100 (source, destination) pairs for which route-getting actually succeeds...
3772 let mut path_endpoints = Vec::new();
3773 let mut seed: usize = 0xdeadbeef;
3774 'load_endpoints: for _ in 0..100 {
3777 let src = graph.get_nodes().keys().skip(seed % graph.get_nodes().len()).next().unwrap();
3779 let dst = graph.get_nodes().keys().skip(seed % graph.get_nodes().len()).next().unwrap();
3780 let amt = seed as u64 % 1_000_000;
3781 if get_route(src, &graph, dst, None, None, &[], amt, 42, &DummyLogger{}).is_ok() {
3782 path_endpoints.push((src, dst, amt));
3783 continue 'load_endpoints;
3788 // ...then benchmark finding paths between the nodes we learned.
3791 let (src, dst, amt) = path_endpoints[idx % path_endpoints.len()];
3792 assert!(get_route(src, &graph, dst, None, None, &[], amt, 42, &DummyLogger{}).is_ok());
3798 fn generate_mpp_routes(bench: &mut Bencher) {
3799 let mut d = File::open("net_graph-2021-02-12.bin").expect("Please fetch https://bitcoin.ninja/ldk-net_graph-879e309c128-2020-02-12.bin and place it at lightning/net_graph-2021-02-12.bin");
3800 let graph = NetworkGraph::read(&mut d).unwrap();
3802 // First, get 100 (source, destination) pairs for which route-getting actually succeeds...
3803 let mut path_endpoints = Vec::new();
3804 let mut seed: usize = 0xdeadbeef;
3805 'load_endpoints: for _ in 0..100 {
3808 let src = graph.get_nodes().keys().skip(seed % graph.get_nodes().len()).next().unwrap();
3810 let dst = graph.get_nodes().keys().skip(seed % graph.get_nodes().len()).next().unwrap();
3811 let amt = seed as u64 % 1_000_000;
3812 if get_route(src, &graph, dst, Some(InvoiceFeatures::known()), None, &[], amt, 42, &DummyLogger{}).is_ok() {
3813 path_endpoints.push((src, dst, amt));
3814 continue 'load_endpoints;
3819 // ...then benchmark finding paths between the nodes we learned.
3822 let (src, dst, amt) = path_endpoints[idx % path_endpoints.len()];
3823 assert!(get_route(src, &graph, dst, Some(InvoiceFeatures::known()), None, &[], amt, 42, &DummyLogger{}).is_ok());