X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Frouting%2Frouter.rs;h=65119f0f843a5266f248ed53f1a9cdd05653a99e;hb=e43cfe135a5b68620cd51b9b982362c272b4ef77;hp=a98fb99124690566040561dee77893ba0c99cda1;hpb=8dc7cfab3af7e26cddd8c65a913d5ee021907442;p=rust-lightning diff --git a/lightning/src/routing/router.rs b/lightning/src/routing/router.rs index a98fb991..65119f0f 100644 --- a/lightning/src/routing/router.rs +++ b/lightning/src/routing/router.rs @@ -17,8 +17,8 @@ use bitcoin::secp256k1::key::PublicKey; use ln::channelmanager::ChannelDetails; use ln::features::{ChannelFeatures, InvoiceFeatures, NodeFeatures}; use ln::msgs::{DecodeError, ErrorAction, LightningError, MAX_VALUE_MSAT}; -use routing; -use routing::network_graph::{NetworkGraph, NodeId, RoutingFees}; +use routing::scoring::Score; +use routing::network_graph::{DirectedChannelInfoWithUpdate, EffectiveCapacity, NetworkGraph, NodeId, RoutingFees}; use util::ser::{Writeable, Readable}; use util::logger::{Level, Logger}; @@ -70,12 +70,12 @@ pub struct Route { /// given path is variable, keeping the length of any path to less than 20 should currently /// ensure it is viable. pub paths: Vec>, - /// The `payee` parameter passed to [`find_route`]. + /// The `payment_params` parameter passed to [`find_route`]. /// This is used by `ChannelManager` to track information which may be required for retries, /// provided back to you via [`Event::PaymentPathFailed`]. /// /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed - pub payee: Option, + pub payment_params: Option, } pub(crate) trait RoutePath { @@ -122,7 +122,7 @@ impl Writeable for Route { } } write_tlv_fields!(writer, { - (1, self.payee, option), + (1, self.payment_params, option), }); Ok(()) } @@ -141,15 +141,15 @@ impl Readable for Route { } paths.push(hops); } - let mut payee = None; + let mut payment_params = None; read_tlv_fields!(reader, { - (1, payee, option), + (1, payment_params, option), }); - Ok(Route { paths, payee }) + Ok(Route { paths, payment_params }) } } -/// Parameters needed to find a [`Route`] for paying a [`Payee`]. +/// Parameters needed to find a [`Route`]. /// /// Passed to [`find_route`] and also provided in [`Event::PaymentPathFailed`] for retrying a failed /// payment path. @@ -157,8 +157,8 @@ impl Readable for Route { /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed #[derive(Clone, Debug)] pub struct RouteParameters { - /// The recipient of the failed payment path. - pub payee: Payee, + /// The parameters of the failed payment path. + pub payment_params: PaymentParameters, /// The amount in msats sent on the failed payment path. pub final_value_msat: u64, @@ -168,16 +168,19 @@ pub struct RouteParameters { } impl_writeable_tlv_based!(RouteParameters, { - (0, payee, required), + (0, payment_params, required), (2, final_value_msat, required), (4, final_cltv_expiry_delta, required), }); +/// Maximum total CTLV difference we allow for a full payment path. +pub const DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA: u32 = 1008; + /// The recipient of a payment. #[derive(Clone, Debug, Hash, PartialEq, Eq)] -pub struct Payee { +pub struct PaymentParameters { /// The node id of the payee. - pub pubkey: PublicKey, + pub payee_pubkey: PublicKey, /// Features supported by the payee. /// @@ -192,29 +195,34 @@ pub struct Payee { /// Expiration of a payment to the payee, in seconds relative to the UNIX epoch. pub expiry_time: Option, + + /// The maximum total CLTV delta we accept for the route. + pub max_total_cltv_expiry_delta: u32, } -impl_writeable_tlv_based!(Payee, { - (0, pubkey, required), +impl_writeable_tlv_based!(PaymentParameters, { + (0, payee_pubkey, required), + (1, max_total_cltv_expiry_delta, (default_value, DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA)), (2, features, option), (4, route_hints, vec_type), (6, expiry_time, option), }); -impl Payee { +impl PaymentParameters { /// Creates a payee with the node id of the given `pubkey`. - pub fn from_node_id(pubkey: PublicKey) -> Self { + pub fn from_node_id(payee_pubkey: PublicKey) -> Self { Self { - pubkey, + payee_pubkey, features: None, route_hints: vec![], expiry_time: None, + max_total_cltv_expiry_delta: DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA, } } /// Creates a payee with the node id of the given `pubkey` to use for keysend payments. - pub fn for_keysend(pubkey: PublicKey) -> Self { - Self::from_node_id(pubkey).with_features(InvoiceFeatures::for_keysend()) + pub fn for_keysend(payee_pubkey: PublicKey) -> Self { + Self::from_node_id(payee_pubkey).with_features(InvoiceFeatures::for_keysend()) } /// Includes the payee's features. @@ -237,6 +245,13 @@ impl Payee { pub fn with_expiry_time(self, expiry_time: u64) -> Self { Self { expiry_time: Some(expiry_time), ..self } } + + /// Includes a limit for the total CLTV expiry delta which is considered during routing + /// + /// (C-not exported) since bindings don't support move semantics + pub fn with_max_total_cltv_expiry_delta(self, max_total_cltv_expiry_delta: u32) -> Self { + Self { max_total_cltv_expiry_delta, ..self } + } } /// A list of hops along a payment path terminating with a channel to the recipient. @@ -296,6 +311,7 @@ struct RouteGraphNode { node_id: NodeId, lowest_fee_to_peer_through_node: u64, lowest_fee_to_node: u64, + total_cltv_delta: u32, // The maximum value a yet-to-be-constructed payment path might flow through this node. // This value is upper-bounded by us by: // - how much is needed for a path being constructed @@ -328,11 +344,79 @@ impl cmp::PartialOrd for RouteGraphNode { } } -struct DummyDirectionalChannelInfo { - cltv_expiry_delta: u32, - htlc_minimum_msat: u64, - htlc_maximum_msat: Option, - fees: RoutingFees, +/// A wrapper around the various hop representations. +/// +/// Used to construct a [`PathBuildingHop`] and to estimate [`EffectiveCapacity`]. +#[derive(Clone, Debug)] +enum CandidateRouteHop<'a> { + /// A hop from the payer, where the outbound liquidity is known. + FirstHop { + details: &'a ChannelDetails, + }, + /// A hop found in the [`NetworkGraph`], where the channel capacity may or may not be known. + PublicHop { + info: DirectedChannelInfoWithUpdate<'a>, + short_channel_id: u64, + }, + /// A hop to the payee found in the payment invoice, though not necessarily a direct channel. + PrivateHop { + hint: &'a RouteHintHop, + } +} + +impl<'a> CandidateRouteHop<'a> { + fn short_channel_id(&self) -> u64 { + match self { + CandidateRouteHop::FirstHop { details } => details.short_channel_id.unwrap(), + CandidateRouteHop::PublicHop { short_channel_id, .. } => *short_channel_id, + CandidateRouteHop::PrivateHop { hint } => hint.short_channel_id, + } + } + + // NOTE: This may alloc memory so avoid calling it in a hot code path. + fn features(&self) -> ChannelFeatures { + match self { + CandidateRouteHop::FirstHop { details } => details.counterparty.features.to_context(), + CandidateRouteHop::PublicHop { info, .. } => info.channel().features.clone(), + CandidateRouteHop::PrivateHop { .. } => ChannelFeatures::empty(), + } + } + + fn cltv_expiry_delta(&self) -> u32 { + match self { + CandidateRouteHop::FirstHop { .. } => 0, + CandidateRouteHop::PublicHop { info, .. } => info.direction().cltv_expiry_delta as u32, + CandidateRouteHop::PrivateHop { hint } => hint.cltv_expiry_delta as u32, + } + } + + fn htlc_minimum_msat(&self) -> u64 { + match self { + CandidateRouteHop::FirstHop { .. } => 0, + CandidateRouteHop::PublicHop { info, .. } => info.direction().htlc_minimum_msat, + CandidateRouteHop::PrivateHop { hint } => hint.htlc_minimum_msat.unwrap_or(0), + } + } + + fn fees(&self) -> RoutingFees { + match self { + CandidateRouteHop::FirstHop { .. } => RoutingFees { + base_msat: 0, proportional_millionths: 0, + }, + CandidateRouteHop::PublicHop { info, .. } => info.direction().fees, + CandidateRouteHop::PrivateHop { hint } => hint.fees, + } + } + + fn effective_capacity(&self) -> EffectiveCapacity { + match self { + CandidateRouteHop::FirstHop { details } => EffectiveCapacity::ExactLiquidity { + liquidity_msat: details.outbound_capacity_msat, + }, + CandidateRouteHop::PublicHop { info, .. } => info.effective_capacity(), + CandidateRouteHop::PrivateHop { .. } => EffectiveCapacity::Infinite, + } + } } /// It's useful to keep track of the hops associated with the fees required to use them, @@ -341,21 +425,17 @@ struct DummyDirectionalChannelInfo { /// These fee values are useful to choose hops as we traverse the graph "payee-to-payer". #[derive(Clone, Debug)] struct PathBuildingHop<'a> { - // The RouteHintHop fields which will eventually be used if this hop is used in a final Route. - // Note that node_features is calculated separately after our initial graph walk. + // Note that this should be dropped in favor of loading it from CandidateRouteHop, but doing so + // is a larger refactor and will require careful performance analysis. node_id: NodeId, - short_channel_id: u64, - channel_features: &'a ChannelFeatures, + candidate: CandidateRouteHop<'a>, fee_msat: u64, - cltv_expiry_delta: u32, /// Minimal fees required to route to the source node of the current hop via any of its inbound channels. src_lowest_inbound_fees: RoutingFees, - /// Fees of the channel used in this hop. - channel_fees: RoutingFees, /// All the fees paid *after* this channel on the way to the destination next_hops_fee_msat: u64, - /// Fee paid for the use of the current channel (see channel_fees). + /// Fee paid for the use of the current channel (see candidate.fees()). /// The value will be actually deducted from the counterparty balance on the previous link. hop_use_fee_msat: u64, /// Used to compare channels when choosing the for routing. @@ -363,10 +443,6 @@ struct PathBuildingHop<'a> { /// an estimated cost of reaching this hop. /// Might get stale when fees are recomputed. Primarily for internal use. total_fee_msat: u64, - /// This is useful for update_value_and_recompute_fees to make sure - /// we don't fall below the minimum. Should not be updated manually and - /// generally should not be accessed. - htlc_minimum_msat: u64, /// A mirror of the same field in RouteGraphNode. Note that this is only used during the graph /// walk and may be invalid thereafter. path_htlc_minimum_msat: u64, @@ -379,7 +455,7 @@ struct PathBuildingHop<'a> { /// decrease as well. Thus, we have to explicitly track which nodes have been processed and /// avoid processing them again. was_processed: bool, - #[cfg(any(test, feature = "fuzztarget"))] + #[cfg(all(not(feature = "_bench_unstable"), any(test, fuzzing)))] // In tests, we apply further sanity checks on cases where we skip nodes we already processed // to ensure it is specifically in cases where the fee has gone down because of a decrease in // value_contribution_msat, which requires tracking it here. See comments below where it is @@ -445,7 +521,7 @@ impl<'a> PaymentPath<'a> { // set it too high just to maliciously take more fees by exploiting this // match htlc_minimum_msat logic. let mut cur_hop_transferred_amount_msat = total_fee_paid_msat + value_msat; - if let Some(extra_fees_msat) = cur_hop.htlc_minimum_msat.checked_sub(cur_hop_transferred_amount_msat) { + if let Some(extra_fees_msat) = cur_hop.candidate.htlc_minimum_msat().checked_sub(cur_hop_transferred_amount_msat) { // Note that there is a risk that *previous hops* (those closer to us, as we go // payee->our_node here) would exceed their htlc_maximum_msat or available balance. // @@ -473,7 +549,7 @@ impl<'a> PaymentPath<'a> { // Irrelevant for the first hop, as it doesn't have the previous hop, and the use of // this channel is free for us. if i != 0 { - if let Some(new_fee) = compute_fees(cur_hop_transferred_amount_msat, cur_hop.channel_fees) { + if let Some(new_fee) = compute_fees(cur_hop_transferred_amount_msat, cur_hop.candidate.fees()) { cur_hop.hop_use_fee_msat = new_fee; total_fee_paid_msat += new_fee; } else { @@ -529,24 +605,24 @@ fn compute_fees(amount_msat: u64, channel_fees: RoutingFees) -> Option { /// /// [`ChannelManager::list_usable_channels`]: crate::ln::channelmanager::ChannelManager::list_usable_channels /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed -pub fn find_route( - our_node_pubkey: &PublicKey, params: &RouteParameters, network: &NetworkGraph, +pub fn find_route( + our_node_pubkey: &PublicKey, route_params: &RouteParameters, network: &NetworkGraph, first_hops: Option<&[&ChannelDetails]>, logger: L, scorer: &S ) -> Result where L::Target: Logger { get_route( - our_node_pubkey, ¶ms.payee, network, first_hops, params.final_value_msat, - params.final_cltv_expiry_delta, logger, scorer + our_node_pubkey, &route_params.payment_params, network, first_hops, route_params.final_value_msat, + route_params.final_cltv_expiry_delta, logger, scorer ) } -pub(crate) fn get_route( - our_node_pubkey: &PublicKey, payee: &Payee, network: &NetworkGraph, - first_hops: Option<&[&ChannelDetails]>, final_value_msat: u64, final_cltv_expiry_delta: u32, +pub(crate) fn get_route( + our_node_pubkey: &PublicKey, payment_params: &PaymentParameters, network: &NetworkGraph, + first_hops: Option<&[&ChannelDetails]>, final_value_msat: u64, final_cltv_expiry_delta: u32, logger: L, scorer: &S ) -> Result where L::Target: Logger { - let payee_node_id = NodeId::from_pubkey(&payee.pubkey); + let payee_node_id = NodeId::from_pubkey(&payment_params.payee_pubkey); let our_node_id = NodeId::from_pubkey(&our_node_pubkey); if payee_node_id == our_node_id { @@ -561,9 +637,9 @@ where L::Target: Logger { return Err(LightningError{err: "Cannot send a payment of 0 msat".to_owned(), action: ErrorAction::IgnoreError}); } - for route in payee.route_hints.iter() { + for route in payment_params.route_hints.iter() { for hop in &route.0 { - if hop.src_node_id == payee.pubkey { + if hop.src_node_id == payment_params.payee_pubkey { return Err(LightningError{err: "Route hint cannot have the payee as the source.".to_owned(), action: ErrorAction::IgnoreError}); } } @@ -575,7 +651,7 @@ where L::Target: Logger { // any ~sufficient (described later) value. // If succeed, remember which channels were used and how much liquidity they have available, // so that future paths don't rely on the same liquidity. - // 3. Prooceed to the next step if: + // 3. Proceed to the next step if: // - we hit the recommended target value; // - OR if we could not construct a new path. Any next attempt will fail too. // Otherwise, repeat step 2. @@ -593,7 +669,7 @@ where L::Target: Logger { // // We are not a faithful Dijkstra's implementation because we can change values which impact // earlier nodes while processing later nodes. Specifically, if we reach a channel with a lower - // liquidity limit (via htlc_maximum_msat, on-chain capacity or assumed liquidity limits) then + // liquidity limit (via htlc_maximum_msat, on-chain capacity or assumed liquidity limits) than // the value we are currently attempting to send over a path, we simply reduce the value being // sent along the path for any hops after that channel. This may imply that later fees (which // we've already tabulated) are lower because a smaller value is passing through the channels @@ -632,20 +708,11 @@ where L::Target: Logger { let network_graph = network.read_only(); let network_channels = network_graph.channels(); let network_nodes = network_graph.nodes(); - let dummy_directional_info = DummyDirectionalChannelInfo { // used for first_hops routes - cltv_expiry_delta: 0, - htlc_minimum_msat: 0, - htlc_maximum_msat: None, - fees: RoutingFees { - base_msat: 0, - proportional_millionths: 0, - } - }; // Allow MPP only if we have a features set from somewhere that indicates the payee supports // it. If the payee supports it they're supposed to include it in the invoice, so that should // work reliably. - let allow_mpp = if let Some(features) = &payee.features { + let allow_mpp = if let Some(features) = &payment_params.features { features.supports_basic_mpp() } else if let Some(node) = network_nodes.get(&payee_node_id) { if let Some(node_info) = node.announcement_info.as_ref() { @@ -653,30 +720,32 @@ where L::Target: Logger { } else { false } } else { false }; log_trace!(logger, "Searching for a route from payer {} to payee {} {} MPP", our_node_pubkey, - payee.pubkey, if allow_mpp { "with" } else { "without" }); + payment_params.payee_pubkey, if allow_mpp { "with" } else { "without" }); // Step (1). // Prepare the data we'll use for payee-to-payer search by // inserting first hops suggested by the caller as targets. // Our search will then attempt to reach them while traversing from the payee node. - let mut first_hop_targets: HashMap<_, Vec<(_, ChannelFeatures, _, NodeFeatures)>> = + let mut first_hop_targets: HashMap<_, Vec<&ChannelDetails>> = HashMap::with_capacity(if first_hops.is_some() { first_hops.as_ref().unwrap().len() } else { 0 }); if let Some(hops) = first_hops { for chan in hops { - let short_channel_id = chan.short_channel_id.expect("first_hops should be filled in with usable channels, not pending ones"); + if chan.short_channel_id.is_none() { + panic!("first_hops should be filled in with usable channels, not pending ones"); + } if chan.counterparty.node_id == *our_node_pubkey { return Err(LightningError{err: "First hop cannot have our_node_pubkey as a destination.".to_owned(), action: ErrorAction::IgnoreError}); } - first_hop_targets.entry(NodeId::from_pubkey(&chan.counterparty.node_id)).or_insert(Vec::new()) - .push((short_channel_id, chan.counterparty.features.to_context(), chan.outbound_capacity_msat, chan.counterparty.features.to_context())); + first_hop_targets + .entry(NodeId::from_pubkey(&chan.counterparty.node_id)) + .or_insert(Vec::new()) + .push(chan); } if first_hop_targets.is_empty() { return Err(LightningError{err: "Cannot route when there are no outbound routes away from us".to_owned(), action: ErrorAction::IgnoreError}); } } - let empty_channel_features = ChannelFeatures::empty(); - // The main heap containing all candidate next-hops sorted by their score (max(A* fee, // htlc_minimum)). Ideally this would be a heap which allowed cheap score reduction instead of // adding duplicate entries when we find a better path to a given node. @@ -703,7 +772,7 @@ where L::Target: Logger { // This map allows paths to be aware of the channel use by other paths in the same call. // This would help to make a better path finding decisions and not "overbook" channels. // It is unaware of the directions (except for `outbound_capacity_msat` in `first_hops`). - let mut bookkeeped_channels_liquidity_available_msat = HashMap::with_capacity(network_nodes.len()); + let mut bookkept_channels_liquidity_available_msat = HashMap::with_capacity(network_nodes.len()); // Keeping track of how much value we already collected across other paths. Helps to decide: // - how much a new path should be transferring (upper bound); @@ -712,45 +781,27 @@ where L::Target: Logger { // - when we want to stop looking for new paths. let mut already_collected_value_msat = 0; - log_trace!(logger, "Building path from {} (payee) to {} (us/payer) for value {} msat.", payee.pubkey, our_node_pubkey, final_value_msat); + log_trace!(logger, "Building path from {} (payee) to {} (us/payer) for value {} msat.", payment_params.payee_pubkey, our_node_pubkey, final_value_msat); macro_rules! add_entry { - // Adds entry which goes from $src_node_id to $dest_node_id - // over the channel with id $chan_id with fees described in - // $directional_info. - // $next_hops_fee_msat represents the fees paid for using all the channel *after* this one, + // Adds entry which goes from $src_node_id to $dest_node_id over the $candidate hop. + // $next_hops_fee_msat represents the fees paid for using all the channels *after* this one, // since that value has to be transferred over this channel. // Returns whether this channel caused an update to `targets`. - ( $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, - $next_hops_value_contribution: expr, $next_hops_path_htlc_minimum_msat: expr, $next_hops_path_penalty_msat: expr ) => { { + ( $candidate: expr, $src_node_id: expr, $dest_node_id: expr, $next_hops_fee_msat: expr, + $next_hops_value_contribution: expr, $next_hops_path_htlc_minimum_msat: expr, + $next_hops_path_penalty_msat: expr, $next_hops_cltv_delta: expr ) => { { // We "return" whether we updated the path at the end, via this: let mut did_add_update_path_to_src_node = false; // Channels to self should not be used. This is more of belt-and-suspenders, because in // practice these cases should be caught earlier: // - for regular channels at channel announcement (TODO) // - for first and last hops early in get_route - if $src_node_id != $dest_node_id.clone() { - let available_liquidity_msat = bookkeeped_channels_liquidity_available_msat.entry($chan_id.clone()).or_insert_with(|| { - let mut initial_liquidity_available_msat = None; - if let Some(capacity_sats) = $capacity_sats { - initial_liquidity_available_msat = Some(capacity_sats * 1000); - } - - if let Some(htlc_maximum_msat) = $directional_info.htlc_maximum_msat { - if let Some(available_msat) = initial_liquidity_available_msat { - initial_liquidity_available_msat = Some(cmp::min(available_msat, htlc_maximum_msat)); - } else { - initial_liquidity_available_msat = Some(htlc_maximum_msat); - } - } - - match initial_liquidity_available_msat { - Some(available_msat) => available_msat, - // We assume channels with unknown balance have - // a capacity of 0.0025 BTC (or 250_000 sats). - None => 250_000 * 1000 - } - }); + if $src_node_id != $dest_node_id { + let short_channel_id = $candidate.short_channel_id(); + let available_liquidity_msat = bookkept_channels_liquidity_available_msat + .entry(short_channel_id) + .or_insert_with(|| $candidate.effective_capacity().as_msat()); // It is tricky to substract $next_hops_fee_msat from available liquidity here. // It may be misleading because we might later choose to reduce the value transferred @@ -784,6 +835,13 @@ where L::Target: Logger { // Verify the liquidity offered by this channel complies to the minimal contribution. let contributes_sufficient_value = available_value_contribution_msat >= minimal_value_contribution_msat; + // Do not consider candidates that exceed the maximum total cltv expiry limit. + let max_total_cltv_expiry_delta = payment_params.max_total_cltv_expiry_delta; + let hop_total_cltv_delta = ($next_hops_cltv_delta as u32) + .checked_add($candidate.cltv_expiry_delta()) + .unwrap_or(u32::max_value()); + let doesnt_exceed_cltv_delta_limit = hop_total_cltv_delta <= max_total_cltv_expiry_delta; + let value_contribution_msat = cmp::min(available_value_contribution_msat, $next_hops_value_contribution); // Includes paying fees for the use of the following channels. let amount_to_transfer_over_msat: u64 = match value_contribution_msat.checked_add($next_hops_fee_msat) { @@ -792,7 +850,7 @@ where L::Target: Logger { None => unreachable!(), }; #[allow(unused_comparisons)] // $next_hops_path_htlc_minimum_msat is 0 in some calls so rustc complains - let over_path_minimum_msat = amount_to_transfer_over_msat >= $directional_info.htlc_minimum_msat && + let over_path_minimum_msat = amount_to_transfer_over_msat >= $candidate.htlc_minimum_msat() && amount_to_transfer_over_msat >= $next_hops_path_htlc_minimum_msat; // If HTLC minimum is larger than the amount we're going to transfer, we shouldn't @@ -800,23 +858,23 @@ where L::Target: Logger { // Since we're choosing amount_to_transfer_over_msat as maximum possible, it can // be only reduced later (not increased), so this channel should just be skipped // as not sufficient. - if !over_path_minimum_msat { + if !over_path_minimum_msat && doesnt_exceed_cltv_delta_limit { hit_minimum_limit = true; - } else if contributes_sufficient_value { + } else if contributes_sufficient_value && doesnt_exceed_cltv_delta_limit { // Note that low contribution here (limited by available_liquidity_msat) // might violate htlc_minimum_msat on the hops which are next along the - // payment path (upstream to the payee). To avoid that, we recompute path + // payment path (upstream to the payee). To avoid that, we recompute // path fees knowing the final path contribution after constructing it. - let path_htlc_minimum_msat = compute_fees($next_hops_path_htlc_minimum_msat, $directional_info.fees) + let path_htlc_minimum_msat = compute_fees($next_hops_path_htlc_minimum_msat, $candidate.fees()) .and_then(|fee_msat| fee_msat.checked_add($next_hops_path_htlc_minimum_msat)) - .map(|fee_msat| cmp::max(fee_msat, $directional_info.htlc_minimum_msat)) + .map(|fee_msat| cmp::max(fee_msat, $candidate.htlc_minimum_msat())) .unwrap_or_else(|| u64::max_value()); let hm_entry = dist.entry($src_node_id); let old_entry = hm_entry.or_insert_with(|| { - // If there was previously no known way to access - // the source node (recall it goes payee-to-payer) of $chan_id, first add - // a semi-dummy record just to compute the fees to reach the source node. - // This will affect our decision on selecting $chan_id + // If there was previously no known way to access the source node + // (recall it goes payee-to-payer) of short_channel_id, first add a + // semi-dummy record just to compute the fees to reach the source node. + // This will affect our decision on selecting short_channel_id // as a way to reach the $dest_node_id. let mut fee_base_msat = u32::max_value(); let mut fee_proportional_millionths = u32::max_value(); @@ -826,30 +884,26 @@ where L::Target: Logger { } PathBuildingHop { node_id: $dest_node_id.clone(), - short_channel_id: 0, - channel_features: $chan_features, + candidate: $candidate.clone(), fee_msat: 0, - cltv_expiry_delta: 0, src_lowest_inbound_fees: RoutingFees { base_msat: fee_base_msat, proportional_millionths: fee_proportional_millionths, }, - channel_fees: $directional_info.fees, next_hops_fee_msat: u64::max_value(), hop_use_fee_msat: u64::max_value(), total_fee_msat: u64::max_value(), - htlc_minimum_msat: $directional_info.htlc_minimum_msat, path_htlc_minimum_msat, path_penalty_msat: u64::max_value(), was_processed: false, - #[cfg(any(test, feature = "fuzztarget"))] + #[cfg(all(not(feature = "_bench_unstable"), any(test, fuzzing)))] value_contribution_msat, } }); #[allow(unused_mut)] // We only use the mut in cfg(test) let mut should_process = !old_entry.was_processed; - #[cfg(any(test, feature = "fuzztarget"))] + #[cfg(all(not(feature = "_bench_unstable"), any(test, fuzzing)))] { // In test/fuzzing builds, we do extra checks to make sure the skipping // of already-seen nodes only happens in cases we expect (see below). @@ -863,7 +917,7 @@ where L::Target: Logger { // Ignore hop_use_fee_msat for channel-from-us as we assume all channels-from-us // will have the same effective-fee if $src_node_id != our_node_id { - match compute_fees(amount_to_transfer_over_msat, $directional_info.fees) { + match compute_fees(amount_to_transfer_over_msat, $candidate.fees()) { // max_value means we'll always fail // the old_entry.total_fee_msat > total_fee_msat check None => total_fee_msat = u64::max_value(), @@ -893,18 +947,19 @@ where L::Target: Logger { } let path_penalty_msat = $next_hops_path_penalty_msat.checked_add( - scorer.channel_penalty_msat($chan_id.clone(), amount_to_transfer_over_msat, Some(*available_liquidity_msat), + scorer.channel_penalty_msat(short_channel_id, amount_to_transfer_over_msat, *available_liquidity_msat, &$src_node_id, &$dest_node_id)).unwrap_or_else(|| u64::max_value()); let new_graph_node = RouteGraphNode { node_id: $src_node_id, lowest_fee_to_peer_through_node: total_fee_msat, lowest_fee_to_node: $next_hops_fee_msat as u64 + hop_use_fee_msat, + total_cltv_delta: hop_total_cltv_delta, value_contribution_msat: value_contribution_msat, path_htlc_minimum_msat, path_penalty_msat, }; - // Update the way of reaching $src_node_id with the given $chan_id (from $dest_node_id), + // Update the way of reaching $src_node_id with the given short_channel_id (from $dest_node_id), // if this way is cheaper than the already known // (considering the cost to "reach" this channel from the route destination, // the cost of using this channel, @@ -933,21 +988,17 @@ where L::Target: Logger { old_entry.hop_use_fee_msat = hop_use_fee_msat; old_entry.total_fee_msat = total_fee_msat; old_entry.node_id = $dest_node_id.clone(); - old_entry.short_channel_id = $chan_id.clone(); - old_entry.channel_features = $chan_features; + old_entry.candidate = $candidate.clone(); old_entry.fee_msat = 0; // This value will be later filled with hop_use_fee_msat of the following channel - old_entry.cltv_expiry_delta = $directional_info.cltv_expiry_delta as u32; - old_entry.channel_fees = $directional_info.fees; - old_entry.htlc_minimum_msat = $directional_info.htlc_minimum_msat; old_entry.path_htlc_minimum_msat = path_htlc_minimum_msat; old_entry.path_penalty_msat = path_penalty_msat; - #[cfg(any(test, feature = "fuzztarget"))] + #[cfg(all(not(feature = "_bench_unstable"), any(test, fuzzing)))] { old_entry.value_contribution_msat = value_contribution_msat; } did_add_update_path_to_src_node = true; } else if old_entry.was_processed && new_cost < old_cost { - #[cfg(any(test, feature = "fuzztarget"))] + #[cfg(all(not(feature = "_bench_unstable"), any(test, fuzzing)))] { // If we're skipping processing a node which was previously // processed even though we found another path to it with a @@ -990,7 +1041,7 @@ where L::Target: Logger { // meaning how much will be paid in fees after this node (to the best of our knowledge). // This data can later be helpful to optimize routing (pay lower fees). macro_rules! add_entries_to_cheapest_to_target_node { - ( $node: expr, $node_id: expr, $fee_to_target_msat: expr, $next_hops_value_contribution: expr, $next_hops_path_htlc_minimum_msat: expr, $next_hops_path_penalty_msat: expr ) => { + ( $node: expr, $node_id: expr, $fee_to_target_msat: expr, $next_hops_value_contribution: expr, $next_hops_path_htlc_minimum_msat: expr, $next_hops_path_penalty_msat: expr, $next_hops_cltv_delta: expr ) => { let skip_node = if let Some(elem) = dist.get_mut(&$node_id) { let was_processed = elem.was_processed; elem.was_processed = true; @@ -1005,8 +1056,9 @@ where L::Target: Logger { if !skip_node { if let Some(first_channels) = first_hop_targets.get(&$node_id) { - for (ref first_hop, ref features, ref outbound_capacity_msat, _) in first_channels { - add_entry!(first_hop, our_node_id, $node_id, dummy_directional_info, Some(outbound_capacity_msat / 1000), features, $fee_to_target_msat, $next_hops_value_contribution, $next_hops_path_htlc_minimum_msat, $next_hops_path_penalty_msat); + for details in first_channels { + let candidate = CandidateRouteHop::FirstHop { details }; + add_entry!(candidate, our_node_id, $node_id, $fee_to_target_msat, $next_hops_value_contribution, $next_hops_path_htlc_minimum_msat, $next_hops_path_penalty_msat, $next_hops_cltv_delta); } } @@ -1020,21 +1072,16 @@ where L::Target: Logger { for chan_id in $node.channels.iter() { let chan = network_channels.get(chan_id).unwrap(); if !chan.features.requires_unknown_bits() { - if chan.node_one == $node_id { - // ie $node is one, ie next hop in A* is two, via the two_to_one channel - if first_hops.is_none() || chan.node_two != our_node_id { - if let Some(two_to_one) = chan.two_to_one.as_ref() { - if two_to_one.enabled { - 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, $next_hops_path_penalty_msat); - } - } - } - } else { - if first_hops.is_none() || chan.node_one != our_node_id{ - if let Some(one_to_two) = chan.one_to_two.as_ref() { - if one_to_two.enabled { - 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, $next_hops_path_penalty_msat); - } + let (directed_channel, source) = + chan.as_directed_to(&$node_id).expect("inconsistent NetworkGraph"); + if first_hops.is_none() || *source != our_node_id { + if let Some(direction) = directed_channel.direction() { + if direction.enabled { + let candidate = CandidateRouteHop::PublicHop { + info: directed_channel.with_update().unwrap(), + short_channel_id: *chan_id, + }; + add_entry!(candidate, *source, $node_id, $fee_to_target_msat, $next_hops_value_contribution, $next_hops_path_htlc_minimum_msat, $next_hops_path_penalty_msat, $next_hops_cltv_delta); } } } @@ -1050,7 +1097,7 @@ where L::Target: Logger { // TODO: diversify by nodes (so that all paths aren't doomed if one node is offline). 'paths_collection: loop { // For every new path, start from scratch, except - // bookkeeped_channels_liquidity_available_msat, which will improve + // bookkept_channels_liquidity_available_msat, which will improve // the further iterations of path finding. Also don't erase first_hop_targets. targets.clear(); dist.clear(); @@ -1059,9 +1106,10 @@ where L::Target: Logger { // If first hop is a private channel and the only way to reach the payee, this is the only // place where it could be added. if let Some(first_channels) = first_hop_targets.get(&payee_node_id) { - for (ref first_hop, ref features, ref outbound_capacity_msat, _) in first_channels { - let added = add_entry!(first_hop, our_node_id, payee_node_id, dummy_directional_info, Some(outbound_capacity_msat / 1000), features, 0, path_value_msat, 0, 0u64); - log_trace!(logger, "{} direct route to payee via SCID {}", if added { "Added" } else { "Skipped" }, first_hop); + for details in first_channels { + let candidate = CandidateRouteHop::FirstHop { details }; + let added = add_entry!(candidate, our_node_id, payee_node_id, 0, path_value_msat, 0, 0u64, 0); + log_trace!(logger, "{} direct route to payee via SCID {}", if added { "Added" } else { "Skipped" }, candidate.short_channel_id()); } } @@ -1074,7 +1122,7 @@ where L::Target: Logger { // If not, targets.pop() will not even let us enter the loop in step 2. None => {}, Some(node) => { - add_entries_to_cheapest_to_target_node!(node, payee_node_id, 0, path_value_msat, 0, 0u64); + add_entries_to_cheapest_to_target_node!(node, payee_node_id, 0, path_value_msat, 0, 0u64, 0); }, } @@ -1082,7 +1130,7 @@ where L::Target: Logger { // If a caller provided us with last hops, add them to routing targets. Since this happens // earlier than general path finding, they will be somewhat prioritized, although currently // it matters only if the fees are exactly the same. - for route in payee.route_hints.iter().filter(|route| !route.0.is_empty()) { + for route in payment_params.route_hints.iter().filter(|route| !route.0.is_empty()) { let first_hop_in_route = &(route.0)[0]; let have_hop_src_in_graph = // Only add the hops in this route to our candidate set if either @@ -1094,41 +1142,36 @@ where L::Target: Logger { // We start building the path from reverse, i.e., from payee // to the first RouteHintHop in the path. let hop_iter = route.0.iter().rev(); - let prev_hop_iter = core::iter::once(&payee.pubkey).chain( + let prev_hop_iter = core::iter::once(&payment_params.payee_pubkey).chain( route.0.iter().skip(1).rev().map(|hop| &hop.src_node_id)); let mut hop_used = true; let mut aggregate_next_hops_fee_msat: u64 = 0; let mut aggregate_next_hops_path_htlc_minimum_msat: u64 = 0; let mut aggregate_next_hops_path_penalty_msat: u64 = 0; + let mut aggregate_next_hops_cltv_delta: u32 = 0; for (idx, (hop, prev_hop_id)) in hop_iter.zip(prev_hop_iter).enumerate() { - // BOLT 11 doesn't allow inclusion of features for the last hop hints, which - // really sucks, cause we're gonna need that eventually. - let hop_htlc_minimum_msat: u64 = hop.htlc_minimum_msat.unwrap_or(0); - - let directional_info = DummyDirectionalChannelInfo { - cltv_expiry_delta: hop.cltv_expiry_delta as u32, - htlc_minimum_msat: hop_htlc_minimum_msat, - htlc_maximum_msat: hop.htlc_maximum_msat, - fees: hop.fees, - }; - - let reqd_channel_cap = if let Some (val) = final_value_msat.checked_add(match idx { - 0 => 999, - _ => aggregate_next_hops_fee_msat.checked_add(999).unwrap_or(u64::max_value()) - }) { Some( val / 1000 ) } else { break; }; // converting from msat or breaking if max ~ infinity - - let src_node_id = NodeId::from_pubkey(&hop.src_node_id); - let dest_node_id = NodeId::from_pubkey(&prev_hop_id); + let source = NodeId::from_pubkey(&hop.src_node_id); + let target = NodeId::from_pubkey(&prev_hop_id); + let candidate = network_channels + .get(&hop.short_channel_id) + .and_then(|channel| channel.as_directed_to(&target)) + .and_then(|(channel, _)| channel.with_update()) + .map(|info| CandidateRouteHop::PublicHop { + info, + short_channel_id: hop.short_channel_id, + }) + .unwrap_or_else(|| CandidateRouteHop::PrivateHop { hint: hop }); + let capacity_msat = candidate.effective_capacity().as_msat(); aggregate_next_hops_path_penalty_msat = aggregate_next_hops_path_penalty_msat - .checked_add(scorer.channel_penalty_msat(hop.short_channel_id, final_value_msat, None, &src_node_id, &dest_node_id)) + .checked_add(scorer.channel_penalty_msat(hop.short_channel_id, final_value_msat, capacity_msat, &source, &target)) .unwrap_or_else(|| u64::max_value()); - // We assume that the recipient only included route hints for routes which had - // sufficient value to route `final_value_msat`. Note that in the case of "0-value" - // invoices where the invoice does not specify value this may not be the case, but - // better to include the hints than not. - if !add_entry!(hop.short_channel_id, src_node_id, dest_node_id, directional_info, reqd_channel_cap, &empty_channel_features, aggregate_next_hops_fee_msat, path_value_msat, aggregate_next_hops_path_htlc_minimum_msat, aggregate_next_hops_path_penalty_msat) { + aggregate_next_hops_cltv_delta = aggregate_next_hops_cltv_delta + .checked_add(hop.cltv_expiry_delta as u32) + .unwrap_or_else(|| u32::max_value()); + + if !add_entry!(candidate, source, target, aggregate_next_hops_fee_msat, path_value_msat, aggregate_next_hops_path_htlc_minimum_msat, aggregate_next_hops_path_penalty_msat, aggregate_next_hops_cltv_delta) { // If this hop was not used then there is no use checking the preceding hops // in the RouteHint. We can break by just searching for a direct channel between // last checked hop and first_hop_targets @@ -1137,8 +1180,9 @@ where L::Target: Logger { // Searching for a direct channel between last checked hop and first_hop_targets if let Some(first_channels) = first_hop_targets.get(&NodeId::from_pubkey(&prev_hop_id)) { - for (ref first_hop, ref features, ref outbound_capacity_msat, _) in first_channels { - add_entry!(first_hop, our_node_id , NodeId::from_pubkey(&prev_hop_id), dummy_directional_info, Some(outbound_capacity_msat / 1000), features, aggregate_next_hops_fee_msat, path_value_msat, aggregate_next_hops_path_htlc_minimum_msat, aggregate_next_hops_path_penalty_msat); + for details in first_channels { + let candidate = CandidateRouteHop::FirstHop { details }; + add_entry!(candidate, our_node_id, NodeId::from_pubkey(&prev_hop_id), aggregate_next_hops_fee_msat, path_value_msat, aggregate_next_hops_path_htlc_minimum_msat, aggregate_next_hops_path_penalty_msat, aggregate_next_hops_cltv_delta); } } @@ -1155,6 +1199,7 @@ where L::Target: Logger { .map_or(None, |inc| inc.checked_add(aggregate_next_hops_fee_msat)); aggregate_next_hops_fee_msat = if let Some(val) = hops_fee { val } else { break; }; + let hop_htlc_minimum_msat = candidate.htlc_minimum_msat(); let hop_htlc_minimum_msat_inc = if let Some(val) = compute_fees(aggregate_next_hops_path_htlc_minimum_msat, hop.fees) { val } else { break; }; let hops_path_htlc_minimum = aggregate_next_hops_path_htlc_minimum_msat .checked_add(hop_htlc_minimum_msat_inc); @@ -1171,8 +1216,9 @@ where L::Target: Logger { // always assumes that the third argument is a node to which we have a // path. if let Some(first_channels) = first_hop_targets.get(&NodeId::from_pubkey(&hop.src_node_id)) { - for (ref first_hop, ref features, ref outbound_capacity_msat, _) in first_channels { - add_entry!(first_hop, our_node_id , NodeId::from_pubkey(&hop.src_node_id), dummy_directional_info, Some(outbound_capacity_msat / 1000), features, aggregate_next_hops_fee_msat, path_value_msat, aggregate_next_hops_path_htlc_minimum_msat, aggregate_next_hops_path_penalty_msat); + for details in first_channels { + let candidate = CandidateRouteHop::FirstHop { details }; + add_entry!(candidate, our_node_id, NodeId::from_pubkey(&hop.src_node_id), aggregate_next_hops_fee_msat, path_value_msat, aggregate_next_hops_path_htlc_minimum_msat, aggregate_next_hops_path_penalty_msat, aggregate_next_hops_cltv_delta); } } } @@ -1195,7 +1241,7 @@ where L::Target: Logger { // Both these cases (and other cases except reaching recommended_value_msat) mean that // paths_collection will be stopped because found_new_path==false. // This is not necessarily a routing failure. - 'path_construction: while let Some(RouteGraphNode { node_id, lowest_fee_to_node, value_contribution_msat, path_htlc_minimum_msat, path_penalty_msat, .. }) = targets.pop() { + 'path_construction: while let Some(RouteGraphNode { node_id, lowest_fee_to_node, total_cltv_delta, value_contribution_msat, path_htlc_minimum_msat, path_penalty_msat, .. }) = targets.pop() { // Since we're going payee-to-payer, hitting our node as a target means we should stop // traversing the graph and arrange the path out of what we found. @@ -1206,9 +1252,9 @@ where L::Target: Logger { 'path_walk: loop { let mut features_set = false; if let Some(first_channels) = first_hop_targets.get(&ordered_hops.last().unwrap().0.node_id) { - for (scid, _, _, ref features) in first_channels { - if *scid == ordered_hops.last().unwrap().0.short_channel_id { - ordered_hops.last_mut().unwrap().1 = features.clone(); + for details in first_channels { + if details.short_channel_id.unwrap() == ordered_hops.last().unwrap().0.candidate.short_channel_id() { + ordered_hops.last_mut().unwrap().1 = details.counterparty.features.to_context(); features_set = true; break; } @@ -1248,12 +1294,10 @@ where L::Target: Logger { // so that fees paid for a HTLC forwarding on the current channel are // associated with the previous channel (where they will be subtracted). ordered_hops.last_mut().unwrap().0.fee_msat = new_entry.hop_use_fee_msat; - ordered_hops.last_mut().unwrap().0.cltv_expiry_delta = new_entry.cltv_expiry_delta; ordered_hops.push((new_entry.clone(), NodeFeatures::empty())); } ordered_hops.last_mut().unwrap().0.fee_msat = value_contribution_msat; ordered_hops.last_mut().unwrap().0.hop_use_fee_msat = 0; - ordered_hops.last_mut().unwrap().0.cltv_expiry_delta = final_cltv_expiry_delta; log_trace!(logger, "Found a path back to us from the target with {} hops contributing up to {} msat: {:?}", ordered_hops.len(), value_contribution_msat, ordered_hops); @@ -1278,7 +1322,7 @@ where L::Target: Logger { // on the same liquidity in future paths. let mut prevented_redundant_path_selection = false; for (payment_hop, _) in payment_path.hops.iter() { - let channel_liquidity_available_msat = bookkeeped_channels_liquidity_available_msat.get_mut(&payment_hop.short_channel_id).unwrap(); + let channel_liquidity_available_msat = bookkept_channels_liquidity_available_msat.get_mut(&payment_hop.candidate.short_channel_id()).unwrap(); let mut spent_on_hop_msat = value_contribution_msat; let next_hops_fee_msat = payment_hop.next_hops_fee_msat; spent_on_hop_msat += next_hops_fee_msat; @@ -1293,9 +1337,9 @@ where L::Target: Logger { // If we weren't capped by hitting a liquidity limit on a channel in the path, // we'll probably end up picking the same path again on the next iteration. // Decrease the available liquidity of a hop in the middle of the path. - let victim_scid = payment_path.hops[(payment_path.hops.len() - 1) / 2].0.short_channel_id; + let victim_scid = payment_path.hops[(payment_path.hops.len() - 1) / 2].0.candidate.short_channel_id(); log_trace!(logger, "Disabling channel {} for future path building iterations to avoid duplicates.", victim_scid); - let victim_liquidity = bookkeeped_channels_liquidity_available_msat.get_mut(&victim_scid).unwrap(); + let victim_liquidity = bookkept_channels_liquidity_available_msat.get_mut(&victim_scid).unwrap(); *victim_liquidity = 0; } @@ -1321,7 +1365,7 @@ where L::Target: Logger { match network_nodes.get(&node_id) { None => {}, Some(node) => { - add_entries_to_cheapest_to_target_node!(node, node_id, lowest_fee_to_node, value_contribution_msat, path_htlc_minimum_msat, path_penalty_msat); + add_entries_to_cheapest_to_target_node!(node, node_id, lowest_fee_to_node, value_contribution_msat, path_htlc_minimum_msat, path_penalty_msat, total_cltv_delta); }, } } @@ -1424,7 +1468,7 @@ where L::Target: Logger { // Now, substract the overpaid value from the most-expensive path. // TODO: this could also be optimized by also sorting by feerate_per_sat_routed, // so that the sender pays less fees overall. And also htlc_minimum_msat. - cur_route.sort_by_key(|path| { path.hops.iter().map(|hop| hop.0.channel_fees.proportional_millionths as u64).sum::() }); + cur_route.sort_by_key(|path| { path.hops.iter().map(|hop| hop.0.candidate.fees().proportional_millionths as u64).sum::() }); let expensive_payment_path = cur_route.first_mut().unwrap(); // We already dropped all the small channels above, meaning all the // remaining channels are larger than remaining overpaid_value_msat. @@ -1442,19 +1486,25 @@ where L::Target: Logger { drawn_routes.sort_by_key(|paths| paths.iter().map(|path| path.get_total_fee_paid_msat()).sum::()); let mut selected_paths = Vec::>>::new(); for payment_path in drawn_routes.first().unwrap() { - selected_paths.push(payment_path.hops.iter().map(|(payment_hop, node_features)| { + let mut path = payment_path.hops.iter().map(|(payment_hop, node_features)| { Ok(RouteHop { pubkey: PublicKey::from_slice(payment_hop.node_id.as_slice()).map_err(|_| LightningError{err: format!("Public key {:?} is invalid", &payment_hop.node_id), action: ErrorAction::IgnoreAndLog(Level::Trace)})?, node_features: node_features.clone(), - short_channel_id: payment_hop.short_channel_id, - channel_features: payment_hop.channel_features.clone(), + short_channel_id: payment_hop.candidate.short_channel_id(), + channel_features: payment_hop.candidate.features(), fee_msat: payment_hop.fee_msat, - cltv_expiry_delta: payment_hop.cltv_expiry_delta, + cltv_expiry_delta: payment_hop.candidate.cltv_expiry_delta(), }) - }).collect()); + }).collect::>(); + // Propagate the cltv_expiry_delta one hop backwards since the delta from the current hop is + // applicable for the previous hop. + path.iter_mut().rev().fold(final_cltv_expiry_delta, |prev_cltv_expiry_delta, hop| { + core::mem::replace(&mut hop.as_mut().unwrap().cltv_expiry_delta, prev_cltv_expiry_delta) + }); + selected_paths.push(path); } - if let Some(features) = &payee.features { + if let Some(features) = &payment_params.features { for path in selected_paths.iter_mut() { if let Ok(route_hop) = path.last_mut().unwrap() { route_hop.node_features = features.to_context(); @@ -1464,17 +1514,17 @@ where L::Target: Logger { let route = Route { paths: selected_paths.into_iter().map(|path| path.into_iter().collect()).collect::, _>>()?, - payee: Some(payee.clone()), + payment_params: Some(payment_params.clone()), }; - log_info!(logger, "Got route to {}: {}", payee.pubkey, log_route!(route)); + log_info!(logger, "Got route to {}: {}", payment_params.payee_pubkey, log_route!(route)); Ok(route) } #[cfg(test)] mod tests { - use routing; + use routing::scoring::{ProbabilisticScorer, ProbabilisticScoringParameters, Score}; use routing::network_graph::{NetworkGraph, NetGraphMsgHandler, NodeId}; - use routing::router::{get_route, Payee, Route, RouteHint, RouteHintHop, RouteHop, RoutingFees}; + use routing::router::{get_route, PaymentParameters, Route, RouteHint, RouteHintHop, RouteHop, RoutingFees}; use chain::transaction::OutPoint; use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures}; use ln::msgs::{ErrorAction, LightningError, OptionalField, UnsignedChannelAnnouncement, ChannelAnnouncement, RoutingMessageHandler, @@ -1482,6 +1532,8 @@ mod tests { use ln::channelmanager; use util::test_utils; use util::ser::Writeable; + #[cfg(c_bindings)] + use util::ser::Writer; use bitcoin::hashes::sha256d::Hash as Sha256dHash; use bitcoin::hashes::Hash; @@ -1513,6 +1565,7 @@ mod tests { short_channel_id, channel_value_satoshis: 0, user_channel_id: 0, + balance_msat: 0, outbound_capacity_msat, inbound_capacity_msat: 42, unspendable_punishment_reserve: None, @@ -1722,7 +1775,7 @@ mod tests { short_channel_id: 2, timestamp: 1, flags: 0, - cltv_expiry_delta: u16::max_value(), + cltv_expiry_delta: (5 << 4) | 3, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: u32::max_value(), @@ -1750,7 +1803,7 @@ mod tests { short_channel_id: 12, timestamp: 1, flags: 0, - cltv_expiry_delta: u16::max_value(), + cltv_expiry_delta: (5 << 4) | 3, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: u32::max_value(), @@ -1778,7 +1831,7 @@ mod tests { short_channel_id: 3, timestamp: 1, flags: 0, - cltv_expiry_delta: (3 << 8) | 1, + cltv_expiry_delta: (3 << 4) | 1, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -1790,7 +1843,7 @@ mod tests { short_channel_id: 3, timestamp: 1, flags: 1, - cltv_expiry_delta: (3 << 8) | 2, + cltv_expiry_delta: (3 << 4) | 2, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 100, @@ -1804,7 +1857,7 @@ mod tests { short_channel_id: 4, timestamp: 1, flags: 0, - cltv_expiry_delta: (4 << 8) | 1, + cltv_expiry_delta: (4 << 4) | 1, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -1816,7 +1869,7 @@ mod tests { short_channel_id: 4, timestamp: 1, flags: 1, - cltv_expiry_delta: (4 << 8) | 2, + cltv_expiry_delta: (4 << 4) | 2, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -1830,7 +1883,7 @@ mod tests { short_channel_id: 13, timestamp: 1, flags: 0, - cltv_expiry_delta: (13 << 8) | 1, + cltv_expiry_delta: (13 << 4) | 1, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -1842,7 +1895,7 @@ mod tests { short_channel_id: 13, timestamp: 1, flags: 1, - cltv_expiry_delta: (13 << 8) | 2, + cltv_expiry_delta: (13 << 4) | 2, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -1858,7 +1911,7 @@ mod tests { short_channel_id: 6, timestamp: 1, flags: 0, - cltv_expiry_delta: (6 << 8) | 1, + cltv_expiry_delta: (6 << 4) | 1, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -1870,7 +1923,7 @@ mod tests { short_channel_id: 6, timestamp: 1, flags: 1, - cltv_expiry_delta: (6 << 8) | 2, + cltv_expiry_delta: (6 << 4) | 2, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -1884,7 +1937,7 @@ mod tests { short_channel_id: 11, timestamp: 1, flags: 0, - cltv_expiry_delta: (11 << 8) | 1, + cltv_expiry_delta: (11 << 4) | 1, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -1896,7 +1949,7 @@ mod tests { short_channel_id: 11, timestamp: 1, flags: 1, - cltv_expiry_delta: (11 << 8) | 2, + cltv_expiry_delta: (11 << 4) | 2, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -1914,7 +1967,7 @@ mod tests { short_channel_id: 7, timestamp: 1, flags: 0, - cltv_expiry_delta: (7 << 8) | 1, + cltv_expiry_delta: (7 << 4) | 1, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -1926,7 +1979,7 @@ mod tests { short_channel_id: 7, timestamp: 1, flags: 1, - cltv_expiry_delta: (7 << 8) | 2, + cltv_expiry_delta: (7 << 4) | 2, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -1943,22 +1996,22 @@ mod tests { fn simple_route_test() { let (secp_ctx, network_graph, _, _, logger) = build_graph(); let (_, our_id, _, nodes) = get_nodes(&secp_ctx); - let payee = Payee::from_node_id(nodes[2]); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[2]); + let scorer = test_utils::TestScorer::with_penalty(0); // Simple route to 2 via 1 - if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payee, &network_graph, None, 0, 42, Arc::clone(&logger), &scorer) { + if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payment_params, &network_graph, None, 0, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Cannot send a payment of 0 msat"); } else { panic!(); } - let route = get_route(&our_id, &payee, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 2); assert_eq!(route.paths[0][0].pubkey, nodes[1]); assert_eq!(route.paths[0][0].short_channel_id, 2); assert_eq!(route.paths[0][0].fee_msat, 100); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2)); @@ -1974,18 +2027,18 @@ mod tests { fn invalid_first_hop_test() { let (secp_ctx, network_graph, _, _, logger) = build_graph(); let (_, our_id, _, nodes) = get_nodes(&secp_ctx); - let payee = Payee::from_node_id(nodes[2]); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[2]); + let scorer = test_utils::TestScorer::with_penalty(0); // Simple route to 2 via 1 let our_chans = vec![get_channel_details(Some(2), our_id, InitFeatures::from_le_bytes(vec![0b11]), 100000)]; - if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payee, &network_graph, Some(&our_chans.iter().collect::>()), 100, 42, Arc::clone(&logger), &scorer) { + if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payment_params, &network_graph, Some(&our_chans.iter().collect::>()), 100, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "First hop cannot have our_node_pubkey as a destination."); } else { panic!(); } - let route = get_route(&our_id, &payee, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 2); } @@ -1993,8 +2046,8 @@ mod tests { fn htlc_minimum_test() { let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let payee = Payee::from_node_id(nodes[2]); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[2]); + let scorer = test_utils::TestScorer::with_penalty(0); // Simple route to 2 via 1 @@ -2091,7 +2144,7 @@ mod tests { }); // Not possible to send 199_999_999, because the minimum on channel=2 is 200_000_000. - if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payee, &network_graph, None, 199_999_999, 42, Arc::clone(&logger), &scorer) { + if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payment_params, &network_graph, None, 199_999_999, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Failed to find a path to the given destination"); } else { panic!(); } @@ -2110,7 +2163,7 @@ mod tests { }); // A payment above the minimum should pass - let route = get_route(&our_id, &payee, &network_graph, None, 199_999_999, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 199_999_999, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 2); } @@ -2118,8 +2171,8 @@ mod tests { fn htlc_minimum_overpay_test() { let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let payee = Payee::from_node_id(nodes[2]).with_features(InvoiceFeatures::known()); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[2]).with_features(InvoiceFeatures::known()); + let scorer = test_utils::TestScorer::with_penalty(0); // A route to node#2 via two paths. // One path allows transferring 35-40 sats, another one also allows 35-40 sats. @@ -2189,7 +2242,7 @@ mod tests { excess_data: Vec::new() }); - let route = get_route(&our_id, &payee, &network_graph, None, 60_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 60_000, 42, Arc::clone(&logger), &scorer).unwrap(); // Overpay fees to hit htlc_minimum_msat. let overpaid_fees = route.paths[0][0].fee_msat + route.paths[1][0].fee_msat; // TODO: this could be better balanced to overpay 10k and not 15k. @@ -2234,14 +2287,14 @@ mod tests { excess_data: Vec::new() }); - let route = get_route(&our_id, &payee, &network_graph, None, 60_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 60_000, 42, Arc::clone(&logger), &scorer).unwrap(); // Fine to overpay for htlc_minimum_msat if it allows us to save fee. assert_eq!(route.paths.len(), 1); assert_eq!(route.paths[0][0].short_channel_id, 12); let fees = route.paths[0][0].fee_msat; assert_eq!(fees, 5_000); - let route = get_route(&our_id, &payee, &network_graph, None, 50_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 50_000, 42, Arc::clone(&logger), &scorer).unwrap(); // Not fine to overpay for htlc_minimum_msat if it requires paying more than fee on // the other channel. assert_eq!(route.paths.len(), 1); @@ -2254,8 +2307,8 @@ mod tests { fn disable_channels_test() { let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let payee = Payee::from_node_id(nodes[2]); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[2]); + let scorer = test_utils::TestScorer::with_penalty(0); // // Disable channels 4 and 12 by flags=2 update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate { @@ -2284,19 +2337,19 @@ mod tests { }); // If all the channels require some features we don't understand, route should fail - if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payee, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer) { + if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Failed to find a path to the given destination"); } else { panic!(); } // If we specify a channel to node7, that overrides our local channel view and that gets used let our_chans = vec![get_channel_details(Some(42), nodes[7].clone(), InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)]; - let route = get_route(&our_id, &payee, &network_graph, Some(&our_chans.iter().collect::>()), 100, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, Some(&our_chans.iter().collect::>()), 100, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 2); assert_eq!(route.paths[0][0].pubkey, nodes[7]); assert_eq!(route.paths[0][0].short_channel_id, 42); assert_eq!(route.paths[0][0].fee_msat, 200); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::::new()); // No feature flags will meet the relevant-to-channel conversion @@ -2312,8 +2365,8 @@ mod tests { fn disable_node_test() { let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let payee = Payee::from_node_id(nodes[2]); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[2]); + let scorer = test_utils::TestScorer::with_penalty(0); // Disable nodes 1, 2, and 8 by requiring unknown feature bits let unknown_features = NodeFeatures::known().set_unknown_feature_required(); @@ -2322,19 +2375,19 @@ mod tests { add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[7], unknown_features.clone(), 1); // If all nodes require some features we don't understand, route should fail - if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payee, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer) { + if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Failed to find a path to the given destination"); } else { panic!(); } // If we specify a channel to node7, that overrides our local channel view and that gets used let our_chans = vec![get_channel_details(Some(42), nodes[7].clone(), InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)]; - let route = get_route(&our_id, &payee, &network_graph, Some(&our_chans.iter().collect::>()), 100, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, Some(&our_chans.iter().collect::>()), 100, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 2); assert_eq!(route.paths[0][0].pubkey, nodes[7]); assert_eq!(route.paths[0][0].short_channel_id, 42); assert_eq!(route.paths[0][0].fee_msat, 200); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); // it should also override our view of their features assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::::new()); // No feature flags will meet the relevant-to-channel conversion @@ -2354,24 +2407,24 @@ mod tests { fn our_chans_test() { let (secp_ctx, network_graph, _, _, logger) = build_graph(); let (_, our_id, _, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let scorer = test_utils::TestScorer::with_penalty(0); // Route to 1 via 2 and 3 because our channel to 1 is disabled - let payee = Payee::from_node_id(nodes[0]); - let route = get_route(&our_id, &payee, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); + let payment_params = PaymentParameters::from_node_id(nodes[0]); + let route = get_route(&our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 3); assert_eq!(route.paths[0][0].pubkey, nodes[1]); assert_eq!(route.paths[0][0].short_channel_id, 2); assert_eq!(route.paths[0][0].fee_msat, 200); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][1].pubkey, nodes[2]); assert_eq!(route.paths[0][1].short_channel_id, 4); assert_eq!(route.paths[0][1].fee_msat, 100); - assert_eq!(route.paths[0][1].cltv_expiry_delta, (3 << 8) | 2); + assert_eq!(route.paths[0][1].cltv_expiry_delta, (3 << 4) | 2); assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3)); assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4)); @@ -2383,15 +2436,15 @@ mod tests { assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(3)); // If we specify a channel to node7, that overrides our local channel view and that gets used - let payee = Payee::from_node_id(nodes[2]); + let payment_params = PaymentParameters::from_node_id(nodes[2]); let our_chans = vec![get_channel_details(Some(42), nodes[7].clone(), InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)]; - let route = get_route(&our_id, &payee, &network_graph, Some(&our_chans.iter().collect::>()), 100, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, Some(&our_chans.iter().collect::>()), 100, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 2); assert_eq!(route.paths[0][0].pubkey, nodes[7]); assert_eq!(route.paths[0][0].short_channel_id, 42); assert_eq!(route.paths[0][0].fee_msat, 200); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::::new()); // No feature flags will meet the relevant-to-channel conversion @@ -2412,7 +2465,7 @@ mod tests { src_node_id: nodes[3], short_channel_id: 8, fees: zero_fees, - cltv_expiry_delta: (8 << 8) | 1, + cltv_expiry_delta: (8 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, } @@ -2423,14 +2476,14 @@ mod tests { base_msat: 1001, proportional_millionths: 0, }, - cltv_expiry_delta: (9 << 8) | 1, + cltv_expiry_delta: (9 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }]), RouteHint(vec![RouteHintHop { src_node_id: nodes[5], short_channel_id: 10, fees: zero_fees, - cltv_expiry_delta: (10 << 8) | 1, + cltv_expiry_delta: (10 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }])] @@ -2448,14 +2501,14 @@ mod tests { base_msat: 100, proportional_millionths: 0, }, - cltv_expiry_delta: (5 << 8) | 1, + cltv_expiry_delta: (5 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }, RouteHintHop { src_node_id: nodes[3], short_channel_id: 8, fees: zero_fees, - cltv_expiry_delta: (8 << 8) | 1, + cltv_expiry_delta: (8 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, } @@ -2466,14 +2519,14 @@ mod tests { base_msat: 1001, proportional_millionths: 0, }, - cltv_expiry_delta: (9 << 8) | 1, + cltv_expiry_delta: (9 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }]), RouteHint(vec![RouteHintHop { src_node_id: nodes[5], short_channel_id: 10, fees: zero_fees, - cltv_expiry_delta: (10 << 8) | 1, + cltv_expiry_delta: (10 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }])] @@ -2483,7 +2536,7 @@ mod tests { fn partial_route_hint_test() { let (secp_ctx, network_graph, _, _, logger) = build_graph(); let (_, our_id, _, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let scorer = test_utils::TestScorer::with_penalty(0); // Simple test across 2, 3, 5, and 4 via a last_hop channel // Tests the behaviour when the RouteHint contains a suboptimal hop. @@ -2497,7 +2550,7 @@ mod tests { base_msat: 1000, proportional_millionths: 0, }, - cltv_expiry_delta: (8 << 8) | 1, + cltv_expiry_delta: (8 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }]); @@ -2505,41 +2558,41 @@ mod tests { let mut invalid_last_hops = last_hops_multi_private_channels(&nodes); invalid_last_hops.push(invalid_last_hop); { - let payee = Payee::from_node_id(nodes[6]).with_route_hints(invalid_last_hops); - if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payee, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer) { + let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(invalid_last_hops); + if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route(&our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Route hint cannot have the payee as the source."); } else { panic!(); } } - let payee = Payee::from_node_id(nodes[6]).with_route_hints(last_hops_multi_private_channels(&nodes)); - let route = get_route(&our_id, &payee, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); + let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops_multi_private_channels(&nodes)); + let route = get_route(&our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 5); assert_eq!(route.paths[0][0].pubkey, nodes[1]); assert_eq!(route.paths[0][0].short_channel_id, 2); assert_eq!(route.paths[0][0].fee_msat, 100); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][1].pubkey, nodes[2]); assert_eq!(route.paths[0][1].short_channel_id, 4); assert_eq!(route.paths[0][1].fee_msat, 0); - assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 8) | 1); + assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 4) | 1); assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3)); assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4)); assert_eq!(route.paths[0][2].pubkey, nodes[4]); assert_eq!(route.paths[0][2].short_channel_id, 6); assert_eq!(route.paths[0][2].fee_msat, 0); - assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 8) | 1); + assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 4) | 1); assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5)); assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6)); assert_eq!(route.paths[0][3].pubkey, nodes[3]); assert_eq!(route.paths[0][3].short_channel_id, 11); assert_eq!(route.paths[0][3].fee_msat, 0); - assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 8) | 1); + assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 4) | 1); // If we have a peer in the node map, we'll use their features here since we don't have // a way of figuring out their features from the invoice: assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4)); @@ -2562,7 +2615,7 @@ mod tests { src_node_id: nodes[3], short_channel_id: 8, fees: zero_fees, - cltv_expiry_delta: (8 << 8) | 1, + cltv_expiry_delta: (8 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }]), RouteHint(vec![ @@ -2571,7 +2624,7 @@ mod tests { src_node_id: nodes[5], short_channel_id: 10, fees: zero_fees, - cltv_expiry_delta: (10 << 8) | 1, + cltv_expiry_delta: (10 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }])] @@ -2581,39 +2634,39 @@ mod tests { fn ignores_empty_last_hops_test() { let (secp_ctx, network_graph, _, _, logger) = build_graph(); let (_, our_id, _, nodes) = get_nodes(&secp_ctx); - let payee = Payee::from_node_id(nodes[6]).with_route_hints(empty_last_hop(&nodes)); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(empty_last_hop(&nodes)); + let scorer = test_utils::TestScorer::with_penalty(0); // Test handling of an empty RouteHint passed in Invoice. - let route = get_route(&our_id, &payee, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 5); assert_eq!(route.paths[0][0].pubkey, nodes[1]); assert_eq!(route.paths[0][0].short_channel_id, 2); assert_eq!(route.paths[0][0].fee_msat, 100); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][1].pubkey, nodes[2]); assert_eq!(route.paths[0][1].short_channel_id, 4); assert_eq!(route.paths[0][1].fee_msat, 0); - assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 8) | 1); + assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 4) | 1); assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3)); assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4)); assert_eq!(route.paths[0][2].pubkey, nodes[4]); assert_eq!(route.paths[0][2].short_channel_id, 6); assert_eq!(route.paths[0][2].fee_msat, 0); - assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 8) | 1); + assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 4) | 1); assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5)); assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6)); assert_eq!(route.paths[0][3].pubkey, nodes[3]); assert_eq!(route.paths[0][3].short_channel_id, 11); assert_eq!(route.paths[0][3].fee_msat, 0); - assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 8) | 1); + assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 4) | 1); // If we have a peer in the node map, we'll use their features here since we don't have // a way of figuring out their features from the invoice: assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4)); @@ -2639,21 +2692,21 @@ mod tests { base_msat: 100, proportional_millionths: 0, }, - cltv_expiry_delta: (5 << 8) | 1, + cltv_expiry_delta: (5 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }, RouteHintHop { src_node_id: nodes[3], short_channel_id: 8, fees: zero_fees, - cltv_expiry_delta: (8 << 8) | 1, + cltv_expiry_delta: (8 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }]), RouteHint(vec![RouteHintHop { src_node_id: nodes[5], short_channel_id: 10, fees: zero_fees, - cltv_expiry_delta: (10 << 8) | 1, + cltv_expiry_delta: (10 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }])] @@ -2663,8 +2716,8 @@ mod tests { fn multi_hint_last_hops_test() { let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (_, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let payee = Payee::from_node_id(nodes[6]).with_route_hints(multi_hint_last_hops(&nodes)); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(multi_hint_last_hops(&nodes)); + let scorer = test_utils::TestScorer::with_penalty(0); // Test through channels 2, 3, 5, 8. // Test shows that multiple hop hints are considered. @@ -2694,27 +2747,27 @@ mod tests { excess_data: Vec::new() }); - let route = get_route(&our_id, &payee, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 4); assert_eq!(route.paths[0][0].pubkey, nodes[1]); assert_eq!(route.paths[0][0].short_channel_id, 2); assert_eq!(route.paths[0][0].fee_msat, 200); - assert_eq!(route.paths[0][0].cltv_expiry_delta, 1025); + assert_eq!(route.paths[0][0].cltv_expiry_delta, 65); assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][1].pubkey, nodes[2]); assert_eq!(route.paths[0][1].short_channel_id, 4); assert_eq!(route.paths[0][1].fee_msat, 100); - assert_eq!(route.paths[0][1].cltv_expiry_delta, 1281); + assert_eq!(route.paths[0][1].cltv_expiry_delta, 81); assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3)); assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4)); assert_eq!(route.paths[0][2].pubkey, nodes[3]); assert_eq!(route.paths[0][2].short_channel_id, 5); assert_eq!(route.paths[0][2].fee_msat, 0); - assert_eq!(route.paths[0][2].cltv_expiry_delta, 2049); + assert_eq!(route.paths[0][2].cltv_expiry_delta, 129); assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(4)); assert_eq!(route.paths[0][2].channel_features.le_flags(), &Vec::::new()); @@ -2735,14 +2788,14 @@ mod tests { src_node_id: nodes[4], short_channel_id: 11, fees: zero_fees, - cltv_expiry_delta: (11 << 8) | 1, + cltv_expiry_delta: (11 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }, RouteHintHop { src_node_id: nodes[3], short_channel_id: 8, fees: zero_fees, - cltv_expiry_delta: (8 << 8) | 1, + cltv_expiry_delta: (8 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }]), RouteHint(vec![RouteHintHop { @@ -2752,14 +2805,14 @@ mod tests { base_msat: 1001, proportional_millionths: 0, }, - cltv_expiry_delta: (9 << 8) | 1, + cltv_expiry_delta: (9 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }]), RouteHint(vec![RouteHintHop { src_node_id: nodes[5], short_channel_id: 10, fees: zero_fees, - cltv_expiry_delta: (10 << 8) | 1, + cltv_expiry_delta: (10 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: None, }])] @@ -2769,43 +2822,43 @@ mod tests { fn last_hops_with_public_channel_test() { let (secp_ctx, network_graph, _, _, logger) = build_graph(); let (_, our_id, _, nodes) = get_nodes(&secp_ctx); - let payee = Payee::from_node_id(nodes[6]).with_route_hints(last_hops_with_public_channel(&nodes)); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops_with_public_channel(&nodes)); + let scorer = test_utils::TestScorer::with_penalty(0); // This test shows that public routes can be present in the invoice // which would be handled in the same manner. - let route = get_route(&our_id, &payee, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 5); assert_eq!(route.paths[0][0].pubkey, nodes[1]); assert_eq!(route.paths[0][0].short_channel_id, 2); assert_eq!(route.paths[0][0].fee_msat, 100); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][1].pubkey, nodes[2]); assert_eq!(route.paths[0][1].short_channel_id, 4); assert_eq!(route.paths[0][1].fee_msat, 0); - assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 8) | 1); + assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 4) | 1); assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3)); assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4)); assert_eq!(route.paths[0][2].pubkey, nodes[4]); assert_eq!(route.paths[0][2].short_channel_id, 6); assert_eq!(route.paths[0][2].fee_msat, 0); - assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 8) | 1); + assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 4) | 1); assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5)); assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6)); assert_eq!(route.paths[0][3].pubkey, nodes[3]); assert_eq!(route.paths[0][3].short_channel_id, 11); assert_eq!(route.paths[0][3].fee_msat, 0); - assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 8) | 1); + assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 4) | 1); // If we have a peer in the node map, we'll use their features here since we don't have // a way of figuring out their features from the invoice: assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4)); - assert_eq!(route.paths[0][3].channel_features.le_flags(), &Vec::::new()); + assert_eq!(route.paths[0][3].channel_features.le_flags(), &id_to_feature_flags(11)); assert_eq!(route.paths[0][4].pubkey, nodes[6]); assert_eq!(route.paths[0][4].short_channel_id, 8); @@ -2819,19 +2872,19 @@ mod tests { fn our_chans_last_hop_connect_test() { let (secp_ctx, network_graph, _, _, logger) = build_graph(); let (_, our_id, _, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let scorer = test_utils::TestScorer::with_penalty(0); // Simple test with outbound channel to 4 to test that last_hops and first_hops connect let our_chans = vec![get_channel_details(Some(42), nodes[3].clone(), InitFeatures::from_le_bytes(vec![0b11]), 250_000_000)]; let mut last_hops = last_hops(&nodes); - let payee = Payee::from_node_id(nodes[6]).with_route_hints(last_hops.clone()); - let route = get_route(&our_id, &payee, &network_graph, Some(&our_chans.iter().collect::>()), 100, 42, Arc::clone(&logger), &scorer).unwrap(); + let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops.clone()); + let route = get_route(&our_id, &payment_params, &network_graph, Some(&our_chans.iter().collect::>()), 100, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 2); assert_eq!(route.paths[0][0].pubkey, nodes[3]); assert_eq!(route.paths[0][0].short_channel_id, 42); assert_eq!(route.paths[0][0].fee_msat, 0); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (8 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (8 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &vec![0b11]); assert_eq!(route.paths[0][0].channel_features.le_flags(), &Vec::::new()); // No feature flags will meet the relevant-to-channel conversion @@ -2845,28 +2898,28 @@ mod tests { last_hops[0].0[0].fees.base_msat = 1000; // Revert to via 6 as the fee on 8 goes up - let payee = Payee::from_node_id(nodes[6]).with_route_hints(last_hops); - let route = get_route(&our_id, &payee, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); + let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops); + let route = get_route(&our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 4); assert_eq!(route.paths[0][0].pubkey, nodes[1]); assert_eq!(route.paths[0][0].short_channel_id, 2); assert_eq!(route.paths[0][0].fee_msat, 200); // fee increased as its % of value transferred across node - assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][1].pubkey, nodes[2]); assert_eq!(route.paths[0][1].short_channel_id, 4); assert_eq!(route.paths[0][1].fee_msat, 100); - assert_eq!(route.paths[0][1].cltv_expiry_delta, (7 << 8) | 1); + assert_eq!(route.paths[0][1].cltv_expiry_delta, (7 << 4) | 1); assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3)); assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4)); assert_eq!(route.paths[0][2].pubkey, nodes[5]); assert_eq!(route.paths[0][2].short_channel_id, 7); assert_eq!(route.paths[0][2].fee_msat, 0); - assert_eq!(route.paths[0][2].cltv_expiry_delta, (10 << 8) | 1); + assert_eq!(route.paths[0][2].cltv_expiry_delta, (10 << 4) | 1); // If we have a peer in the node map, we'll use their features here since we don't have // a way of figuring out their features from the invoice: assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(6)); @@ -2880,34 +2933,34 @@ mod tests { assert_eq!(route.paths[0][3].channel_features.le_flags(), &Vec::::new()); // We can't learn any flags from invoices, sadly // ...but still use 8 for larger payments as 6 has a variable feerate - let route = get_route(&our_id, &payee, &network_graph, None, 2000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 2000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths[0].len(), 5); assert_eq!(route.paths[0][0].pubkey, nodes[1]); assert_eq!(route.paths[0][0].short_channel_id, 2); assert_eq!(route.paths[0][0].fee_msat, 3000); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (4 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(2)); assert_eq!(route.paths[0][1].pubkey, nodes[2]); assert_eq!(route.paths[0][1].short_channel_id, 4); assert_eq!(route.paths[0][1].fee_msat, 0); - assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 8) | 1); + assert_eq!(route.paths[0][1].cltv_expiry_delta, (6 << 4) | 1); assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(3)); assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(4)); assert_eq!(route.paths[0][2].pubkey, nodes[4]); assert_eq!(route.paths[0][2].short_channel_id, 6); assert_eq!(route.paths[0][2].fee_msat, 0); - assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 8) | 1); + assert_eq!(route.paths[0][2].cltv_expiry_delta, (11 << 4) | 1); assert_eq!(route.paths[0][2].node_features.le_flags(), &id_to_feature_flags(5)); assert_eq!(route.paths[0][2].channel_features.le_flags(), &id_to_feature_flags(6)); assert_eq!(route.paths[0][3].pubkey, nodes[3]); assert_eq!(route.paths[0][3].short_channel_id, 11); assert_eq!(route.paths[0][3].fee_msat, 1000); - assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 8) | 1); + assert_eq!(route.paths[0][3].cltv_expiry_delta, (8 << 4) | 1); // If we have a peer in the node map, we'll use their features here since we don't have // a way of figuring out their features from the invoice: assert_eq!(route.paths[0][3].node_features.le_flags(), &id_to_feature_flags(4)); @@ -2934,14 +2987,14 @@ mod tests { base_msat: 1000, proportional_millionths: last_hop_fee_prop, }, - cltv_expiry_delta: (8 << 8) | 1, + cltv_expiry_delta: (8 << 4) | 1, htlc_minimum_msat: None, htlc_maximum_msat: last_hop_htlc_max, }]); - let payee = Payee::from_node_id(target_node_id).with_route_hints(vec![last_hops]); + let payment_params = PaymentParameters::from_node_id(target_node_id).with_route_hints(vec![last_hops]); let our_chans = vec![get_channel_details(Some(42), middle_node_id, InitFeatures::from_le_bytes(vec![0b11]), outbound_capacity_msat)]; - let scorer = test_utils::TestScorer::with_fixed_penalty(0); - get_route(&source_node_id, &payee, &NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash()), Some(&our_chans.iter().collect::>()), route_val, 42, &test_utils::TestLogger::new(), &scorer) + let scorer = test_utils::TestScorer::with_penalty(0); + get_route(&source_node_id, &payment_params, &NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash()), Some(&our_chans.iter().collect::>()), route_val, 42, &test_utils::TestLogger::new(), &scorer) } #[test] @@ -2958,7 +3011,7 @@ mod tests { assert_eq!(route.paths[0][0].pubkey, middle_node_id); assert_eq!(route.paths[0][0].short_channel_id, 42); assert_eq!(route.paths[0][0].fee_msat, 1001); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (8 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (8 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &[0b11]); assert_eq!(route.paths[0][0].channel_features.le_flags(), &[0; 0]); // We can't learn any flags from invoices, sadly @@ -2994,8 +3047,8 @@ mod tests { let (secp_ctx, network_graph, mut net_graph_msg_handler, chain_monitor, logger) = build_graph(); let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); - let payee = Payee::from_node_id(nodes[2]).with_features(InvoiceFeatures::known()); + let scorer = test_utils::TestScorer::with_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[2]).with_features(InvoiceFeatures::known()); // We will use a simple single-path route from // our node to node2 via node0: channels {1, 3}. @@ -3059,14 +3112,14 @@ mod tests { { // Attempt to route more than available results in a failure. if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route( - &our_id, &payee, &network_graph, None, 250_000_001, 42, Arc::clone(&logger), &scorer) { + &our_id, &payment_params, &network_graph, None, 250_000_001, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Failed to find a sufficient route to the given destination"); } else { panic!(); } } { // Now, attempt to route an exact amount we have should be fine. - let route = get_route(&our_id, &payee, &network_graph, None, 250_000_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 250_000_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 1); let path = route.paths.last().unwrap(); assert_eq!(path.len(), 2); @@ -3095,14 +3148,14 @@ mod tests { { // Attempt to route more than available results in a failure. if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route( - &our_id, &payee, &network_graph, Some(&our_chans.iter().collect::>()), 200_000_001, 42, Arc::clone(&logger), &scorer) { + &our_id, &payment_params, &network_graph, Some(&our_chans.iter().collect::>()), 200_000_001, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Failed to find a sufficient route to the given destination"); } else { panic!(); } } { // Now, attempt to route an exact amount we have should be fine. - let route = get_route(&our_id, &payee, &network_graph, Some(&our_chans.iter().collect::>()), 200_000_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, Some(&our_chans.iter().collect::>()), 200_000_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 1); let path = route.paths.last().unwrap(); assert_eq!(path.len(), 2); @@ -3142,14 +3195,14 @@ mod tests { { // Attempt to route more than available results in a failure. if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route( - &our_id, &payee, &network_graph, None, 15_001, 42, Arc::clone(&logger), &scorer) { + &our_id, &payment_params, &network_graph, None, 15_001, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Failed to find a sufficient route to the given destination"); } else { panic!(); } } { // Now, attempt to route an exact amount we have should be fine. - let route = get_route(&our_id, &payee, &network_graph, None, 15_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 15_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 1); let path = route.paths.last().unwrap(); assert_eq!(path.len(), 2); @@ -3189,7 +3242,7 @@ mod tests { short_channel_id: 333, timestamp: 1, flags: 0, - cltv_expiry_delta: (3 << 8) | 1, + cltv_expiry_delta: (3 << 4) | 1, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -3201,7 +3254,7 @@ mod tests { short_channel_id: 333, timestamp: 1, flags: 1, - cltv_expiry_delta: (3 << 8) | 2, + cltv_expiry_delta: (3 << 4) | 2, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 100, @@ -3212,14 +3265,14 @@ mod tests { { // Attempt to route more than available results in a failure. if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route( - &our_id, &payee, &network_graph, None, 15_001, 42, Arc::clone(&logger), &scorer) { + &our_id, &payment_params, &network_graph, None, 15_001, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Failed to find a sufficient route to the given destination"); } else { panic!(); } } { // Now, attempt to route an exact amount we have should be fine. - let route = get_route(&our_id, &payee, &network_graph, None, 15_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 15_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 1); let path = route.paths.last().unwrap(); assert_eq!(path.len(), 2); @@ -3244,14 +3297,14 @@ mod tests { { // Attempt to route more than available results in a failure. if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route( - &our_id, &payee, &network_graph, None, 10_001, 42, Arc::clone(&logger), &scorer) { + &our_id, &payment_params, &network_graph, None, 10_001, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Failed to find a sufficient route to the given destination"); } else { panic!(); } } { // Now, attempt to route an exact amount we have should be fine. - let route = get_route(&our_id, &payee, &network_graph, None, 10_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 10_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 1); let path = route.paths.last().unwrap(); assert_eq!(path.len(), 2); @@ -3266,8 +3319,8 @@ mod tests { // one of the latter hops is limited. let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); - let payee = Payee::from_node_id(nodes[3]).with_features(InvoiceFeatures::known()); + let scorer = test_utils::TestScorer::with_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[3]).with_features(InvoiceFeatures::known()); // Path via {node7, node2, node4} is channels {12, 13, 6, 11}. // {12, 13, 11} have the capacities of 100, {6} has a capacity of 50. @@ -3353,14 +3406,14 @@ mod tests { { // Attempt to route more than available results in a failure. if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route( - &our_id, &payee, &network_graph, None, 60_000, 42, Arc::clone(&logger), &scorer) { + &our_id, &payment_params, &network_graph, None, 60_000, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Failed to find a sufficient route to the given destination"); } else { panic!(); } } { // Now, attempt to route 49 sats (just a bit below the capacity). - let route = get_route(&our_id, &payee, &network_graph, None, 49_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 49_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 1); let mut total_amount_paid_msat = 0; for path in &route.paths { @@ -3373,7 +3426,7 @@ mod tests { { // Attempt to route an exact amount is also fine - let route = get_route(&our_id, &payee, &network_graph, None, 50_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 50_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 1); let mut total_amount_paid_msat = 0; for path in &route.paths { @@ -3389,8 +3442,8 @@ mod tests { fn ignore_fee_first_hop_test() { let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); - let payee = Payee::from_node_id(nodes[2]); + let scorer = test_utils::TestScorer::with_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[2]); // Path via node0 is channels {1, 3}. Limit them to 100 and 50 sats (total limit 50). update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate { @@ -3419,7 +3472,7 @@ mod tests { }); { - let route = get_route(&our_id, &payee, &network_graph, None, 50_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 50_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 1); let mut total_amount_paid_msat = 0; for path in &route.paths { @@ -3435,8 +3488,8 @@ mod tests { fn simple_mpp_route_test() { let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); - let payee = Payee::from_node_id(nodes[2]).with_features(InvoiceFeatures::known()); + let scorer = test_utils::TestScorer::with_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[2]).with_features(InvoiceFeatures::known()); // We need a route consisting of 3 paths: // From our node to node2 via node0, node7, node1 (three paths one hop each). @@ -3529,7 +3582,7 @@ mod tests { { // Attempt to route more than available results in a failure. if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route( - &our_id, &payee, &network_graph, None, 300_000, 42, Arc::clone(&logger), &scorer) { + &our_id, &payment_params, &network_graph, None, 300_000, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Failed to find a sufficient route to the given destination"); } else { panic!(); } } @@ -3537,7 +3590,7 @@ mod tests { { // Now, attempt to route 250 sats (just a bit below the capacity). // Our algorithm should provide us with these 3 paths. - let route = get_route(&our_id, &payee, &network_graph, None, 250_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 250_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 3); let mut total_amount_paid_msat = 0; for path in &route.paths { @@ -3550,7 +3603,7 @@ mod tests { { // Attempt to route an exact amount is also fine - let route = get_route(&our_id, &payee, &network_graph, None, 290_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 290_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 3); let mut total_amount_paid_msat = 0; for path in &route.paths { @@ -3566,8 +3619,8 @@ mod tests { fn long_mpp_route_test() { let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); - let payee = Payee::from_node_id(nodes[3]).with_features(InvoiceFeatures::known()); + let scorer = test_utils::TestScorer::with_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[3]).with_features(InvoiceFeatures::known()); // We need a route consisting of 3 paths: // From our node to node3 via {node0, node2}, {node7, node2, node4} and {node7, node2}. @@ -3703,7 +3756,7 @@ mod tests { { // Attempt to route more than available results in a failure. if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route( - &our_id, &payee, &network_graph, None, 350_000, 42, Arc::clone(&logger), &scorer) { + &our_id, &payment_params, &network_graph, None, 350_000, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Failed to find a sufficient route to the given destination"); } else { panic!(); } } @@ -3711,7 +3764,7 @@ mod tests { { // Now, attempt to route 300 sats (exact amount we can route). // Our algorithm should provide us with these 3 paths, 100 sats each. - let route = get_route(&our_id, &payee, &network_graph, None, 300_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 300_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 3); let mut total_amount_paid_msat = 0; @@ -3728,8 +3781,8 @@ mod tests { fn mpp_cheaper_route_test() { let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); - let payee = Payee::from_node_id(nodes[3]).with_features(InvoiceFeatures::known()); + let scorer = test_utils::TestScorer::with_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[3]).with_features(InvoiceFeatures::known()); // This test checks that if we have two cheaper paths and one more expensive path, // so that liquidity-wise any 2 of 3 combination is sufficient, @@ -3869,7 +3922,7 @@ mod tests { { // Now, attempt to route 180 sats. // Our algorithm should provide us with these 2 paths. - let route = get_route(&our_id, &payee, &network_graph, None, 180_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 180_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 2); let mut total_value_transferred_msat = 0; @@ -3895,8 +3948,8 @@ mod tests { // if the fee is not properly accounted for, the behavior is different. let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); - let payee = Payee::from_node_id(nodes[3]).with_features(InvoiceFeatures::known()); + let scorer = test_utils::TestScorer::with_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[3]).with_features(InvoiceFeatures::known()); // We need a route consisting of 2 paths: // From our node to node3 via {node0, node2} and {node7, node2, node4}. @@ -4037,14 +4090,14 @@ mod tests { { // Attempt to route more than available results in a failure. if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route( - &our_id, &payee, &network_graph, None, 210_000, 42, Arc::clone(&logger), &scorer) { + &our_id, &payment_params, &network_graph, None, 210_000, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Failed to find a sufficient route to the given destination"); } else { panic!(); } } { // Now, attempt to route 200 sats (exact amount we can route). - let route = get_route(&our_id, &payee, &network_graph, None, 200_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 200_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 2); let mut total_amount_paid_msat = 0; @@ -4055,7 +4108,105 @@ mod tests { assert_eq!(total_amount_paid_msat, 200_000); assert_eq!(route.get_total_fees(), 150_000); } + } + + #[test] + fn mpp_with_last_hops() { + // Previously, if we tried to send an MPP payment to a destination which was only reachable + // via a single last-hop route hint, we'd fail to route if we first collected routes + // totaling close but not quite enough to fund the full payment. + // + // This was because we considered last-hop hints to have exactly the sought payment amount + // instead of the amount we were trying to collect, needlessly limiting our path searching + // at the very first hop. + // + // Specifically, this interacted with our "all paths must fund at least 5% of total target" + // criterion to cause us to refuse all routes at the last hop hint which would be considered + // to only have the remaining to-collect amount in available liquidity. + // + // This bug appeared in production in some specific channel configurations. + let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); + let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); + let scorer = test_utils::TestScorer::with_penalty(0); + let payment_params = PaymentParameters::from_node_id(PublicKey::from_slice(&[02; 33]).unwrap()).with_features(InvoiceFeatures::known()) + .with_route_hints(vec![RouteHint(vec![RouteHintHop { + src_node_id: nodes[2], + short_channel_id: 42, + fees: RoutingFees { base_msat: 0, proportional_millionths: 0 }, + cltv_expiry_delta: 42, + htlc_minimum_msat: None, + htlc_maximum_msat: None, + }])]); + + // Keep only two paths from us to nodes[2], both with a 99sat HTLC maximum, with one with + // no fee and one with a 1msat fee. Previously, trying to route 100 sats to nodes[2] here + // would first use the no-fee route and then fail to find a path along the second route as + // we think we can only send up to 1 additional sat over the last-hop but refuse to as its + // under 5% of our payment amount. + update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate { + chain_hash: genesis_block(Network::Testnet).header.block_hash(), + short_channel_id: 1, + timestamp: 2, + flags: 0, + cltv_expiry_delta: (5 << 4) | 5, + htlc_minimum_msat: 0, + htlc_maximum_msat: OptionalField::Present(99_000), + fee_base_msat: u32::max_value(), + fee_proportional_millionths: u32::max_value(), + excess_data: Vec::new() + }); + update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate { + chain_hash: genesis_block(Network::Testnet).header.block_hash(), + short_channel_id: 2, + timestamp: 2, + flags: 0, + cltv_expiry_delta: (5 << 4) | 3, + htlc_minimum_msat: 0, + htlc_maximum_msat: OptionalField::Present(99_000), + fee_base_msat: u32::max_value(), + fee_proportional_millionths: u32::max_value(), + excess_data: Vec::new() + }); + update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[1], UnsignedChannelUpdate { + chain_hash: genesis_block(Network::Testnet).header.block_hash(), + short_channel_id: 4, + timestamp: 2, + flags: 0, + cltv_expiry_delta: (4 << 4) | 1, + htlc_minimum_msat: 0, + htlc_maximum_msat: OptionalField::Absent, + fee_base_msat: 1, + fee_proportional_millionths: 0, + excess_data: Vec::new() + }); + update_channel(&net_graph_msg_handler, &secp_ctx, &privkeys[7], UnsignedChannelUpdate { + chain_hash: genesis_block(Network::Testnet).header.block_hash(), + short_channel_id: 13, + timestamp: 2, + flags: 0|2, // Channel disabled + cltv_expiry_delta: (13 << 4) | 1, + htlc_minimum_msat: 0, + htlc_maximum_msat: OptionalField::Absent, + fee_base_msat: 0, + fee_proportional_millionths: 2000000, + excess_data: Vec::new() + }); + // Get a route for 100 sats and check that we found the MPP route no problem and didn't + // overpay at all. + let route = get_route(&our_id, &payment_params, &network_graph, None, 100_000, 42, Arc::clone(&logger), &scorer).unwrap(); + assert_eq!(route.paths.len(), 2); + // Paths are somewhat randomly ordered, but: + // * the first is channel 2 (1 msat fee) -> channel 4 -> channel 42 + // * the second is channel 1 (0 fee, but 99 sat maximum) -> channel 3 -> channel 42 + assert_eq!(route.paths[0][0].short_channel_id, 2); + assert_eq!(route.paths[0][0].fee_msat, 1); + assert_eq!(route.paths[0][2].fee_msat, 1_000); + assert_eq!(route.paths[1][0].short_channel_id, 1); + assert_eq!(route.paths[1][0].fee_msat, 0); + assert_eq!(route.paths[1][2].fee_msat, 99_000); + assert_eq!(route.get_total_fees(), 1); + assert_eq!(route.get_total_amount(), 100_000); } #[test] @@ -4064,8 +4215,8 @@ mod tests { // path finding we realize that we found more capacity than we need. let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); - let payee = Payee::from_node_id(nodes[2]).with_features(InvoiceFeatures::known()); + let scorer = test_utils::TestScorer::with_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[2]).with_features(InvoiceFeatures::known()); // We need a route consisting of 3 paths: // From our node to node2 via node0, node7, node1 (three paths one hop each). @@ -4157,7 +4308,7 @@ mod tests { { // Attempt to route more than available results in a failure. if let Err(LightningError{err, action: ErrorAction::IgnoreError}) = get_route( - &our_id, &payee, &network_graph, None, 150_000, 42, Arc::clone(&logger), &scorer) { + &our_id, &payment_params, &network_graph, None, 150_000, 42, Arc::clone(&logger), &scorer) { assert_eq!(err, "Failed to find a sufficient route to the given destination"); } else { panic!(); } } @@ -4165,7 +4316,7 @@ mod tests { { // Now, attempt to route 125 sats (just a bit below the capacity of 3 channels). // Our algorithm should provide us with these 3 paths. - let route = get_route(&our_id, &payee, &network_graph, None, 125_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 125_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 3); let mut total_amount_paid_msat = 0; for path in &route.paths { @@ -4178,7 +4329,7 @@ mod tests { { // Attempt to route without the last small cheap channel - let route = get_route(&our_id, &payee, &network_graph, None, 90_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 90_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 2); let mut total_amount_paid_msat = 0; for path in &route.paths { @@ -4221,8 +4372,8 @@ mod tests { let network_graph = Arc::new(NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash())); let net_graph_msg_handler = NetGraphMsgHandler::new(Arc::clone(&network_graph), None, Arc::clone(&logger)); let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); - let payee = Payee::from_node_id(nodes[6]); + let scorer = test_utils::TestScorer::with_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[6]); add_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, &privkeys[1], ChannelFeatures::from_le_bytes(id_to_feature_flags(6)), 6); update_channel(&net_graph_msg_handler, &secp_ctx, &our_privkey, UnsignedChannelUpdate { @@ -4230,7 +4381,7 @@ mod tests { short_channel_id: 6, timestamp: 1, flags: 0, - cltv_expiry_delta: (6 << 8) | 0, + cltv_expiry_delta: (6 << 4) | 0, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -4245,7 +4396,7 @@ mod tests { short_channel_id: 5, timestamp: 1, flags: 0, - cltv_expiry_delta: (5 << 8) | 0, + cltv_expiry_delta: (5 << 4) | 0, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 100, @@ -4260,7 +4411,7 @@ mod tests { short_channel_id: 4, timestamp: 1, flags: 0, - cltv_expiry_delta: (4 << 8) | 0, + cltv_expiry_delta: (4 << 4) | 0, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -4275,7 +4426,7 @@ mod tests { short_channel_id: 3, timestamp: 1, flags: 0, - cltv_expiry_delta: (3 << 8) | 0, + cltv_expiry_delta: (3 << 4) | 0, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -4290,7 +4441,7 @@ mod tests { short_channel_id: 2, timestamp: 1, flags: 0, - cltv_expiry_delta: (2 << 8) | 0, + cltv_expiry_delta: (2 << 4) | 0, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -4304,7 +4455,7 @@ mod tests { short_channel_id: 1, timestamp: 1, flags: 0, - cltv_expiry_delta: (1 << 8) | 0, + cltv_expiry_delta: (1 << 4) | 0, htlc_minimum_msat: 100, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -4315,21 +4466,21 @@ mod tests { { // Now ensure the route flows simply over nodes 1 and 4 to 6. - let route = get_route(&our_id, &payee, &network_graph, None, 10_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 10_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 1); assert_eq!(route.paths[0].len(), 3); assert_eq!(route.paths[0][0].pubkey, nodes[1]); assert_eq!(route.paths[0][0].short_channel_id, 6); assert_eq!(route.paths[0][0].fee_msat, 100); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (5 << 8) | 0); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (5 << 4) | 0); assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(1)); assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(6)); assert_eq!(route.paths[0][1].pubkey, nodes[4]); assert_eq!(route.paths[0][1].short_channel_id, 5); assert_eq!(route.paths[0][1].fee_msat, 0); - assert_eq!(route.paths[0][1].cltv_expiry_delta, (1 << 8) | 0); + assert_eq!(route.paths[0][1].cltv_expiry_delta, (1 << 4) | 0); assert_eq!(route.paths[0][1].node_features.le_flags(), &id_to_feature_flags(4)); assert_eq!(route.paths[0][1].channel_features.le_flags(), &id_to_feature_flags(5)); @@ -4350,8 +4501,8 @@ mod tests { // we calculated fees on a higher value, resulting in us ignoring such paths. let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (our_privkey, our_id, _, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); - let payee = Payee::from_node_id(nodes[2]); + let scorer = test_utils::TestScorer::with_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[2]); // We modify the graph to set the htlc_maximum of channel 2 to below the value we wish to // send. @@ -4373,7 +4524,7 @@ mod tests { short_channel_id: 12, timestamp: 2, flags: 0, - cltv_expiry_delta: (4 << 8) | 1, + cltv_expiry_delta: (4 << 4) | 1, htlc_minimum_msat: 0, htlc_maximum_msat: OptionalField::Present(270_000), fee_base_msat: 0, @@ -4384,14 +4535,14 @@ mod tests { { // Now, attempt to route 90 sats, which is exactly 90 sats at the last hop, plus the // 200% fee charged channel 13 in the 1-to-2 direction. - let route = get_route(&our_id, &payee, &network_graph, None, 90_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 90_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 1); assert_eq!(route.paths[0].len(), 2); assert_eq!(route.paths[0][0].pubkey, nodes[7]); assert_eq!(route.paths[0][0].short_channel_id, 12); assert_eq!(route.paths[0][0].fee_msat, 90_000*2); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(8)); assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(12)); @@ -4412,8 +4563,8 @@ mod tests { // resulting in us thinking there is no possible path, even if other paths exist. let (secp_ctx, network_graph, net_graph_msg_handler, _, logger) = build_graph(); let (our_privkey, our_id, privkeys, nodes) = get_nodes(&secp_ctx); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); - let payee = Payee::from_node_id(nodes[2]).with_features(InvoiceFeatures::known()); + let scorer = test_utils::TestScorer::with_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[2]).with_features(InvoiceFeatures::known()); // We modify the graph to set the htlc_minimum of channel 2 and 4 as needed - channel 2 // gets an htlc_maximum_msat of 80_000 and channel 4 an htlc_minimum_msat of 90_000. We @@ -4435,7 +4586,7 @@ mod tests { short_channel_id: 4, timestamp: 2, flags: 0, - cltv_expiry_delta: (4 << 8) | 1, + cltv_expiry_delta: (4 << 4) | 1, htlc_minimum_msat: 90_000, htlc_maximum_msat: OptionalField::Absent, fee_base_msat: 0, @@ -4447,14 +4598,14 @@ mod tests { // Now, attempt to route 90 sats, hitting the htlc_minimum on channel 4, but // overshooting the htlc_maximum on channel 2. Thus, we should pick the (absurdly // expensive) channels 12-13 path. - let route = get_route(&our_id, &payee, &network_graph, None, 90_000, 42, Arc::clone(&logger), &scorer).unwrap(); + let route = get_route(&our_id, &payment_params, &network_graph, None, 90_000, 42, Arc::clone(&logger), &scorer).unwrap(); assert_eq!(route.paths.len(), 1); assert_eq!(route.paths[0].len(), 2); assert_eq!(route.paths[0][0].pubkey, nodes[7]); assert_eq!(route.paths[0][0].short_channel_id, 12); assert_eq!(route.paths[0][0].fee_msat, 90_000*2); - assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 8) | 1); + assert_eq!(route.paths[0][0].cltv_expiry_delta, (13 << 4) | 1); assert_eq!(route.paths[0][0].node_features.le_flags(), &id_to_feature_flags(8)); assert_eq!(route.paths[0][0].channel_features.le_flags(), &id_to_feature_flags(12)); @@ -4479,11 +4630,11 @@ mod tests { let (_, our_id, _, nodes) = get_nodes(&secp_ctx); let logger = Arc::new(test_utils::TestLogger::new()); let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash()); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); - let payee = Payee::from_node_id(nodes[0]).with_features(InvoiceFeatures::known()); + let scorer = test_utils::TestScorer::with_penalty(0); + let payment_params = PaymentParameters::from_node_id(nodes[0]).with_features(InvoiceFeatures::known()); { - let route = get_route(&our_id, &payee, &network_graph, Some(&[ + let route = get_route(&our_id, &payment_params, &network_graph, Some(&[ &get_channel_details(Some(3), nodes[0], InitFeatures::known(), 200_000), &get_channel_details(Some(2), nodes[0], InitFeatures::known(), 10_000), ]), 100_000, 42, Arc::clone(&logger), &scorer).unwrap(); @@ -4495,7 +4646,7 @@ mod tests { assert_eq!(route.paths[0][0].fee_msat, 100_000); } { - let route = get_route(&our_id, &payee, &network_graph, Some(&[ + let route = get_route(&our_id, &payment_params, &network_graph, Some(&[ &get_channel_details(Some(3), nodes[0], InitFeatures::known(), 50_000), &get_channel_details(Some(2), nodes[0], InitFeatures::known(), 50_000), ]), 100_000, 42, Arc::clone(&logger), &scorer).unwrap(); @@ -4517,12 +4668,12 @@ mod tests { fn prefers_shorter_route_with_higher_fees() { let (secp_ctx, network_graph, _, _, logger) = build_graph(); let (_, our_id, _, nodes) = get_nodes(&secp_ctx); - let payee = Payee::from_node_id(nodes[6]).with_route_hints(last_hops(&nodes)); + let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops(&nodes)); // Without penalizing each hop 100 msats, a longer path with lower fees is chosen. - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let scorer = test_utils::TestScorer::with_penalty(0); let route = get_route( - &our_id, &payee, &network_graph, None, 100, 42, + &our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer ).unwrap(); let path = route.paths[0].iter().map(|hop| hop.short_channel_id).collect::>(); @@ -4533,9 +4684,9 @@ mod tests { // Applying a 100 msat penalty to each hop results in taking channels 7 and 10 to nodes[6] // from nodes[2] rather than channel 6, 11, and 8, even though the longer path is cheaper. - let scorer = test_utils::TestScorer::with_fixed_penalty(100); + let scorer = test_utils::TestScorer::with_penalty(100); let route = get_route( - &our_id, &payee, &network_graph, None, 100, 42, + &our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer ).unwrap(); let path = route.paths[0].iter().map(|hop| hop.short_channel_id).collect::>(); @@ -4549,36 +4700,47 @@ mod tests { short_channel_id: u64, } - impl routing::Score for BadChannelScorer { - fn channel_penalty_msat(&self, short_channel_id: u64, _send_amt: u64, _chan_amt: Option, _source: &NodeId, _target: &NodeId) -> u64 { + #[cfg(c_bindings)] + impl Writeable for BadChannelScorer { + fn write(&self, _w: &mut W) -> Result<(), ::io::Error> { unimplemented!() } + } + impl Score for BadChannelScorer { + fn channel_penalty_msat(&self, short_channel_id: u64, _send_amt: u64, _capacity_msat: u64, _source: &NodeId, _target: &NodeId) -> u64 { if short_channel_id == self.short_channel_id { u64::max_value() } else { 0 } } fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) {} + fn payment_path_successful(&mut self, _path: &[&RouteHop]) {} } struct BadNodeScorer { node_id: NodeId, } - impl routing::Score for BadNodeScorer { - fn channel_penalty_msat(&self, _short_channel_id: u64, _send_amt: u64, _chan_amt: Option, _source: &NodeId, target: &NodeId) -> u64 { + #[cfg(c_bindings)] + impl Writeable for BadNodeScorer { + fn write(&self, _w: &mut W) -> Result<(), ::io::Error> { unimplemented!() } + } + + impl Score for BadNodeScorer { + fn channel_penalty_msat(&self, _short_channel_id: u64, _send_amt: u64, _capacity_msat: u64, _source: &NodeId, target: &NodeId) -> u64 { if *target == self.node_id { u64::max_value() } else { 0 } } fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) {} + fn payment_path_successful(&mut self, _path: &[&RouteHop]) {} } #[test] fn avoids_routing_through_bad_channels_and_nodes() { let (secp_ctx, network_graph, _, _, logger) = build_graph(); let (_, our_id, _, nodes) = get_nodes(&secp_ctx); - let payee = Payee::from_node_id(nodes[6]).with_route_hints(last_hops(&nodes)); + let payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops(&nodes)); // A path to nodes[6] exists when no penalties are applied to any channel. - let scorer = test_utils::TestScorer::with_fixed_penalty(0); + let scorer = test_utils::TestScorer::with_penalty(0); let route = get_route( - &our_id, &payee, &network_graph, None, 100, 42, + &our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer ).unwrap(); let path = route.paths[0].iter().map(|hop| hop.short_channel_id).collect::>(); @@ -4590,7 +4752,7 @@ mod tests { // A different path to nodes[6] exists if channel 6 cannot be routed over. let scorer = BadChannelScorer { short_channel_id: 6 }; let route = get_route( - &our_id, &payee, &network_graph, None, 100, 42, + &our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer ).unwrap(); let path = route.paths[0].iter().map(|hop| hop.short_channel_id).collect::>(); @@ -4602,7 +4764,7 @@ mod tests { // A path to nodes[6] does not exist if nodes[2] cannot be routed through. let scorer = BadNodeScorer { node_id: NodeId::from_pubkey(&nodes[2]) }; match get_route( - &our_id, &payee, &network_graph, None, 100, 42, + &our_id, &payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer ) { Err(LightningError { err, .. } ) => { @@ -4632,7 +4794,7 @@ mod tests { short_channel_id: 0, fee_msat: 225, cltv_expiry_delta: 0 }, ]], - payee: None, + payment_params: None, }; assert_eq!(route.get_total_fees(), 250); @@ -4665,7 +4827,7 @@ mod tests { short_channel_id: 0, fee_msat: 150, cltv_expiry_delta: 0 }, ]], - payee: None, + payment_params: None, }; assert_eq!(route.get_total_fees(), 200); @@ -4677,12 +4839,40 @@ mod tests { // In an earlier version of `Route::get_total_fees` and `Route::get_total_amount`, they // would both panic if the route was completely empty. We test to ensure they return 0 // here, even though its somewhat nonsensical as a route. - let route = Route { paths: Vec::new(), payee: None }; + let route = Route { paths: Vec::new(), payment_params: None }; assert_eq!(route.get_total_fees(), 0); assert_eq!(route.get_total_amount(), 0); } + #[test] + fn limits_total_cltv_delta() { + let (secp_ctx, network_graph, _, _, logger) = build_graph(); + let (_, our_id, _, nodes) = get_nodes(&secp_ctx); + + let scorer = test_utils::TestScorer::with_penalty(0); + + // Make sure that generally there is at least one route available + let feasible_max_total_cltv_delta = 1008; + let feasible_payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops(&nodes)) + .with_max_total_cltv_expiry_delta(feasible_max_total_cltv_delta); + let route = get_route(&our_id, &feasible_payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer).unwrap(); + let path = route.paths[0].iter().map(|hop| hop.short_channel_id).collect::>(); + assert_ne!(path.len(), 0); + + // But not if we exclude all paths on the basis of their accumulated CLTV delta + let fail_max_total_cltv_delta = 23; + let fail_payment_params = PaymentParameters::from_node_id(nodes[6]).with_route_hints(last_hops(&nodes)) + .with_max_total_cltv_expiry_delta(fail_max_total_cltv_delta); + match get_route(&our_id, &fail_payment_params, &network_graph, None, 100, 42, Arc::clone(&logger), &scorer) + { + Err(LightningError { err, .. } ) => { + assert_eq!(err, "Failed to find a path to the given destination"); + }, + Ok(_) => panic!("Expected error"), + } + } + #[cfg(not(feature = "no-std"))] pub(super) fn random_init_seed() -> u64 { // Because the default HashMap in std pulls OS randomness, we can use it as a (bad) RNG. @@ -4705,7 +4895,6 @@ mod tests { }, }; let graph = NetworkGraph::read(&mut d).unwrap(); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); // First, get 100 (source, destination) pairs for which route-getting actually succeeds... let mut seed = random_init_seed() as usize; @@ -4716,9 +4905,11 @@ mod tests { let src = &PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap(); seed = seed.overflowing_mul(0xdeadbeef).0; let dst = PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap(); - let payee = Payee::from_node_id(dst); + let payment_params = PaymentParameters::from_node_id(dst); let amt = seed as u64 % 200_000_000; - if get_route(src, &payee, &graph, None, amt, 42, &test_utils::TestLogger::new(), &scorer).is_ok() { + let params = ProbabilisticScoringParameters::default(); + let scorer = ProbabilisticScorer::new(params, &graph); + if get_route(src, &payment_params, &graph, None, amt, 42, &test_utils::TestLogger::new(), &scorer).is_ok() { continue 'load_endpoints; } } @@ -4736,7 +4927,6 @@ mod tests { }, }; let graph = NetworkGraph::read(&mut d).unwrap(); - let scorer = test_utils::TestScorer::with_fixed_penalty(0); // First, get 100 (source, destination) pairs for which route-getting actually succeeds... let mut seed = random_init_seed() as usize; @@ -4747,9 +4937,11 @@ mod tests { let src = &PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap(); seed = seed.overflowing_mul(0xdeadbeef).0; let dst = PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap(); - let payee = Payee::from_node_id(dst).with_features(InvoiceFeatures::known()); + let payment_params = PaymentParameters::from_node_id(dst).with_features(InvoiceFeatures::known()); let amt = seed as u64 % 200_000_000; - if get_route(src, &payee, &graph, None, amt, 42, &test_utils::TestLogger::new(), &scorer).is_ok() { + let params = ProbabilisticScoringParameters::default(); + let scorer = ProbabilisticScorer::new(params, &graph); + if get_route(src, &payment_params, &graph, None, amt, 42, &test_utils::TestLogger::new(), &scorer).is_ok() { continue 'load_endpoints; } } @@ -4784,10 +4976,15 @@ pub(crate) mod test_utils { } } -#[cfg(all(test, feature = "unstable", not(feature = "no-std")))] +#[cfg(all(test, feature = "_bench_unstable", not(feature = "no-std")))] mod benches { use super::*; - use routing::scorer::Scorer; + use bitcoin::hashes::Hash; + use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey}; + use chain::transaction::OutPoint; + use ln::channelmanager::{ChannelCounterparty, ChannelDetails}; + use ln::features::{InitFeatures, InvoiceFeatures}; + use routing::scoring::{FixedPenaltyScorer, ProbabilisticScorer, ProbabilisticScoringParameters, Scorer}; use util::logger::{Logger, Record}; use test::Bencher; @@ -4797,50 +4994,98 @@ mod benches { fn log(&self, _record: &Record) {} } - #[bench] - fn generate_routes(bench: &mut Bencher) { + fn read_network_graph() -> NetworkGraph { let mut d = test_utils::get_route_file().unwrap(); - let graph = NetworkGraph::read(&mut d).unwrap(); - let nodes = graph.read_only().nodes().clone(); - let scorer = Scorer::with_fixed_penalty(0); + NetworkGraph::read(&mut d).unwrap() + } - // First, get 100 (source, destination) pairs for which route-getting actually succeeds... - let mut path_endpoints = Vec::new(); - let mut seed: usize = 0xdeadbeef; - 'load_endpoints: for _ in 0..100 { - loop { - seed *= 0xdeadbeef; - let src = PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap(); - seed *= 0xdeadbeef; - let dst = PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap(); - let payee = Payee::from_node_id(dst); - let amt = seed as u64 % 1_000_000; - if get_route(&src, &payee, &graph, None, amt, 42, &DummyLogger{}, &scorer).is_ok() { - path_endpoints.push((src, dst, amt)); - continue 'load_endpoints; - } - } + fn payer_pubkey() -> PublicKey { + let secp_ctx = Secp256k1::new(); + PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()) + } + + #[inline] + fn first_hop(node_id: PublicKey) -> ChannelDetails { + ChannelDetails { + channel_id: [0; 32], + counterparty: ChannelCounterparty { + features: InitFeatures::known(), + node_id, + unspendable_punishment_reserve: 0, + forwarding_info: None, + }, + funding_txo: Some(OutPoint { + txid: bitcoin::Txid::from_slice(&[0; 32]).unwrap(), index: 0 + }), + short_channel_id: Some(1), + channel_value_satoshis: 10_000_000, + user_channel_id: 0, + balance_msat: 10_000_000, + outbound_capacity_msat: 10_000_000, + inbound_capacity_msat: 0, + unspendable_punishment_reserve: None, + confirmations_required: None, + force_close_spend_delay: None, + is_outbound: true, + is_funding_locked: true, + is_usable: true, + is_public: true, } + } - // ...then benchmark finding paths between the nodes we learned. - let mut idx = 0; - bench.iter(|| { - let (src, dst, amt) = path_endpoints[idx % path_endpoints.len()]; - let payee = Payee::from_node_id(dst); - assert!(get_route(&src, &payee, &graph, None, amt, 42, &DummyLogger{}, &scorer).is_ok()); - idx += 1; - }); + #[bench] + fn generate_routes_with_zero_penalty_scorer(bench: &mut Bencher) { + let network_graph = read_network_graph(); + let scorer = FixedPenaltyScorer::with_penalty(0); + generate_routes(bench, &network_graph, scorer, InvoiceFeatures::empty()); } #[bench] - fn generate_mpp_routes(bench: &mut Bencher) { - let mut d = test_utils::get_route_file().unwrap(); - let graph = NetworkGraph::read(&mut d).unwrap(); + fn generate_mpp_routes_with_zero_penalty_scorer(bench: &mut Bencher) { + let network_graph = read_network_graph(); + let scorer = FixedPenaltyScorer::with_penalty(0); + generate_routes(bench, &network_graph, scorer, InvoiceFeatures::known()); + } + + #[bench] + fn generate_routes_with_default_scorer(bench: &mut Bencher) { + let network_graph = read_network_graph(); + let scorer = Scorer::default(); + generate_routes(bench, &network_graph, scorer, InvoiceFeatures::empty()); + } + + #[bench] + fn generate_mpp_routes_with_default_scorer(bench: &mut Bencher) { + let network_graph = read_network_graph(); + let scorer = Scorer::default(); + generate_routes(bench, &network_graph, scorer, InvoiceFeatures::known()); + } + + #[bench] + fn generate_routes_with_probabilistic_scorer(bench: &mut Bencher) { + let network_graph = read_network_graph(); + let params = ProbabilisticScoringParameters::default(); + let scorer = ProbabilisticScorer::new(params, &network_graph); + generate_routes(bench, &network_graph, scorer, InvoiceFeatures::empty()); + } + + #[bench] + fn generate_mpp_routes_with_probabilistic_scorer(bench: &mut Bencher) { + let network_graph = read_network_graph(); + let params = ProbabilisticScoringParameters::default(); + let scorer = ProbabilisticScorer::new(params, &network_graph); + generate_routes(bench, &network_graph, scorer, InvoiceFeatures::known()); + } + + fn generate_routes( + bench: &mut Bencher, graph: &NetworkGraph, mut scorer: S, features: InvoiceFeatures + ) { let nodes = graph.read_only().nodes().clone(); - let scorer = Scorer::with_fixed_penalty(0); + let payer = payer_pubkey(); // First, get 100 (source, destination) pairs for which route-getting actually succeeds... - let mut path_endpoints = Vec::new(); + let mut routes = Vec::new(); + let mut route_endpoints = Vec::new(); let mut seed: usize = 0xdeadbeef; 'load_endpoints: for _ in 0..100 { loop { @@ -4848,21 +5093,37 @@ mod benches { let src = PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap(); seed *= 0xdeadbeef; let dst = PublicKey::from_slice(nodes.keys().skip(seed % nodes.len()).next().unwrap().as_slice()).unwrap(); - let payee = Payee::from_node_id(dst).with_features(InvoiceFeatures::known()); + let params = PaymentParameters::from_node_id(dst).with_features(features.clone()); + let first_hop = first_hop(src); let amt = seed as u64 % 1_000_000; - if get_route(&src, &payee, &graph, None, amt, 42, &DummyLogger{}, &scorer).is_ok() { - path_endpoints.push((src, dst, amt)); + if let Ok(route) = get_route(&payer, ¶ms, &graph, Some(&[&first_hop]), amt, 42, &DummyLogger{}, &scorer) { + routes.push(route); + route_endpoints.push((first_hop, params, amt)); continue 'load_endpoints; } } } + // ...and seed the scorer with success and failure data... + for route in routes { + let amount = route.get_total_amount(); + if amount < 250_000 { + for path in route.paths { + scorer.payment_path_successful(&path.iter().collect::>()); + } + } else if amount > 750_000 { + for path in route.paths { + let short_channel_id = path[path.len() / 2].short_channel_id; + scorer.payment_path_failed(&path.iter().collect::>(), short_channel_id); + } + } + } + // ...then benchmark finding paths between the nodes we learned. let mut idx = 0; bench.iter(|| { - let (src, dst, amt) = path_endpoints[idx % path_endpoints.len()]; - let payee = Payee::from_node_id(dst).with_features(InvoiceFeatures::known()); - assert!(get_route(&src, &payee, &graph, None, amt, 42, &DummyLogger{}, &scorer).is_ok()); + let (first_hop, params, amt) = &route_endpoints[idx % route_endpoints.len()]; + assert!(get_route(&payer, params, &graph, Some(&[first_hop]), *amt, 42, &DummyLogger{}, &scorer).is_ok()); idx += 1; }); }