_ 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 chain::{ChannelMonitorUpdateErr, Confirm, Listen, Watch};
  15 use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor, LATENCY_GRACE_PERIOD_BLOCKS};
  16 use chain::transaction::OutPoint;
  17 use chain::keysinterface::KeysInterface;
  18 use ln::channel::EXPIRE_PREV_CONFIG_TICKS;
  19 use ln::channelmanager::{self, BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, MPP_TIMEOUT_TICKS, MIN_CLTV_EXPIRY_DELTA, PaymentId, PaymentSendFailure};
  20 use ln::msgs;
  21 use ln::msgs::ChannelMessageHandler;
  22 use routing::router::{PaymentParameters, get_route};
  23 use util::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider};
  24 use util::test_utils;
  25 use util::errors::APIError;
  26 use util::enforcing_trait_impls::EnforcingSigner;
  27 use util::ser::{ReadableArgs, Writeable};
  28 use io;
  29
  30 use bitcoin::{Block, BlockHeader, BlockHash, TxMerkleNode};
  31 use bitcoin::hashes::Hash;
  32 use bitcoin::network::constants::Network;
  33
  34 use prelude::*;
  35
  36 use ln::functional_test_utils::*;
  37
  38 #[test]
  39 fn retry_single_path_payment() {
  40         let chanmon_cfgs = create_chanmon_cfgs(3);
  41         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
  42         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
  43         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
  44
  45         let _chan_0 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
  46         let chan_1 = create_announced_chan_between_nodes(&nodes, 2, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
  47         // Rebalance to find a route
  48         send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
  49
  50         let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100_000);
  51
  52         // Rebalance so that the first hop fails.
  53         send_payment(&nodes[1], &vec!(&nodes[2])[..], 2_000_000);
  54
  55         // Make sure the payment fails on the first hop.
  56         let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
  57         check_added_monitors!(nodes[0], 1);
  58         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
  59         assert_eq!(events.len(), 1);
  60         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
  61         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
  62         check_added_monitors!(nodes[1], 0);
  63         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
  64         expect_pending_htlcs_forwardable!(nodes[1]);
  65         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_1.2 }]);
  66         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
  67         assert!(htlc_updates.update_add_htlcs.is_empty());
  68         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
  69         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
  70         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
  71         check_added_monitors!(nodes[1], 1);
  72         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
  73         commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false);
  74         expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
  75
  76         // Rebalance the channel so the retry succeeds.
  77         send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
  78
  79         // Mine two blocks (we expire retries after 3, so this will check that we don't expire early)
  80         connect_blocks(&nodes[0], 2);
  81
  82         // Retry the payment and make sure it succeeds.
  83         nodes[0].node.retry_payment(&route, payment_id).unwrap();
  84         check_added_monitors!(nodes[0], 1);
  85         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
  86         assert_eq!(events.len(), 1);
  87         pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], 100_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
  88         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
  89 }
  90
  91 #[test]
  92 fn mpp_failure() {
  93         let chanmon_cfgs = create_chanmon_cfgs(4);
  94         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
  95         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
  96         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
  97
  98         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
  99         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
 100         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
 101         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
 102
 103         let (mut route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
 104         let path = route.paths[0].clone();
 105         route.paths.push(path);
 106         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
 107         route.paths[0][0].short_channel_id = chan_1_id;
 108         route.paths[0][1].short_channel_id = chan_3_id;
 109         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
 110         route.paths[1][0].short_channel_id = chan_2_id;
 111         route.paths[1][1].short_channel_id = chan_4_id;
 112         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
 113         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
 114 }
 115
 116 #[test]
 117 fn mpp_retry() {
 118         let chanmon_cfgs = create_chanmon_cfgs(4);
 119         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 120         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 121         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 122
 123         let (chan_1_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 124         let (chan_2_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 125         let (chan_3_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 1, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 126         let (chan_4_update, _, chan_4_id, _) = create_announced_chan_between_nodes(&nodes, 3, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 127         // Rebalance
 128         send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
 129
 130         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 1_000_000);
 131         let path = route.paths[0].clone();
 132         route.paths.push(path);
 133         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
 134         route.paths[0][0].short_channel_id = chan_1_update.contents.short_channel_id;
 135         route.paths[0][1].short_channel_id = chan_3_update.contents.short_channel_id;
 136         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
 137         route.paths[1][0].short_channel_id = chan_2_update.contents.short_channel_id;
 138         route.paths[1][1].short_channel_id = chan_4_update.contents.short_channel_id;
 139
 140         // Initiate the MPP payment.
 141         let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
 142         check_added_monitors!(nodes[0], 2); // one monitor per path
 143         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 144         assert_eq!(events.len(), 2);
 145
 146         // Pass half of the payment along the success path.
 147         let success_path_msgs = events.remove(0);
 148         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), success_path_msgs, false, None);
 149
 150         // Add the HTLC along the first hop.
 151         let fail_path_msgs_1 = events.remove(0);
 152         let (update_add, commitment_signed) = match fail_path_msgs_1 {
 153                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
 154                         assert_eq!(update_add_htlcs.len(), 1);
 155                         assert!(update_fail_htlcs.is_empty());
 156                         assert!(update_fulfill_htlcs.is_empty());
 157                         assert!(update_fail_malformed_htlcs.is_empty());
 158                         assert!(update_fee.is_none());
 159                         (update_add_htlcs[0].clone(), commitment_signed.clone())
 160                 },
 161                 _ => panic!("Unexpected event"),
 162         };
 163         nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
 164         commitment_signed_dance!(nodes[2], nodes[0], commitment_signed, false);
 165
 166         // Attempt to forward the payment and complete the 2nd path's failure.
 167         expect_pending_htlcs_forwardable!(&nodes[2]);
 168         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 }]);
 169         let htlc_updates = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
 170         assert!(htlc_updates.update_add_htlcs.is_empty());
 171         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
 172         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
 173         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
 174         check_added_monitors!(nodes[2], 1);
 175         nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
 176         commitment_signed_dance!(nodes[0], nodes[2], htlc_updates.commitment_signed, false);
 177         expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
 178
 179         // Rebalance the channel so the second half of the payment can succeed.
 180         send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
 181
 182         // Make sure it errors as expected given a too-large amount.
 183         if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, payment_id) {
 184                 assert!(err.contains("over total_payment_amt_msat"));
 185         } else { panic!("Unexpected error"); }
 186
 187         // Make sure it errors as expected given the wrong payment_id.
 188         if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, PaymentId([0; 32])) {
 189                 assert!(err.contains("not found"));
 190         } else { panic!("Unexpected error"); }
 191
 192         // Retry the second half of the payment and make sure it succeeds.
 193         let mut path = route.clone();
 194         path.paths.remove(0);
 195         nodes[0].node.retry_payment(&path, payment_id).unwrap();
 196         check_added_monitors!(nodes[0], 1);
 197         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 198         assert_eq!(events.len(), 1);
 199         pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
 200         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
 201 }
 202
 203 fn do_mpp_receive_timeout(send_partial_mpp: bool) {
 204         let chanmon_cfgs = create_chanmon_cfgs(4);
 205         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 206         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 207         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 208
 209         let (chan_1_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 210         let (chan_2_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 211         let (chan_3_update, _, chan_3_id, _) = create_announced_chan_between_nodes(&nodes, 1, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 212         let (chan_4_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 213
 214         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 100_000);
 215         let path = route.paths[0].clone();
 216         route.paths.push(path);
 217         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
 218         route.paths[0][0].short_channel_id = chan_1_update.contents.short_channel_id;
 219         route.paths[0][1].short_channel_id = chan_3_update.contents.short_channel_id;
 220         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
 221         route.paths[1][0].short_channel_id = chan_2_update.contents.short_channel_id;
 222         route.paths[1][1].short_channel_id = chan_4_update.contents.short_channel_id;
 223
 224         // Initiate the MPP payment.
 225         let _ = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
 226         check_added_monitors!(nodes[0], 2); // one monitor per path
 227         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 228         assert_eq!(events.len(), 2);
 229
 230         // Pass half of the payment along the first path.
 231         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 200_000, payment_hash, Some(payment_secret), events.remove(0), false, None);
 232
 233         if send_partial_mpp {
 234                 // Time out the partial MPP
 235                 for _ in 0..MPP_TIMEOUT_TICKS {
 236                         nodes[3].node.timer_tick_occurred();
 237                 }
 238
 239                 // Failed HTLC from node 3 -> 1
 240                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], vec![HTLCDestination::FailedPayment { payment_hash }]);
 241                 let htlc_fail_updates_3_1 = get_htlc_update_msgs!(nodes[3], nodes[1].node.get_our_node_id());
 242                 assert_eq!(htlc_fail_updates_3_1.update_fail_htlcs.len(), 1);
 243                 nodes[1].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &htlc_fail_updates_3_1.update_fail_htlcs[0]);
 244                 check_added_monitors!(nodes[3], 1);
 245                 commitment_signed_dance!(nodes[1], nodes[3], htlc_fail_updates_3_1.commitment_signed, false);
 246
 247                 // Failed HTLC from node 1 -> 0
 248                 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 }]);
 249                 let htlc_fail_updates_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 250                 assert_eq!(htlc_fail_updates_1_0.update_fail_htlcs.len(), 1);
 251                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates_1_0.update_fail_htlcs[0]);
 252                 check_added_monitors!(nodes[1], 1);
 253                 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates_1_0.commitment_signed, false);
 254
 255                 expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain().expected_htlc_error_data(23, &[][..]));
 256         } else {
 257                 // Pass half of the payment along the second path.
 258                 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash, Some(payment_secret), events.remove(0), true, None);
 259
 260                 // Even after MPP_TIMEOUT_TICKS we should not timeout the MPP if we have all the parts
 261                 for _ in 0..MPP_TIMEOUT_TICKS {
 262                         nodes[3].node.timer_tick_occurred();
 263                 }
 264
 265                 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
 266         }
 267 }
 268
 269 #[test]
 270 fn mpp_receive_timeout() {
 271         do_mpp_receive_timeout(true);
 272         do_mpp_receive_timeout(false);
 273 }
 274
 275 #[test]
 276 fn retry_expired_payment() {
 277         let chanmon_cfgs = create_chanmon_cfgs(3);
 278         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 279         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 280         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 281
 282         let _chan_0 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 283         let chan_1 = create_announced_chan_between_nodes(&nodes, 2, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 284         // Rebalance to find a route
 285         send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
 286
 287         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100_000);
 288
 289         // Rebalance so that the first hop fails.
 290         send_payment(&nodes[1], &vec!(&nodes[2])[..], 2_000_000);
 291
 292         // Make sure the payment fails on the first hop.
 293         let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
 294         check_added_monitors!(nodes[0], 1);
 295         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 296         assert_eq!(events.len(), 1);
 297         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
 298         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 299         check_added_monitors!(nodes[1], 0);
 300         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
 301         expect_pending_htlcs_forwardable!(nodes[1]);
 302         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_1.2 }]);
 303         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 304         assert!(htlc_updates.update_add_htlcs.is_empty());
 305         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
 306         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
 307         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
 308         check_added_monitors!(nodes[1], 1);
 309         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
 310         commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false);
 311         expect_payment_failed!(nodes[0], payment_hash, false);
 312
 313         // Mine blocks so the payment will have expired.
 314         connect_blocks(&nodes[0], 3);
 315
 316         // Retry the payment and make sure it errors as expected.
 317         if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, payment_id) {
 318                 assert!(err.contains("not found"));
 319         } else {
 320                 panic!("Unexpected error");
 321         }
 322 }
 323
 324 #[test]
 325 fn no_pending_leak_on_initial_send_failure() {
 326         // In an earlier version of our payment tracking, we'd have a retry entry even when the initial
 327         // HTLC for payment failed to send due to local channel errors (e.g. peer disconnected). In this
 328         // case, the user wouldn't have a PaymentId to retry the payment with, but we'd think we have a
 329         // pending payment forever and never time it out.
 330         // Here we test exactly that - retrying a payment when a peer was disconnected on the first
 331         // try, and then check that no pending payment is being tracked.
 332         let chanmon_cfgs = create_chanmon_cfgs(2);
 333         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 334         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 335         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 336
 337         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 338
 339         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
 340
 341         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 342         nodes[1].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 343
 344         unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)),
 345                 true, APIError::ChannelUnavailable { ref err },
 346                 assert_eq!(err, "Peer for first hop currently disconnected/pending monitor update!"));
 347
 348         assert!(!nodes[0].node.has_pending_payments());
 349 }
 350
 351 fn do_retry_with_no_persist(confirm_before_reload: bool) {
 352         // If we send a pending payment and `send_payment` returns success, we should always either
 353         // return a payment failure event or a payment success event, and on failure the payment should
 354         // be retryable.
 355         //
 356         // In order to do so when the ChannelManager isn't immediately persisted (which is normal - its
 357         // always persisted asynchronously), the ChannelManager has to reload some payment data from
 358         // ChannelMonitor(s) in some cases. This tests that reloading.
 359         //
 360         // `confirm_before_reload` confirms the channel-closing commitment transaction on-chain prior
 361         // to reloading the ChannelManager, increasing test coverage in ChannelMonitor HTLC tracking
 362         // which has separate codepaths for "commitment transaction already confirmed" and not.
 363         let chanmon_cfgs = create_chanmon_cfgs(3);
 364         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 365         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 366         let persister: test_utils::TestPersister;
 367         let new_chain_monitor: test_utils::TestChainMonitor;
 368         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
 369         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 370
 371         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
 372         let (_, _, chan_id_2, _) = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 373
 374         // Serialize the ChannelManager prior to sending payments
 375         let nodes_0_serialized = nodes[0].node.encode();
 376
 377         // Send two payments - one which will get to nodes[2] and will be claimed, one which we'll time
 378         // out and retry.
 379         let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 1_000_000);
 380         let (payment_preimage_1, payment_hash_1, _, payment_id_1) = send_along_route(&nodes[0], route.clone(), &[&nodes[1], &nodes[2]], 1_000_000);
 381         let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
 382         check_added_monitors!(nodes[0], 1);
 383
 384         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 385         assert_eq!(events.len(), 1);
 386         let payment_event = SendEvent::from_event(events.pop().unwrap());
 387         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
 388
 389         // We relay the payment to nodes[1] while its disconnected from nodes[2], causing the payment
 390         // to be returned immediately to nodes[0], without having nodes[2] fail the inbound payment
 391         // which would prevent retry.
 392         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
 393         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 394
 395         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 396         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
 397         // nodes[1] now immediately fails the HTLC as the next-hop channel is disconnected
 398         let _ = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 399
 400         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
 401
 402         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan_id)[0].clone();
 403         if confirm_before_reload {
 404                 mine_transaction(&nodes[0], &as_commitment_tx);
 405                 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 406         }
 407
 408         // The ChannelMonitor should always be the latest version, as we're required to persist it
 409         // during the `commitment_signed_dance!()`.
 410         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
 411         get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
 412
 413         persister = test_utils::TestPersister::new();
 414         let keys_manager = &chanmon_cfgs[0].keys_manager;
 415         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
 416         nodes[0].chain_monitor = &new_chain_monitor;
 417         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
 418         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
 419                 &mut chan_0_monitor_read, keys_manager).unwrap();
 420         assert!(chan_0_monitor_read.is_empty());
 421
 422         let mut nodes_0_read = &nodes_0_serialized[..];
 423         let (_, nodes_0_deserialized_tmp) = {
 424                 let mut channel_monitors = HashMap::new();
 425                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
 426                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
 427                         default_config: test_default_channel_config(),
 428                         keys_manager,
 429                         fee_estimator: node_cfgs[0].fee_estimator,
 430                         chain_monitor: nodes[0].chain_monitor,
 431                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
 432                         logger: nodes[0].logger,
 433                         channel_monitors,
 434                 }).unwrap()
 435         };
 436         nodes_0_deserialized = nodes_0_deserialized_tmp;
 437         assert!(nodes_0_read.is_empty());
 438
 439         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
 440         nodes[0].node = &nodes_0_deserialized;
 441         check_added_monitors!(nodes[0], 1);
 442
 443         // On reload, the ChannelManager should realize it is stale compared to the ChannelMonitor and
 444         // force-close the channel.
 445         check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager);
 446         assert!(nodes[0].node.list_channels().is_empty());
 447         assert!(nodes[0].node.has_pending_payments());
 448         let as_broadcasted_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 449         assert_eq!(as_broadcasted_txn.len(), 1);
 450         assert_eq!(as_broadcasted_txn[0], as_commitment_tx);
 451
 452         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 453         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
 454         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 455
 456         // Now nodes[1] should send a channel reestablish, which nodes[0] will respond to with an
 457         // error, as the channel has hit the chain.
 458         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
 459         let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
 460         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
 461         let as_err = nodes[0].node.get_and_clear_pending_msg_events();
 462         assert_eq!(as_err.len(), 1);
 463         match as_err[0] {
 464                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
 465                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
 466                         nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), msg);
 467                         check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Failed to find corresponding channel".to_string() });
 468                         check_added_monitors!(nodes[1], 1);
 469                         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
 470                 },
 471                 _ => panic!("Unexpected event"),
 472         }
 473         check_closed_broadcast!(nodes[1], false);
 474
 475         // Now claim the first payment, which should allow nodes[1] to claim the payment on-chain when
 476         // we close in a moment.
 477         nodes[2].node.claim_funds(payment_preimage_1);
 478         check_added_monitors!(nodes[2], 1);
 479         expect_payment_claimed!(nodes[2], payment_hash_1, 1_000_000);
 480
 481         let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 482         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
 483         check_added_monitors!(nodes[1], 1);
 484         commitment_signed_dance!(nodes[1], nodes[2], htlc_fulfill_updates.commitment_signed, false);
 485
 486         if confirm_before_reload {
 487                 let best_block = nodes[0].blocks.lock().unwrap().last().unwrap().clone();
 488                 nodes[0].node.best_block_updated(&best_block.0.header, best_block.1);
 489         }
 490
 491         // Create a new channel on which to retry the payment before we fail the payment via the
 492         // HTLC-Timeout transaction. This avoids ChannelManager timing out the payment due to us
 493         // connecting several blocks while creating the channel (implying time has passed).
 494         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 495         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
 496
 497         mine_transaction(&nodes[1], &as_commitment_tx);
 498         let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 499         assert_eq!(bs_htlc_claim_txn.len(), 1);
 500         check_spends!(bs_htlc_claim_txn[0], as_commitment_tx);
 501         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], None, false, false);
 502
 503         if !confirm_before_reload {
 504                 mine_transaction(&nodes[0], &as_commitment_tx);
 505         }
 506         mine_transaction(&nodes[0], &bs_htlc_claim_txn[0]);
 507         expect_payment_sent!(nodes[0], payment_preimage_1);
 508         connect_blocks(&nodes[0], TEST_FINAL_CLTV*4 + 20);
 509         let as_htlc_timeout_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 510         assert_eq!(as_htlc_timeout_txn.len(), 2);
 511         let (first_htlc_timeout_tx, second_htlc_timeout_tx) = (&as_htlc_timeout_txn[0], &as_htlc_timeout_txn[1]);
 512         check_spends!(first_htlc_timeout_tx, as_commitment_tx);
 513         check_spends!(second_htlc_timeout_tx, as_commitment_tx);
 514         if first_htlc_timeout_tx.input[0].previous_output == bs_htlc_claim_txn[0].input[0].previous_output {
 515                 confirm_transaction(&nodes[0], &second_htlc_timeout_tx);
 516         } else {
 517                 confirm_transaction(&nodes[0], &first_htlc_timeout_tx);
 518         }
 519         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 520         expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
 521
 522         // Finally, retry the payment (which was reloaded from the ChannelMonitor when nodes[0] was
 523         // reloaded) via a route over the new channel, which work without issue and eventually be
 524         // received and claimed at the recipient just like any other payment.
 525         let (mut new_route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], 1_000_000);
 526
 527         // Update the fee on the middle hop to ensure PaymentSent events have the correct (retried) fee
 528         // and not the original fee. We also update node[1]'s relevant config as
 529         // do_claim_payment_along_route expects us to never overpay.
 530         {
 531                 let mut channel_state = nodes[1].node.channel_state.lock().unwrap();
 532                 let mut channel = channel_state.by_id.get_mut(&chan_id_2).unwrap();
 533                 let mut new_config = channel.config();
 534                 new_config.forwarding_fee_base_msat += 100_000;
 535                 channel.update_config(&new_config);
 536                 new_route.paths[0][0].fee_msat += 100_000;
 537         }
 538
 539         // Force expiration of the channel's previous config.
 540         for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
 541                 nodes[1].node.timer_tick_occurred();
 542         }
 543
 544         assert!(nodes[0].node.retry_payment(&new_route, payment_id_1).is_err()); // Shouldn't be allowed to retry a fulfilled payment
 545         nodes[0].node.retry_payment(&new_route, payment_id).unwrap();
 546         check_added_monitors!(nodes[0], 1);
 547         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 548         assert_eq!(events.len(), 1);
 549         pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
 550         do_claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
 551         expect_payment_sent!(nodes[0], payment_preimage, Some(new_route.paths[0][0].fee_msat));
 552 }
 553
 554 #[test]
 555 fn retry_with_no_persist() {
 556         do_retry_with_no_persist(true);
 557         do_retry_with_no_persist(false);
 558 }
 559
 560 fn do_test_completed_payment_not_retryable_on_reload(use_dust: bool) {
 561         // Test that an off-chain completed payment is not retryable on restart. This was previously
 562         // broken for dust payments, but we test for both dust and non-dust payments.
 563         //
 564         // `use_dust` switches to using a dust HTLC, which results in the HTLC not having an on-chain
 565         // output at all.
 566         let chanmon_cfgs = create_chanmon_cfgs(3);
 567         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 568
 569         let mut manually_accept_config = test_default_channel_config();
 570         manually_accept_config.manually_accept_inbound_channels = true;
 571
 572         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(manually_accept_config), None]);
 573
 574         let first_persister: test_utils::TestPersister;
 575         let first_new_chain_monitor: test_utils::TestChainMonitor;
 576         let first_nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
 577         let second_persister: test_utils::TestPersister;
 578         let second_new_chain_monitor: test_utils::TestChainMonitor;
 579         let second_nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
 580         let third_persister: test_utils::TestPersister;
 581         let third_new_chain_monitor: test_utils::TestChainMonitor;
 582         let third_nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
 583
 584         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 585
 586         // Because we set nodes[1] to manually accept channels, just open a 0-conf channel.
 587         let (funding_tx, chan_id) = open_zero_conf_channel(&nodes[0], &nodes[1], None);
 588         confirm_transaction(&nodes[0], &funding_tx);
 589         confirm_transaction(&nodes[1], &funding_tx);
 590         // Ignore the announcement_signatures messages
 591         nodes[0].node.get_and_clear_pending_msg_events();
 592         nodes[1].node.get_and_clear_pending_msg_events();
 593         let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
 594
 595         // Serialize the ChannelManager prior to sending payments
 596         let mut nodes_0_serialized = nodes[0].node.encode();
 597
 598         let route = get_route_and_payment_hash!(nodes[0], nodes[2], if use_dust { 1_000 } else { 1_000_000 }).0;
 599         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 });
 600
 601         // The ChannelMonitor should always be the latest version, as we're required to persist it
 602         // during the `commitment_signed_dance!()`.
 603         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
 604         get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
 605
 606         let mut chan_1_monitor_serialized = test_utils::TestVecWriter(Vec::new());
 607
 608         macro_rules! reload_node {
 609                 ($chain_monitor: ident, $chan_manager: ident, $persister: ident) => { {
 610                         $persister = test_utils::TestPersister::new();
 611                         let keys_manager = &chanmon_cfgs[0].keys_manager;
 612                         $chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &$persister, keys_manager);
 613                         nodes[0].chain_monitor = &$chain_monitor;
 614                         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
 615                         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
 616                                 &mut chan_0_monitor_read, keys_manager).unwrap();
 617                         assert!(chan_0_monitor_read.is_empty());
 618
 619                         let mut chan_1_monitor = None;
 620                         let mut channel_monitors = HashMap::new();
 621                         channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
 622
 623                         if !chan_1_monitor_serialized.0.is_empty() {
 624                                 let mut chan_1_monitor_read = &chan_1_monitor_serialized.0[..];
 625                                 chan_1_monitor = Some(<(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
 626                                         &mut chan_1_monitor_read, keys_manager).unwrap().1);
 627                                 assert!(chan_1_monitor_read.is_empty());
 628                                 channel_monitors.insert(chan_1_monitor.as_ref().unwrap().get_funding_txo().0, chan_1_monitor.as_mut().unwrap());
 629                         }
 630
 631                         let mut nodes_0_read = &nodes_0_serialized[..];
 632                         let (_, nodes_0_deserialized_tmp) = {
 633                                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
 634                                         default_config: test_default_channel_config(),
 635                                         keys_manager,
 636                                         fee_estimator: node_cfgs[0].fee_estimator,
 637                                         chain_monitor: nodes[0].chain_monitor,
 638                                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
 639                                         logger: nodes[0].logger,
 640                                         channel_monitors,
 641                                 }).unwrap()
 642                         };
 643                         $chan_manager = nodes_0_deserialized_tmp;
 644                         assert!(nodes_0_read.is_empty());
 645
 646                         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
 647                         if !chan_1_monitor_serialized.0.is_empty() {
 648                                 let funding_txo = chan_1_monitor.as_ref().unwrap().get_funding_txo().0;
 649                                 assert!(nodes[0].chain_monitor.watch_channel(funding_txo, chan_1_monitor.unwrap()).is_ok());
 650                         }
 651                         nodes[0].node = &$chan_manager;
 652                         check_added_monitors!(nodes[0], if !chan_1_monitor_serialized.0.is_empty() { 2 } else { 1 });
 653
 654                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 655                 } }
 656         }
 657
 658         reload_node!(first_new_chain_monitor, first_nodes_0_deserialized, first_persister);
 659
 660         // On reload, the ChannelManager should realize it is stale compared to the ChannelMonitor and
 661         // force-close the channel.
 662         check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager);
 663         assert!(nodes[0].node.list_channels().is_empty());
 664         assert!(nodes[0].node.has_pending_payments());
 665         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
 666
 667         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
 668         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 669
 670         // Now nodes[1] should send a channel reestablish, which nodes[0] will respond to with an
 671         // error, as the channel has hit the chain.
 672         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
 673         let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
 674         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
 675         let as_err = nodes[0].node.get_and_clear_pending_msg_events();
 676         assert_eq!(as_err.len(), 1);
 677         let bs_commitment_tx;
 678         match as_err[0] {
 679                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
 680                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
 681                         nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), msg);
 682                         check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Failed to find corresponding channel".to_string() });
 683                         check_added_monitors!(nodes[1], 1);
 684                         bs_commitment_tx = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 685                 },
 686                 _ => panic!("Unexpected event"),
 687         }
 688         check_closed_broadcast!(nodes[1], false);
 689
 690         // Now fail back the payment from nodes[2] to nodes[1]. This doesn't really matter as the
 691         // previous hop channel is already on-chain, but it makes nodes[2] willing to see additional
 692         // incoming HTLCs with the same payment hash later.
 693         nodes[2].node.fail_htlc_backwards(&payment_hash);
 694         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], [HTLCDestination::FailedPayment { payment_hash }]);
 695         check_added_monitors!(nodes[2], 1);
 696
 697         let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 698         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &htlc_fulfill_updates.update_fail_htlcs[0]);
 699         commitment_signed_dance!(nodes[1], nodes[2], htlc_fulfill_updates.commitment_signed, false);
 700         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1],
 701                 [HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_id_2 }]);
 702
 703         // Connect the HTLC-Timeout transaction, timing out the HTLC on both nodes (but not confirming
 704         // the HTLC-Timeout transaction beyond 1 conf). For dust HTLCs, the HTLC is considered resolved
 705         // after the commitment transaction, so always connect the commitment transaction.
 706         mine_transaction(&nodes[0], &bs_commitment_tx[0]);
 707         mine_transaction(&nodes[1], &bs_commitment_tx[0]);
 708         if !use_dust {
 709                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1 + (MIN_CLTV_EXPIRY_DELTA as u32));
 710                 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1 + (MIN_CLTV_EXPIRY_DELTA as u32));
 711                 let as_htlc_timeout = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 712                 check_spends!(as_htlc_timeout[0], bs_commitment_tx[0]);
 713                 assert_eq!(as_htlc_timeout.len(), 1);
 714
 715                 mine_transaction(&nodes[0], &as_htlc_timeout[0]);
 716                 // nodes[0] may rebroadcast (or RBF-bump) its HTLC-Timeout, so wipe the announced set.
 717                 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 718                 mine_transaction(&nodes[1], &as_htlc_timeout[0]);
 719         }
 720
 721         // Create a new channel on which to retry the payment before we fail the payment via the
 722         // HTLC-Timeout transaction. This avoids ChannelManager timing out the payment due to us
 723         // connecting several blocks while creating the channel (implying time has passed).
 724         // We do this with a zero-conf channel to avoid connecting blocks as a side-effect.
 725         let (_, chan_id_3) = open_zero_conf_channel(&nodes[0], &nodes[1], None);
 726         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
 727
 728         // If we attempt to retry prior to the HTLC-Timeout (or commitment transaction, for dust HTLCs)
 729         // confirming, we will fail as it's considered still-pending...
 730         let (new_route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], if use_dust { 1_000 } else { 1_000_000 });
 731         assert!(nodes[0].node.retry_payment(&new_route, payment_id).is_err());
 732         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 733
 734         // After ANTI_REORG_DELAY confirmations, the HTLC should be failed and we can try the payment
 735         // again. We serialize the node first as we'll then test retrying the HTLC after a restart
 736         // (which should also still work).
 737         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
 738         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 739         // We set mpp_parts_remain to avoid having abandon_payment called
 740         expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
 741
 742         chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
 743         get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
 744         chan_1_monitor_serialized = test_utils::TestVecWriter(Vec::new());
 745         get_monitor!(nodes[0], chan_id_3).write(&mut chan_1_monitor_serialized).unwrap();
 746         nodes_0_serialized = nodes[0].node.encode();
 747
 748         assert!(nodes[0].node.retry_payment(&new_route, payment_id).is_ok());
 749         assert!(!nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 750
 751         reload_node!(second_new_chain_monitor, second_nodes_0_deserialized, second_persister);
 752         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
 753
 754         // Now resend the payment, delivering the HTLC and actually claiming it this time. This ensures
 755         // the payment is not (spuriously) listed as still pending.
 756         assert!(nodes[0].node.retry_payment(&new_route, payment_id).is_ok());
 757         check_added_monitors!(nodes[0], 1);
 758         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], if use_dust { 1_000 } else { 1_000_000 }, payment_hash, payment_secret);
 759         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
 760
 761         assert!(nodes[0].node.retry_payment(&new_route, payment_id).is_err());
 762         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 763
 764         chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
 765         get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
 766         chan_1_monitor_serialized = test_utils::TestVecWriter(Vec::new());
 767         get_monitor!(nodes[0], chan_id_3).write(&mut chan_1_monitor_serialized).unwrap();
 768         nodes_0_serialized = nodes[0].node.encode();
 769
 770         // Ensure that after reload we cannot retry the payment.
 771         reload_node!(third_new_chain_monitor, third_nodes_0_deserialized, third_persister);
 772         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
 773
 774         assert!(nodes[0].node.retry_payment(&new_route, payment_id).is_err());
 775         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 776 }
 777
 778 #[test]
 779 fn test_completed_payment_not_retryable_on_reload() {
 780         do_test_completed_payment_not_retryable_on_reload(true);
 781         do_test_completed_payment_not_retryable_on_reload(false);
 782 }
 783
 784
 785 fn do_test_dup_htlc_onchain_fails_on_reload(persist_manager_post_event: bool, confirm_commitment_tx: bool, payment_timeout: bool) {
 786         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
 787         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
 788         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
 789         // the ChannelMonitor tells it to.
 790         //
 791         // If, due to an on-chain event, an HTLC is failed/claimed, we should avoid providing the
 792         // ChannelManager the HTLC event until after the monitor is re-persisted. This should prevent a
 793         // duplicate HTLC fail/claim (e.g. via a PaymentPathFailed event).
 794         let chanmon_cfgs = create_chanmon_cfgs(2);
 795         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 796         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 797         let persister: test_utils::TestPersister;
 798         let new_chain_monitor: test_utils::TestChainMonitor;
 799         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
 800         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 801
 802         let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 803
 804         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
 805         // nodes[0].
 806         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000_000);
 807         nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 808         check_closed_broadcast!(nodes[0], true);
 809         check_added_monitors!(nodes[0], 1);
 810         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
 811
 812         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 813         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 814
 815         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
 816         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
 817         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 818         assert_eq!(node_txn.len(), 3);
 819         assert_eq!(node_txn[0], node_txn[1]);
 820         check_spends!(node_txn[1], funding_tx);
 821         check_spends!(node_txn[2], node_txn[1]);
 822         let timeout_txn = vec![node_txn[2].clone()];
 823
 824         nodes[1].node.claim_funds(payment_preimage);
 825         check_added_monitors!(nodes[1], 1);
 826         expect_payment_claimed!(nodes[1], payment_hash, 10_000_000);
 827
 828         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
 829         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone()]});
 830         check_closed_broadcast!(nodes[1], true);
 831         check_added_monitors!(nodes[1], 1);
 832         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
 833         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 834         assert_eq!(claim_txn.len(), 3);
 835         check_spends!(claim_txn[0], node_txn[1]);
 836         check_spends!(claim_txn[1], funding_tx);
 837         check_spends!(claim_txn[2], claim_txn[1]);
 838
 839         header.prev_blockhash = nodes[0].best_block_hash();
 840         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone()]});
 841
 842         if confirm_commitment_tx {
 843                 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
 844         }
 845
 846         header.prev_blockhash = nodes[0].best_block_hash();
 847         let claim_block = Block { header, txdata: if payment_timeout { timeout_txn } else { vec![claim_txn[0].clone()] } };
 848
 849         if payment_timeout {
 850                 assert!(confirm_commitment_tx); // Otherwise we're spending below our CSV!
 851                 connect_block(&nodes[0], &claim_block);
 852                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 2);
 853         }
 854
 855         // Now connect the HTLC claim transaction with the ChainMonitor-generated ChannelMonitor update
 856         // returning TemporaryFailure. This should cause the claim event to never make its way to the
 857         // ChannelManager.
 858         chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clear();
 859         chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
 860
 861         if payment_timeout {
 862                 connect_blocks(&nodes[0], 1);
 863         } else {
 864                 connect_block(&nodes[0], &claim_block);
 865         }
 866
 867         let funding_txo = OutPoint { txid: funding_tx.txid(), index: 0 };
 868         let mon_updates: Vec<_> = chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap()
 869                 .get_mut(&funding_txo).unwrap().drain().collect();
 870         // If we are using chain::Confirm instead of chain::Listen, we will get the same update twice
 871         assert!(mon_updates.len() == 1 || mon_updates.len() == 2);
 872         assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
 873         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 874
 875         // If we persist the ChannelManager here, we should get the PaymentSent event after
 876         // deserialization.
 877         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
 878         if !persist_manager_post_event {
 879                 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
 880         }
 881
 882         // Now persist the ChannelMonitor and inform the ChainMonitor that we're done, generating the
 883         // payment sent event.
 884         chanmon_cfgs[0].persister.set_update_ret(Ok(()));
 885         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
 886         get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
 887         for update in mon_updates {
 888                 nodes[0].chain_monitor.chain_monitor.channel_monitor_updated(funding_txo, update).unwrap();
 889         }
 890         if payment_timeout {
 891                 expect_payment_failed!(nodes[0], payment_hash, false);
 892         } else {
 893                 expect_payment_sent!(nodes[0], payment_preimage);
 894         }
 895
 896         // If we persist the ChannelManager after we get the PaymentSent event, we shouldn't get it
 897         // twice.
 898         if persist_manager_post_event {
 899                 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
 900         }
 901
 902         // Now reload nodes[0]...
 903         persister = test_utils::TestPersister::new();
 904         let keys_manager = &chanmon_cfgs[0].keys_manager;
 905         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
 906         nodes[0].chain_monitor = &new_chain_monitor;
 907         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
 908         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
 909                 &mut chan_0_monitor_read, keys_manager).unwrap();
 910         assert!(chan_0_monitor_read.is_empty());
 911
 912         let (_, nodes_0_deserialized_tmp) = {
 913                 let mut channel_monitors = HashMap::new();
 914                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
 915                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
 916                         ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
 917                                 default_config: Default::default(),
 918                                 keys_manager,
 919                                 fee_estimator: node_cfgs[0].fee_estimator,
 920                                 chain_monitor: nodes[0].chain_monitor,
 921                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
 922                                 logger: nodes[0].logger,
 923                                 channel_monitors,
 924                         }).unwrap()
 925         };
 926         nodes_0_deserialized = nodes_0_deserialized_tmp;
 927
 928         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
 929         check_added_monitors!(nodes[0], 1);
 930         nodes[0].node = &nodes_0_deserialized;
 931
 932         if persist_manager_post_event {
 933                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 934         } else if payment_timeout {
 935                 expect_payment_failed!(nodes[0], payment_hash, false);
 936         } else {
 937                 expect_payment_sent!(nodes[0], payment_preimage);
 938         }
 939
 940         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
 941         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
 942         // payment events should kick in, leaving us with no pending events here.
 943         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
 944         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
 945         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 946 }
 947
 948 #[test]
 949 fn test_dup_htlc_onchain_fails_on_reload() {
 950         do_test_dup_htlc_onchain_fails_on_reload(true, true, true);
 951         do_test_dup_htlc_onchain_fails_on_reload(true, true, false);
 952         do_test_dup_htlc_onchain_fails_on_reload(true, false, false);
 953         do_test_dup_htlc_onchain_fails_on_reload(false, true, true);
 954         do_test_dup_htlc_onchain_fails_on_reload(false, true, false);
 955         do_test_dup_htlc_onchain_fails_on_reload(false, false, false);
 956 }
 957
 958 #[test]
 959 fn test_fulfill_restart_failure() {
 960         // When we receive an update_fulfill_htlc message, we immediately consider the HTLC fully
 961         // fulfilled. At this point, the peer can reconnect and decide to either fulfill the HTLC
 962         // again, or fail it, giving us free money.
 963         //
 964         // Of course probably they won't fail it and give us free money, but because we have code to
 965         // handle it, we should test the logic for it anyway. We do that here.
 966         let chanmon_cfgs = create_chanmon_cfgs(2);
 967         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 968         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 969         let persister: test_utils::TestPersister;
 970         let new_chain_monitor: test_utils::TestChainMonitor;
 971         let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
 972         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 973
 974         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
 975         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
 976
 977         // The simplest way to get a failure after a fulfill is to reload nodes[1] from a state
 978         // pre-fulfill, which we do by serializing it here.
 979         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
 980         nodes[1].node.write(&mut chan_manager_serialized).unwrap();
 981         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
 982         get_monitor!(nodes[1], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
 983
 984         nodes[1].node.claim_funds(payment_preimage);
 985         check_added_monitors!(nodes[1], 1);
 986         expect_payment_claimed!(nodes[1], payment_hash, 100_000);
 987
 988         let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 989         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
 990         expect_payment_sent_without_paths!(nodes[0], payment_preimage);
 991
 992         // Now reload nodes[1]...
 993         persister = test_utils::TestPersister::new();
 994         let keys_manager = &chanmon_cfgs[1].keys_manager;
 995         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger, node_cfgs[1].fee_estimator, &persister, keys_manager);
 996         nodes[1].chain_monitor = &new_chain_monitor;
 997         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
 998         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
 999                 &mut chan_0_monitor_read, keys_manager).unwrap();
1000         assert!(chan_0_monitor_read.is_empty());
1001
1002         let (_, nodes_1_deserialized_tmp) = {
1003                 let mut channel_monitors = HashMap::new();
1004                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
1005                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
1006                         ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
1007                                 default_config: Default::default(),
1008                                 keys_manager,
1009                                 fee_estimator: node_cfgs[1].fee_estimator,
1010                                 chain_monitor: nodes[1].chain_monitor,
1011                                 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
1012                                 logger: nodes[1].logger,
1013                                 channel_monitors,
1014                         }).unwrap()
1015         };
1016         nodes_1_deserialized = nodes_1_deserialized_tmp;
1017
1018         assert!(nodes[1].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
1019         check_added_monitors!(nodes[1], 1);
1020         nodes[1].node = &nodes_1_deserialized;
1021
1022         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1023         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1024
1025         nodes[1].node.fail_htlc_backwards(&payment_hash);
1026         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1027         check_added_monitors!(nodes[1], 1);
1028         let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1029         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
1030         commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, false);
1031         // nodes[0] shouldn't generate any events here, while it just got a payment failure completion
1032         // it had already considered the payment fulfilled, and now they just got free money.
1033         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1034 }
1035
1036 #[test]
1037 fn get_ldk_payment_preimage() {
1038         // Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
1039         let chanmon_cfgs = create_chanmon_cfgs(2);
1040         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1041         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1042         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1043         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1044
1045         let amt_msat = 60_000;
1046         let expiry_secs = 60 * 60;
1047         let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs).unwrap();
1048
1049         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id())
1050                 .with_features(channelmanager::provided_invoice_features());
1051         let scorer = test_utils::TestScorer::with_penalty(0);
1052         let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
1053         let random_seed_bytes = keys_manager.get_secure_random_bytes();
1054         let route = get_route(
1055                 &nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(),
1056                 Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
1057                 amt_msat, TEST_FINAL_CLTV, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
1058         let _payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1059         check_added_monitors!(nodes[0], 1);
1060
1061         // Make sure to use `get_payment_preimage`
1062         let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
1063         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1064         assert_eq!(events.len(), 1);
1065         pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
1066         claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);
1067 }
1068
1069 #[test]
1070 fn sent_probe_is_probe_of_sending_node() {
1071         let chanmon_cfgs = create_chanmon_cfgs(3);
1072         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1073         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None, None]);
1074         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1075
1076         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1077         create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1078
1079         // First check we refuse to build a single-hop probe
1080         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
1081         assert!(nodes[0].node.send_probe(route.paths[0].clone()).is_err());
1082
1083         // Then build an actual two-hop probing path
1084         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], 100_000);
1085
1086         match nodes[0].node.send_probe(route.paths[0].clone()) {
1087                 Ok((payment_hash, payment_id)) => {
1088                         assert!(nodes[0].node.payment_is_probe(&payment_hash, &payment_id));
1089                         assert!(!nodes[1].node.payment_is_probe(&payment_hash, &payment_id));
1090                         assert!(!nodes[2].node.payment_is_probe(&payment_hash, &payment_id));
1091                 },
1092                 _ => panic!(),
1093         }
1094
1095         get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1096         check_added_monitors!(nodes[0], 1);
1097 }
1098
1099 #[test]
1100 fn successful_probe_yields_event() {
1101         let chanmon_cfgs = create_chanmon_cfgs(3);
1102         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1103         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None, None]);
1104         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1105
1106         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1107         create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1108
1109         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], 100_000);
1110
1111         let (payment_hash, payment_id) = nodes[0].node.send_probe(route.paths[0].clone()).unwrap();
1112
1113         // node[0] -- update_add_htlcs -> node[1]
1114         check_added_monitors!(nodes[0], 1);
1115         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1116         let probe_event = SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), updates);
1117         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &probe_event.msgs[0]);
1118         check_added_monitors!(nodes[1], 0);
1119         commitment_signed_dance!(nodes[1], nodes[0], probe_event.commitment_msg, false);
1120         expect_pending_htlcs_forwardable!(nodes[1]);
1121
1122         // node[1] -- update_add_htlcs -> node[2]
1123         check_added_monitors!(nodes[1], 1);
1124         let updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1125         let probe_event = SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), updates);
1126         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &probe_event.msgs[0]);
1127         check_added_monitors!(nodes[2], 0);
1128         commitment_signed_dance!(nodes[2], nodes[1], probe_event.commitment_msg, true, true);
1129
1130         // node[1] <- update_fail_htlcs -- node[2]
1131         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1132         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1133         check_added_monitors!(nodes[1], 0);
1134         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, true);
1135
1136         // node[0] <- update_fail_htlcs -- node[1]
1137         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1138         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1139         check_added_monitors!(nodes[0], 0);
1140         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1141
1142         let mut events = nodes[0].node.get_and_clear_pending_events();
1143         assert_eq!(events.len(), 1);
1144         match events.drain(..).next().unwrap() {
1145                 crate::util::events::Event::ProbeSuccessful { payment_id: ev_pid, payment_hash: ev_ph, .. } => {
1146                         assert_eq!(payment_id, ev_pid);
1147                         assert_eq!(payment_hash, ev_ph);
1148                 },
1149                 _ => panic!(),
1150         };
1151 }
1152
1153 #[test]
1154 fn failed_probe_yields_event() {
1155         let chanmon_cfgs = create_chanmon_cfgs(3);
1156         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1157         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None, None]);
1158         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1159
1160         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1161         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 90000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1162
1163         let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id());
1164
1165         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], &payment_params, 9_998_000, 42);
1166
1167         let (payment_hash, payment_id) = nodes[0].node.send_probe(route.paths[0].clone()).unwrap();
1168
1169         // node[0] -- update_add_htlcs -> node[1]
1170         check_added_monitors!(nodes[0], 1);
1171         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1172         let probe_event = SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), updates);
1173         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &probe_event.msgs[0]);
1174         check_added_monitors!(nodes[1], 0);
1175         commitment_signed_dance!(nodes[1], nodes[0], probe_event.commitment_msg, false);
1176         expect_pending_htlcs_forwardable!(nodes[1]);
1177
1178         // node[0] <- update_fail_htlcs -- node[1]
1179         check_added_monitors!(nodes[1], 1);
1180         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1181         // Skip the PendingHTLCsForwardable event
1182         let _events = nodes[1].node.get_and_clear_pending_events();
1183         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1184         check_added_monitors!(nodes[0], 0);
1185         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1186
1187         let mut events = nodes[0].node.get_and_clear_pending_events();
1188         assert_eq!(events.len(), 1);
1189         match events.drain(..).next().unwrap() {
1190                 crate::util::events::Event::ProbeFailed { payment_id: ev_pid, payment_hash: ev_ph, .. } => {
1191                         assert_eq!(payment_id, ev_pid);
1192                         assert_eq!(payment_hash, ev_ph);
1193                 },
1194                 _ => panic!(),
1195         };
1196 }
1197
1198 #[test]
1199 fn onchain_failed_probe_yields_event() {
1200         // Tests that an attempt to probe over a channel that is eventaully closed results in a failure
1201         // event.
1202         let chanmon_cfgs = create_chanmon_cfgs(3);
1203         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1204         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1205         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1206
1207         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1208         create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1209
1210         let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id());
1211
1212         // Send a dust HTLC, which will be treated as if it timed out once the channel hits the chain.
1213         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], &payment_params, 1_000, 42);
1214         let (payment_hash, payment_id) = nodes[0].node.send_probe(route.paths[0].clone()).unwrap();
1215
1216         // node[0] -- update_add_htlcs -> node[1]
1217         check_added_monitors!(nodes[0], 1);
1218         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1219         let probe_event = SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), updates);
1220         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &probe_event.msgs[0]);
1221         check_added_monitors!(nodes[1], 0);
1222         commitment_signed_dance!(nodes[1], nodes[0], probe_event.commitment_msg, false);
1223         expect_pending_htlcs_forwardable!(nodes[1]);
1224
1225         check_added_monitors!(nodes[1], 1);
1226         let _ = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1227
1228         // Don't bother forwarding the HTLC onwards and just confirm the force-close transaction on
1229         // Node A, which after 6 confirmations should result in a probe failure event.
1230         let bs_txn = get_local_commitment_txn!(nodes[1], chan_id);
1231         confirm_transaction(&nodes[0], &bs_txn[0]);
1232         check_closed_broadcast!(&nodes[0], true);
1233         check_added_monitors!(nodes[0], 1);
1234
1235         let mut events = nodes[0].node.get_and_clear_pending_events();
1236         assert_eq!(events.len(), 2);
1237         let mut found_probe_failed = false;
1238         for event in events.drain(..) {
1239                 match event {
1240                         Event::ProbeFailed { payment_id: ev_pid, payment_hash: ev_ph, .. } => {
1241                                 assert_eq!(payment_id, ev_pid);
1242                                 assert_eq!(payment_hash, ev_ph);
1243                                 found_probe_failed = true;
1244                         },
1245                         Event::ChannelClosed { .. } => {},
1246                         _ => panic!(),
1247                 }
1248         }
1249         assert!(found_probe_failed);
1250 }