_ Git - rust-lightning/blob - lightning/src/ln/payment_tests.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Tests that test the payment retry logic in ChannelManager, including various edge-cases around
  11 //! serialization ordering between ChannelManager/ChannelMonitors and ensuring we can still retry
  12 //! payments thereafter.
  13
  14 use crate::chain::{ChannelMonitorUpdateStatus, Confirm, Listen, Watch};
  15 use crate::chain::channelmonitor::{ANTI_REORG_DELAY, HTLC_FAIL_BACK_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
  16 use crate::sign::EntropySource;
  17 use crate::chain::transaction::OutPoint;
  18 use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason, PaymentPurpose};
  19 use crate::ln::channel::{EXPIRE_PREV_CONFIG_TICKS, commit_tx_fee_msat, get_holder_selected_channel_reserve_satoshis, ANCHOR_OUTPUT_VALUE_SATOSHI};
  20 use crate::ln::channelmanager::{BREAKDOWN_TIMEOUT, MPP_TIMEOUT_TICKS, MIN_CLTV_EXPIRY_DELTA, PaymentId, PaymentSendFailure, RecentPaymentDetails, RecipientOnionFields, HTLCForwardInfo, PendingHTLCRouting, PendingAddHTLCInfo};
  21 use crate::ln::features::{Bolt11InvoiceFeatures, ChannelTypeFeatures};
  22 use crate::ln::{msgs, ChannelId, PaymentHash, PaymentSecret, PaymentPreimage};
  23 use crate::ln::msgs::ChannelMessageHandler;
  24 use crate::ln::onion_utils;
  25 use crate::ln::outbound_payment::{IDEMPOTENCY_TIMEOUT_TICKS, Retry};
  26 use crate::routing::gossip::{EffectiveCapacity, RoutingFees};
  27 use crate::routing::router::{get_route, Path, PaymentParameters, Route, Router, RouteHint, RouteHintHop, RouteHop, RouteParameters, find_route};
  28 use crate::routing::scoring::ChannelUsage;
  29 use crate::util::config::UserConfig;
  30 use crate::util::test_utils;
  31 use crate::util::errors::APIError;
  32 use crate::util::ser::Writeable;
  33 use crate::util::string::UntrustedString;
  34
  35 use bitcoin::hashes::Hash;
  36 use bitcoin::hashes::sha256::Hash as Sha256;
  37 use bitcoin::network::constants::Network;
  38 use bitcoin::secp256k1::{Secp256k1, SecretKey};
  39
  40 use crate::prelude::*;
  41
  42 use crate::ln::functional_test_utils;
  43 use crate::ln::functional_test_utils::*;
  44 use crate::routing::gossip::NodeId;
  45
  46 #[cfg(feature = "std")]
  47 use {
  48         crate::util::time::tests::SinceEpoch,
  49         std::time::{SystemTime, Instant, Duration},
  50 };
  51
  52 #[test]
  53 fn mpp_failure() {
  54         let chanmon_cfgs = create_chanmon_cfgs(4);
  55         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
  56         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
  57         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
  58
  59         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
  60         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
  61         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
  62         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
  63
  64         let (mut route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
  65         let path = route.paths[0].clone();
  66         route.paths.push(path);
  67         route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
  68         route.paths[0].hops[0].short_channel_id = chan_1_id;
  69         route.paths[0].hops[1].short_channel_id = chan_3_id;
  70         route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
  71         route.paths[1].hops[0].short_channel_id = chan_2_id;
  72         route.paths[1].hops[1].short_channel_id = chan_4_id;
  73         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
  74         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
  75 }
  76
  77 #[test]
  78 fn mpp_retry() {
  79         let chanmon_cfgs = create_chanmon_cfgs(4);
  80         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
  81         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
  82         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
  83
  84         let (chan_1_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 1);
  85         let (chan_2_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 2);
  86         let (chan_3_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 1, 3);
  87         let (chan_4_update, _, chan_4_id, _) = create_announced_chan_between_nodes(&nodes, 3, 2);
  88         // Rebalance
  89         send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
  90
  91         let amt_msat = 1_000_000;
  92         let max_total_routing_fee_msat = 50_000;
  93         let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
  94                 .with_bolt11_features(nodes[3].node.bolt11_invoice_features()).unwrap();
  95         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(
  96                 nodes[0], nodes[3], payment_params, amt_msat, Some(max_total_routing_fee_msat));
  97         let path = route.paths[0].clone();
  98         route.paths.push(path);
  99         route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
 100         route.paths[0].hops[0].short_channel_id = chan_1_update.contents.short_channel_id;
 101         route.paths[0].hops[1].short_channel_id = chan_3_update.contents.short_channel_id;
 102         route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
 103         route.paths[1].hops[0].short_channel_id = chan_2_update.contents.short_channel_id;
 104         route.paths[1].hops[1].short_channel_id = chan_4_update.contents.short_channel_id;
 105
 106         // Initiate the MPP payment.
 107         let payment_id = PaymentId(payment_hash.0);
 108         let mut route_params = route.route_params.clone().unwrap();
 109
 110         nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
 111         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
 112                 payment_id, route_params.clone(), Retry::Attempts(1)).unwrap();
 113         check_added_monitors!(nodes[0], 2); // one monitor per path
 114         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 115         assert_eq!(events.len(), 2);
 116
 117         // Pass half of the payment along the success path.
 118         let success_path_msgs = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 119         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), success_path_msgs, false, None);
 120
 121         // Add the HTLC along the first hop.
 122         let fail_path_msgs_1 = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
 123         let send_event = SendEvent::from_event(fail_path_msgs_1);
 124         nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
 125         commitment_signed_dance!(nodes[2], nodes[0], &send_event.commitment_msg, false);
 126
 127         // Attempt to forward the payment and complete the 2nd path's failure.
 128         expect_pending_htlcs_forwardable!(&nodes[2]);
 129         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[2], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_4_id }]);
 130         let htlc_updates = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
 131         assert!(htlc_updates.update_add_htlcs.is_empty());
 132         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
 133         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
 134         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
 135         check_added_monitors!(nodes[2], 1);
 136         nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
 137         commitment_signed_dance!(nodes[0], nodes[2], htlc_updates.commitment_signed, false);
 138         let mut events = nodes[0].node.get_and_clear_pending_events();
 139         match events[1] {
 140                 Event::PendingHTLCsForwardable { .. } => {},
 141                 _ => panic!("Unexpected event")
 142         }
 143         events.remove(1);
 144         expect_payment_failed_conditions_event(events, payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
 145
 146         // Rebalance the channel so the second half of the payment can succeed.
 147         send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
 148
 149         // Retry the second half of the payment and make sure it succeeds.
 150         route.paths.remove(0);
 151         route_params.final_value_msat = 1_000_000;
 152         route_params.payment_params.previously_failed_channels.push(chan_4_update.contents.short_channel_id);
 153         // Check the remaining max total routing fee for the second attempt is 50_000 - 1_000 msat fee
 154         // used by the first path
 155         route_params.max_total_routing_fee_msat = Some(max_total_routing_fee_msat - 1_000);
 156         route.route_params = Some(route_params.clone());
 157         nodes[0].router.expect_find_route(route_params, Ok(route));
 158         nodes[0].node.process_pending_htlc_forwards();
 159         check_added_monitors!(nodes[0], 1);
 160         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 161         assert_eq!(events.len(), 1);
 162         pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
 163         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
 164 }
 165
 166 #[test]
 167 fn mpp_retry_overpay() {
 168         // We create an MPP scenario with two paths in which we need to overpay to reach
 169         // htlc_minimum_msat. We then fail the overpaid path and check that on retry our
 170         // max_total_routing_fee_msat only accounts for the path's fees, but not for the fees overpaid
 171         // in the first attempt.
 172         let chanmon_cfgs = create_chanmon_cfgs(4);
 173         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 174         let mut user_config = test_default_channel_config();
 175         user_config.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 100;
 176         let mut limited_config_1 = user_config.clone();
 177         limited_config_1.channel_handshake_config.our_htlc_minimum_msat = 35_000_000;
 178         let mut limited_config_2 = user_config.clone();
 179         limited_config_2.channel_handshake_config.our_htlc_minimum_msat = 34_500_000;
 180         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
 181                 &[Some(user_config), Some(limited_config_1), Some(limited_config_2), Some(user_config)]);
 182         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 183
 184         let (chan_1_update, _, _, _) = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 40_000, 0);
 185         let (chan_2_update, _, _, _) = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 40_000, 0);
 186         let (_chan_3_update, _, _, _) = create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 40_000, 0);
 187         let (chan_4_update, _, chan_4_id, _) = create_announced_chan_between_nodes_with_value(&nodes, 3, 2, 40_000, 0);
 188
 189         let amt_msat = 70_000_000;
 190         let max_total_routing_fee_msat = Some(1_000_000);
 191
 192         let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
 193                 .with_bolt11_features(nodes[3].node.bolt11_invoice_features()).unwrap();
 194         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(
 195                 nodes[0], nodes[3], payment_params, amt_msat, max_total_routing_fee_msat);
 196
 197         // Check we overpay on the second path which we're about to fail.
 198         assert_eq!(chan_1_update.contents.fee_proportional_millionths, 0);
 199         let overpaid_amount_1 = route.paths[0].fee_msat() as u32 - chan_1_update.contents.fee_base_msat;
 200         assert_eq!(overpaid_amount_1, 0);
 201
 202         assert_eq!(chan_2_update.contents.fee_proportional_millionths, 0);
 203         let overpaid_amount_2 = route.paths[1].fee_msat() as u32 - chan_2_update.contents.fee_base_msat;
 204
 205         let total_overpaid_amount = overpaid_amount_1 + overpaid_amount_2;
 206
 207         // Initiate the payment.
 208         let payment_id = PaymentId(payment_hash.0);
 209         let mut route_params = route.route_params.clone().unwrap();
 210
 211         nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
 212         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
 213                 payment_id, route_params.clone(), Retry::Attempts(1)).unwrap();
 214         check_added_monitors!(nodes[0], 2); // one monitor per path
 215         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 216         assert_eq!(events.len(), 2);
 217
 218         // Pass half of the payment along the success path.
 219         let success_path_msgs = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 220         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], amt_msat, payment_hash,
 221                 Some(payment_secret), success_path_msgs, false, None);
 222
 223         // Add the HTLC along the first hop.
 224         let fail_path_msgs_1 = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
 225         let send_event = SendEvent::from_event(fail_path_msgs_1);
 226         nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
 227         commitment_signed_dance!(nodes[2], nodes[0], &send_event.commitment_msg, false);
 228
 229         // Attempt to forward the payment and complete the 2nd path's failure.
 230         expect_pending_htlcs_forwardable!(&nodes[2]);
 231         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[2],
 232                 vec![HTLCDestination::NextHopChannel {
 233                         node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_4_id
 234                 }]
 235         );
 236         let htlc_updates = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
 237         assert!(htlc_updates.update_add_htlcs.is_empty());
 238         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
 239         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
 240         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
 241         check_added_monitors!(nodes[2], 1);
 242         nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(),
 243                 &htlc_updates.update_fail_htlcs[0]);
 244         commitment_signed_dance!(nodes[0], nodes[2], htlc_updates.commitment_signed, false);
 245         let mut events = nodes[0].node.get_and_clear_pending_events();
 246         match events[1] {
 247                 Event::PendingHTLCsForwardable { .. } => {},
 248                 _ => panic!("Unexpected event")
 249         }
 250         events.remove(1);
 251         expect_payment_failed_conditions_event(events, payment_hash, false,
 252                 PaymentFailedConditions::new().mpp_parts_remain());
 253
 254         // Rebalance the channel so the second half of the payment can succeed.
 255         send_payment(&nodes[3], &vec!(&nodes[2])[..], 38_000_000);
 256
 257         // Retry the second half of the payment and make sure it succeeds.
 258         let first_path_value = route.paths[0].final_value_msat();
 259         assert_eq!(first_path_value, 36_000_000);
 260
 261         route.paths.remove(0);
 262         route_params.final_value_msat -= first_path_value;
 263         route_params.payment_params.previously_failed_channels.push(chan_4_update.contents.short_channel_id);
 264         // Check the remaining max total routing fee for the second attempt accounts only for 1_000 msat
 265         // base fee, but not for overpaid value of the first try.
 266         route_params.max_total_routing_fee_msat.as_mut().map(|m| *m -= 1000);
 267
 268         route.route_params = Some(route_params.clone());
 269         nodes[0].router.expect_find_route(route_params, Ok(route));
 270         nodes[0].node.process_pending_htlc_forwards();
 271
 272         check_added_monitors!(nodes[0], 1);
 273         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 274         assert_eq!(events.len(), 1);
 275         pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], amt_msat, payment_hash,
 276                 Some(payment_secret), events.pop().unwrap(), true, None);
 277
 278         // Can't use claim_payment_along_route as it doesn't support overpayment, so we break out the
 279         // individual steps here.
 280         nodes[3].node.claim_funds(payment_preimage);
 281         let extra_fees = vec![0, total_overpaid_amount];
 282         let expected_route = &[&[&nodes[1], &nodes[3]][..], &[&nodes[2], &nodes[3]][..]];
 283         let args = ClaimAlongRouteArgs::new(&nodes[0], &expected_route[..], payment_preimage)
 284                 .with_expected_min_htlc_overpay(extra_fees);
 285         let expected_total_fee_msat = pass_claimed_payment_along_route(args);
 286         expect_payment_sent!(&nodes[0], payment_preimage, Some(expected_total_fee_msat));
 287 }
 288
 289 fn do_mpp_receive_timeout(send_partial_mpp: bool) {
 290         let chanmon_cfgs = create_chanmon_cfgs(4);
 291         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 292         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 293         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 294
 295         let (chan_1_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 1);
 296         let (chan_2_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 2);
 297         let (chan_3_update, _, chan_3_id, _) = create_announced_chan_between_nodes(&nodes, 1, 3);
 298         let (chan_4_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 2, 3);
 299
 300         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 100_000);
 301         let path = route.paths[0].clone();
 302         route.paths.push(path);
 303         route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
 304         route.paths[0].hops[0].short_channel_id = chan_1_update.contents.short_channel_id;
 305         route.paths[0].hops[1].short_channel_id = chan_3_update.contents.short_channel_id;
 306         route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
 307         route.paths[1].hops[0].short_channel_id = chan_2_update.contents.short_channel_id;
 308         route.paths[1].hops[1].short_channel_id = chan_4_update.contents.short_channel_id;
 309
 310         // Initiate the MPP payment.
 311         nodes[0].node.send_payment_with_route(&route, payment_hash,
 312                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
 313         check_added_monitors!(nodes[0], 2); // one monitor per path
 314         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 315         assert_eq!(events.len(), 2);
 316
 317         // Pass half of the payment along the first path.
 318         let node_1_msgs = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 319         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 200_000, payment_hash, Some(payment_secret), node_1_msgs, false, None);
 320
 321         if send_partial_mpp {
 322                 // Time out the partial MPP
 323                 for _ in 0..MPP_TIMEOUT_TICKS {
 324                         nodes[3].node.timer_tick_occurred();
 325                 }
 326
 327                 // Failed HTLC from node 3 -> 1
 328                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], vec![HTLCDestination::FailedPayment { payment_hash }]);
 329                 let htlc_fail_updates_3_1 = get_htlc_update_msgs!(nodes[3], nodes[1].node.get_our_node_id());
 330                 assert_eq!(htlc_fail_updates_3_1.update_fail_htlcs.len(), 1);
 331                 nodes[1].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &htlc_fail_updates_3_1.update_fail_htlcs[0]);
 332                 check_added_monitors!(nodes[3], 1);
 333                 commitment_signed_dance!(nodes[1], nodes[3], htlc_fail_updates_3_1.commitment_signed, false);
 334
 335                 // Failed HTLC from node 1 -> 0
 336                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_3_id }]);
 337                 let htlc_fail_updates_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 338                 assert_eq!(htlc_fail_updates_1_0.update_fail_htlcs.len(), 1);
 339                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates_1_0.update_fail_htlcs[0]);
 340                 check_added_monitors!(nodes[1], 1);
 341                 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates_1_0.commitment_signed, false);
 342
 343                 expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain().expected_htlc_error_data(23, &[][..]));
 344         } else {
 345                 // Pass half of the payment along the second path.
 346                 let node_2_msgs = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
 347                 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash, Some(payment_secret), node_2_msgs, true, None);
 348
 349                 // Even after MPP_TIMEOUT_TICKS we should not timeout the MPP if we have all the parts
 350                 for _ in 0..MPP_TIMEOUT_TICKS {
 351                         nodes[3].node.timer_tick_occurred();
 352                 }
 353
 354                 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
 355         }
 356 }
 357
 358 #[test]
 359 fn mpp_receive_timeout() {
 360         do_mpp_receive_timeout(true);
 361         do_mpp_receive_timeout(false);
 362 }
 363
 364 #[test]
 365 fn test_keysend_payments() {
 366         do_test_keysend_payments(false, false);
 367         do_test_keysend_payments(false, true);
 368         do_test_keysend_payments(true, false);
 369         do_test_keysend_payments(true, true);
 370 }
 371
 372 fn do_test_keysend_payments(public_node: bool, with_retry: bool) {
 373         let chanmon_cfgs = create_chanmon_cfgs(2);
 374         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 375         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 376         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 377
 378         if public_node {
 379                 create_announced_chan_between_nodes(&nodes, 0, 1);
 380         } else {
 381                 create_chan_between_nodes(&nodes[0], &nodes[1]);
 382         }
 383         let payer_pubkey = nodes[0].node.get_our_node_id();
 384         let payee_pubkey = nodes[1].node.get_our_node_id();
 385         let route_params = RouteParameters::from_payment_params_and_value(
 386                 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10000);
 387
 388         let network_graph = nodes[0].network_graph;
 389         let channels = nodes[0].node.list_usable_channels();
 390         let first_hops = channels.iter().collect::<Vec<_>>();
 391         let first_hops = if public_node { None } else { Some(first_hops.as_slice()) };
 392
 393         let scorer = test_utils::TestScorer::new();
 394         let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
 395         let route = find_route(
 396                 &payer_pubkey, &route_params, &network_graph, first_hops,
 397                 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
 398         ).unwrap();
 399
 400         {
 401                 let test_preimage = PaymentPreimage([42; 32]);
 402                 if with_retry {
 403                         nodes[0].node.send_spontaneous_payment_with_retry(Some(test_preimage),
 404                                 RecipientOnionFields::spontaneous_empty(), PaymentId(test_preimage.0),
 405                                 route_params, Retry::Attempts(1)).unwrap()
 406                 } else {
 407                         nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage),
 408                                 RecipientOnionFields::spontaneous_empty(), PaymentId(test_preimage.0)).unwrap()
 409                 };
 410         }
 411         check_added_monitors!(nodes[0], 1);
 412         let send_event = SendEvent::from_node(&nodes[0]);
 413         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
 414         do_commitment_signed_dance(&nodes[1], &nodes[0], &send_event.commitment_msg, false, false);
 415         expect_pending_htlcs_forwardable!(nodes[1]);
 416         // Previously, a refactor caused us to stop including the payment preimage in the onion which
 417         // is sent as a part of keysend payments. Thus, to be extra careful here, we scope the preimage
 418         // above to demonstrate that we have no way to get the preimage at this point except by
 419         // extracting it from the onion nodes[1] received.
 420         let event = nodes[1].node.get_and_clear_pending_events();
 421         assert_eq!(event.len(), 1);
 422         if let Event::PaymentClaimable { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. } = event[0] {
 423                 claim_payment(&nodes[0], &[&nodes[1]], preimage);
 424         } else { panic!(); }
 425 }
 426
 427 #[test]
 428 fn test_mpp_keysend() {
 429         let mut mpp_keysend_config = test_default_channel_config();
 430         mpp_keysend_config.accept_mpp_keysend = true;
 431         let chanmon_cfgs = create_chanmon_cfgs(4);
 432         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 433         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, Some(mpp_keysend_config)]);
 434         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 435
 436         create_announced_chan_between_nodes(&nodes, 0, 1);
 437         create_announced_chan_between_nodes(&nodes, 0, 2);
 438         create_announced_chan_between_nodes(&nodes, 1, 3);
 439         create_announced_chan_between_nodes(&nodes, 2, 3);
 440         let network_graph = nodes[0].network_graph;
 441
 442         let payer_pubkey = nodes[0].node.get_our_node_id();
 443         let payee_pubkey = nodes[3].node.get_our_node_id();
 444         let recv_value = 15_000_000;
 445         let route_params = RouteParameters::from_payment_params_and_value(
 446                 PaymentParameters::for_keysend(payee_pubkey, 40, true), recv_value);
 447         let scorer = test_utils::TestScorer::new();
 448         let random_seed_bytes = chanmon_cfgs[0].keys_manager.get_secure_random_bytes();
 449         let route = find_route(&payer_pubkey, &route_params, &network_graph, None, nodes[0].logger,
 450                 &scorer, &Default::default(), &random_seed_bytes).unwrap();
 451
 452         let payment_preimage = PaymentPreimage([42; 32]);
 453         let payment_secret = PaymentSecret(payment_preimage.0);
 454         let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
 455                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_preimage.0)).unwrap();
 456         check_added_monitors!(nodes[0], 2);
 457
 458         let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]];
 459         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 460         assert_eq!(events.len(), 2);
 461
 462         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 463         pass_along_path(&nodes[0], expected_route[0], recv_value, payment_hash.clone(),
 464                 Some(payment_secret), ev.clone(), false, Some(payment_preimage));
 465
 466         let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
 467         pass_along_path(&nodes[0], expected_route[1], recv_value, payment_hash.clone(),
 468                 Some(payment_secret), ev.clone(), true, Some(payment_preimage));
 469         claim_payment_along_route(&nodes[0], expected_route, false, payment_preimage);
 470 }
 471
 472 #[test]
 473 fn test_reject_mpp_keysend_htlc() {
 474         // This test enforces that we reject MPP keysend HTLCs if our config states we don't support
 475         // MPP keysend. When receiving a payment, if we don't support MPP keysend we'll reject the
 476         // payment if it's keysend and has a payment secret, never reaching our payment validation
 477         // logic. To check that we enforce rejecting MPP keysends in our payment logic, here we send
 478         // keysend payments without payment secrets, then modify them by adding payment secrets in the
 479         // final node in between receiving the HTLCs and actually processing them.
 480         let mut reject_mpp_keysend_cfg = test_default_channel_config();
 481         reject_mpp_keysend_cfg.accept_mpp_keysend = false;
 482
 483         let chanmon_cfgs = create_chanmon_cfgs(4);
 484         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 485         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, Some(reject_mpp_keysend_cfg)]);
 486         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 487         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
 488         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
 489         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
 490         let (update_a, _, chan_4_channel_id, _) = create_announced_chan_between_nodes(&nodes, 2, 3);
 491         let chan_4_id = update_a.contents.short_channel_id;
 492         let amount = 40_000;
 493         let (mut route, payment_hash, payment_preimage, _) = get_route_and_payment_hash!(nodes[0], nodes[3], amount);
 494
 495         // Pay along nodes[1]
 496         route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
 497         route.paths[0].hops[0].short_channel_id = chan_1_id;
 498         route.paths[0].hops[1].short_channel_id = chan_3_id;
 499
 500         let payment_id_0 = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
 501         nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), RecipientOnionFields::spontaneous_empty(), payment_id_0).unwrap();
 502         check_added_monitors!(nodes[0], 1);
 503
 504         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 505         let update_add_0 = update_0.update_add_htlcs[0].clone();
 506         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
 507         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
 508         expect_pending_htlcs_forwardable!(nodes[1]);
 509
 510         check_added_monitors!(&nodes[1], 1);
 511         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[3].node.get_our_node_id());
 512         let update_add_1 = update_1.update_add_htlcs[0].clone();
 513         nodes[3].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
 514         commitment_signed_dance!(nodes[3], nodes[1], update_1.commitment_signed, false, true);
 515
 516         assert!(nodes[3].node.get_and_clear_pending_msg_events().is_empty());
 517         for (_, pending_forwards) in nodes[3].node.forward_htlcs.lock().unwrap().iter_mut() {
 518                 for f in pending_forwards.iter_mut() {
 519                         match f {
 520                                 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) => {
 521                                         match forward_info.routing {
 522                                                 PendingHTLCRouting::ReceiveKeysend { ref mut payment_data, .. } => {
 523                                                         *payment_data = Some(msgs::FinalOnionHopData {
 524                                                                 payment_secret: PaymentSecret([42; 32]),
 525                                                                 total_msat: amount * 2,
 526                                                         });
 527                                                 },
 528                                                 _ => panic!("Expected PendingHTLCRouting::ReceiveKeysend"),
 529                                         }
 530                                 },
 531                                 _ => {},
 532                         }
 533                 }
 534         }
 535         expect_pending_htlcs_forwardable!(nodes[3]);
 536
 537         // Pay along nodes[2]
 538         route.paths[0].hops[0].pubkey = nodes[2].node.get_our_node_id();
 539         route.paths[0].hops[0].short_channel_id = chan_2_id;
 540         route.paths[0].hops[1].short_channel_id = chan_4_id;
 541
 542         let payment_id_1 = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
 543         nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
 544         check_added_monitors!(nodes[0], 1);
 545
 546         let update_2 = get_htlc_update_msgs!(nodes[0], nodes[2].node.get_our_node_id());
 547         let update_add_2 = update_2.update_add_htlcs[0].clone();
 548         nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_2);
 549         commitment_signed_dance!(nodes[2], nodes[0], &update_2.commitment_signed, false, true);
 550         expect_pending_htlcs_forwardable!(nodes[2]);
 551
 552         check_added_monitors!(&nodes[2], 1);
 553         let update_3 = get_htlc_update_msgs!(nodes[2], nodes[3].node.get_our_node_id());
 554         let update_add_3 = update_3.update_add_htlcs[0].clone();
 555         nodes[3].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &update_add_3);
 556         commitment_signed_dance!(nodes[3], nodes[2], update_3.commitment_signed, false, true);
 557
 558         assert!(nodes[3].node.get_and_clear_pending_msg_events().is_empty());
 559         for (_, pending_forwards) in nodes[3].node.forward_htlcs.lock().unwrap().iter_mut() {
 560                 for f in pending_forwards.iter_mut() {
 561                         match f {
 562                                 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) => {
 563                                         match forward_info.routing {
 564                                                 PendingHTLCRouting::ReceiveKeysend { ref mut payment_data, .. } => {
 565                                                         *payment_data = Some(msgs::FinalOnionHopData {
 566                                                                 payment_secret: PaymentSecret([42; 32]),
 567                                                                 total_msat: amount * 2,
 568                                                         });
 569                                                 },
 570                                                 _ => panic!("Expected PendingHTLCRouting::ReceiveKeysend"),
 571                                         }
 572                                 },
 573                                 _ => {},
 574                         }
 575                 }
 576         }
 577         expect_pending_htlcs_forwardable!(nodes[3]);
 578         check_added_monitors!(nodes[3], 1);
 579
 580         // Fail back along nodes[2]
 581         let update_fail_0 = get_htlc_update_msgs!(&nodes[3], &nodes[2].node.get_our_node_id());
 582         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &update_fail_0.update_fail_htlcs[0]);
 583         commitment_signed_dance!(nodes[2], nodes[3], update_fail_0.commitment_signed, false);
 584         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_4_channel_id }]);
 585         check_added_monitors!(nodes[2], 1);
 586
 587         let update_fail_1 = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
 588         nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &update_fail_1.update_fail_htlcs[0]);
 589         commitment_signed_dance!(nodes[0], nodes[2], update_fail_1.commitment_signed, false);
 590
 591         expect_payment_failed_conditions(&nodes[0], payment_hash, true, PaymentFailedConditions::new());
 592         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], vec![HTLCDestination::FailedPayment { payment_hash }]);
 593 }
 594
 595
 596 #[test]
 597 fn no_pending_leak_on_initial_send_failure() {
 598         // In an earlier version of our payment tracking, we'd have a retry entry even when the initial
 599         // HTLC for payment failed to send due to local channel errors (e.g. peer disconnected). In this
 600         // case, the user wouldn't have a PaymentId to retry the payment with, but we'd think we have a
 601         // pending payment forever and never time it out.
 602         // Here we test exactly that - retrying a payment when a peer was disconnected on the first
 603         // try, and then check that no pending payment is being tracked.
 604         let chanmon_cfgs = create_chanmon_cfgs(2);
 605         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 606         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 607         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 608
 609         create_announced_chan_between_nodes(&nodes, 0, 1);
 610
 611         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
 612
 613         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
 614         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
 615
 616         unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash,
 617                         RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
 618                 ), true, APIError::ChannelUnavailable { ref err },
 619                 assert_eq!(err, "Peer for first hop currently disconnected"));
 620
 621         assert!(!nodes[0].node.has_pending_payments());
 622 }
 623
 624 fn do_retry_with_no_persist(confirm_before_reload: bool) {
 625         // If we send a pending payment and `send_payment` returns success, we should always either
 626         // return a payment failure event or a payment success event, and on failure the payment should
 627         // be retryable.
 628         //
 629         // In order to do so when the ChannelManager isn't immediately persisted (which is normal - its
 630         // always persisted asynchronously), the ChannelManager has to reload some payment data from
 631         // ChannelMonitor(s) in some cases. This tests that reloading.
 632         //
 633         // `confirm_before_reload` confirms the channel-closing commitment transaction on-chain prior
 634         // to reloading the ChannelManager, increasing test coverage in ChannelMonitor HTLC tracking
 635         // which has separate codepaths for "commitment transaction already confirmed" and not.
 636         let chanmon_cfgs = create_chanmon_cfgs(3);
 637         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 638         let persister;
 639         let new_chain_monitor;
 640         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 641         let nodes_0_deserialized;
 642         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 643
 644         let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
 645         let (_, _, chan_id_2, _) = create_announced_chan_between_nodes(&nodes, 1, 2);
 646
 647         // Serialize the ChannelManager prior to sending payments
 648         let nodes_0_serialized = nodes[0].node.encode();
 649
 650         // Send two payments - one which will get to nodes[2] and will be claimed, one which we'll time
 651         // out and retry.
 652         let amt_msat = 1_000_000;
 653         let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);
 654         let (payment_preimage_1, payment_hash_1, _, payment_id_1) = send_along_route(&nodes[0], route.clone(), &[&nodes[1], &nodes[2]], 1_000_000);
 655         let route_params = route.route_params.unwrap().clone();
 656         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
 657                 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
 658         check_added_monitors!(nodes[0], 1);
 659
 660         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 661         assert_eq!(events.len(), 1);
 662         let payment_event = SendEvent::from_event(events.pop().unwrap());
 663         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
 664
 665         // We relay the payment to nodes[1] while its disconnected from nodes[2], causing the payment
 666         // to be returned immediately to nodes[0], without having nodes[2] fail the inbound payment
 667         // which would prevent retry.
 668         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
 669         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
 670
 671         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 672         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
 673         // nodes[1] now immediately fails the HTLC as the next-hop channel is disconnected
 674         let _ = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 675
 676         reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[2]));
 677
 678         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan_id)[0].clone();
 679         if confirm_before_reload {
 680                 mine_transaction(&nodes[0], &as_commitment_tx);
 681                 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 682         }
 683
 684         // The ChannelMonitor should always be the latest version, as we're required to persist it
 685         // during the `commitment_signed_dance!()`.
 686         let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
 687         reload_node!(nodes[0], test_default_channel_config(), &nodes_0_serialized, &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
 688
 689         // On reload, the ChannelManager should realize it is stale compared to the ChannelMonitor and
 690         // force-close the channel.
 691         check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager, [nodes[1].node.get_our_node_id()], 100000);
 692         assert!(nodes[0].node.list_channels().is_empty());
 693         assert!(nodes[0].node.has_pending_payments());
 694         nodes[0].node.timer_tick_occurred();
 695         if !confirm_before_reload {
 696                 let as_broadcasted_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 697                 assert_eq!(as_broadcasted_txn.len(), 1);
 698                 assert_eq!(as_broadcasted_txn[0].txid(), as_commitment_tx.txid());
 699         } else {
 700                 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 701         }
 702         check_added_monitors!(nodes[0], 1);
 703
 704         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
 705         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
 706                 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
 707         }, true).unwrap();
 708         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 709
 710         // Now nodes[1] should send a channel reestablish, which nodes[0] will respond to with an
 711         // error, as the channel has hit the chain.
 712         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
 713                 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
 714         }, false).unwrap();
 715         let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
 716         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
 717         let as_err = nodes[0].node.get_and_clear_pending_msg_events();
 718         assert_eq!(as_err.len(), 2);
 719         match as_err[1] {
 720                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
 721                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
 722                         nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), msg);
 723                         check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}",
 724                                 &nodes[1].node.get_our_node_id())) }, [nodes[0].node.get_our_node_id()], 100000);
 725                         check_added_monitors!(nodes[1], 1);
 726                         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
 727                 },
 728                 _ => panic!("Unexpected event"),
 729         }
 730         check_closed_broadcast!(nodes[1], false);
 731
 732         // Now claim the first payment, which should allow nodes[1] to claim the payment on-chain when
 733         // we close in a moment.
 734         nodes[2].node.claim_funds(payment_preimage_1);
 735         check_added_monitors!(nodes[2], 1);
 736         expect_payment_claimed!(nodes[2], payment_hash_1, 1_000_000);
 737
 738         let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 739         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
 740         check_added_monitors!(nodes[1], 1);
 741         commitment_signed_dance!(nodes[1], nodes[2], htlc_fulfill_updates.commitment_signed, false);
 742         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], None, true, false);
 743
 744         if confirm_before_reload {
 745                 let best_block = nodes[0].blocks.lock().unwrap().last().unwrap().clone();
 746                 nodes[0].node.best_block_updated(&best_block.0.header, best_block.1);
 747         }
 748
 749         // Create a new channel on which to retry the payment before we fail the payment via the
 750         // HTLC-Timeout transaction. This avoids ChannelManager timing out the payment due to us
 751         // connecting several blocks while creating the channel (implying time has passed).
 752         create_announced_chan_between_nodes(&nodes, 0, 1);
 753         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
 754
 755         mine_transaction(&nodes[1], &as_commitment_tx);
 756         let bs_htlc_claim_txn = {
 757                 let mut txn = nodes[1].tx_broadcaster.unique_txn_broadcast();
 758                 assert_eq!(txn.len(), 2);
 759                 check_spends!(txn[0], funding_tx);
 760                 check_spends!(txn[1], as_commitment_tx);
 761                 txn.pop().unwrap()
 762         };
 763
 764         if !confirm_before_reload {
 765                 mine_transaction(&nodes[0], &as_commitment_tx);
 766                 let txn = nodes[0].tx_broadcaster.unique_txn_broadcast();
 767                 assert_eq!(txn.len(), 1);
 768                 assert_eq!(txn[0].txid(), as_commitment_tx.txid());
 769         }
 770         mine_transaction(&nodes[0], &bs_htlc_claim_txn);
 771         expect_payment_sent(&nodes[0], payment_preimage_1, None, true, false);
 772         connect_blocks(&nodes[0], TEST_FINAL_CLTV*4 + 20);
 773         let (first_htlc_timeout_tx, second_htlc_timeout_tx) = {
 774                 let mut txn = nodes[0].tx_broadcaster.unique_txn_broadcast();
 775                 assert_eq!(txn.len(), 2);
 776                 (txn.remove(0), txn.remove(0))
 777         };
 778         check_spends!(first_htlc_timeout_tx, as_commitment_tx);
 779         check_spends!(second_htlc_timeout_tx, as_commitment_tx);
 780         if first_htlc_timeout_tx.input[0].previous_output == bs_htlc_claim_txn.input[0].previous_output {
 781                 confirm_transaction(&nodes[0], &second_htlc_timeout_tx);
 782         } else {
 783                 confirm_transaction(&nodes[0], &first_htlc_timeout_tx);
 784         }
 785         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 786         expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new());
 787
 788         // Finally, retry the payment (which was reloaded from the ChannelMonitor when nodes[0] was
 789         // reloaded) via a route over the new channel, which work without issue and eventually be
 790         // received and claimed at the recipient just like any other payment.
 791         let (mut new_route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], 1_000_000);
 792
 793         // Update the fee on the middle hop to ensure PaymentSent events have the correct (retried) fee
 794         // and not the original fee. We also update node[1]'s relevant config as
 795         // do_claim_payment_along_route expects us to never overpay.
 796         {
 797                 let per_peer_state = nodes[1].node.per_peer_state.read().unwrap();
 798                 let mut peer_state = per_peer_state.get(&nodes[2].node.get_our_node_id())
 799                         .unwrap().lock().unwrap();
 800                 let mut channel = peer_state.channel_by_id.get_mut(&chan_id_2).unwrap();
 801                 let mut new_config = channel.context().config();
 802                 new_config.forwarding_fee_base_msat += 100_000;
 803                 channel.context_mut().update_config(&new_config);
 804                 new_route.paths[0].hops[0].fee_msat += 100_000;
 805         }
 806
 807         // Force expiration of the channel's previous config.
 808         for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
 809                 nodes[1].node.timer_tick_occurred();
 810         }
 811
 812         assert!(nodes[0].node.send_payment_with_route(&new_route, payment_hash, // Shouldn't be allowed to retry a fulfilled payment
 813                 RecipientOnionFields::secret_only(payment_secret), payment_id_1).is_err());
 814         nodes[0].node.send_payment_with_route(&new_route, payment_hash,
 815                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
 816         check_added_monitors!(nodes[0], 1);
 817         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 818         assert_eq!(events.len(), 1);
 819         pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
 820         do_claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
 821         expect_payment_sent!(nodes[0], payment_preimage, Some(new_route.paths[0].hops[0].fee_msat));
 822 }
 823
 824 #[test]
 825 fn retry_with_no_persist() {
 826         do_retry_with_no_persist(true);
 827         do_retry_with_no_persist(false);
 828 }
 829
 830 fn do_test_completed_payment_not_retryable_on_reload(use_dust: bool) {
 831         // Test that an off-chain completed payment is not retryable on restart. This was previously
 832         // broken for dust payments, but we test for both dust and non-dust payments.
 833         //
 834         // `use_dust` switches to using a dust HTLC, which results in the HTLC not having an on-chain
 835         // output at all.
 836         let chanmon_cfgs = create_chanmon_cfgs(3);
 837         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 838
 839         let mut manually_accept_config = test_default_channel_config();
 840         manually_accept_config.manually_accept_inbound_channels = true;
 841
 842         let first_persister;
 843         let first_new_chain_monitor;
 844         let second_persister;
 845         let second_new_chain_monitor;
 846         let third_persister;
 847         let third_new_chain_monitor;
 848
 849         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(manually_accept_config), None]);
 850         let first_nodes_0_deserialized;
 851         let second_nodes_0_deserialized;
 852         let third_nodes_0_deserialized;
 853
 854         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 855
 856         // Because we set nodes[1] to manually accept channels, just open a 0-conf channel.
 857         let (funding_tx, chan_id) = open_zero_conf_channel(&nodes[0], &nodes[1], None);
 858         confirm_transaction(&nodes[0], &funding_tx);
 859         confirm_transaction(&nodes[1], &funding_tx);
 860         // Ignore the announcement_signatures messages
 861         nodes[0].node.get_and_clear_pending_msg_events();
 862         nodes[1].node.get_and_clear_pending_msg_events();
 863         let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
 864
 865         // Serialize the ChannelManager prior to sending payments
 866         let mut nodes_0_serialized = nodes[0].node.encode();
 867
 868         let route = get_route_and_payment_hash!(nodes[0], nodes[2], if use_dust { 1_000 } else { 1_000_000 }).0;
 869         let (payment_preimage, payment_hash, payment_secret, payment_id) = send_along_route(&nodes[0], route, &[&nodes[1], &nodes[2]], if use_dust { 1_000 } else { 1_000_000 });
 870
 871         // The ChannelMonitor should always be the latest version, as we're required to persist it
 872         // during the `commitment_signed_dance!()`.
 873         let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
 874
 875         reload_node!(nodes[0], test_default_channel_config(), nodes_0_serialized, &[&chan_0_monitor_serialized], first_persister, first_new_chain_monitor, first_nodes_0_deserialized);
 876         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
 877
 878         // On reload, the ChannelManager should realize it is stale compared to the ChannelMonitor and
 879         // force-close the channel.
 880         check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager, [nodes[1].node.get_our_node_id()], 100000);
 881         nodes[0].node.timer_tick_occurred();
 882         assert!(nodes[0].node.list_channels().is_empty());
 883         assert!(nodes[0].node.has_pending_payments());
 884         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
 885         check_added_monitors!(nodes[0], 1);
 886
 887         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
 888                 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
 889         }, true).unwrap();
 890         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 891
 892         // Now nodes[1] should send a channel reestablish, which nodes[0] will respond to with an
 893         // error, as the channel has hit the chain.
 894         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
 895                 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
 896         }, false).unwrap();
 897         let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
 898         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
 899         let as_err = nodes[0].node.get_and_clear_pending_msg_events();
 900         assert_eq!(as_err.len(), 2);
 901         let bs_commitment_tx;
 902         match as_err[1] {
 903                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
 904                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
 905                         nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), msg);
 906                         check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", &nodes[1].node.get_our_node_id())) }
 907                                 , [nodes[0].node.get_our_node_id()], 100000);
 908                         check_added_monitors!(nodes[1], 1);
 909                         bs_commitment_tx = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 910                 },
 911                 _ => panic!("Unexpected event"),
 912         }
 913         check_closed_broadcast!(nodes[1], false);
 914
 915         // Now fail back the payment from nodes[2] to nodes[1]. This doesn't really matter as the
 916         // previous hop channel is already on-chain, but it makes nodes[2] willing to see additional
 917         // incoming HTLCs with the same payment hash later.
 918         nodes[2].node.fail_htlc_backwards(&payment_hash);
 919         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], [HTLCDestination::FailedPayment { payment_hash }]);
 920         check_added_monitors!(nodes[2], 1);
 921
 922         let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 923         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &htlc_fulfill_updates.update_fail_htlcs[0]);
 924         commitment_signed_dance!(nodes[1], nodes[2], htlc_fulfill_updates.commitment_signed, false);
 925         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1],
 926                 [HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_id_2 }]);
 927
 928         // Connect the HTLC-Timeout transaction, timing out the HTLC on both nodes (but not confirming
 929         // the HTLC-Timeout transaction beyond 1 conf). For dust HTLCs, the HTLC is considered resolved
 930         // after the commitment transaction, so always connect the commitment transaction.
 931         mine_transaction(&nodes[0], &bs_commitment_tx[0]);
 932         if nodes[0].connect_style.borrow().updates_best_block_first() {
 933                 let _ = nodes[0].tx_broadcaster.txn_broadcast();
 934         }
 935         mine_transaction(&nodes[1], &bs_commitment_tx[0]);
 936         if !use_dust {
 937                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + (MIN_CLTV_EXPIRY_DELTA as u32));
 938                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + (MIN_CLTV_EXPIRY_DELTA as u32));
 939                 let as_htlc_timeout = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 940                 assert_eq!(as_htlc_timeout.len(), 1);
 941                 check_spends!(as_htlc_timeout[0], bs_commitment_tx[0]);
 942
 943                 mine_transaction(&nodes[0], &as_htlc_timeout[0]);
 944                 mine_transaction(&nodes[1], &as_htlc_timeout[0]);
 945         }
 946         if nodes[0].connect_style.borrow().updates_best_block_first() {
 947                 let _ = nodes[0].tx_broadcaster.txn_broadcast();
 948         }
 949
 950         // Create a new channel on which to retry the payment before we fail the payment via the
 951         // HTLC-Timeout transaction. This avoids ChannelManager timing out the payment due to us
 952         // connecting several blocks while creating the channel (implying time has passed).
 953         // We do this with a zero-conf channel to avoid connecting blocks as a side-effect.
 954         let (_, chan_id_3) = open_zero_conf_channel(&nodes[0], &nodes[1], None);
 955         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
 956
 957         // If we attempt to retry prior to the HTLC-Timeout (or commitment transaction, for dust HTLCs)
 958         // confirming, we will fail as it's considered still-pending...
 959         let (new_route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], if use_dust { 1_000 } else { 1_000_000 });
 960         match nodes[0].node.send_payment_with_route(&new_route, payment_hash, RecipientOnionFields::secret_only(payment_secret), payment_id) {
 961                 Err(PaymentSendFailure::DuplicatePayment) => {},
 962                 _ => panic!("Unexpected error")
 963         }
 964         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 965
 966         // After ANTI_REORG_DELAY confirmations, the HTLC should be failed and we can try the payment
 967         // again. We serialize the node first as we'll then test retrying the HTLC after a restart
 968         // (which should also still work).
 969         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
 970         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 971         expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new());
 972
 973         let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
 974         let chan_1_monitor_serialized = get_monitor!(nodes[0], chan_id_3).encode();
 975         nodes_0_serialized = nodes[0].node.encode();
 976
 977         // After the payment failed, we're free to send it again.
 978         assert!(nodes[0].node.send_payment_with_route(&new_route, payment_hash,
 979                 RecipientOnionFields::secret_only(payment_secret), payment_id).is_ok());
 980         assert!(!nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 981
 982         reload_node!(nodes[0], test_default_channel_config(), nodes_0_serialized, &[&chan_0_monitor_serialized, &chan_1_monitor_serialized], second_persister, second_new_chain_monitor, second_nodes_0_deserialized);
 983         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
 984
 985         nodes[0].node.test_process_background_events();
 986         check_added_monitors(&nodes[0], 1);
 987
 988         let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
 989         reconnect_args.send_channel_ready = (true, true);
 990         reconnect_nodes(reconnect_args);
 991
 992         // Now resend the payment, delivering the HTLC and actually claiming it this time. This ensures
 993         // the payment is not (spuriously) listed as still pending.
 994         assert!(nodes[0].node.send_payment_with_route(&new_route, payment_hash,
 995                 RecipientOnionFields::secret_only(payment_secret), payment_id).is_ok());
 996         check_added_monitors!(nodes[0], 1);
 997         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], if use_dust { 1_000 } else { 1_000_000 }, payment_hash, payment_secret);
 998         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
 999
1000         match nodes[0].node.send_payment_with_route(&new_route, payment_hash, RecipientOnionFields::secret_only(payment_secret), payment_id) {
1001                 Err(PaymentSendFailure::DuplicatePayment) => {},
1002                 _ => panic!("Unexpected error")
1003         }
1004         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1005
1006         let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
1007         let chan_1_monitor_serialized = get_monitor!(nodes[0], chan_id_3).encode();
1008         nodes_0_serialized = nodes[0].node.encode();
1009
1010         // Check that after reload we can send the payment again (though we shouldn't, since it was
1011         // claimed previously).
1012         reload_node!(nodes[0], test_default_channel_config(), nodes_0_serialized, &[&chan_0_monitor_serialized, &chan_1_monitor_serialized], third_persister, third_new_chain_monitor, third_nodes_0_deserialized);
1013         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1014
1015         nodes[0].node.test_process_background_events();
1016         check_added_monitors(&nodes[0], 1);
1017
1018         reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
1019
1020         match nodes[0].node.send_payment_with_route(&new_route, payment_hash, RecipientOnionFields::secret_only(payment_secret), payment_id) {
1021                 Err(PaymentSendFailure::DuplicatePayment) => {},
1022                 _ => panic!("Unexpected error")
1023         }
1024         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1025 }
1026
1027 #[test]
1028 fn test_completed_payment_not_retryable_on_reload() {
1029         do_test_completed_payment_not_retryable_on_reload(true);
1030         do_test_completed_payment_not_retryable_on_reload(false);
1031 }
1032
1033
1034 fn do_test_dup_htlc_onchain_fails_on_reload(persist_manager_post_event: bool, confirm_commitment_tx: bool, payment_timeout: bool) {
1035         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
1036         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
1037         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
1038         // the ChannelMonitor tells it to.
1039         //
1040         // If, due to an on-chain event, an HTLC is failed/claimed, we should avoid providing the
1041         // ChannelManager the HTLC event until after the monitor is re-persisted. This should prevent a
1042         // duplicate HTLC fail/claim (e.g. via a PaymentPathFailed event).
1043         let chanmon_cfgs = create_chanmon_cfgs(2);
1044         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1045         let persister;
1046         let new_chain_monitor;
1047         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1048         let nodes_0_deserialized;
1049         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1050
1051         let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
1052         let error_message = "Channel force-closed";
1053
1054         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
1055         // nodes[0].
1056         let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 10_000_000);
1057         nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id(), error_message.to_string()).unwrap();
1058         check_closed_broadcast!(nodes[0], true);
1059         check_added_monitors!(nodes[0], 1);
1060         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
1061
1062         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1063         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1064
1065         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
1066         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
1067         let (commitment_tx, htlc_timeout_tx) = {
1068                 let mut txn = nodes[0].tx_broadcaster.unique_txn_broadcast();
1069                 assert_eq!(txn.len(), 2);
1070                 check_spends!(txn[0], funding_tx);
1071                 check_spends!(txn[1], txn[0]);
1072                 (txn.remove(0), txn.remove(0))
1073         };
1074
1075         nodes[1].node.claim_funds(payment_preimage);
1076         check_added_monitors!(nodes[1], 1);
1077         expect_payment_claimed!(nodes[1], payment_hash, 10_000_000);
1078
1079         mine_transaction(&nodes[1], &commitment_tx);
1080         check_closed_broadcast!(nodes[1], true);
1081         check_added_monitors!(nodes[1], 1);
1082         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
1083         let htlc_success_tx = {
1084                 let mut txn = nodes[1].tx_broadcaster.txn_broadcast();
1085                 assert_eq!(txn.len(), 1);
1086                 check_spends!(txn[0], commitment_tx);
1087                 txn.pop().unwrap()
1088         };
1089
1090         mine_transaction(&nodes[0], &commitment_tx);
1091
1092         if confirm_commitment_tx {
1093                 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
1094         }
1095
1096         let claim_block = create_dummy_block(nodes[0].best_block_hash(), 42, if payment_timeout { vec![htlc_timeout_tx] } else { vec![htlc_success_tx] });
1097
1098         if payment_timeout {
1099                 assert!(confirm_commitment_tx); // Otherwise we're spending below our CSV!
1100                 connect_block(&nodes[0], &claim_block);
1101                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 2);
1102         }
1103
1104         // Now connect the HTLC claim transaction with the ChainMonitor-generated ChannelMonitor update
1105         // returning InProgress. This should cause the claim event to never make its way to the
1106         // ChannelManager.
1107         chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clear();
1108         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1109
1110         if payment_timeout {
1111                 connect_blocks(&nodes[0], 1);
1112         } else {
1113                 connect_block(&nodes[0], &claim_block);
1114         }
1115
1116         let funding_txo = OutPoint { txid: funding_tx.txid(), index: 0 };
1117         let mon_updates: Vec<_> = chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap()
1118                 .get_mut(&funding_txo).unwrap().drain().collect();
1119         // If we are using chain::Confirm instead of chain::Listen, we will get the same update twice.
1120         // If we're testing connection idempotency we may get substantially more.
1121         assert!(mon_updates.len() >= 1);
1122         assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
1123         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1124
1125         // If we persist the ChannelManager here, we should get the PaymentSent event after
1126         // deserialization.
1127         let mut chan_manager_serialized = Vec::new();
1128         if !persist_manager_post_event {
1129                 chan_manager_serialized = nodes[0].node.encode();
1130         }
1131
1132         // Now persist the ChannelMonitor and inform the ChainMonitor that we're done, generating the
1133         // payment sent event.
1134         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1135         let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
1136         for update in mon_updates {
1137                 nodes[0].chain_monitor.chain_monitor.channel_monitor_updated(funding_txo, update).unwrap();
1138         }
1139         if payment_timeout {
1140                 expect_payment_failed!(nodes[0], payment_hash, false);
1141         } else {
1142                 expect_payment_sent(&nodes[0], payment_preimage, None, true, false);
1143         }
1144
1145         // If we persist the ChannelManager after we get the PaymentSent event, we shouldn't get it
1146         // twice.
1147         if persist_manager_post_event {
1148                 chan_manager_serialized = nodes[0].node.encode();
1149         }
1150
1151         // Now reload nodes[0]...
1152         reload_node!(nodes[0], &chan_manager_serialized, &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
1153
1154         if persist_manager_post_event {
1155                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1156         } else if payment_timeout {
1157                 expect_payment_failed!(nodes[0], payment_hash, false);
1158         } else {
1159                 expect_payment_sent(&nodes[0], payment_preimage, None, true, false);
1160         }
1161
1162         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
1163         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
1164         // payment events should kick in, leaving us with no pending events here.
1165         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
1166         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
1167         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1168         check_added_monitors(&nodes[0], 1);
1169 }
1170
1171 #[test]
1172 fn test_dup_htlc_onchain_fails_on_reload() {
1173         do_test_dup_htlc_onchain_fails_on_reload(true, true, true);
1174         do_test_dup_htlc_onchain_fails_on_reload(true, true, false);
1175         do_test_dup_htlc_onchain_fails_on_reload(true, false, false);
1176         do_test_dup_htlc_onchain_fails_on_reload(false, true, true);
1177         do_test_dup_htlc_onchain_fails_on_reload(false, true, false);
1178         do_test_dup_htlc_onchain_fails_on_reload(false, false, false);
1179 }
1180
1181 #[test]
1182 fn test_fulfill_restart_failure() {
1183         // When we receive an update_fulfill_htlc message, we immediately consider the HTLC fully
1184         // fulfilled. At this point, the peer can reconnect and decide to either fulfill the HTLC
1185         // again, or fail it, giving us free money.
1186         //
1187         // Of course probably they won't fail it and give us free money, but because we have code to
1188         // handle it, we should test the logic for it anyway. We do that here.
1189         let chanmon_cfgs = create_chanmon_cfgs(2);
1190         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1191         let persister;
1192         let new_chain_monitor;
1193         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1194         let nodes_1_deserialized;
1195         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1196
1197         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1198         let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
1199
1200         // The simplest way to get a failure after a fulfill is to reload nodes[1] from a state
1201         // pre-fulfill, which we do by serializing it here.
1202         let chan_manager_serialized = nodes[1].node.encode();
1203         let chan_0_monitor_serialized = get_monitor!(nodes[1], chan_id).encode();
1204
1205         nodes[1].node.claim_funds(payment_preimage);
1206         check_added_monitors!(nodes[1], 1);
1207         expect_payment_claimed!(nodes[1], payment_hash, 100_000);
1208
1209         let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1210         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
1211         expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
1212
1213         // Now reload nodes[1]...
1214         reload_node!(nodes[1], &chan_manager_serialized, &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_1_deserialized);
1215
1216         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1217         reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
1218
1219         nodes[1].node.fail_htlc_backwards(&payment_hash);
1220         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1221         check_added_monitors!(nodes[1], 1);
1222         let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1223         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
1224         commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, false);
1225         // nodes[0] shouldn't generate any events here, while it just got a payment failure completion
1226         // it had already considered the payment fulfilled, and now they just got free money.
1227         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1228 }
1229
1230 #[test]
1231 fn get_ldk_payment_preimage() {
1232         // Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
1233         let chanmon_cfgs = create_chanmon_cfgs(2);
1234         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1235         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1236         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1237         create_announced_chan_between_nodes(&nodes, 0, 1);
1238
1239         let amt_msat = 60_000;
1240         let expiry_secs = 60 * 60;
1241         let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs, None).unwrap();
1242
1243         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
1244                 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
1245         let scorer = test_utils::TestScorer::new();
1246         let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
1247         let random_seed_bytes = keys_manager.get_secure_random_bytes();
1248         let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
1249         let route = get_route( &nodes[0].node.get_our_node_id(), &route_params,
1250                 &nodes[0].network_graph.read_only(),
1251                 Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()), nodes[0].logger,
1252                 &scorer, &Default::default(), &random_seed_bytes).unwrap();
1253         nodes[0].node.send_payment_with_route(&route, payment_hash,
1254                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1255         check_added_monitors!(nodes[0], 1);
1256
1257         // Make sure to use `get_payment_preimage`
1258         let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
1259         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1260         assert_eq!(events.len(), 1);
1261         pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
1262         claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);
1263 }
1264
1265 #[test]
1266 fn sent_probe_is_probe_of_sending_node() {
1267         let chanmon_cfgs = create_chanmon_cfgs(3);
1268         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1269         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None, None]);
1270         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1271
1272         create_announced_chan_between_nodes(&nodes, 0, 1);
1273         create_announced_chan_between_nodes(&nodes, 1, 2);
1274
1275         // First check we refuse to build a single-hop probe
1276         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
1277         assert!(nodes[0].node.send_probe(route.paths[0].clone()).is_err());
1278
1279         // Then build an actual two-hop probing path
1280         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], 100_000);
1281
1282         match nodes[0].node.send_probe(route.paths[0].clone()) {
1283                 Ok((payment_hash, payment_id)) => {
1284                         assert!(nodes[0].node.payment_is_probe(&payment_hash, &payment_id));
1285                         assert!(!nodes[1].node.payment_is_probe(&payment_hash, &payment_id));
1286                         assert!(!nodes[2].node.payment_is_probe(&payment_hash, &payment_id));
1287                 },
1288                 _ => panic!(),
1289         }
1290
1291         get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1292         check_added_monitors!(nodes[0], 1);
1293 }
1294
1295 #[test]
1296 fn successful_probe_yields_event() {
1297         let chanmon_cfgs = create_chanmon_cfgs(3);
1298         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1299         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None, None]);
1300         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1301
1302         create_announced_chan_between_nodes(&nodes, 0, 1);
1303         create_announced_chan_between_nodes(&nodes, 1, 2);
1304
1305         let recv_value = 100_000;
1306         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], recv_value);
1307
1308         let res = nodes[0].node.send_probe(route.paths[0].clone()).unwrap();
1309
1310         let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[2]]];
1311
1312         send_probe_along_route(&nodes[0], expected_route);
1313
1314         expect_probe_successful_events(&nodes[0], vec![res]);
1315
1316         assert!(!nodes[0].node.has_pending_payments());
1317 }
1318
1319 #[test]
1320 fn failed_probe_yields_event() {
1321         let chanmon_cfgs = create_chanmon_cfgs(3);
1322         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1323         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None, None]);
1324         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1325
1326         create_announced_chan_between_nodes(&nodes, 0, 1);
1327         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 90000000);
1328
1329         let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), 42);
1330
1331         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], payment_params, 9_998_000);
1332
1333         let (payment_hash, payment_id) = nodes[0].node.send_probe(route.paths[0].clone()).unwrap();
1334
1335         // node[0] -- update_add_htlcs -> node[1]
1336         check_added_monitors!(nodes[0], 1);
1337         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1338         let probe_event = SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), updates);
1339         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &probe_event.msgs[0]);
1340         check_added_monitors!(nodes[1], 0);
1341         commitment_signed_dance!(nodes[1], nodes[0], probe_event.commitment_msg, false);
1342         expect_pending_htlcs_forwardable!(nodes[1]);
1343
1344         // node[0] <- update_fail_htlcs -- node[1]
1345         check_added_monitors!(nodes[1], 1);
1346         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1347         // Skip the PendingHTLCsForwardable event
1348         let _events = nodes[1].node.get_and_clear_pending_events();
1349         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1350         check_added_monitors!(nodes[0], 0);
1351         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1352
1353         let mut events = nodes[0].node.get_and_clear_pending_events();
1354         assert_eq!(events.len(), 1);
1355         match events.drain(..).next().unwrap() {
1356                 crate::events::Event::ProbeFailed { payment_id: ev_pid, payment_hash: ev_ph, .. } => {
1357                         assert_eq!(payment_id, ev_pid);
1358                         assert_eq!(payment_hash, ev_ph);
1359                 },
1360                 _ => panic!(),
1361         };
1362         assert!(!nodes[0].node.has_pending_payments());
1363 }
1364
1365 #[test]
1366 fn onchain_failed_probe_yields_event() {
1367         // Tests that an attempt to probe over a channel that is eventaully closed results in a failure
1368         // event.
1369         let chanmon_cfgs = create_chanmon_cfgs(3);
1370         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1371         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1372         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1373
1374         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1375         create_announced_chan_between_nodes(&nodes, 1, 2);
1376
1377         let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), 42);
1378
1379         // Send a dust HTLC, which will be treated as if it timed out once the channel hits the chain.
1380         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], payment_params, 1_000);
1381         let (payment_hash, payment_id) = nodes[0].node.send_probe(route.paths[0].clone()).unwrap();
1382
1383         // node[0] -- update_add_htlcs -> node[1]
1384         check_added_monitors!(nodes[0], 1);
1385         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1386         let probe_event = SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), updates);
1387         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &probe_event.msgs[0]);
1388         check_added_monitors!(nodes[1], 0);
1389         commitment_signed_dance!(nodes[1], nodes[0], probe_event.commitment_msg, false);
1390         expect_pending_htlcs_forwardable!(nodes[1]);
1391
1392         check_added_monitors!(nodes[1], 1);
1393         let _ = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1394
1395         // Don't bother forwarding the HTLC onwards and just confirm the force-close transaction on
1396         // Node A, which after 6 confirmations should result in a probe failure event.
1397         let bs_txn = get_local_commitment_txn!(nodes[1], chan_id);
1398         confirm_transaction(&nodes[0], &bs_txn[0]);
1399         check_closed_broadcast!(&nodes[0], true);
1400         check_added_monitors!(nodes[0], 1);
1401
1402         let mut events = nodes[0].node.get_and_clear_pending_events();
1403         assert_eq!(events.len(), 2);
1404         let mut found_probe_failed = false;
1405         for event in events.drain(..) {
1406                 match event {
1407                         Event::ProbeFailed { payment_id: ev_pid, payment_hash: ev_ph, .. } => {
1408                                 assert_eq!(payment_id, ev_pid);
1409                                 assert_eq!(payment_hash, ev_ph);
1410                                 found_probe_failed = true;
1411                         },
1412                         Event::ChannelClosed { .. } => {},
1413                         _ => panic!(),
1414                 }
1415         }
1416         assert!(found_probe_failed);
1417         assert!(!nodes[0].node.has_pending_payments());
1418 }
1419
1420 #[test]
1421 fn preflight_probes_yield_event_skip_private_hop() {
1422         let chanmon_cfgs = create_chanmon_cfgs(5);
1423         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1424
1425         // We alleviate the HTLC max-in-flight limit, as otherwise we'd always be limited through that.
1426         let mut no_htlc_limit_config = test_default_channel_config();
1427         no_htlc_limit_config.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 100;
1428
1429         let user_configs = std::iter::repeat(no_htlc_limit_config).take(5).map(|c| Some(c)).collect::<Vec<Option<UserConfig>>>();
1430         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &user_configs);
1431         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1432
1433         // Setup channel topology:
1434         //            N0 -(1M:0)- N1 -(1M:0)- N2 -(70k:0)- N3 -(50k:0)- N4
1435
1436         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
1437         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0);
1438         create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 70_000, 0);
1439         create_unannounced_chan_between_nodes_with_value(&nodes, 3, 4, 50_000, 0);
1440
1441         let mut invoice_features = Bolt11InvoiceFeatures::empty();
1442         invoice_features.set_basic_mpp_optional();
1443
1444         let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
1445                 .with_bolt11_features(invoice_features).unwrap();
1446
1447         let recv_value = 50_000_000;
1448         let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
1449         let res = nodes[0].node.send_preflight_probes(route_params, None).unwrap();
1450
1451         let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[2], &nodes[3]]];
1452
1453         assert_eq!(res.len(), expected_route.len());
1454
1455         send_probe_along_route(&nodes[0], expected_route);
1456
1457         expect_probe_successful_events(&nodes[0], res.clone());
1458
1459         assert!(!nodes[0].node.has_pending_payments());
1460 }
1461
1462 #[test]
1463 fn preflight_probes_yield_event() {
1464         let chanmon_cfgs = create_chanmon_cfgs(4);
1465         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1466
1467         // We alleviate the HTLC max-in-flight limit, as otherwise we'd always be limited through that.
1468         let mut no_htlc_limit_config = test_default_channel_config();
1469         no_htlc_limit_config.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 100;
1470
1471         let user_configs = std::iter::repeat(no_htlc_limit_config).take(4).map(|c| Some(c)).collect::<Vec<Option<UserConfig>>>();
1472         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &user_configs);
1473         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1474
1475         // Setup channel topology:
1476         //                    (1M:0)- N1 -(30k:0)
1477         //                   /                  \
1478         //                 N0                    N4
1479         //                   \                  /
1480         //                    (1M:0)- N2 -(70k:0)
1481         //
1482         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
1483         create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0);
1484         create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 30_000, 0);
1485         create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 70_000, 0);
1486
1487         let mut invoice_features = Bolt11InvoiceFeatures::empty();
1488         invoice_features.set_basic_mpp_optional();
1489
1490         let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
1491                 .with_bolt11_features(invoice_features).unwrap();
1492
1493         let recv_value = 50_000_000;
1494         let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
1495         let res = nodes[0].node.send_preflight_probes(route_params, None).unwrap();
1496
1497         let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]];
1498
1499         assert_eq!(res.len(), expected_route.len());
1500
1501         send_probe_along_route(&nodes[0], expected_route);
1502
1503         expect_probe_successful_events(&nodes[0], res.clone());
1504
1505         assert!(!nodes[0].node.has_pending_payments());
1506 }
1507
1508 #[test]
1509 fn preflight_probes_yield_event_and_skip() {
1510         let chanmon_cfgs = create_chanmon_cfgs(5);
1511         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1512
1513         // We alleviate the HTLC max-in-flight limit, as otherwise we'd always be limited through that.
1514         let mut no_htlc_limit_config = test_default_channel_config();
1515         no_htlc_limit_config.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 100;
1516
1517         let user_configs = std::iter::repeat(no_htlc_limit_config).take(5).map(|c| Some(c)).collect::<Vec<Option<UserConfig>>>();
1518         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &user_configs);
1519         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1520
1521         // Setup channel topology:
1522         //                    (30k:0)- N2 -(1M:0)
1523         //                   /                  \
1524         //  N0 -(100k:0)-> N1                    N4
1525         //                   \                  /
1526         //                    (70k:0)- N3 -(1M:0)
1527         //
1528         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
1529         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 30_000, 0);
1530         create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 70_000, 0);
1531         create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 1_000_000, 0);
1532         create_announced_chan_between_nodes_with_value(&nodes, 3, 4, 1_000_000, 0);
1533
1534         let mut invoice_features = Bolt11InvoiceFeatures::empty();
1535         invoice_features.set_basic_mpp_optional();
1536
1537         let payment_params = PaymentParameters::from_node_id(nodes[4].node.get_our_node_id(), TEST_FINAL_CLTV)
1538                 .with_bolt11_features(invoice_features).unwrap();
1539
1540         let recv_value = 80_000_000;
1541         let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
1542         let res = nodes[0].node.send_preflight_probes(route_params, None).unwrap();
1543
1544         let expected_route : &[&[&Node]] = &[&[&nodes[1], &nodes[2], &nodes[4]]];
1545
1546         // We check that only one probe was sent, the other one was skipped due to limited liquidity.
1547         assert_eq!(res.len(), 1);
1548
1549         send_probe_along_route(&nodes[0], expected_route);
1550
1551         expect_probe_successful_events(&nodes[0], res.clone());
1552
1553         assert!(!nodes[0].node.has_pending_payments());
1554 }
1555
1556 #[test]
1557 fn claimed_send_payment_idempotent() {
1558         // Tests that `send_payment` (and friends) are (reasonably) idempotent.
1559         let chanmon_cfgs = create_chanmon_cfgs(2);
1560         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1561         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1562         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1563
1564         create_announced_chan_between_nodes(&nodes, 0, 1).2;
1565
1566         let (route, second_payment_hash, second_payment_preimage, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
1567         let (first_payment_preimage, _, _, payment_id) = send_along_route(&nodes[0], route.clone(), &[&nodes[1]], 100_000);
1568
1569         macro_rules! check_send_rejected {
1570                 () => {
1571                         // If we try to resend a new payment with a different payment_hash but with the same
1572                         // payment_id, it should be rejected.
1573                         let send_result = nodes[0].node.send_payment_with_route(&route, second_payment_hash,
1574                                 RecipientOnionFields::secret_only(second_payment_secret), payment_id);
1575                         match send_result {
1576                                 Err(PaymentSendFailure::DuplicatePayment) => {},
1577                                 _ => panic!("Unexpected send result: {:?}", send_result),
1578                         }
1579
1580                         // Further, if we try to send a spontaneous payment with the same payment_id it should
1581                         // also be rejected.
1582                         let send_result = nodes[0].node.send_spontaneous_payment(
1583                                 &route, None, RecipientOnionFields::spontaneous_empty(), payment_id);
1584                         match send_result {
1585                                 Err(PaymentSendFailure::DuplicatePayment) => {},
1586                                 _ => panic!("Unexpected send result: {:?}", send_result),
1587                         }
1588                 }
1589         }
1590
1591         check_send_rejected!();
1592
1593         // Claim the payment backwards, but note that the PaymentSent event is still pending and has
1594         // not been seen by the user. At this point, from the user perspective nothing has changed, so
1595         // we must remain just as idempotent as we were before.
1596         do_claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, first_payment_preimage);
1597
1598         for _ in 0..=IDEMPOTENCY_TIMEOUT_TICKS {
1599                 nodes[0].node.timer_tick_occurred();
1600         }
1601
1602         check_send_rejected!();
1603
1604         // Once the user sees and handles the `PaymentSent` event, we expect them to no longer call
1605         // `send_payment`, and our idempotency guarantees are off - they should have atomically marked
1606         // the payment complete. However, they could have called `send_payment` while the event was
1607         // being processed, leading to a race in our idempotency guarantees. Thus, even immediately
1608         // after the event is handled a duplicate payment should sitll be rejected.
1609         expect_payment_sent!(&nodes[0], first_payment_preimage, Some(0));
1610         check_send_rejected!();
1611
1612         // If relatively little time has passed, a duplicate payment should still fail.
1613         nodes[0].node.timer_tick_occurred();
1614         check_send_rejected!();
1615
1616         // However, after some time has passed (at least more than the one timer tick above), a
1617         // duplicate payment should go through, as ChannelManager should no longer have any remaining
1618         // references to the old payment data.
1619         for _ in 0..IDEMPOTENCY_TIMEOUT_TICKS {
1620                 nodes[0].node.timer_tick_occurred();
1621         }
1622
1623         nodes[0].node.send_payment_with_route(&route, second_payment_hash,
1624                 RecipientOnionFields::secret_only(second_payment_secret), payment_id).unwrap();
1625         check_added_monitors!(nodes[0], 1);
1626         pass_along_route(&nodes[0], &[&[&nodes[1]]], 100_000, second_payment_hash, second_payment_secret);
1627         claim_payment(&nodes[0], &[&nodes[1]], second_payment_preimage);
1628 }
1629
1630 #[test]
1631 fn abandoned_send_payment_idempotent() {
1632         // Tests that `send_payment` (and friends) allow duplicate PaymentIds immediately after
1633         // abandon_payment.
1634         let chanmon_cfgs = create_chanmon_cfgs(2);
1635         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1636         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1637         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1638
1639         create_announced_chan_between_nodes(&nodes, 0, 1).2;
1640
1641         let (route, second_payment_hash, second_payment_preimage, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
1642         let (_, first_payment_hash, _, payment_id) = send_along_route(&nodes[0], route.clone(), &[&nodes[1]], 100_000);
1643
1644         macro_rules! check_send_rejected {
1645                 () => {
1646                         // If we try to resend a new payment with a different payment_hash but with the same
1647                         // payment_id, it should be rejected.
1648                         let send_result = nodes[0].node.send_payment_with_route(&route, second_payment_hash,
1649                                 RecipientOnionFields::secret_only(second_payment_secret), payment_id);
1650                         match send_result {
1651                                 Err(PaymentSendFailure::DuplicatePayment) => {},
1652                                 _ => panic!("Unexpected send result: {:?}", send_result),
1653                         }
1654
1655                         // Further, if we try to send a spontaneous payment with the same payment_id it should
1656                         // also be rejected.
1657                         let send_result = nodes[0].node.send_spontaneous_payment(
1658                                 &route, None, RecipientOnionFields::spontaneous_empty(), payment_id);
1659                         match send_result {
1660                                 Err(PaymentSendFailure::DuplicatePayment) => {},
1661                                 _ => panic!("Unexpected send result: {:?}", send_result),
1662                         }
1663                 }
1664         }
1665
1666         check_send_rejected!();
1667
1668         nodes[1].node.fail_htlc_backwards(&first_payment_hash);
1669         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], [HTLCDestination::FailedPayment { payment_hash: first_payment_hash }]);
1670
1671         // Until we abandon the payment upon path failure, no matter how many timer ticks pass, we still cannot reuse the
1672         // PaymentId.
1673         for _ in 0..=IDEMPOTENCY_TIMEOUT_TICKS {
1674                 nodes[0].node.timer_tick_occurred();
1675         }
1676         check_send_rejected!();
1677
1678         pass_failed_payment_back(&nodes[0], &[&[&nodes[1]]], false, first_payment_hash, PaymentFailureReason::RecipientRejected);
1679
1680         // However, we can reuse the PaymentId immediately after we `abandon_payment` upon passing the
1681         // failed payment back.
1682         nodes[0].node.send_payment_with_route(&route, second_payment_hash,
1683                 RecipientOnionFields::secret_only(second_payment_secret), payment_id).unwrap();
1684         check_added_monitors!(nodes[0], 1);
1685         pass_along_route(&nodes[0], &[&[&nodes[1]]], 100_000, second_payment_hash, second_payment_secret);
1686         claim_payment(&nodes[0], &[&nodes[1]], second_payment_preimage);
1687 }
1688
1689 #[derive(PartialEq)]
1690 enum InterceptTest {
1691         Forward,
1692         Fail,
1693         Timeout,
1694 }
1695
1696 #[test]
1697 fn test_trivial_inflight_htlc_tracking(){
1698         // In this test, we test three scenarios:
1699         // (1) Sending + claiming a payment successfully should return `None` when querying InFlightHtlcs
1700         // (2) Sending a payment without claiming it should return the payment's value (500000) when querying InFlightHtlcs
1701         // (3) After we claim the payment sent in (2), InFlightHtlcs should return `None` for the query.
1702         let chanmon_cfgs = create_chanmon_cfgs(3);
1703         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1704         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1705         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1706
1707         let (_, _, chan_1_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1);
1708         let (_, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2);
1709
1710         // Send and claim the payment. Inflight HTLCs should be empty.
1711         let (_, payment_hash, _, payment_id) = send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 500000);
1712         let inflight_htlcs = node_chanmgrs[0].compute_inflight_htlcs();
1713         {
1714                 let mut node_0_per_peer_lock;
1715                 let mut node_0_peer_state_lock;
1716                 let channel_1 =  get_channel_ref!(&nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_1_id);
1717
1718                 let chan_1_used_liquidity = inflight_htlcs.used_liquidity_msat(
1719                         &NodeId::from_pubkey(&nodes[0].node.get_our_node_id()) ,
1720                         &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()),
1721                         channel_1.context().get_short_channel_id().unwrap()
1722                 );
1723                 assert_eq!(chan_1_used_liquidity, None);
1724         }
1725         {
1726                 let mut node_1_per_peer_lock;
1727                 let mut node_1_peer_state_lock;
1728                 let channel_2 =  get_channel_ref!(&nodes[1], nodes[2], node_1_per_peer_lock, node_1_peer_state_lock, chan_2_id);
1729
1730                 let chan_2_used_liquidity = inflight_htlcs.used_liquidity_msat(
1731                         &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()) ,
1732                         &NodeId::from_pubkey(&nodes[2].node.get_our_node_id()),
1733                         channel_2.context().get_short_channel_id().unwrap()
1734                 );
1735
1736                 assert_eq!(chan_2_used_liquidity, None);
1737         }
1738         let pending_payments = nodes[0].node.list_recent_payments();
1739         assert_eq!(pending_payments.len(), 1);
1740         assert_eq!(pending_payments[0], RecentPaymentDetails::Fulfilled { payment_hash: Some(payment_hash), payment_id });
1741
1742         // Remove fulfilled payment
1743         for _ in 0..=IDEMPOTENCY_TIMEOUT_TICKS {
1744                 nodes[0].node.timer_tick_occurred();
1745         }
1746
1747         // Send the payment, but do not claim it. Our inflight HTLCs should contain the pending payment.
1748         let (payment_preimage, payment_hash,  _, payment_id) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 500000);
1749         let inflight_htlcs = node_chanmgrs[0].compute_inflight_htlcs();
1750         {
1751                 let mut node_0_per_peer_lock;
1752                 let mut node_0_peer_state_lock;
1753                 let channel_1 =  get_channel_ref!(&nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_1_id);
1754
1755                 let chan_1_used_liquidity = inflight_htlcs.used_liquidity_msat(
1756                         &NodeId::from_pubkey(&nodes[0].node.get_our_node_id()) ,
1757                         &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()),
1758                         channel_1.context().get_short_channel_id().unwrap()
1759                 );
1760                 // First hop accounts for expected 1000 msat fee
1761                 assert_eq!(chan_1_used_liquidity, Some(501000));
1762         }
1763         {
1764                 let mut node_1_per_peer_lock;
1765                 let mut node_1_peer_state_lock;
1766                 let channel_2 =  get_channel_ref!(&nodes[1], nodes[2], node_1_per_peer_lock, node_1_peer_state_lock, chan_2_id);
1767
1768                 let chan_2_used_liquidity = inflight_htlcs.used_liquidity_msat(
1769                         &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()) ,
1770                         &NodeId::from_pubkey(&nodes[2].node.get_our_node_id()),
1771                         channel_2.context().get_short_channel_id().unwrap()
1772                 );
1773
1774                 assert_eq!(chan_2_used_liquidity, Some(500000));
1775         }
1776         let pending_payments = nodes[0].node.list_recent_payments();
1777         assert_eq!(pending_payments.len(), 1);
1778         assert_eq!(pending_payments[0], RecentPaymentDetails::Pending { payment_id, payment_hash, total_msat: 500000 });
1779
1780         // Now, let's claim the payment. This should result in the used liquidity to return `None`.
1781         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
1782
1783         // Remove fulfilled payment
1784         for _ in 0..=IDEMPOTENCY_TIMEOUT_TICKS {
1785                 nodes[0].node.timer_tick_occurred();
1786         }
1787
1788         let inflight_htlcs = node_chanmgrs[0].compute_inflight_htlcs();
1789         {
1790                 let mut node_0_per_peer_lock;
1791                 let mut node_0_peer_state_lock;
1792                 let channel_1 =  get_channel_ref!(&nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_1_id);
1793
1794                 let chan_1_used_liquidity = inflight_htlcs.used_liquidity_msat(
1795                         &NodeId::from_pubkey(&nodes[0].node.get_our_node_id()) ,
1796                         &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()),
1797                         channel_1.context().get_short_channel_id().unwrap()
1798                 );
1799                 assert_eq!(chan_1_used_liquidity, None);
1800         }
1801         {
1802                 let mut node_1_per_peer_lock;
1803                 let mut node_1_peer_state_lock;
1804                 let channel_2 =  get_channel_ref!(&nodes[1], nodes[2], node_1_per_peer_lock, node_1_peer_state_lock, chan_2_id);
1805
1806                 let chan_2_used_liquidity = inflight_htlcs.used_liquidity_msat(
1807                         &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()) ,
1808                         &NodeId::from_pubkey(&nodes[2].node.get_our_node_id()),
1809                         channel_2.context().get_short_channel_id().unwrap()
1810                 );
1811                 assert_eq!(chan_2_used_liquidity, None);
1812         }
1813
1814         let pending_payments = nodes[0].node.list_recent_payments();
1815         assert_eq!(pending_payments.len(), 0);
1816 }
1817
1818 #[test]
1819 fn test_holding_cell_inflight_htlcs() {
1820         let chanmon_cfgs = create_chanmon_cfgs(2);
1821         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1822         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1823         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1824         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1825
1826         let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1827         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1828
1829         // Queue up two payments - one will be delivered right away, one immediately goes into the
1830         // holding cell as nodes[0] is AwaitingRAA.
1831         {
1832                 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1833                         RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1834                 check_added_monitors!(nodes[0], 1);
1835                 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1836                         RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1837                 check_added_monitors!(nodes[0], 0);
1838         }
1839
1840         let inflight_htlcs = node_chanmgrs[0].compute_inflight_htlcs();
1841
1842         {
1843                 let mut node_0_per_peer_lock;
1844                 let mut node_0_peer_state_lock;
1845                 let channel =  get_channel_ref!(&nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, channel_id);
1846
1847                 let used_liquidity = inflight_htlcs.used_liquidity_msat(
1848                         &NodeId::from_pubkey(&nodes[0].node.get_our_node_id()) ,
1849                         &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()),
1850                         channel.context().get_short_channel_id().unwrap()
1851                 );
1852
1853                 assert_eq!(used_liquidity, Some(2000000));
1854         }
1855
1856         // Clear pending events so test doesn't throw a "Had excess message on node..." error
1857         nodes[0].node.get_and_clear_pending_msg_events();
1858 }
1859
1860 #[test]
1861 fn intercepted_payment() {
1862         // Test that detecting an intercept scid on payment forward will signal LDK to generate an
1863         // intercept event, which the LSP can then use to either (a) open a JIT channel to forward the
1864         // payment or (b) fail the payment.
1865         do_test_intercepted_payment(InterceptTest::Forward);
1866         do_test_intercepted_payment(InterceptTest::Fail);
1867         // Make sure that intercepted payments will be automatically failed back if too many blocks pass.
1868         do_test_intercepted_payment(InterceptTest::Timeout);
1869 }
1870
1871 fn do_test_intercepted_payment(test: InterceptTest) {
1872         let chanmon_cfgs = create_chanmon_cfgs(3);
1873         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1874
1875         let mut zero_conf_chan_config = test_default_channel_config();
1876         zero_conf_chan_config.manually_accept_inbound_channels = true;
1877         let mut intercept_forwards_config = test_default_channel_config();
1878         intercept_forwards_config.accept_intercept_htlcs = true;
1879         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(intercept_forwards_config), Some(zero_conf_chan_config)]);
1880
1881         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1882         let scorer = test_utils::TestScorer::new();
1883         let random_seed_bytes = chanmon_cfgs[0].keys_manager.get_secure_random_bytes();
1884
1885         let _ = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1886
1887         let amt_msat = 100_000;
1888         let intercept_scid = nodes[1].node.get_intercept_scid();
1889         let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
1890                 .with_route_hints(vec![
1891                         RouteHint(vec![RouteHintHop {
1892                                 src_node_id: nodes[1].node.get_our_node_id(),
1893                                 short_channel_id: intercept_scid,
1894                                 fees: RoutingFees {
1895                                         base_msat: 1000,
1896                                         proportional_millionths: 0,
1897                                 },
1898                                 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
1899                                 htlc_minimum_msat: None,
1900                                 htlc_maximum_msat: None,
1901                         }])
1902                 ]).unwrap()
1903                 .with_bolt11_features(nodes[2].node.bolt11_invoice_features()).unwrap();
1904         let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
1905         let route = get_route(
1906                 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(), None,
1907                 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
1908         ).unwrap();
1909
1910         let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60, None).unwrap();
1911         nodes[0].node.send_payment_with_route(&route, payment_hash,
1912                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1913         let payment_event = {
1914                 {
1915                         let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
1916                         assert_eq!(added_monitors.len(), 1);
1917                         added_monitors.clear();
1918                 }
1919                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1920                 assert_eq!(events.len(), 1);
1921                 SendEvent::from_event(events.remove(0))
1922         };
1923         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1924         commitment_signed_dance!(nodes[1], nodes[0], &payment_event.commitment_msg, false, true);
1925
1926         // Check that we generate the PaymentIntercepted event when an intercept forward is detected.
1927         let events = nodes[1].node.get_and_clear_pending_events();
1928         assert_eq!(events.len(), 1);
1929         let (intercept_id, expected_outbound_amount_msat) = match events[0] {
1930                 crate::events::Event::HTLCIntercepted {
1931                         intercept_id, expected_outbound_amount_msat, payment_hash: pmt_hash, inbound_amount_msat, requested_next_hop_scid: short_channel_id
1932                 } => {
1933                         assert_eq!(pmt_hash, payment_hash);
1934                         assert_eq!(inbound_amount_msat, route.get_total_amount() + route.get_total_fees());
1935                         assert_eq!(short_channel_id, intercept_scid);
1936                         (intercept_id, expected_outbound_amount_msat)
1937                 },
1938                 _ => panic!()
1939         };
1940
1941         // Check for unknown channel id error.
1942         let unknown_chan_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &ChannelId::from_bytes([42; 32]), nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
1943         assert_eq!(unknown_chan_id_err , APIError::ChannelUnavailable  {
1944                 err: format!("Channel with id {} not found for the passed counterparty node_id {}",
1945                         log_bytes!([42; 32]), nodes[2].node.get_our_node_id()) });
1946
1947         if test == InterceptTest::Fail {
1948                 // Ensure we can fail the intercepted payment back.
1949                 nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap();
1950                 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::UnknownNextHop { requested_forward_scid: intercept_scid }]);
1951                 nodes[1].node.process_pending_htlc_forwards();
1952                 let update_fail = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1953                 check_added_monitors!(&nodes[1], 1);
1954                 assert!(update_fail.update_fail_htlcs.len() == 1);
1955                 let fail_msg = update_fail.update_fail_htlcs[0].clone();
1956                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1957                 commitment_signed_dance!(nodes[0], nodes[1], update_fail.commitment_signed, false);
1958
1959                 // Ensure the payment fails with the expected error.
1960                 let fail_conditions = PaymentFailedConditions::new()
1961                         .blamed_scid(intercept_scid)
1962                         .blamed_chan_closed(true)
1963                         .expected_htlc_error_data(0x4000 | 10, &[]);
1964                 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1965         } else if test == InterceptTest::Forward {
1966                 // Check that we'll fail as expected when sending to a channel that isn't in `ChannelReady` yet.
1967                 let temp_chan_id = nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
1968                 let unusable_chan_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &temp_chan_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
1969                 assert_eq!(unusable_chan_err , APIError::ChannelUnavailable {
1970                         err: format!("Channel with id {} for the passed counterparty node_id {} is still opening.",
1971                                 temp_chan_id, nodes[2].node.get_our_node_id()) });
1972                 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
1973
1974                 // Open the just-in-time channel so the payment can then be forwarded.
1975                 let (_, channel_id) = open_zero_conf_channel(&nodes[1], &nodes[2], None);
1976
1977                 // Finally, forward the intercepted payment through and claim it.
1978                 nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap();
1979                 expect_pending_htlcs_forwardable!(nodes[1]);
1980
1981                 let payment_event = {
1982                         {
1983                                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
1984                                 assert_eq!(added_monitors.len(), 1);
1985                                 added_monitors.clear();
1986                         }
1987                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1988                         assert_eq!(events.len(), 1);
1989                         SendEvent::from_event(events.remove(0))
1990                 };
1991                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
1992                 commitment_signed_dance!(nodes[2], nodes[1], &payment_event.commitment_msg, false, true);
1993                 expect_pending_htlcs_forwardable!(nodes[2]);
1994
1995                 let payment_preimage = nodes[2].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
1996                 expect_payment_claimable!(&nodes[2], payment_hash, payment_secret, amt_msat, Some(payment_preimage), nodes[2].node.get_our_node_id());
1997                 do_claim_payment_along_route(&nodes[0], &vec!(&vec!(&nodes[1], &nodes[2])[..]), false, payment_preimage);
1998                 let events = nodes[0].node.get_and_clear_pending_events();
1999                 assert_eq!(events.len(), 2);
2000                 match events[0] {
2001                         Event::PaymentSent { payment_preimage: ref ev_preimage, payment_hash: ref ev_hash, ref fee_paid_msat, .. } => {
2002                                 assert_eq!(payment_preimage, *ev_preimage);
2003                                 assert_eq!(payment_hash, *ev_hash);
2004                                 assert_eq!(fee_paid_msat, &Some(1000));
2005                         },
2006                         _ => panic!("Unexpected event")
2007                 }
2008                 match events[1] {
2009                         Event::PaymentPathSuccessful { payment_hash: hash, .. } => {
2010                                 assert_eq!(hash, Some(payment_hash));
2011                         },
2012                         _ => panic!("Unexpected event")
2013                 }
2014                 check_added_monitors(&nodes[0], 1);
2015         } else if test == InterceptTest::Timeout {
2016                 let mut block = create_dummy_block(nodes[0].best_block_hash(), 42, Vec::new());
2017                 connect_block(&nodes[0], &block);
2018                 connect_block(&nodes[1], &block);
2019                 for _ in 0..TEST_FINAL_CLTV {
2020                         block.header.prev_blockhash = block.block_hash();
2021                         connect_block(&nodes[0], &block);
2022                         connect_block(&nodes[1], &block);
2023                 }
2024                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::InvalidForward { requested_forward_scid: intercept_scid }]);
2025                 check_added_monitors!(nodes[1], 1);
2026                 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2027                 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
2028                 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
2029                 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
2030                 assert!(htlc_timeout_updates.update_fee.is_none());
2031
2032                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
2033                 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
2034                 expect_payment_failed!(nodes[0], payment_hash, false, 0x2000 | 2, []);
2035
2036                 // Check for unknown intercept id error.
2037                 let (_, channel_id) = open_zero_conf_channel(&nodes[1], &nodes[2], None);
2038                 let unknown_intercept_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
2039                 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
2040                 let unknown_intercept_id_err = nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap_err();
2041                 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
2042         }
2043 }
2044
2045 #[test]
2046 fn accept_underpaying_htlcs_config() {
2047         do_accept_underpaying_htlcs_config(1);
2048         do_accept_underpaying_htlcs_config(2);
2049         do_accept_underpaying_htlcs_config(3);
2050 }
2051
2052 fn do_accept_underpaying_htlcs_config(num_mpp_parts: usize) {
2053         let chanmon_cfgs = create_chanmon_cfgs(3);
2054         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2055         let mut intercept_forwards_config = test_default_channel_config();
2056         intercept_forwards_config.accept_intercept_htlcs = true;
2057         let mut underpay_config = test_default_channel_config();
2058         underpay_config.channel_config.accept_underpaying_htlcs = true;
2059         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(intercept_forwards_config), Some(underpay_config)]);
2060         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2061
2062         let mut chan_ids = Vec::new();
2063         for _ in 0..num_mpp_parts {
2064                 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000, 0);
2065                 let channel_id = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 2_000_000, 0).0.channel_id;
2066                 chan_ids.push(channel_id);
2067         }
2068
2069         // Send the initial payment.
2070         let amt_msat = 900_000;
2071         let skimmed_fee_msat = 20;
2072         let mut route_hints = Vec::new();
2073         for _ in 0..num_mpp_parts {
2074                 route_hints.push(RouteHint(vec![RouteHintHop {
2075                         src_node_id: nodes[1].node.get_our_node_id(),
2076                         short_channel_id: nodes[1].node.get_intercept_scid(),
2077                         fees: RoutingFees {
2078                                 base_msat: 1000,
2079                                 proportional_millionths: 0,
2080                         },
2081                         cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
2082                         htlc_minimum_msat: None,
2083                         htlc_maximum_msat: Some(amt_msat / num_mpp_parts as u64 + 5),
2084                 }]));
2085         }
2086         let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
2087                 .with_route_hints(route_hints).unwrap()
2088                 .with_bolt11_features(nodes[2].node.bolt11_invoice_features()).unwrap();
2089         let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2090         let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60, None).unwrap();
2091         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2092                 PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
2093         check_added_monitors!(nodes[0], num_mpp_parts); // one monitor per path
2094         let mut events: Vec<SendEvent> = nodes[0].node.get_and_clear_pending_msg_events().into_iter().map(|e| SendEvent::from_event(e)).collect();
2095         assert_eq!(events.len(), num_mpp_parts);
2096
2097         // Forward the intercepted payments.
2098         for (idx, ev) in events.into_iter().enumerate() {
2099                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &ev.msgs[0]);
2100                 do_commitment_signed_dance(&nodes[1], &nodes[0], &ev.commitment_msg, false, true);
2101
2102                 let events = nodes[1].node.get_and_clear_pending_events();
2103                 assert_eq!(events.len(), 1);
2104                 let (intercept_id, expected_outbound_amt_msat) = match events[0] {
2105                         crate::events::Event::HTLCIntercepted {
2106                                 intercept_id, expected_outbound_amount_msat, payment_hash: pmt_hash, ..
2107                         } => {
2108                                 assert_eq!(pmt_hash, payment_hash);
2109                                 (intercept_id, expected_outbound_amount_msat)
2110                         },
2111                         _ => panic!()
2112                 };
2113                 nodes[1].node.forward_intercepted_htlc(intercept_id, &chan_ids[idx],
2114                         nodes[2].node.get_our_node_id(), expected_outbound_amt_msat - skimmed_fee_msat).unwrap();
2115                 expect_pending_htlcs_forwardable!(nodes[1]);
2116                 let payment_event = {
2117                         {
2118                                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2119                                 assert_eq!(added_monitors.len(), 1);
2120                                 added_monitors.clear();
2121                         }
2122                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2123                         assert_eq!(events.len(), 1);
2124                         SendEvent::from_event(events.remove(0))
2125                 };
2126                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
2127                 do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event.commitment_msg, false, true);
2128                 if idx == num_mpp_parts - 1 {
2129                         expect_pending_htlcs_forwardable!(nodes[2]);
2130                 }
2131         }
2132
2133         // Claim the payment and check that the skimmed fee is as expected.
2134         let payment_preimage = nodes[2].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
2135         let events = nodes[2].node.get_and_clear_pending_events();
2136         assert_eq!(events.len(), 1);
2137         match events[0] {
2138                 crate::events::Event::PaymentClaimable {
2139                         ref payment_hash, ref purpose, amount_msat, counterparty_skimmed_fee_msat, receiver_node_id, ..
2140                 } => {
2141                         assert_eq!(payment_hash, payment_hash);
2142                         assert_eq!(amt_msat - skimmed_fee_msat * num_mpp_parts as u64, amount_msat);
2143                         assert_eq!(skimmed_fee_msat * num_mpp_parts as u64, counterparty_skimmed_fee_msat);
2144                         assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
2145                         match purpose {
2146                                 crate::events::PaymentPurpose::InvoicePayment { payment_preimage: ev_payment_preimage,
2147                                         payment_secret: ev_payment_secret, .. } =>
2148                                 {
2149                                         assert_eq!(payment_preimage, ev_payment_preimage.unwrap());
2150                                         assert_eq!(payment_secret, *ev_payment_secret);
2151                                 },
2152                                 _ => panic!(),
2153                         }
2154                 },
2155                 _ => panic!("Unexpected event"),
2156         }
2157         let mut expected_paths_vecs = Vec::new();
2158         let mut expected_paths = Vec::new();
2159         for _ in 0..num_mpp_parts { expected_paths_vecs.push(vec!(&nodes[1], &nodes[2])); }
2160         for i in 0..num_mpp_parts { expected_paths.push(&expected_paths_vecs[i][..]); }
2161         expected_paths[0].last().unwrap().node.claim_funds(payment_preimage);
2162         let args = ClaimAlongRouteArgs::new(&nodes[0], &expected_paths[..], payment_preimage)
2163                 .with_expected_extra_fees(vec![skimmed_fee_msat as u32; num_mpp_parts]);
2164         let total_fee_msat = pass_claimed_payment_along_route(args);
2165         // The sender doesn't know that the penultimate hop took an extra fee.
2166         expect_payment_sent(&nodes[0], payment_preimage,
2167                 Some(Some(total_fee_msat - skimmed_fee_msat * num_mpp_parts as u64)), true, true);
2168 }
2169
2170 #[derive(PartialEq)]
2171 enum AutoRetry {
2172         Success,
2173         Spontaneous,
2174         FailAttempts,
2175         FailTimeout,
2176         FailOnRestart,
2177         FailOnRetry,
2178 }
2179
2180 #[test]
2181 fn automatic_retries() {
2182         do_automatic_retries(AutoRetry::Success);
2183         do_automatic_retries(AutoRetry::Spontaneous);
2184         do_automatic_retries(AutoRetry::FailAttempts);
2185         do_automatic_retries(AutoRetry::FailTimeout);
2186         do_automatic_retries(AutoRetry::FailOnRestart);
2187         do_automatic_retries(AutoRetry::FailOnRetry);
2188 }
2189 fn do_automatic_retries(test: AutoRetry) {
2190         // Test basic automatic payment retries in ChannelManager. See individual `test` variant comments
2191         // below.
2192         let chanmon_cfgs = create_chanmon_cfgs(3);
2193         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2194         let persister;
2195         let new_chain_monitor;
2196
2197         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2198         let node_0_deserialized;
2199
2200         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2201         let channel_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1).2;
2202         let channel_id_2 = create_announced_chan_between_nodes(&nodes, 2, 1).2;
2203
2204         // Marshall data to send the payment
2205         #[cfg(feature = "std")]
2206         let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2207         #[cfg(not(feature = "std"))]
2208         let payment_expiry_secs = 60 * 60;
2209         let amt_msat = 1000;
2210         let mut invoice_features = Bolt11InvoiceFeatures::empty();
2211         invoice_features.set_variable_length_onion_required();
2212         invoice_features.set_payment_secret_required();
2213         invoice_features.set_basic_mpp_optional();
2214         let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
2215                 .with_expiry_time(payment_expiry_secs as u64)
2216                 .with_bolt11_features(invoice_features).unwrap();
2217         let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2218         let (_, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);
2219
2220         macro_rules! pass_failed_attempt_with_retry_along_path {
2221                 ($failing_channel_id: expr, $expect_pending_htlcs_forwardable: expr) => {
2222                         // Send a payment attempt that fails due to lack of liquidity on the second hop
2223                         check_added_monitors!(nodes[0], 1);
2224                         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2225                         let mut update_add = update_0.update_add_htlcs[0].clone();
2226                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
2227                         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
2228                         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
2229                         nodes[1].node.process_pending_htlc_forwards();
2230                         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1],
2231                                 vec![HTLCDestination::NextHopChannel {
2232                                         node_id: Some(nodes[2].node.get_our_node_id()),
2233                                         channel_id: $failing_channel_id,
2234                                 }]);
2235                         nodes[1].node.process_pending_htlc_forwards();
2236                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2237                         check_added_monitors!(&nodes[1], 1);
2238                         assert!(update_1.update_fail_htlcs.len() == 1);
2239                         let fail_msg = update_1.update_fail_htlcs[0].clone();
2240                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
2241                         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
2242
2243                         // Ensure the attempt fails and a new PendingHTLCsForwardable event is generated for the retry
2244                         let mut events = nodes[0].node.get_and_clear_pending_events();
2245                         assert_eq!(events.len(), 2);
2246                         match events[0] {
2247                                 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently, ..  } => {
2248                                         assert_eq!(payment_hash, ev_payment_hash);
2249                                         assert_eq!(payment_failed_permanently, false);
2250                                 },
2251                                 _ => panic!("Unexpected event"),
2252                         }
2253                         if $expect_pending_htlcs_forwardable {
2254                                 match events[1] {
2255                                         Event::PendingHTLCsForwardable { .. } => {},
2256                                         _ => panic!("Unexpected event"),
2257                                 }
2258                         } else {
2259                                 match events[1] {
2260                                         Event::PaymentFailed { payment_hash: ev_payment_hash, .. } => {
2261                                                 assert_eq!(payment_hash, ev_payment_hash);
2262                                         },
2263                                         _ => panic!("Unexpected event"),
2264                                 }
2265                         }
2266                 }
2267         }
2268
2269         if test == AutoRetry::Success {
2270                 // Test that we can succeed on the first retry.
2271                 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2272                         PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2273                 pass_failed_attempt_with_retry_along_path!(channel_id_2, true);
2274
2275                 // Open a new channel with liquidity on the second hop so we can find a route for the retry
2276                 // attempt, since the initial second hop channel will be excluded from pathfinding
2277                 create_announced_chan_between_nodes(&nodes, 1, 2);
2278
2279                 // We retry payments in `process_pending_htlc_forwards`
2280                 nodes[0].node.process_pending_htlc_forwards();
2281                 check_added_monitors!(nodes[0], 1);
2282                 let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2283                 assert_eq!(msg_events.len(), 1);
2284                 pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], amt_msat, payment_hash, Some(payment_secret), msg_events.pop().unwrap(), true, None);
2285                 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
2286         } else if test == AutoRetry::Spontaneous {
2287                 nodes[0].node.send_spontaneous_payment_with_retry(Some(payment_preimage),
2288                         RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params,
2289                         Retry::Attempts(1)).unwrap();
2290                 pass_failed_attempt_with_retry_along_path!(channel_id_2, true);
2291
2292                 // Open a new channel with liquidity on the second hop so we can find a route for the retry
2293                 // attempt, since the initial second hop channel will be excluded from pathfinding
2294                 create_announced_chan_between_nodes(&nodes, 1, 2);
2295
2296                 // We retry payments in `process_pending_htlc_forwards`
2297                 nodes[0].node.process_pending_htlc_forwards();
2298                 check_added_monitors!(nodes[0], 1);
2299                 let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2300                 assert_eq!(msg_events.len(), 1);
2301                 pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], amt_msat, payment_hash, None, msg_events.pop().unwrap(), true, Some(payment_preimage));
2302                 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
2303         } else if test == AutoRetry::FailAttempts {
2304                 // Ensure ChannelManager will not retry a payment if it has run out of payment attempts.
2305                 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2306                         PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2307                 pass_failed_attempt_with_retry_along_path!(channel_id_2, true);
2308
2309                 // Open a new channel with no liquidity on the second hop so we can find a (bad) route for
2310                 // the retry attempt, since the initial second hop channel will be excluded from pathfinding
2311                 let channel_id_3 = create_announced_chan_between_nodes(&nodes, 2, 1).2;
2312
2313                 // We retry payments in `process_pending_htlc_forwards`
2314                 nodes[0].node.process_pending_htlc_forwards();
2315                 pass_failed_attempt_with_retry_along_path!(channel_id_3, false);
2316
2317                 // Ensure we won't retry a second time.
2318                 nodes[0].node.process_pending_htlc_forwards();
2319                 let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2320                 assert_eq!(msg_events.len(), 0);
2321         } else if test == AutoRetry::FailTimeout {
2322                 #[cfg(feature = "std")] {
2323                         // Ensure ChannelManager will not retry a payment if it times out due to Retry::Timeout.
2324                         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2325                                 PaymentId(payment_hash.0), route_params, Retry::Timeout(Duration::from_secs(60))).unwrap();
2326                         pass_failed_attempt_with_retry_along_path!(channel_id_2, true);
2327
2328                         // Advance the time so the second attempt fails due to timeout.
2329                         SinceEpoch::advance(Duration::from_secs(61));
2330
2331                         // Make sure we don't retry again.
2332                         nodes[0].node.process_pending_htlc_forwards();
2333                         let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2334                         assert_eq!(msg_events.len(), 0);
2335
2336                         let mut events = nodes[0].node.get_and_clear_pending_events();
2337                         assert_eq!(events.len(), 1);
2338                         match events[0] {
2339                                 Event::PaymentFailed { payment_hash: ref ev_payment_hash, payment_id: ref ev_payment_id, reason: ref ev_reason } => {
2340                                         assert_eq!(payment_hash, *ev_payment_hash);
2341                                         assert_eq!(PaymentId(payment_hash.0), *ev_payment_id);
2342                                         assert_eq!(PaymentFailureReason::RetriesExhausted, ev_reason.unwrap());
2343                                 },
2344                                 _ => panic!("Unexpected event"),
2345                         }
2346                 }
2347         } else if test == AutoRetry::FailOnRestart {
2348                 // Ensure ChannelManager will not retry a payment after restart, even if there were retry
2349                 // attempts remaining prior to restart.
2350                 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2351                         PaymentId(payment_hash.0), route_params, Retry::Attempts(2)).unwrap();
2352                 pass_failed_attempt_with_retry_along_path!(channel_id_2, true);
2353
2354                 // Open a new channel with no liquidity on the second hop so we can find a (bad) route for
2355                 // the retry attempt, since the initial second hop channel will be excluded from pathfinding
2356                 let channel_id_3 = create_announced_chan_between_nodes(&nodes, 2, 1).2;
2357
2358                 // Ensure the first retry attempt fails, with 1 retry attempt remaining
2359                 nodes[0].node.process_pending_htlc_forwards();
2360                 pass_failed_attempt_with_retry_along_path!(channel_id_3, true);
2361
2362                 // Restart the node and ensure that ChannelManager does not use its remaining retry attempt
2363                 let node_encoded = nodes[0].node.encode();
2364                 let chan_1_monitor_serialized = get_monitor!(nodes[0], channel_id_1).encode();
2365                 reload_node!(nodes[0], node_encoded, &[&chan_1_monitor_serialized], persister, new_chain_monitor, node_0_deserialized);
2366
2367                 let mut events = nodes[0].node.get_and_clear_pending_events();
2368                 expect_pending_htlcs_forwardable_from_events!(nodes[0], events, true);
2369                 // Make sure we don't retry again.
2370                 let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2371                 assert_eq!(msg_events.len(), 0);
2372
2373                 let mut events = nodes[0].node.get_and_clear_pending_events();
2374                 assert_eq!(events.len(), 1);
2375                 match events[0] {
2376                         Event::PaymentFailed { payment_hash: ref ev_payment_hash, payment_id: ref ev_payment_id, reason: ref ev_reason } => {
2377                                 assert_eq!(payment_hash, *ev_payment_hash);
2378                                 assert_eq!(PaymentId(payment_hash.0), *ev_payment_id);
2379                                 assert_eq!(PaymentFailureReason::RetriesExhausted, ev_reason.unwrap());
2380                         },
2381                         _ => panic!("Unexpected event"),
2382                 }
2383         } else if test == AutoRetry::FailOnRetry {
2384                 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2385                         PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2386                 pass_failed_attempt_with_retry_along_path!(channel_id_2, true);
2387
2388                 // We retry payments in `process_pending_htlc_forwards`. Since our channel closed, we should
2389                 // fail to find a route.
2390                 nodes[0].node.process_pending_htlc_forwards();
2391                 let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2392                 assert_eq!(msg_events.len(), 0);
2393
2394                 let mut events = nodes[0].node.get_and_clear_pending_events();
2395                 assert_eq!(events.len(), 1);
2396                 match events[0] {
2397                         Event::PaymentFailed { payment_hash: ref ev_payment_hash, payment_id: ref ev_payment_id, reason: ref ev_reason } => {
2398                                 assert_eq!(payment_hash, *ev_payment_hash);
2399                                 assert_eq!(PaymentId(payment_hash.0), *ev_payment_id);
2400                                 assert_eq!(PaymentFailureReason::RouteNotFound, ev_reason.unwrap());
2401                         },
2402                         _ => panic!("Unexpected event"),
2403                 }
2404         }
2405 }
2406
2407 #[test]
2408 fn auto_retry_partial_failure() {
2409         // Test that we'll retry appropriately on send partial failure and retry partial failure.
2410         let chanmon_cfgs = create_chanmon_cfgs(2);
2411         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2412         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2413         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2414
2415         // Open three channels, the first has plenty of liquidity, the second and third have ~no
2416         // available liquidity, causing any outbound payments routed over it to fail immediately.
2417         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
2418         let chan_2_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 989_000_000).0.contents.short_channel_id;
2419         let chan_3_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 989_000_000).0.contents.short_channel_id;
2420
2421         // Marshall data to send the payment
2422         let amt_msat = 10_000_000;
2423         let (_, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], amt_msat);
2424         #[cfg(feature = "std")]
2425         let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2426         #[cfg(not(feature = "std"))]
2427         let payment_expiry_secs = 60 * 60;
2428         let mut invoice_features = Bolt11InvoiceFeatures::empty();
2429         invoice_features.set_variable_length_onion_required();
2430         invoice_features.set_payment_secret_required();
2431         invoice_features.set_basic_mpp_optional();
2432         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
2433                 .with_expiry_time(payment_expiry_secs as u64)
2434                 .with_bolt11_features(invoice_features).unwrap();
2435
2436         // Configure the initial send path
2437         let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2438         route_params.max_total_routing_fee_msat = None;
2439
2440         let send_route = Route {
2441                 paths: vec![
2442                         Path { hops: vec![RouteHop {
2443                                 pubkey: nodes[1].node.get_our_node_id(),
2444                                 node_features: nodes[1].node.node_features(),
2445                                 short_channel_id: chan_1_id,
2446                                 channel_features: nodes[1].node.channel_features(),
2447                                 fee_msat: amt_msat / 2,
2448                                 cltv_expiry_delta: 100,
2449                                 maybe_announced_channel: true,
2450                         }], blinded_tail: None },
2451                         Path { hops: vec![RouteHop {
2452                                 pubkey: nodes[1].node.get_our_node_id(),
2453                                 node_features: nodes[1].node.node_features(),
2454                                 short_channel_id: chan_2_id,
2455                                 channel_features: nodes[1].node.channel_features(),
2456                                 fee_msat: amt_msat / 2,
2457                                 cltv_expiry_delta: 100,
2458                                 maybe_announced_channel: true,
2459                         }], blinded_tail: None },
2460                 ],
2461                 route_params: Some(route_params.clone()),
2462         };
2463         nodes[0].router.expect_find_route(route_params.clone(), Ok(send_route));
2464
2465         // Configure the retry1 paths
2466         let mut payment_params = route_params.payment_params.clone();
2467         payment_params.previously_failed_channels.push(chan_2_id);
2468         let mut retry_1_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat / 2);
2469         retry_1_params.max_total_routing_fee_msat = None;
2470
2471         let retry_1_route = Route {
2472                 paths: vec![
2473                         Path { hops: vec![RouteHop {
2474                                 pubkey: nodes[1].node.get_our_node_id(),
2475                                 node_features: nodes[1].node.node_features(),
2476                                 short_channel_id: chan_1_id,
2477                                 channel_features: nodes[1].node.channel_features(),
2478                                 fee_msat: amt_msat / 4,
2479                                 cltv_expiry_delta: 100,
2480                                 maybe_announced_channel: true,
2481                         }], blinded_tail: None },
2482                         Path { hops: vec![RouteHop {
2483                                 pubkey: nodes[1].node.get_our_node_id(),
2484                                 node_features: nodes[1].node.node_features(),
2485                                 short_channel_id: chan_3_id,
2486                                 channel_features: nodes[1].node.channel_features(),
2487                                 fee_msat: amt_msat / 4,
2488                                 cltv_expiry_delta: 100,
2489                                 maybe_announced_channel: true,
2490                         }], blinded_tail: None },
2491                 ],
2492                 route_params: Some(retry_1_params.clone()),
2493         };
2494         nodes[0].router.expect_find_route(retry_1_params.clone(), Ok(retry_1_route));
2495
2496         // Configure the retry2 path
2497         let mut payment_params = retry_1_params.payment_params.clone();
2498         payment_params.previously_failed_channels.push(chan_3_id);
2499         let mut retry_2_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat / 4);
2500         retry_2_params.max_total_routing_fee_msat = None;
2501
2502         let retry_2_route = Route {
2503                 paths: vec![
2504                         Path { hops: vec![RouteHop {
2505                                 pubkey: nodes[1].node.get_our_node_id(),
2506                                 node_features: nodes[1].node.node_features(),
2507                                 short_channel_id: chan_1_id,
2508                                 channel_features: nodes[1].node.channel_features(),
2509                                 fee_msat: amt_msat / 4,
2510                                 cltv_expiry_delta: 100,
2511                                 maybe_announced_channel: true,
2512                         }], blinded_tail: None },
2513                 ],
2514                 route_params: Some(retry_2_params.clone()),
2515         };
2516         nodes[0].router.expect_find_route(retry_2_params, Ok(retry_2_route));
2517
2518         // Send a payment that will partially fail on send, then partially fail on retry, then succeed.
2519         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2520                 PaymentId(payment_hash.0), route_params, Retry::Attempts(3)).unwrap();
2521         let payment_failed_events = nodes[0].node.get_and_clear_pending_events();
2522         assert_eq!(payment_failed_events.len(), 2);
2523         match payment_failed_events[0] {
2524                 Event::PaymentPathFailed { .. } => {},
2525                 _ => panic!("Unexpected event"),
2526         }
2527         match payment_failed_events[1] {
2528                 Event::PaymentPathFailed { .. } => {},
2529                 _ => panic!("Unexpected event"),
2530         }
2531
2532         // Pass the first part of the payment along the path.
2533         check_added_monitors!(nodes[0], 1); // only one HTLC actually made it out
2534         let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2535
2536         // Only one HTLC/channel update actually made it out
2537         assert_eq!(msg_events.len(), 1);
2538         let mut payment_event = SendEvent::from_event(msg_events.remove(0));
2539
2540         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2541         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
2542         check_added_monitors!(nodes[1], 1);
2543         let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2544
2545         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2546         check_added_monitors!(nodes[0], 1);
2547         let as_second_htlc_updates = SendEvent::from_node(&nodes[0]);
2548
2549         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2550         check_added_monitors!(nodes[0], 1);
2551         let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2552
2553         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2554         check_added_monitors!(nodes[1], 1);
2555
2556         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_second_htlc_updates.msgs[0]);
2557         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_second_htlc_updates.msgs[1]);
2558         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_htlc_updates.commitment_msg);
2559         check_added_monitors!(nodes[1], 1);
2560         let (bs_second_raa, bs_second_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2561
2562         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2563         check_added_monitors!(nodes[0], 1);
2564
2565         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2566         check_added_monitors!(nodes[0], 1);
2567         let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2568
2569         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2570         check_added_monitors!(nodes[1], 1);
2571
2572         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
2573         nodes[1].node.process_pending_htlc_forwards();
2574         expect_payment_claimable!(nodes[1], payment_hash, payment_secret, amt_msat);
2575         nodes[1].node.claim_funds(payment_preimage);
2576         expect_payment_claimed!(nodes[1], payment_hash, amt_msat);
2577         let bs_claim_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2578         assert_eq!(bs_claim_update.update_fulfill_htlcs.len(), 1);
2579
2580         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_claim_update.update_fulfill_htlcs[0]);
2581         expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2582         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_claim_update.commitment_signed);
2583         check_added_monitors!(nodes[0], 1);
2584         let (as_third_raa, as_third_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2585
2586         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_third_raa);
2587         check_added_monitors!(nodes[1], 4);
2588         let bs_second_claim_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2589
2590         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_third_cs);
2591         check_added_monitors!(nodes[1], 1);
2592         let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2593
2594         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2595         check_added_monitors!(nodes[0], 1);
2596         expect_payment_path_successful!(nodes[0]);
2597
2598         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_claim_update.update_fulfill_htlcs[0]);
2599         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_claim_update.update_fulfill_htlcs[1]);
2600         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_claim_update.commitment_signed);
2601         check_added_monitors!(nodes[0], 1);
2602         let (as_fourth_raa, as_fourth_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2603
2604         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_fourth_raa);
2605         check_added_monitors!(nodes[1], 1);
2606
2607         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_fourth_cs);
2608         check_added_monitors!(nodes[1], 1);
2609         let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2610
2611         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2612         check_added_monitors!(nodes[0], 1);
2613         let events = nodes[0].node.get_and_clear_pending_events();
2614         assert_eq!(events.len(), 2);
2615         if let Event::PaymentPathSuccessful { .. } = events[0] {} else { panic!(); }
2616         if let Event::PaymentPathSuccessful { .. } = events[1] {} else { panic!(); }
2617 }
2618
2619 #[test]
2620 fn auto_retry_zero_attempts_send_error() {
2621         let chanmon_cfgs = create_chanmon_cfgs(2);
2622         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2623         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2624         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2625
2626         // Open a single channel that does not have sufficient liquidity for the payment we want to
2627         // send.
2628         let chan_id  = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 989_000_000).0.contents.short_channel_id;
2629
2630         // Marshall data to send the payment
2631         let amt_msat = 10_000_000;
2632         let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[1], Some(amt_msat), None);
2633         #[cfg(feature = "std")]
2634         let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2635         #[cfg(not(feature = "std"))]
2636         let payment_expiry_secs = 60 * 60;
2637         let mut invoice_features = Bolt11InvoiceFeatures::empty();
2638         invoice_features.set_variable_length_onion_required();
2639         invoice_features.set_payment_secret_required();
2640         invoice_features.set_basic_mpp_optional();
2641         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
2642                 .with_expiry_time(payment_expiry_secs as u64)
2643                 .with_bolt11_features(invoice_features).unwrap();
2644         let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2645
2646         // Override the route search to return a route, rather than failing at the route-finding step.
2647         let send_route = Route {
2648                 paths: vec![
2649                         Path { hops: vec![RouteHop {
2650                                 pubkey: nodes[1].node.get_our_node_id(),
2651                                 node_features: nodes[1].node.node_features(),
2652                                 short_channel_id: chan_id,
2653                                 channel_features: nodes[1].node.channel_features(),
2654                                 fee_msat: amt_msat,
2655                                 cltv_expiry_delta: 100,
2656                                 maybe_announced_channel: true,
2657                         }], blinded_tail: None },
2658                 ],
2659                 route_params: Some(route_params.clone()),
2660         };
2661         nodes[0].router.expect_find_route(route_params.clone(), Ok(send_route));
2662
2663         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2664                 PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
2665         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2666         let events = nodes[0].node.get_and_clear_pending_events();
2667         assert_eq!(events.len(), 2);
2668         if let Event::PaymentPathFailed { .. } = events[0] { } else { panic!(); }
2669         if let Event::PaymentFailed { .. } = events[1] { } else { panic!(); }
2670         check_added_monitors!(nodes[0], 0);
2671 }
2672
2673 #[test]
2674 fn fails_paying_after_rejected_by_payee() {
2675         let chanmon_cfgs = create_chanmon_cfgs(2);
2676         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2677         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2678         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2679
2680         create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
2681
2682         // Marshall data to send the payment
2683         let amt_msat = 20_000;
2684         let (_, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], amt_msat);
2685         #[cfg(feature = "std")]
2686         let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2687         #[cfg(not(feature = "std"))]
2688         let payment_expiry_secs = 60 * 60;
2689         let mut invoice_features = Bolt11InvoiceFeatures::empty();
2690         invoice_features.set_variable_length_onion_required();
2691         invoice_features.set_payment_secret_required();
2692         invoice_features.set_basic_mpp_optional();
2693         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
2694                 .with_expiry_time(payment_expiry_secs as u64)
2695                 .with_bolt11_features(invoice_features).unwrap();
2696         let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2697
2698         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2699                 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2700         check_added_monitors!(nodes[0], 1);
2701         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2702         assert_eq!(events.len(), 1);
2703         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
2704         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2705         check_added_monitors!(nodes[1], 0);
2706         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
2707         expect_pending_htlcs_forwardable!(nodes[1]);
2708         expect_payment_claimable!(&nodes[1], payment_hash, payment_secret, amt_msat);
2709
2710         nodes[1].node.fail_htlc_backwards(&payment_hash);
2711         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], [HTLCDestination::FailedPayment { payment_hash }]);
2712         pass_failed_payment_back(&nodes[0], &[&[&nodes[1]]], false, payment_hash, PaymentFailureReason::RecipientRejected);
2713 }
2714
2715 #[test]
2716 fn retry_multi_path_single_failed_payment() {
2717         // Tests that we can/will retry after a single path of an MPP payment failed immediately
2718         let chanmon_cfgs = create_chanmon_cfgs(2);
2719         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2720         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
2721         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2722
2723         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
2724         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
2725
2726         let amt_msat = 100_010_000;
2727
2728         let (_, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], amt_msat);
2729         #[cfg(feature = "std")]
2730         let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2731         #[cfg(not(feature = "std"))]
2732         let payment_expiry_secs = 60 * 60;
2733         let mut invoice_features = Bolt11InvoiceFeatures::empty();
2734         invoice_features.set_variable_length_onion_required();
2735         invoice_features.set_payment_secret_required();
2736         invoice_features.set_basic_mpp_optional();
2737         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
2738                 .with_expiry_time(payment_expiry_secs as u64)
2739                 .with_bolt11_features(invoice_features).unwrap();
2740         let mut route_params = RouteParameters::from_payment_params_and_value(
2741                 payment_params.clone(), amt_msat);
2742         route_params.max_total_routing_fee_msat = None;
2743
2744         let chans = nodes[0].node.list_usable_channels();
2745         let mut route = Route {
2746                 paths: vec![
2747                         Path { hops: vec![RouteHop {
2748                                 pubkey: nodes[1].node.get_our_node_id(),
2749                                 node_features: nodes[1].node.node_features(),
2750                                 short_channel_id: chans[0].short_channel_id.unwrap(),
2751                                 channel_features: nodes[1].node.channel_features(),
2752                                 fee_msat: 10_000,
2753                                 cltv_expiry_delta: 100,
2754                                 maybe_announced_channel: true,
2755                         }], blinded_tail: None },
2756                         Path { hops: vec![RouteHop {
2757                                 pubkey: nodes[1].node.get_our_node_id(),
2758                                 node_features: nodes[1].node.node_features(),
2759                                 short_channel_id: chans[1].short_channel_id.unwrap(),
2760                                 channel_features: nodes[1].node.channel_features(),
2761                                 fee_msat: 100_000_001, // Our default max-HTLC-value is 10% of the channel value, which this is one more than
2762                                 cltv_expiry_delta: 100,
2763                                 maybe_announced_channel: true,
2764                         }], blinded_tail: None },
2765                 ],
2766                 route_params: Some(route_params.clone()),
2767         };
2768         nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
2769         // On retry, split the payment across both channels.
2770         route.paths[0].hops[0].fee_msat = 50_000_001;
2771         route.paths[1].hops[0].fee_msat = 50_000_000;
2772         let mut pay_params = route.route_params.clone().unwrap().payment_params;
2773         pay_params.previously_failed_channels.push(chans[1].short_channel_id.unwrap());
2774
2775         let mut retry_params = RouteParameters::from_payment_params_and_value(pay_params, 100_000_000);
2776         retry_params.max_total_routing_fee_msat = None;
2777         route.route_params = Some(retry_params.clone());
2778         nodes[0].router.expect_find_route(retry_params, Ok(route.clone()));
2779
2780         {
2781                 let scorer = chanmon_cfgs[0].scorer.read().unwrap();
2782                 // The initial send attempt, 2 paths
2783                 scorer.expect_usage(chans[0].short_channel_id.unwrap(), ChannelUsage { amount_msat: 10_000, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown });
2784                 scorer.expect_usage(chans[1].short_channel_id.unwrap(), ChannelUsage { amount_msat: 100_000_001, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown });
2785                 // The retry, 2 paths. Ensure that the in-flight HTLC amount is factored in.
2786                 scorer.expect_usage(chans[0].short_channel_id.unwrap(), ChannelUsage { amount_msat: 50_000_001, inflight_htlc_msat: 10_000, effective_capacity: EffectiveCapacity::Unknown });
2787                 scorer.expect_usage(chans[1].short_channel_id.unwrap(), ChannelUsage { amount_msat: 50_000_000, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown });
2788         }
2789
2790         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2791                 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2792         let events = nodes[0].node.get_and_clear_pending_events();
2793         assert_eq!(events.len(), 1);
2794         match events[0] {
2795                 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently: false,
2796                         failure: PathFailure::InitialSend { err: APIError::ChannelUnavailable { .. }},
2797                         short_channel_id: Some(expected_scid), .. } =>
2798                 {
2799                         assert_eq!(payment_hash, ev_payment_hash);
2800                         assert_eq!(expected_scid, route.paths[1].hops[0].short_channel_id);
2801                 },
2802                 _ => panic!("Unexpected event"),
2803         }
2804         let htlc_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2805         assert_eq!(htlc_msgs.len(), 2);
2806         check_added_monitors!(nodes[0], 2);
2807 }
2808
2809 #[test]
2810 fn immediate_retry_on_failure() {
2811         // Tests that we can/will retry immediately after a failure
2812         let chanmon_cfgs = create_chanmon_cfgs(2);
2813         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2814         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
2815         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2816
2817         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
2818         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
2819
2820         let amt_msat = 100_000_001;
2821         let (_, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], amt_msat);
2822         #[cfg(feature = "std")]
2823         let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2824         #[cfg(not(feature = "std"))]
2825         let payment_expiry_secs = 60 * 60;
2826         let mut invoice_features = Bolt11InvoiceFeatures::empty();
2827         invoice_features.set_variable_length_onion_required();
2828         invoice_features.set_payment_secret_required();
2829         invoice_features.set_basic_mpp_optional();
2830         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
2831                 .with_expiry_time(payment_expiry_secs as u64)
2832                 .with_bolt11_features(invoice_features).unwrap();
2833         let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2834
2835         let chans = nodes[0].node.list_usable_channels();
2836         let mut route = Route {
2837                 paths: vec![
2838                         Path { hops: vec![RouteHop {
2839                                 pubkey: nodes[1].node.get_our_node_id(),
2840                                 node_features: nodes[1].node.node_features(),
2841                                 short_channel_id: chans[0].short_channel_id.unwrap(),
2842                                 channel_features: nodes[1].node.channel_features(),
2843                                 fee_msat: 100_000_001, // Our default max-HTLC-value is 10% of the channel value, which this is one more than
2844                                 cltv_expiry_delta: 100,
2845                                 maybe_announced_channel: true,
2846                         }], blinded_tail: None },
2847                 ],
2848                 route_params: Some(route_params.clone()),
2849         };
2850         nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
2851         // On retry, split the payment across both channels.
2852         route.paths.push(route.paths[0].clone());
2853         route.paths[0].hops[0].short_channel_id = chans[1].short_channel_id.unwrap();
2854         route.paths[0].hops[0].fee_msat = 50_000_000;
2855         route.paths[1].hops[0].fee_msat = 50_000_001;
2856         let mut pay_params = route_params.payment_params.clone();
2857         pay_params.previously_failed_channels.push(chans[0].short_channel_id.unwrap());
2858         let retry_params = RouteParameters::from_payment_params_and_value(pay_params, amt_msat);
2859         route.route_params = Some(retry_params.clone());
2860         nodes[0].router.expect_find_route(retry_params, Ok(route.clone()));
2861
2862         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2863                 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2864         let events = nodes[0].node.get_and_clear_pending_events();
2865         assert_eq!(events.len(), 1);
2866         match events[0] {
2867                 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently: false,
2868                         failure: PathFailure::InitialSend { err: APIError::ChannelUnavailable { .. }},
2869                         short_channel_id: Some(expected_scid), .. } =>
2870                 {
2871                         assert_eq!(payment_hash, ev_payment_hash);
2872                         assert_eq!(expected_scid, route.paths[1].hops[0].short_channel_id);
2873                 },
2874                 _ => panic!("Unexpected event"),
2875         }
2876         let htlc_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2877         assert_eq!(htlc_msgs.len(), 2);
2878         check_added_monitors!(nodes[0], 2);
2879 }
2880
2881 #[test]
2882 fn no_extra_retries_on_back_to_back_fail() {
2883         // In a previous release, we had a race where we may exceed the payment retry count if we
2884         // get two failures in a row with the second indicating that all paths had failed (this field,
2885         // `all_paths_failed`, has since been removed).
2886         // Generally, when we give up trying to retry a payment, we don't know for sure what the
2887         // current state of the ChannelManager event queue is. Specifically, we cannot be sure that
2888         // there are not multiple additional `PaymentPathFailed` or even `PaymentSent` events
2889         // pending which we will see later. Thus, when we previously removed the retry tracking map
2890         // entry after a `all_paths_failed` `PaymentPathFailed` event, we may have dropped the
2891         // retry entry even though more events for the same payment were still pending. This led to
2892         // us retrying a payment again even though we'd already given up on it.
2893         //
2894         // We now have a separate event - `PaymentFailed` which indicates no HTLCs remain and which
2895         // is used to remove the payment retry counter entries instead. This tests for the specific
2896         // excess-retry case while also testing `PaymentFailed` generation.
2897
2898         let chanmon_cfgs = create_chanmon_cfgs(3);
2899         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2900         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2901         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2902
2903         let chan_1_scid = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0).0.contents.short_channel_id;
2904         let chan_2_scid = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 0).0.contents.short_channel_id;
2905
2906         let amt_msat = 200_000_000;
2907         let (_, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], amt_msat);
2908         #[cfg(feature = "std")]
2909         let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2910         #[cfg(not(feature = "std"))]
2911         let payment_expiry_secs = 60 * 60;
2912         let mut invoice_features = Bolt11InvoiceFeatures::empty();
2913         invoice_features.set_variable_length_onion_required();
2914         invoice_features.set_payment_secret_required();
2915         invoice_features.set_basic_mpp_optional();
2916         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
2917                 .with_expiry_time(payment_expiry_secs as u64)
2918                 .with_bolt11_features(invoice_features).unwrap();
2919         let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2920         route_params.max_total_routing_fee_msat = None;
2921
2922         let mut route = Route {
2923                 paths: vec![
2924                         Path { hops: vec![RouteHop {
2925                                 pubkey: nodes[1].node.get_our_node_id(),
2926                                 node_features: nodes[1].node.node_features(),
2927                                 short_channel_id: chan_1_scid,
2928                                 channel_features: nodes[1].node.channel_features(),
2929                                 fee_msat: 0, // nodes[1] will fail the payment as we don't pay its fee
2930                                 cltv_expiry_delta: 100,
2931                                 maybe_announced_channel: true,
2932                         }, RouteHop {
2933                                 pubkey: nodes[2].node.get_our_node_id(),
2934                                 node_features: nodes[2].node.node_features(),
2935                                 short_channel_id: chan_2_scid,
2936                                 channel_features: nodes[2].node.channel_features(),
2937                                 fee_msat: 100_000_000,
2938                                 cltv_expiry_delta: 100,
2939                                 maybe_announced_channel: true,
2940                         }], blinded_tail: None },
2941                         Path { hops: vec![RouteHop {
2942                                 pubkey: nodes[1].node.get_our_node_id(),
2943                                 node_features: nodes[1].node.node_features(),
2944                                 short_channel_id: chan_1_scid,
2945                                 channel_features: nodes[1].node.channel_features(),
2946                                 fee_msat: 0, // nodes[1] will fail the payment as we don't pay its fee
2947                                 cltv_expiry_delta: 100,
2948                                 maybe_announced_channel: true,
2949                         }, RouteHop {
2950                                 pubkey: nodes[2].node.get_our_node_id(),
2951                                 node_features: nodes[2].node.node_features(),
2952                                 short_channel_id: chan_2_scid,
2953                                 channel_features: nodes[2].node.channel_features(),
2954                                 fee_msat: 100_000_000,
2955                                 cltv_expiry_delta: 100,
2956                                 maybe_announced_channel: true,
2957                         }], blinded_tail: None }
2958                 ],
2959                 route_params: Some(route_params.clone()),
2960         };
2961         route.route_params.as_mut().unwrap().max_total_routing_fee_msat = None;
2962         nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
2963         let mut second_payment_params = route_params.payment_params.clone();
2964         second_payment_params.previously_failed_channels = vec![chan_2_scid, chan_2_scid];
2965         // On retry, we'll only return one path
2966         route.paths.remove(1);
2967         route.paths[0].hops[1].fee_msat = amt_msat;
2968         let mut retry_params = RouteParameters::from_payment_params_and_value(second_payment_params, amt_msat);
2969         retry_params.max_total_routing_fee_msat = None;
2970         route.route_params = Some(retry_params.clone());
2971         nodes[0].router.expect_find_route(retry_params, Ok(route.clone()));
2972
2973         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2974                 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2975         let htlc_updates = SendEvent::from_node(&nodes[0]);
2976         check_added_monitors!(nodes[0], 1);
2977         assert_eq!(htlc_updates.msgs.len(), 1);
2978
2979         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &htlc_updates.msgs[0]);
2980         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &htlc_updates.commitment_msg);
2981         check_added_monitors!(nodes[1], 1);
2982         let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2983
2984         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2985         check_added_monitors!(nodes[0], 1);
2986         let second_htlc_updates = SendEvent::from_node(&nodes[0]);
2987
2988         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2989         check_added_monitors!(nodes[0], 1);
2990         let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2991
2992         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &second_htlc_updates.msgs[0]);
2993         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &second_htlc_updates.commitment_msg);
2994         check_added_monitors!(nodes[1], 1);
2995         let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2996
2997         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2998         check_added_monitors!(nodes[1], 1);
2999         let bs_fail_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3000
3001         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
3002         check_added_monitors!(nodes[0], 1);
3003
3004         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_update.update_fail_htlcs[0]);
3005         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_fail_update.commitment_signed);
3006         check_added_monitors!(nodes[0], 1);
3007         let (as_second_raa, as_third_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3008
3009         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
3010         check_added_monitors!(nodes[1], 1);
3011         let bs_second_fail_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3012
3013         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_third_cs);
3014         check_added_monitors!(nodes[1], 1);
3015         let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3016
3017         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_second_fail_update.update_fail_htlcs[0]);
3018         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_fail_update.commitment_signed);
3019         check_added_monitors!(nodes[0], 1);
3020
3021         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
3022         check_added_monitors!(nodes[0], 1);
3023         let (as_third_raa, as_fourth_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3024
3025         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_third_raa);
3026         check_added_monitors!(nodes[1], 1);
3027         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_fourth_cs);
3028         check_added_monitors!(nodes[1], 1);
3029         let bs_fourth_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3030
3031         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_fourth_raa);
3032         check_added_monitors!(nodes[0], 1);
3033
3034         // At this point A has sent two HTLCs which both failed due to lack of fee. It now has two
3035         // pending `PaymentPathFailed` events, one with `all_paths_failed` unset, and the second
3036         // with it set.
3037         //
3038         // Previously, we retried payments in an event consumer, which would retry each
3039         // `PaymentPathFailed` individually. In that setup, we had retried the payment in response to
3040         // the first `PaymentPathFailed`, then seen the second `PaymentPathFailed` with
3041         // `all_paths_failed` set and assumed the payment was completely failed. We ultimately fixed it
3042         // by adding the `PaymentFailed` event.
3043         //
3044         // Because we now retry payments as a batch, we simply return a single-path route in the
3045         // second, batched, request, have that fail, ensure the payment was abandoned.
3046         let mut events = nodes[0].node.get_and_clear_pending_events();
3047         assert_eq!(events.len(), 3);
3048         match events[0] {
3049                 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently, ..  } => {
3050                         assert_eq!(payment_hash, ev_payment_hash);
3051                         assert_eq!(payment_failed_permanently, false);
3052                 },
3053                 _ => panic!("Unexpected event"),
3054         }
3055         match events[1] {
3056                 Event::PendingHTLCsForwardable { .. } => {},
3057                 _ => panic!("Unexpected event"),
3058         }
3059         match events[2] {
3060                 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently, ..  } => {
3061                         assert_eq!(payment_hash, ev_payment_hash);
3062                         assert_eq!(payment_failed_permanently, false);
3063                 },
3064                 _ => panic!("Unexpected event"),
3065         }
3066
3067         nodes[0].node.process_pending_htlc_forwards();
3068         let retry_htlc_updates = SendEvent::from_node(&nodes[0]);
3069         check_added_monitors!(nodes[0], 1);
3070
3071         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &retry_htlc_updates.msgs[0]);
3072         commitment_signed_dance!(nodes[1], nodes[0], &retry_htlc_updates.commitment_msg, false, true);
3073         let bs_fail_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3074         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_update.update_fail_htlcs[0]);
3075         commitment_signed_dance!(nodes[0], nodes[1], &bs_fail_update.commitment_signed, false, true);
3076
3077         let mut events = nodes[0].node.get_and_clear_pending_events();
3078         assert_eq!(events.len(), 2);
3079         match events[0] {
3080                 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently, ..  } => {
3081                         assert_eq!(payment_hash, ev_payment_hash);
3082                         assert_eq!(payment_failed_permanently, false);
3083                 },
3084                 _ => panic!("Unexpected event"),
3085         }
3086         match events[1] {
3087                 Event::PaymentFailed { payment_hash: ref ev_payment_hash, payment_id: ref ev_payment_id, reason: ref ev_reason } => {
3088                         assert_eq!(payment_hash, *ev_payment_hash);
3089                         assert_eq!(PaymentId(payment_hash.0), *ev_payment_id);
3090                         assert_eq!(PaymentFailureReason::RetriesExhausted, ev_reason.unwrap());
3091                 },
3092                 _ => panic!("Unexpected event"),
3093         }
3094 }
3095
3096 #[test]
3097 fn test_simple_partial_retry() {
3098         // In the first version of the in-`ChannelManager` payment retries, retries were sent for the
3099         // full amount of the payment, rather than only the missing amount. Here we simply test for
3100         // this by sending a payment with two parts, failing one, and retrying the second. Note that
3101         // `TestRouter` will check that the `RouteParameters` (which contain the amount) matches the
3102         // request.
3103         let chanmon_cfgs = create_chanmon_cfgs(3);
3104         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3105         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3106         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3107
3108         let chan_1_scid = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0).0.contents.short_channel_id;
3109         let chan_2_scid = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 0).0.contents.short_channel_id;
3110
3111         let amt_msat = 200_000_000;
3112         let (_, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[2], amt_msat);
3113         #[cfg(feature = "std")]
3114         let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
3115         #[cfg(not(feature = "std"))]
3116         let payment_expiry_secs = 60 * 60;
3117         let mut invoice_features = Bolt11InvoiceFeatures::empty();
3118         invoice_features.set_variable_length_onion_required();
3119         invoice_features.set_payment_secret_required();
3120         invoice_features.set_basic_mpp_optional();
3121         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
3122                 .with_expiry_time(payment_expiry_secs as u64)
3123                 .with_bolt11_features(invoice_features).unwrap();
3124         let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
3125         route_params.max_total_routing_fee_msat = None;
3126
3127         let mut route = Route {
3128                 paths: vec![
3129                         Path { hops: vec![RouteHop {
3130                                 pubkey: nodes[1].node.get_our_node_id(),
3131                                 node_features: nodes[1].node.node_features(),
3132                                 short_channel_id: chan_1_scid,
3133                                 channel_features: nodes[1].node.channel_features(),
3134                                 fee_msat: 0, // nodes[1] will fail the payment as we don't pay its fee
3135                                 cltv_expiry_delta: 100,
3136                                 maybe_announced_channel: true,
3137                         }, RouteHop {
3138                                 pubkey: nodes[2].node.get_our_node_id(),
3139                                 node_features: nodes[2].node.node_features(),
3140                                 short_channel_id: chan_2_scid,
3141                                 channel_features: nodes[2].node.channel_features(),
3142                                 fee_msat: 100_000_000,
3143                                 cltv_expiry_delta: 100,
3144                                 maybe_announced_channel: true,
3145                         }], blinded_tail: None },
3146                         Path { hops: vec![RouteHop {
3147                                 pubkey: nodes[1].node.get_our_node_id(),
3148                                 node_features: nodes[1].node.node_features(),
3149                                 short_channel_id: chan_1_scid,
3150                                 channel_features: nodes[1].node.channel_features(),
3151                                 fee_msat: 100_000,
3152                                 cltv_expiry_delta: 100,
3153                                 maybe_announced_channel: true,
3154                         }, RouteHop {
3155                                 pubkey: nodes[2].node.get_our_node_id(),
3156                                 node_features: nodes[2].node.node_features(),
3157                                 short_channel_id: chan_2_scid,
3158                                 channel_features: nodes[2].node.channel_features(),
3159                                 fee_msat: 100_000_000,
3160                                 cltv_expiry_delta: 100,
3161                                 maybe_announced_channel: true,
3162                         }], blinded_tail: None }
3163                 ],
3164                 route_params: Some(route_params.clone()),
3165         };
3166
3167         nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
3168
3169         let mut second_payment_params = route_params.payment_params.clone();
3170         second_payment_params.previously_failed_channels = vec![chan_2_scid];
3171         // On retry, we'll only be asked for one path (or 100k sats)
3172         route.paths.remove(0);
3173         let mut retry_params = RouteParameters::from_payment_params_and_value(second_payment_params, amt_msat / 2);
3174         retry_params.max_total_routing_fee_msat = None;
3175         route.route_params = Some(retry_params.clone());
3176         nodes[0].router.expect_find_route(retry_params, Ok(route.clone()));
3177
3178         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
3179                 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
3180         let htlc_updates = SendEvent::from_node(&nodes[0]);
3181         check_added_monitors!(nodes[0], 1);
3182         assert_eq!(htlc_updates.msgs.len(), 1);
3183
3184         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &htlc_updates.msgs[0]);
3185         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &htlc_updates.commitment_msg);
3186         check_added_monitors!(nodes[1], 1);
3187         let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3188
3189         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
3190         check_added_monitors!(nodes[0], 1);
3191         let second_htlc_updates = SendEvent::from_node(&nodes[0]);
3192
3193         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
3194         check_added_monitors!(nodes[0], 1);
3195         let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3196
3197         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &second_htlc_updates.msgs[0]);
3198         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &second_htlc_updates.commitment_msg);
3199         check_added_monitors!(nodes[1], 1);
3200         let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3201
3202         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
3203         check_added_monitors!(nodes[1], 1);
3204         let bs_fail_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3205
3206         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
3207         check_added_monitors!(nodes[0], 1);
3208
3209         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_update.update_fail_htlcs[0]);
3210         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_fail_update.commitment_signed);
3211         check_added_monitors!(nodes[0], 1);
3212         let (as_second_raa, as_third_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3213
3214         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
3215         check_added_monitors!(nodes[1], 1);
3216
3217         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_third_cs);
3218         check_added_monitors!(nodes[1], 1);
3219
3220         let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3221
3222         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
3223         check_added_monitors!(nodes[0], 1);
3224
3225         let mut events = nodes[0].node.get_and_clear_pending_events();
3226         assert_eq!(events.len(), 2);
3227         match events[0] {
3228                 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently, ..  } => {
3229                         assert_eq!(payment_hash, ev_payment_hash);
3230                         assert_eq!(payment_failed_permanently, false);
3231                 },
3232                 _ => panic!("Unexpected event"),
3233         }
3234         match events[1] {
3235                 Event::PendingHTLCsForwardable { .. } => {},
3236                 _ => panic!("Unexpected event"),
3237         }
3238
3239         nodes[0].node.process_pending_htlc_forwards();
3240         let retry_htlc_updates = SendEvent::from_node(&nodes[0]);
3241         check_added_monitors!(nodes[0], 1);
3242
3243         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &retry_htlc_updates.msgs[0]);
3244         commitment_signed_dance!(nodes[1], nodes[0], &retry_htlc_updates.commitment_msg, false, true);
3245
3246         expect_pending_htlcs_forwardable!(nodes[1]);
3247         check_added_monitors!(nodes[1], 1);
3248
3249         let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3250         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
3251         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
3252         commitment_signed_dance!(nodes[2], nodes[1], &bs_forward_update.commitment_signed, false);
3253
3254         expect_pending_htlcs_forwardable!(nodes[2]);
3255         expect_payment_claimable!(nodes[2], payment_hash, payment_secret, amt_msat);
3256 }
3257
3258 #[test]
3259 #[cfg(feature = "std")]
3260 fn test_threaded_payment_retries() {
3261         // In the first version of the in-`ChannelManager` payment retries, retries weren't limited to
3262         // a single thread and would happily let multiple threads run retries at the same time. Because
3263         // retries are done by first calculating the amount we need to retry, then dropping the
3264         // relevant lock, then actually sending, we would happily let multiple threads retry the same
3265         // amount at the same time, overpaying our original HTLC!
3266         let chanmon_cfgs = create_chanmon_cfgs(4);
3267         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3268         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3269         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3270
3271         // There is one mitigating guardrail when retrying payments - we can never over-pay by more
3272         // than 10% of the original value. Thus, we want all our retries to be below that. In order to
3273         // keep things simple, we route one HTLC for 0.1% of the payment over channel 1 and the rest
3274         // out over channel 3+4. This will let us ignore 99% of the payment value and deal with only
3275         // our channel.
3276         let chan_1_scid = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0).0.contents.short_channel_id;
3277         create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 10_000_000, 0);
3278         let chan_3_scid = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 10_000_000, 0).0.contents.short_channel_id;
3279         let chan_4_scid = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 0).0.contents.short_channel_id;
3280
3281         let amt_msat = 100_000_000;
3282         let (_, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[2], amt_msat);
3283         #[cfg(feature = "std")]
3284         let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
3285         #[cfg(not(feature = "std"))]
3286         let payment_expiry_secs = 60 * 60;
3287         let mut invoice_features = Bolt11InvoiceFeatures::empty();
3288         invoice_features.set_variable_length_onion_required();
3289         invoice_features.set_payment_secret_required();
3290         invoice_features.set_basic_mpp_optional();
3291         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
3292                 .with_expiry_time(payment_expiry_secs as u64)
3293                 .with_bolt11_features(invoice_features).unwrap();
3294         let mut route_params = RouteParameters {
3295                 payment_params, final_value_msat: amt_msat, max_total_routing_fee_msat: Some(500_000),
3296         };
3297
3298         let mut route = Route {
3299                 paths: vec![
3300                         Path { hops: vec![RouteHop {
3301                                 pubkey: nodes[1].node.get_our_node_id(),
3302                                 node_features: nodes[1].node.node_features(),
3303                                 short_channel_id: chan_1_scid,
3304                                 channel_features: nodes[1].node.channel_features(),
3305                                 fee_msat: 0,
3306                                 cltv_expiry_delta: 100,
3307                                 maybe_announced_channel: true,
3308                         }, RouteHop {
3309                                 pubkey: nodes[3].node.get_our_node_id(),
3310                                 node_features: nodes[2].node.node_features(),
3311                                 short_channel_id: 42, // Set a random SCID which nodes[1] will fail as unknown
3312                                 channel_features: nodes[2].node.channel_features(),
3313                                 fee_msat: amt_msat / 1000,
3314                                 cltv_expiry_delta: 100,
3315                                 maybe_announced_channel: true,
3316                         }], blinded_tail: None },
3317                         Path { hops: vec![RouteHop {
3318                                 pubkey: nodes[2].node.get_our_node_id(),
3319                                 node_features: nodes[2].node.node_features(),
3320                                 short_channel_id: chan_3_scid,
3321                                 channel_features: nodes[2].node.channel_features(),
3322                                 fee_msat: 100_000,
3323                                 cltv_expiry_delta: 100,
3324                                 maybe_announced_channel: true,
3325                         }, RouteHop {
3326                                 pubkey: nodes[3].node.get_our_node_id(),
3327                                 node_features: nodes[3].node.node_features(),
3328                                 short_channel_id: chan_4_scid,
3329                                 channel_features: nodes[3].node.channel_features(),
3330                                 fee_msat: amt_msat - amt_msat / 1000,
3331                                 cltv_expiry_delta: 100,
3332                                 maybe_announced_channel: true,
3333                         }], blinded_tail: None }
3334                 ],
3335                 route_params: Some(route_params.clone()),
3336         };
3337         nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
3338
3339         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
3340                 PaymentId(payment_hash.0), route_params.clone(), Retry::Attempts(0xdeadbeef)).unwrap();
3341         check_added_monitors!(nodes[0], 2);
3342         let mut send_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3343         assert_eq!(send_msg_events.len(), 2);
3344         send_msg_events.retain(|msg|
3345                 if let MessageSendEvent::UpdateHTLCs { node_id, .. } = msg {
3346                         // Drop the commitment update for nodes[2], we can just let that one sit pending
3347                         // forever.
3348                         *node_id == nodes[1].node.get_our_node_id()
3349                 } else { panic!(); }
3350         );
3351
3352         // from here on out, the retry `RouteParameters` amount will be amt/1000
3353         route_params.final_value_msat /= 1000;
3354         route.route_params = Some(route_params.clone());
3355         route.paths.pop();
3356
3357         let end_time = Instant::now() + Duration::from_secs(1);
3358         macro_rules! thread_body { () => { {
3359                 // We really want std::thread::scope, but its not stable until 1.63. Until then, we get unsafe.
3360                 let node_ref = NodePtr::from_node(&nodes[0]);
3361                 move || {
3362                         let _ = &node_ref;
3363                         let node_a = unsafe { &*node_ref.0 };
3364                         while Instant::now() < end_time {
3365                                 node_a.node.get_and_clear_pending_events(); // wipe the PendingHTLCsForwardable
3366                                 // Ignore if we have any pending events, just always pretend we just got a
3367                                 // PendingHTLCsForwardable
3368                                 node_a.node.process_pending_htlc_forwards();
3369                         }
3370                 }
3371         } } }
3372         let mut threads = Vec::new();
3373         for _ in 0..16 { threads.push(std::thread::spawn(thread_body!())); }
3374
3375         // Back in the main thread, poll pending messages and make sure that we never have more than
3376         // one HTLC pending at a time. Note that the commitment_signed_dance will fail horribly if
3377         // there are HTLC messages shoved in while its running. This allows us to test that we never
3378         // generate an additional update_add_htlc until we've fully failed the first.
3379         let mut previously_failed_channels = Vec::new();
3380         loop {
3381                 assert_eq!(send_msg_events.len(), 1);
3382                 let send_event = SendEvent::from_event(send_msg_events.pop().unwrap());
3383                 assert_eq!(send_event.msgs.len(), 1);
3384
3385                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
3386                 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
3387
3388                 // Note that we only push one route into `expect_find_route` at a time, because that's all
3389                 // the retries (should) need. If the bug is reintroduced "real" routes may be selected, but
3390                 // we should still ultimately fail for the same reason - because we're trying to send too
3391                 // many HTLCs at once.
3392                 let mut new_route_params = route_params.clone();
3393                 previously_failed_channels.push(route.paths[0].hops[1].short_channel_id);
3394                 new_route_params.payment_params.previously_failed_channels = previously_failed_channels.clone();
3395                 new_route_params.max_total_routing_fee_msat.as_mut().map(|m| *m -= 100_000);
3396                 route.paths[0].hops[1].short_channel_id += 1;
3397                 route.route_params = Some(new_route_params.clone());
3398                 nodes[0].router.expect_find_route(new_route_params, Ok(route.clone()));
3399
3400                 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3401                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
3402                 // The "normal" commitment_signed_dance delivers the final RAA and then calls
3403                 // `check_added_monitors` to ensure only the one RAA-generated monitor update was created.
3404                 // This races with our other threads which may generate an add-HTLCs commitment update via
3405                 // `process_pending_htlc_forwards`. Instead, we defer the monitor update check until after
3406                 // *we've* called `process_pending_htlc_forwards` when its guaranteed to have two updates.
3407                 let last_raa = commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true, false, true);
3408                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &last_raa);
3409
3410                 let cur_time = Instant::now();
3411                 if cur_time > end_time {
3412                         for thread in threads.drain(..) { thread.join().unwrap(); }
3413                 }
3414
3415                 // Make sure we have some events to handle when we go around...
3416                 nodes[0].node.get_and_clear_pending_events(); // wipe the PendingHTLCsForwardable
3417                 nodes[0].node.process_pending_htlc_forwards();
3418                 send_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3419                 check_added_monitors!(nodes[0], 2);
3420
3421                 if cur_time > end_time {
3422                         break;
3423                 }
3424         }
3425 }
3426
3427 fn do_no_missing_sent_on_reload(persist_manager_with_payment: bool, at_midpoint: bool) {
3428         // Test that if we reload in the middle of an HTLC claim commitment signed dance we'll still
3429         // receive the PaymentSent event even if the ChannelManager had no idea about the payment when
3430         // it was last persisted.
3431         let chanmon_cfgs = create_chanmon_cfgs(2);
3432         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3433         let (persister_a, persister_b, persister_c);
3434         let (chain_monitor_a, chain_monitor_b, chain_monitor_c);
3435         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3436         let (nodes_0_deserialized, nodes_0_deserialized_b, nodes_0_deserialized_c);
3437         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3438
3439         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
3440
3441         let mut nodes_0_serialized = Vec::new();
3442         if !persist_manager_with_payment {
3443                 nodes_0_serialized = nodes[0].node.encode();
3444         }
3445
3446         let (our_payment_preimage, our_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
3447
3448         if persist_manager_with_payment {
3449                 nodes_0_serialized = nodes[0].node.encode();
3450         }
3451
3452         nodes[1].node.claim_funds(our_payment_preimage);
3453         check_added_monitors!(nodes[1], 1);
3454         expect_payment_claimed!(nodes[1], our_payment_hash, 1_000_000);
3455
3456         if at_midpoint {
3457                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3458                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
3459                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
3460                 check_added_monitors!(nodes[0], 1);
3461         } else {
3462                 let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3463                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
3464                 commitment_signed_dance!(nodes[0], nodes[1], htlc_fulfill_updates.commitment_signed, false);
3465                 // Ignore the PaymentSent event which is now pending on nodes[0] - if we were to handle it we'd
3466                 // be expected to ignore the eventual conflicting PaymentFailed, but by not looking at it we
3467                 // expect to get the PaymentSent again later.
3468                 check_added_monitors(&nodes[0], 0);
3469         }
3470
3471         // The ChannelMonitor should always be the latest version, as we're required to persist it
3472         // during the commitment signed handling.
3473         let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
3474         reload_node!(nodes[0], test_default_channel_config(), &nodes_0_serialized, &[&chan_0_monitor_serialized], persister_a, chain_monitor_a, nodes_0_deserialized);
3475
3476         let events = nodes[0].node.get_and_clear_pending_events();
3477         assert_eq!(events.len(), 2);
3478         if let Event::ChannelClosed { reason: ClosureReason::OutdatedChannelManager, .. } = events[0] {} else { panic!(); }
3479         if let Event::PaymentSent { payment_preimage, .. } = events[1] { assert_eq!(payment_preimage, our_payment_preimage); } else { panic!(); }
3480         // Note that we don't get a PaymentPathSuccessful here as we leave the HTLC pending to avoid
3481         // the double-claim that would otherwise appear at the end of this test.
3482         nodes[0].node.timer_tick_occurred();
3483         let as_broadcasted_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3484         assert_eq!(as_broadcasted_txn.len(), 1);
3485
3486         // Ensure that, even after some time, if we restart we still include *something* in the current
3487         // `ChannelManager` which prevents a `PaymentFailed` when we restart even if pending resolved
3488         // payments have since been timed out thanks to `IDEMPOTENCY_TIMEOUT_TICKS`.
3489         // A naive implementation of the fix here would wipe the pending payments set, causing a
3490         // failure event when we restart.
3491         for _ in 0..(IDEMPOTENCY_TIMEOUT_TICKS * 2) { nodes[0].node.timer_tick_occurred(); }
3492
3493         let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
3494         reload_node!(nodes[0], test_default_channel_config(), &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister_b, chain_monitor_b, nodes_0_deserialized_b);
3495         let events = nodes[0].node.get_and_clear_pending_events();
3496         assert!(events.is_empty());
3497
3498         // Ensure that we don't generate any further events even after the channel-closing commitment
3499         // transaction is confirmed on-chain.
3500         confirm_transaction(&nodes[0], &as_broadcasted_txn[0]);
3501         for _ in 0..(IDEMPOTENCY_TIMEOUT_TICKS * 2) { nodes[0].node.timer_tick_occurred(); }
3502
3503         let events = nodes[0].node.get_and_clear_pending_events();
3504         assert!(events.is_empty());
3505
3506         let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
3507         reload_node!(nodes[0], test_default_channel_config(), &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister_c, chain_monitor_c, nodes_0_deserialized_c);
3508         let events = nodes[0].node.get_and_clear_pending_events();
3509         assert!(events.is_empty());
3510         check_added_monitors(&nodes[0], 1);
3511 }
3512
3513 #[test]
3514 fn no_missing_sent_on_midpoint_reload() {
3515         do_no_missing_sent_on_reload(false, true);
3516         do_no_missing_sent_on_reload(true, true);
3517 }
3518
3519 #[test]
3520 fn no_missing_sent_on_reload() {
3521         do_no_missing_sent_on_reload(false, false);
3522         do_no_missing_sent_on_reload(true, false);
3523 }
3524
3525 fn do_claim_from_closed_chan(fail_payment: bool) {
3526         // Previously, LDK would refuse to claim a payment if a channel on which the payment was
3527         // received had been closed between when the HTLC was received and when we went to claim it.
3528         // This makes sense in the payment case - why pay an on-chain fee to claim the HTLC when
3529         // presumably the sender may retry later. Long ago it also reduced total code in the claim
3530         // pipeline.
3531         //
3532         // However, this doesn't make sense if you're trying to do an atomic swap or some other
3533         // protocol that requires atomicity with some other action - if your money got claimed
3534         // elsewhere you need to be able to claim the HTLC in lightning no matter what. Further, this
3535         // is an over-optimization - there should be a very, very low likelihood that a channel closes
3536         // between when we receive the last HTLC for a payment and the user goes to claim the payment.
3537         // Since we now have code to handle this anyway we should allow it.
3538
3539         // Build 4 nodes and send an MPP payment across two paths. By building a route manually set the
3540         // CLTVs on the paths to different value resulting in a different claim deadline.
3541         let chanmon_cfgs = create_chanmon_cfgs(4);
3542         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3543         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3544         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3545
3546         create_announced_chan_between_nodes(&nodes, 0, 1);
3547         create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0);
3548         let chan_bd = create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 1_000_000, 0).2;
3549         create_announced_chan_between_nodes(&nodes, 2, 3);
3550
3551         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[3]);
3552         let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
3553                 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
3554         let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, 10_000_000);
3555         let mut route = nodes[0].router.find_route(&nodes[0].node.get_our_node_id(), &route_params,
3556                 None, nodes[0].node.compute_inflight_htlcs()).unwrap();
3557         // Make sure the route is ordered as the B->D path before C->D
3558         route.paths.sort_by(|a, _| if a.hops[0].pubkey == nodes[1].node.get_our_node_id() {
3559                 std::cmp::Ordering::Less } else { std::cmp::Ordering::Greater });
3560
3561         // Note that we add an extra 1 in the send pipeline to compensate for any blocks found while
3562         // the HTLC is being relayed.
3563         route.paths[0].hops[1].cltv_expiry_delta = TEST_FINAL_CLTV + 8;
3564         route.paths[1].hops[1].cltv_expiry_delta = TEST_FINAL_CLTV + 12;
3565         let final_cltv = nodes[0].best_block_info().1 + TEST_FINAL_CLTV + 8 + 1;
3566
3567         nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
3568         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
3569                 PaymentId(payment_hash.0), route_params.clone(), Retry::Attempts(1)).unwrap();
3570         check_added_monitors(&nodes[0], 2);
3571         let mut send_msgs = nodes[0].node.get_and_clear_pending_msg_events();
3572         send_msgs.sort_by(|a, _| {
3573                 let a_node_id =
3574                         if let MessageSendEvent::UpdateHTLCs { node_id, .. } = a { node_id } else { panic!() };
3575                 let node_b_id = nodes[1].node.get_our_node_id();
3576                 if *a_node_id == node_b_id { std::cmp::Ordering::Less } else { std::cmp::Ordering::Greater }
3577         });
3578
3579         assert_eq!(send_msgs.len(), 2);
3580         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 10_000_000,
3581                 payment_hash, Some(payment_secret), send_msgs.remove(0), false, None);
3582         let receive_event = pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 10_000_000,
3583                 payment_hash, Some(payment_secret), send_msgs.remove(0), true, None);
3584
3585         match receive_event.unwrap() {
3586                 Event::PaymentClaimable { claim_deadline, .. } => {
3587                         assert_eq!(claim_deadline.unwrap(), final_cltv - HTLC_FAIL_BACK_BUFFER);
3588                 },
3589                 _ => panic!(),
3590         }
3591
3592         // Ensure that the claim_deadline is correct, with the payment failing at exactly the given
3593         // height.
3594         connect_blocks(&nodes[3], final_cltv - HTLC_FAIL_BACK_BUFFER - nodes[3].best_block_info().1
3595                 - if fail_payment { 0 } else { 2 });
3596         let error_message = "Channel force-closed";
3597         if fail_payment {
3598                 // We fail the HTLC on the A->B->D path first as it expires 4 blocks earlier. We go ahead
3599                 // and expire both immediately, though, by connecting another 4 blocks.
3600                 let reason = HTLCDestination::FailedPayment { payment_hash };
3601                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[3], [reason.clone()]);
3602                 connect_blocks(&nodes[3], 4);
3603                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[3], [reason]);
3604                 pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash, PaymentFailureReason::RecipientRejected);
3605         } else {
3606                 nodes[1].node.force_close_broadcasting_latest_txn(&chan_bd, &nodes[3].node.get_our_node_id(), error_message.to_string()).unwrap();
3607                 check_closed_event!(&nodes[1], 1, ClosureReason::HolderForceClosed, false,
3608                         [nodes[3].node.get_our_node_id()], 1000000);
3609                 check_closed_broadcast(&nodes[1], 1, true);
3610                 let bs_tx = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3611                 assert_eq!(bs_tx.len(), 1);
3612
3613                 mine_transaction(&nodes[3], &bs_tx[0]);
3614                 check_added_monitors(&nodes[3], 1);
3615                 check_closed_broadcast(&nodes[3], 1, true);
3616                 check_closed_event!(&nodes[3], 1, ClosureReason::CommitmentTxConfirmed, false,
3617                         [nodes[1].node.get_our_node_id()], 1000000);
3618
3619                 nodes[3].node.claim_funds(payment_preimage);
3620                 check_added_monitors(&nodes[3], 2);
3621                 expect_payment_claimed!(nodes[3], payment_hash, 10_000_000);
3622
3623                 let ds_tx = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3624                 assert_eq!(ds_tx.len(), 1);
3625                 check_spends!(&ds_tx[0], &bs_tx[0]);
3626
3627                 mine_transactions(&nodes[1], &[&bs_tx[0], &ds_tx[0]]);
3628                 check_added_monitors(&nodes[1], 1);
3629                 expect_payment_forwarded!(nodes[1], nodes[0], nodes[3], Some(1000), false, true);
3630
3631                 let bs_claims = nodes[1].node.get_and_clear_pending_msg_events();
3632                 check_added_monitors(&nodes[1], 1);
3633                 assert_eq!(bs_claims.len(), 1);
3634                 if let MessageSendEvent::UpdateHTLCs { updates, .. } = &bs_claims[0] {
3635                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
3636                         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false, true);
3637                 } else { panic!(); }
3638
3639                 expect_payment_sent!(nodes[0], payment_preimage);
3640
3641                 let ds_claim_msgs = nodes[3].node.get_and_clear_pending_msg_events();
3642                 assert_eq!(ds_claim_msgs.len(), 1);
3643                 let cs_claim_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = &ds_claim_msgs[0] {
3644                         nodes[2].node.handle_update_fulfill_htlc(&nodes[3].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
3645                         let cs_claim_msgs = nodes[2].node.get_and_clear_pending_msg_events();
3646                         check_added_monitors(&nodes[2], 1);
3647                         commitment_signed_dance!(nodes[2], nodes[3], updates.commitment_signed, false, true);
3648                         expect_payment_forwarded!(nodes[2], nodes[0], nodes[3], Some(1000), false, false);
3649                         cs_claim_msgs
3650                 } else { panic!(); };
3651
3652                 assert_eq!(cs_claim_msgs.len(), 1);
3653                 if let MessageSendEvent::UpdateHTLCs { updates, .. } = &cs_claim_msgs[0] {
3654                         nodes[0].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
3655                         commitment_signed_dance!(nodes[0], nodes[2], updates.commitment_signed, false, true);
3656                 } else { panic!(); }
3657
3658                 expect_payment_path_successful!(nodes[0]);
3659         }
3660 }
3661
3662 #[test]
3663 fn claim_from_closed_chan() {
3664         do_claim_from_closed_chan(true);
3665         do_claim_from_closed_chan(false);
3666 }
3667
3668 #[test]
3669 fn test_custom_tlvs_basic() {
3670         do_test_custom_tlvs(false, false, false);
3671         do_test_custom_tlvs(true, false, false);
3672 }
3673
3674 #[test]
3675 fn test_custom_tlvs_explicit_claim() {
3676         // Test that when receiving even custom TLVs the user must explicitly accept in case they
3677         // are unknown.
3678         do_test_custom_tlvs(false, true, false);
3679         do_test_custom_tlvs(false, true, true);
3680 }
3681
3682 fn do_test_custom_tlvs(spontaneous: bool, even_tlvs: bool, known_tlvs: bool) {
3683         let chanmon_cfgs = create_chanmon_cfgs(2);
3684         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3685         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None; 2]);
3686         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3687
3688         create_announced_chan_between_nodes(&nodes, 0, 1);
3689
3690         let amt_msat = 100_000;
3691         let (mut route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(&nodes[0], &nodes[1], amt_msat);
3692         let payment_id = PaymentId(our_payment_hash.0);
3693         let custom_tlvs = vec![
3694                 (if even_tlvs { 5482373482 } else { 5482373483 }, vec![1, 2, 3, 4]),
3695                 (5482373487, vec![0x42u8; 16]),
3696         ];
3697         let onion_fields = RecipientOnionFields {
3698                 payment_secret: if spontaneous { None } else { Some(our_payment_secret) },
3699                 payment_metadata: None,
3700                 custom_tlvs: custom_tlvs.clone()
3701         };
3702         if spontaneous {
3703                 nodes[0].node.send_spontaneous_payment(&route, Some(our_payment_preimage), onion_fields, payment_id).unwrap();
3704         } else {
3705                 nodes[0].node.send_payment_with_route(&route, our_payment_hash, onion_fields, payment_id).unwrap();
3706         }
3707         check_added_monitors(&nodes[0], 1);
3708
3709         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3710         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
3711         let mut payment_event = SendEvent::from_event(ev);
3712
3713         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3714         check_added_monitors!(&nodes[1], 0);
3715         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3716         expect_pending_htlcs_forwardable!(nodes[1]);
3717
3718         let events = nodes[1].node.get_and_clear_pending_events();
3719         assert_eq!(events.len(), 1);
3720         match events[0] {
3721                 Event::PaymentClaimable { ref onion_fields, .. } => {
3722                         assert_eq!(onion_fields.clone().unwrap().custom_tlvs().clone(), custom_tlvs);
3723                 },
3724                 _ => panic!("Unexpected event"),
3725         }
3726
3727         match (known_tlvs, even_tlvs) {
3728                 (true, _) => {
3729                         nodes[1].node.claim_funds_with_known_custom_tlvs(our_payment_preimage);
3730                         let expected_total_fee_msat = pass_claimed_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[&[&nodes[1]]], our_payment_preimage));
3731                         expect_payment_sent!(&nodes[0], our_payment_preimage, Some(expected_total_fee_msat));
3732                 },
3733                 (false, false) => {
3734                         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
3735                 },
3736                 (false, true) => {
3737                         nodes[1].node.claim_funds(our_payment_preimage);
3738                         let expected_destinations = vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }];
3739                         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], expected_destinations);
3740                         pass_failed_payment_back(&nodes[0], &[&[&nodes[1]]], false, our_payment_hash, PaymentFailureReason::RecipientRejected);
3741                 }
3742         }
3743 }
3744
3745 #[test]
3746 fn test_retry_custom_tlvs() {
3747         // Test that custom TLVs are successfully sent on retries
3748         let chanmon_cfgs = create_chanmon_cfgs(3);
3749         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3750         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3751         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3752
3753         create_announced_chan_between_nodes(&nodes, 0, 1);
3754         let (chan_2_update, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 2, 1);
3755
3756         // Rebalance
3757         send_payment(&nodes[2], &vec!(&nodes[1])[..], 1_500_000);
3758
3759         let amt_msat = 1_000_000;
3760         let (mut route, payment_hash, payment_preimage, payment_secret) =
3761                 get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);
3762
3763         // Initiate the payment
3764         let payment_id = PaymentId(payment_hash.0);
3765         let mut route_params = route.route_params.clone().unwrap();
3766
3767         let custom_tlvs = vec![((1 << 16) + 1, vec![0x42u8; 16])];
3768         let onion_fields = RecipientOnionFields::secret_only(payment_secret);
3769         let onion_fields = onion_fields.with_custom_tlvs(custom_tlvs.clone()).unwrap();
3770
3771         nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
3772         nodes[0].node.send_payment(payment_hash, onion_fields,
3773                 payment_id, route_params.clone(), Retry::Attempts(1)).unwrap();
3774         check_added_monitors!(nodes[0], 1); // one monitor per path
3775
3776         // Add the HTLC along the first hop.
3777         let htlc_updates = get_htlc_update_msgs(&nodes[0], &nodes[1].node.get_our_node_id());
3778         let msgs::CommitmentUpdate { update_add_htlcs, commitment_signed, .. } = htlc_updates;
3779         assert_eq!(update_add_htlcs.len(), 1);
3780         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_htlcs[0]);
3781         commitment_signed_dance!(nodes[1], nodes[0], commitment_signed, false);
3782
3783         // Attempt to forward the payment and complete the path's failure.
3784         expect_pending_htlcs_forwardable!(&nodes[1]);
3785         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[1],
3786                 vec![HTLCDestination::NextHopChannel {
3787                         node_id: Some(nodes[2].node.get_our_node_id()),
3788                         channel_id: chan_2_id
3789                 }]);
3790         check_added_monitors!(nodes[1], 1);
3791
3792         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3793         let msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } = htlc_updates;
3794         assert_eq!(update_fail_htlcs.len(), 1);
3795         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3796         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
3797
3798         let mut events = nodes[0].node.get_and_clear_pending_events();
3799         match events[1] {
3800                 Event::PendingHTLCsForwardable { .. } => {},
3801                 _ => panic!("Unexpected event")
3802         }
3803         events.remove(1);
3804         expect_payment_failed_conditions_event(events, payment_hash, false,
3805                 PaymentFailedConditions::new().mpp_parts_remain());
3806
3807         // Rebalance the channel so the retry of the payment can succeed.
3808         send_payment(&nodes[2], &vec!(&nodes[1])[..], 1_500_000);
3809
3810         // Retry the payment and make sure it succeeds
3811         route_params.payment_params.previously_failed_channels.push(chan_2_update.contents.short_channel_id);
3812         route.route_params = Some(route_params.clone());
3813         nodes[0].router.expect_find_route(route_params, Ok(route));
3814         nodes[0].node.process_pending_htlc_forwards();
3815         check_added_monitors!(nodes[0], 1);
3816         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3817         assert_eq!(events.len(), 1);
3818         let path = &[&nodes[1], &nodes[2]];
3819         let args = PassAlongPathArgs::new(&nodes[0], path, 1_000_000, payment_hash, events.pop().unwrap())
3820                 .with_payment_secret(payment_secret)
3821                 .with_custom_tlvs(custom_tlvs);
3822         do_pass_along_path(args);
3823         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
3824 }
3825
3826 #[test]
3827 fn test_custom_tlvs_consistency() {
3828         let even_type_1 = 1 << 16;
3829         let odd_type_1  = (1 << 16)+ 1;
3830         let even_type_2 = (1 << 16) + 2;
3831         let odd_type_2  = (1 << 16) + 3;
3832         let value_1 = || vec![1, 2, 3, 4];
3833         let differing_value_1 = || vec![1, 2, 3, 5];
3834         let value_2 = || vec![42u8; 16];
3835
3836         // Drop missing odd tlvs
3837         do_test_custom_tlvs_consistency(
3838                 vec![(odd_type_1, value_1()), (odd_type_2, value_2())],
3839                 vec![(odd_type_1, value_1())],
3840                 Some(vec![(odd_type_1, value_1())]),
3841         );
3842         // Drop non-matching odd tlvs
3843         do_test_custom_tlvs_consistency(
3844                 vec![(odd_type_1, value_1()), (odd_type_2, value_2())],
3845                 vec![(odd_type_1, differing_value_1()), (odd_type_2, value_2())],
3846                 Some(vec![(odd_type_2, value_2())]),
3847         );
3848         // Fail missing even tlvs
3849         do_test_custom_tlvs_consistency(
3850                 vec![(odd_type_1, value_1()), (even_type_2, value_2())],
3851                 vec![(odd_type_1, value_1())],
3852                 None,
3853         );
3854         // Fail non-matching even tlvs
3855         do_test_custom_tlvs_consistency(
3856                 vec![(even_type_1, value_1()), (odd_type_2, value_2())],
3857                 vec![(even_type_1, differing_value_1()), (odd_type_2, value_2())],
3858                 None,
3859         );
3860 }
3861
3862 fn do_test_custom_tlvs_consistency(first_tlvs: Vec<(u64, Vec<u8>)>, second_tlvs: Vec<(u64, Vec<u8>)>,
3863         expected_receive_tlvs: Option<Vec<(u64, Vec<u8>)>>) {
3864
3865         let chanmon_cfgs = create_chanmon_cfgs(4);
3866         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3867         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3868         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3869
3870         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
3871         create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100_000, 0);
3872         create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 100_000, 0);
3873         let chan_2_3 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 100_000, 0);
3874
3875         let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
3876                 .with_bolt11_features(nodes[3].node.bolt11_invoice_features()).unwrap();
3877         let mut route = get_route!(nodes[0], payment_params, 15_000_000).unwrap();
3878         assert_eq!(route.paths.len(), 2);
3879         route.paths.sort_by(|path_a, _| {
3880                 // Sort the path so that the path through nodes[1] comes first
3881                 if path_a.hops[0].pubkey == nodes[1].node.get_our_node_id() {
3882                         core::cmp::Ordering::Less } else { core::cmp::Ordering::Greater }
3883         });
3884
3885         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(&nodes[3]);
3886         let payment_id = PaymentId([42; 32]);
3887         let amt_msat = 15_000_000;
3888
3889         // Send first part
3890         let onion_fields = RecipientOnionFields {
3891                 payment_secret: Some(our_payment_secret),
3892                 payment_metadata: None,
3893                 custom_tlvs: first_tlvs
3894         };
3895         let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
3896                         onion_fields.clone(), payment_id, &route).unwrap();
3897         let cur_height = nodes[0].best_block_info().1;
3898         nodes[0].node.test_send_payment_along_path(&route.paths[0], &our_payment_hash,
3899                 onion_fields.clone(), amt_msat, cur_height, payment_id,
3900                 &None, session_privs[0]).unwrap();
3901         check_added_monitors!(nodes[0], 1);
3902
3903         {
3904                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3905                 assert_eq!(events.len(), 1);
3906                 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], amt_msat, our_payment_hash,
3907                         Some(our_payment_secret), events.pop().unwrap(), false, None);
3908         }
3909         assert!(nodes[3].node.get_and_clear_pending_events().is_empty());
3910
3911         // Send second part
3912         let onion_fields = RecipientOnionFields {
3913                 payment_secret: Some(our_payment_secret),
3914                 payment_metadata: None,
3915                 custom_tlvs: second_tlvs
3916         };
3917         nodes[0].node.test_send_payment_along_path(&route.paths[1], &our_payment_hash,
3918                 onion_fields.clone(), amt_msat, cur_height, payment_id, &None, session_privs[1]).unwrap();
3919         check_added_monitors!(nodes[0], 1);
3920
3921         {
3922                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3923                 assert_eq!(events.len(), 1);
3924                 let payment_event = SendEvent::from_event(events.pop().unwrap());
3925
3926                 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3927                 commitment_signed_dance!(nodes[2], nodes[0], payment_event.commitment_msg, false);
3928
3929                 expect_pending_htlcs_forwardable!(nodes[2]);
3930                 check_added_monitors!(nodes[2], 1);
3931
3932                 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
3933                 assert_eq!(events.len(), 1);
3934                 let payment_event = SendEvent::from_event(events.pop().unwrap());
3935
3936                 nodes[3].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
3937                 check_added_monitors!(nodes[3], 0);
3938                 commitment_signed_dance!(nodes[3], nodes[2], payment_event.commitment_msg, true, true);
3939         }
3940         expect_pending_htlcs_forwardable_ignore!(nodes[3]);
3941         nodes[3].node.process_pending_htlc_forwards();
3942
3943         if let Some(expected_tlvs) = expected_receive_tlvs {
3944                 // Claim and match expected
3945                 let events = nodes[3].node.get_and_clear_pending_events();
3946                 assert_eq!(events.len(), 1);
3947                 match events[0] {
3948                         Event::PaymentClaimable { ref onion_fields, .. } => {
3949                                 assert_eq!(onion_fields.clone().unwrap().custom_tlvs, expected_tlvs);
3950                         },
3951                         _ => panic!("Unexpected event"),
3952                 }
3953
3954                 do_claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]],
3955                         false, our_payment_preimage);
3956                 expect_payment_sent(&nodes[0], our_payment_preimage, Some(Some(2000)), true, true);
3957         } else {
3958                 // Expect fail back
3959                 let expected_destinations = vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }];
3960                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], expected_destinations);
3961                 check_added_monitors!(nodes[3], 1);
3962
3963                 let fail_updates_1 = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
3964                 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
3965                 commitment_signed_dance!(nodes[2], nodes[3], fail_updates_1.commitment_signed, false);
3966
3967                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![
3968                         HTLCDestination::NextHopChannel {
3969                                 node_id: Some(nodes[3].node.get_our_node_id()),
3970                                 channel_id: chan_2_3.2
3971                         }]);
3972                 check_added_monitors!(nodes[2], 1);
3973
3974                 let fail_updates_2 = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
3975                 nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_updates_2.update_fail_htlcs[0]);
3976                 commitment_signed_dance!(nodes[0], nodes[2], fail_updates_2.commitment_signed, false);
3977
3978                 expect_payment_failed_conditions(&nodes[0], our_payment_hash, true,
3979                         PaymentFailedConditions::new().mpp_parts_remain());
3980         }
3981 }
3982
3983 fn do_test_payment_metadata_consistency(do_reload: bool, do_modify: bool) {
3984         // Check that a payment metadata received on one HTLC that doesn't match the one received on
3985         // another results in the HTLC being rejected.
3986         //
3987         // We first set up a diamond shaped network, allowing us to split a payment into two HTLCs, the
3988         // first of which we'll deliver and the second of which we'll fail and then re-send with
3989         // modified payment metadata, which will in turn result in it being failed by the recipient.
3990         let chanmon_cfgs = create_chanmon_cfgs(4);
3991         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3992         let persister;
3993         let new_chain_monitor;
3994
3995         let mut config = test_default_channel_config();
3996         config.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 50;
3997         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, Some(config), Some(config), Some(config)]);
3998         let nodes_0_deserialized;
3999
4000         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4001
4002         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
4003         let chan_id_bd = create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 1_000_000, 0).2;
4004         create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0);
4005         let chan_id_cd = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0).2;
4006
4007         // Pay more than half of each channel's max, requiring MPP
4008         let amt_msat = 750_000_000;
4009         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[3], Some(amt_msat));
4010         let payment_id = PaymentId(payment_hash.0);
4011         let payment_metadata = vec![44, 49, 52, 142];
4012
4013         let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
4014                 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
4015         let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
4016
4017         // Send the MPP payment, delivering the updated commitment state to nodes[1].
4018         nodes[0].node.send_payment(payment_hash, RecipientOnionFields {
4019                         payment_secret: Some(payment_secret), payment_metadata: Some(payment_metadata), custom_tlvs: vec![],
4020                 }, payment_id, route_params.clone(), Retry::Attempts(1)).unwrap();
4021         check_added_monitors!(nodes[0], 2);
4022
4023         let mut send_events = nodes[0].node.get_and_clear_pending_msg_events();
4024         assert_eq!(send_events.len(), 2);
4025         let first_send = SendEvent::from_event(send_events.pop().unwrap());
4026         let second_send = SendEvent::from_event(send_events.pop().unwrap());
4027
4028         let (b_recv_ev, c_recv_ev) = if first_send.node_id == nodes[1].node.get_our_node_id() {
4029                 (&first_send, &second_send)
4030         } else {
4031                 (&second_send, &first_send)
4032         };
4033         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &b_recv_ev.msgs[0]);
4034         commitment_signed_dance!(nodes[1], nodes[0], b_recv_ev.commitment_msg, false, true);
4035
4036         expect_pending_htlcs_forwardable!(nodes[1]);
4037         check_added_monitors(&nodes[1], 1);
4038         let b_forward_ev = SendEvent::from_node(&nodes[1]);
4039         nodes[3].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &b_forward_ev.msgs[0]);
4040         commitment_signed_dance!(nodes[3], nodes[1], b_forward_ev.commitment_msg, false, true);
4041
4042         expect_pending_htlcs_forwardable!(nodes[3]);
4043
4044         // Before delivering the second MPP HTLC to nodes[2], disconnect nodes[2] and nodes[3], which
4045         // will result in nodes[2] failing the HTLC back.
4046         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id());
4047         nodes[3].node.peer_disconnected(&nodes[2].node.get_our_node_id());
4048
4049         nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &c_recv_ev.msgs[0]);
4050         commitment_signed_dance!(nodes[2], nodes[0], c_recv_ev.commitment_msg, false, true);
4051
4052         let cs_fail = get_htlc_update_msgs(&nodes[2], &nodes[0].node.get_our_node_id());
4053         nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail.update_fail_htlcs[0]);
4054         commitment_signed_dance!(nodes[0], nodes[2], cs_fail.commitment_signed, false, true);
4055
4056         let payment_fail_retryable_evs = nodes[0].node.get_and_clear_pending_events();
4057         assert_eq!(payment_fail_retryable_evs.len(), 2);
4058         if let Event::PaymentPathFailed { .. } = payment_fail_retryable_evs[0] {} else { panic!(); }
4059         if let Event::PendingHTLCsForwardable { .. } = payment_fail_retryable_evs[1] {} else { panic!(); }
4060
4061         // Before we allow the HTLC to be retried, optionally change the payment_metadata we have
4062         // stored for our payment.
4063         if do_modify {
4064                 nodes[0].node.test_set_payment_metadata(payment_id, Some(Vec::new()));
4065         }
4066
4067         // Optionally reload nodes[3] to check that the payment_metadata is properly serialized with
4068         // the payment state.
4069         if do_reload {
4070                 let mon_bd = get_monitor!(nodes[3], chan_id_bd).encode();
4071                 let mon_cd = get_monitor!(nodes[3], chan_id_cd).encode();
4072                 reload_node!(nodes[3], config, &nodes[3].node.encode(), &[&mon_bd, &mon_cd],
4073                         persister, new_chain_monitor, nodes_0_deserialized);
4074                 nodes[1].node.peer_disconnected(&nodes[3].node.get_our_node_id());
4075                 reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[3]));
4076         }
4077         let mut reconnect_args = ReconnectArgs::new(&nodes[2], &nodes[3]);
4078         reconnect_args.send_channel_ready = (true, true);
4079         reconnect_nodes(reconnect_args);
4080
4081         // Create a new channel between C and D as A will refuse to retry on the existing one because
4082         // it just failed.
4083         let chan_id_cd_2 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0).2;
4084
4085         // Now retry the failed HTLC.
4086         nodes[0].node.process_pending_htlc_forwards();
4087         check_added_monitors(&nodes[0], 1);
4088         let as_resend = SendEvent::from_node(&nodes[0]);
4089         nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resend.msgs[0]);
4090         commitment_signed_dance!(nodes[2], nodes[0], as_resend.commitment_msg, false, true);
4091
4092         expect_pending_htlcs_forwardable!(nodes[2]);
4093         check_added_monitors(&nodes[2], 1);
4094         let cs_forward = SendEvent::from_node(&nodes[2]);
4095         nodes[3].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &cs_forward.msgs[0]);
4096         commitment_signed_dance!(nodes[3], nodes[2], cs_forward.commitment_msg, false, true);
4097
4098         // Finally, check that nodes[3] does the correct thing - either accepting the payment or, if
4099         // the payment metadata was modified, failing only the one modified HTLC and retaining the
4100         // other.
4101         if do_modify {
4102                 expect_pending_htlcs_forwardable_ignore!(nodes[3]);
4103                 nodes[3].node.process_pending_htlc_forwards();
4104                 expect_pending_htlcs_forwardable_conditions(nodes[3].node.get_and_clear_pending_events(),
4105                         &[HTLCDestination::FailedPayment {payment_hash}]);
4106                 nodes[3].node.process_pending_htlc_forwards();
4107
4108                 check_added_monitors(&nodes[3], 1);
4109                 let ds_fail = get_htlc_update_msgs(&nodes[3], &nodes[2].node.get_our_node_id());
4110
4111                 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &ds_fail.update_fail_htlcs[0]);
4112                 commitment_signed_dance!(nodes[2], nodes[3], ds_fail.commitment_signed, false, true);
4113                 expect_pending_htlcs_forwardable_conditions(nodes[2].node.get_and_clear_pending_events(),
4114                         &[HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_id_cd_2 }]);
4115         } else {
4116                 expect_pending_htlcs_forwardable!(nodes[3]);
4117                 expect_payment_claimable!(nodes[3], payment_hash, payment_secret, amt_msat);
4118                 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
4119         }
4120 }
4121
4122 #[test]
4123 fn test_payment_metadata_consistency() {
4124         do_test_payment_metadata_consistency(true, true);
4125         do_test_payment_metadata_consistency(true, false);
4126         do_test_payment_metadata_consistency(false, true);
4127         do_test_payment_metadata_consistency(false, false);
4128 }
4129
4130 #[test]
4131 fn  test_htlc_forward_considers_anchor_outputs_value() {
4132         // Tests that:
4133         //
4134         // 1) Forwarding nodes don't forward HTLCs that would cause their balance to dip below the
4135         //    reserve when considering the value of anchor outputs.
4136         //
4137         // 2) Recipients of `update_add_htlc` properly reject HTLCs that would cause the initiator's
4138         //    balance to dip below the reserve when considering the value of anchor outputs.
4139         let mut config = test_default_channel_config();
4140         config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
4141         config.manually_accept_inbound_channels = true;
4142         config.channel_config.forwarding_fee_base_msat = 0;
4143         config.channel_config.forwarding_fee_proportional_millionths = 0;
4144
4145         // Set up a test network of three nodes that replicates a production failure leading to the
4146         // discovery of this bug.
4147         let chanmon_cfgs = create_chanmon_cfgs(3);
4148         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4149         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
4150         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4151
4152         const CHAN_AMT: u64 = 1_000_000;
4153         const PUSH_MSAT: u64 = 900_000_000;
4154         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, CHAN_AMT, 500_000_000);
4155         let (_, _, chan_id_2, _) = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, CHAN_AMT, PUSH_MSAT);
4156
4157         let channel_reserve_msat = get_holder_selected_channel_reserve_satoshis(CHAN_AMT, &config) * 1000;
4158         let commitment_fee_msat = commit_tx_fee_msat(
4159                 *nodes[1].fee_estimator.sat_per_kw.lock().unwrap(), 2, &ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()
4160         );
4161         let anchor_outpus_value_msat = ANCHOR_OUTPUT_VALUE_SATOSHI * 2 * 1000;
4162         let sendable_balance_msat = CHAN_AMT * 1000 - PUSH_MSAT - channel_reserve_msat - commitment_fee_msat - anchor_outpus_value_msat;
4163         let channel_details = nodes[1].node.list_channels().into_iter().find(|channel| channel.channel_id == chan_id_2).unwrap();
4164         assert!(sendable_balance_msat >= channel_details.next_outbound_htlc_minimum_msat);
4165         assert!(sendable_balance_msat <= channel_details.next_outbound_htlc_limit_msat);
4166
4167         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], sendable_balance_msat);
4168         send_payment(&nodes[2], &[&nodes[1], &nodes[0]], sendable_balance_msat);
4169
4170         // Send out an HTLC that would cause the forwarding node to dip below its reserve when
4171         // considering the value of anchor outputs.
4172         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(
4173                 nodes[0], nodes[2], sendable_balance_msat + anchor_outpus_value_msat
4174         );
4175         nodes[0].node.send_payment_with_route(
4176                 &route, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
4177         ).unwrap();
4178         check_added_monitors!(nodes[0], 1);
4179
4180         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4181         assert_eq!(events.len(), 1);
4182         let mut update_add_htlc = if let MessageSendEvent::UpdateHTLCs { updates, .. } = events.pop().unwrap() {
4183                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
4184                 check_added_monitors(&nodes[1], 0);
4185                 commitment_signed_dance!(nodes[1], nodes[0], &updates.commitment_signed, false);
4186                 updates.update_add_htlcs[0].clone()
4187         } else {
4188                 panic!("Unexpected event");
4189         };
4190
4191         // The forwarding node should reject forwarding it as expected.
4192         expect_pending_htlcs_forwardable!(nodes[1]);
4193         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[1], vec![HTLCDestination::NextHopChannel {
4194                 node_id: Some(nodes[2].node.get_our_node_id()),
4195                 channel_id: chan_id_2
4196         }]);
4197         check_added_monitors(&nodes[1], 1);
4198
4199         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
4200         assert_eq!(events.len(), 1);
4201         if let MessageSendEvent::UpdateHTLCs { updates, .. } = events.pop().unwrap() {
4202                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4203                 check_added_monitors(&nodes[0], 0);
4204                 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4205         } else {
4206                 panic!("Unexpected event");
4207         }
4208
4209         expect_payment_failed!(nodes[0], payment_hash, false);
4210
4211         // Assume that the forwarding node did forward it, and make sure the recipient rejects it as an
4212         // invalid update and closes the channel.
4213         update_add_htlc.channel_id = chan_id_2;
4214         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
4215         check_closed_event(&nodes[2], 1, ClosureReason::ProcessingError {
4216                 err: "Remote HTLC add would put them under remote reserve value".to_owned()
4217         }, false, &[nodes[1].node.get_our_node_id()], 1_000_000);
4218         check_closed_broadcast(&nodes[2], 1, true);
4219         check_added_monitors(&nodes[2], 1);
4220 }
4221
4222 #[test]
4223 fn peel_payment_onion_custom_tlvs() {
4224         let chanmon_cfgs = create_chanmon_cfgs(2);
4225         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4226         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4227         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4228         create_announced_chan_between_nodes(&nodes, 0, 1);
4229         let secp_ctx = Secp256k1::new();
4230
4231         let amt_msat = 1000;
4232         let payment_params = PaymentParameters::for_keysend(nodes[1].node.get_our_node_id(),
4233                 TEST_FINAL_CLTV, false);
4234         let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
4235         let route = functional_test_utils::get_route(&nodes[0], &route_params).unwrap();
4236         let mut recipient_onion = RecipientOnionFields::spontaneous_empty()
4237                 .with_custom_tlvs(vec![(414141, vec![42; 1200])]).unwrap();
4238         let prng_seed = chanmon_cfgs[0].keys_manager.get_secure_random_bytes();
4239         let session_priv = SecretKey::from_slice(&prng_seed[..]).expect("RNG is busted");
4240         let keysend_preimage = PaymentPreimage([42; 32]);
4241         let payment_hash = PaymentHash(Sha256::hash(&keysend_preimage.0).to_byte_array());
4242
4243         let (onion_routing_packet, first_hop_msat, cltv_expiry) = onion_utils::create_payment_onion(
4244                 &secp_ctx, &route.paths[0], &session_priv, amt_msat, recipient_onion.clone(),
4245                 nodes[0].best_block_info().1, &payment_hash, &Some(keysend_preimage), prng_seed
4246         ).unwrap();
4247
4248         let update_add = msgs::UpdateAddHTLC {
4249                 channel_id: ChannelId([0; 32]),
4250                 htlc_id: 42,
4251                 amount_msat: first_hop_msat,
4252                 payment_hash,
4253                 cltv_expiry,
4254                 skimmed_fee_msat: None,
4255                 onion_routing_packet,
4256                 blinding_point: None,
4257         };
4258         let peeled_onion = crate::ln::onion_payment::peel_payment_onion(
4259                 &update_add, &&chanmon_cfgs[1].keys_manager, &&chanmon_cfgs[1].logger, &secp_ctx,
4260                 nodes[1].best_block_info().1, true, false
4261         ).unwrap();
4262         assert_eq!(peeled_onion.incoming_amt_msat, Some(amt_msat));
4263         match peeled_onion.routing {
4264                 PendingHTLCRouting::ReceiveKeysend {
4265                         payment_data, payment_metadata, custom_tlvs, ..
4266                 } => {
4267                         #[cfg(not(c_bindings))]
4268                         assert_eq!(&custom_tlvs, recipient_onion.custom_tlvs());
4269                         #[cfg(c_bindings)]
4270                         assert_eq!(custom_tlvs, recipient_onion.custom_tlvs());
4271                         assert!(payment_metadata.is_none());
4272                         assert!(payment_data.is_none());
4273                 },
4274                 _ => panic!()
4275         }
4276 }