_ Git - rust-lightning/blob - lightning/src/ln/chanmon_update_fail_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 //! Functional tests which test the correct handling of ChannelMonitorUpdateStatus returns from
  11 //! monitor updates.
  12 //! There are a bunch of these as their handling is relatively error-prone so they are split out
  13 //! here. See also the chanmon_fail_consistency fuzz test.
  14
  15 use bitcoin::blockdata::constants::genesis_block;
  16 use bitcoin::hash_types::BlockHash;
  17 use bitcoin::network::Network;
  18 use crate::chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor};
  19 use crate::chain::transaction::OutPoint;
  20 use crate::chain::{ChannelMonitorUpdateStatus, Listen, Watch};
  21 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason, HTLCDestination};
  22 use crate::ln::channelmanager::{RAACommitmentOrder, PaymentSendFailure, PaymentId, RecipientOnionFields};
  23 use crate::ln::channel::{AnnouncementSigsState, ChannelPhase};
  24 use crate::ln::msgs;
  25 use crate::ln::types::ChannelId;
  26 use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
  27 use crate::util::test_channel_signer::TestChannelSigner;
  28 use crate::util::errors::APIError;
  29 use crate::util::ser::{ReadableArgs, Writeable};
  30 use crate::util::test_utils::TestBroadcaster;
  31
  32 use crate::ln::functional_test_utils::*;
  33
  34 use crate::util::test_utils;
  35
  36 use crate::io;
  37 use bitcoin::hashes::Hash;
  38 use crate::prelude::*;
  39 use crate::sync::{Arc, Mutex};
  40
  41 #[test]
  42 fn test_monitor_and_persister_update_fail() {
  43         // Test that if both updating the `ChannelMonitor` and persisting the updated
  44         // `ChannelMonitor` fail, then the failure from updating the `ChannelMonitor`
  45         // one that gets returned.
  46         let chanmon_cfgs = create_chanmon_cfgs(2);
  47         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  48         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  49         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  50
  51         // Create some initial channel
  52         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
  53         let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
  54
  55         // Rebalance the network to generate htlc in the two directions
  56         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
  57
  58         // Route an HTLC from node 0 to node 1 (but don't settle)
  59         let (preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
  60
  61         // Make a copy of the ChainMonitor so we can capture the error it returns on a
  62         // bogus update. Note that if instead we updated the nodes[0]'s ChainMonitor
  63         // directly, the node would fail to be `Drop`'d at the end because its
  64         // ChannelManager and ChainMonitor would be out of sync.
  65         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
  66         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
  67         let persister = test_utils::TestPersister::new();
  68         let tx_broadcaster = TestBroadcaster {
  69                 txn_broadcasted: Mutex::new(Vec::new()),
  70                 // Because we will connect a block at height 200 below, we need the TestBroadcaster to know
  71                 // that we are at height 200 so that it doesn't think we're violating the time lock
  72                 // requirements of transactions broadcasted at that point.
  73                 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 200); 200])),
  74         };
  75         let chain_mon = {
  76                 let new_monitor = {
  77                         let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
  78                         let new_monitor = <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(
  79                                 &mut io::Cursor::new(&monitor.encode()), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
  80                         assert!(new_monitor == *monitor);
  81                         new_monitor
  82                 };
  83                 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
  84                 assert_eq!(chain_mon.watch_channel(outpoint, new_monitor), Ok(ChannelMonitorUpdateStatus::Completed));
  85                 chain_mon
  86         };
  87         chain_mon.chain_monitor.block_connected(&create_dummy_block(BlockHash::all_zeros(), 42, Vec::new()), 200);
  88
  89         // Try to update ChannelMonitor
  90         nodes[1].node.claim_funds(preimage);
  91         expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
  92         check_added_monitors!(nodes[1], 1);
  93
  94         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
  95         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
  96         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
  97
  98         {
  99                 let mut node_0_per_peer_lock;
 100                 let mut node_0_peer_state_lock;
 101                 if let ChannelPhase::Funded(ref mut channel) = get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan.2) {
 102                         if let Ok(Some(update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
 103                                 // Check that the persister returns InProgress (and will never actually complete)
 104                                 // as the monitor update errors.
 105                                 if let ChannelMonitorUpdateStatus::InProgress = chain_mon.chain_monitor.update_channel(outpoint, &update) {} else { panic!("Expected monitor paused"); }
 106                                 logger.assert_log_regex("lightning::chain::chainmonitor", regex::Regex::new("Failed to update ChannelMonitor for channel [0-9a-f]*.").unwrap(), 1);
 107
 108                                 // Apply the monitor update to the original ChainMonitor, ensuring the
 109                                 // ChannelManager and ChannelMonitor aren't out of sync.
 110                                 assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, &update),
 111                                         ChannelMonitorUpdateStatus::Completed);
 112                         } else { assert!(false); }
 113                 } else {
 114                         assert!(false);
 115                 }
 116         }
 117
 118         check_added_monitors!(nodes[0], 1);
 119         expect_payment_sent(&nodes[0], preimage, None, false, false);
 120 }
 121
 122 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
 123         // Test that we can recover from a simple temporary monitor update failure optionally with
 124         // a disconnect in between
 125         let chanmon_cfgs = create_chanmon_cfgs(2);
 126         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 127         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 128         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 129         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
 130
 131         let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
 132
 133         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 134
 135         {
 136                 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_1,
 137                                 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)
 138                         ), false, APIError::MonitorUpdateInProgress, {});
 139                 check_added_monitors!(nodes[0], 1);
 140         }
 141
 142         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 143         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 144         assert_eq!(nodes[0].node.list_channels().len(), 1);
 145
 146         if disconnect {
 147                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
 148                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
 149                 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
 150                 reconnect_args.send_channel_ready = (true, true);
 151                 reconnect_nodes(reconnect_args);
 152         }
 153
 154         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
 155         let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
 156         nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
 157         check_added_monitors!(nodes[0], 0);
 158
 159         let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
 160         assert_eq!(events_2.len(), 1);
 161         let payment_event = SendEvent::from_event(events_2.pop().unwrap());
 162         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
 163         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 164         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
 165
 166         expect_pending_htlcs_forwardable!(nodes[1]);
 167
 168         let events_3 = nodes[1].node.get_and_clear_pending_events();
 169         assert_eq!(events_3.len(), 1);
 170         match events_3[0] {
 171                 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
 172                         assert_eq!(payment_hash_1, *payment_hash);
 173                         assert_eq!(amount_msat, 1_000_000);
 174                         assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
 175                         assert_eq!(via_channel_id, Some(channel_id));
 176                         match &purpose {
 177                                 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
 178                                         assert!(payment_preimage.is_none());
 179                                         assert_eq!(payment_secret_1, *payment_secret);
 180                                 },
 181                                 _ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
 182                         }
 183                 },
 184                 _ => panic!("Unexpected event"),
 185         }
 186
 187         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
 188
 189         // Now set it to failed again...
 190         let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
 191         {
 192                 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 193                 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_2,
 194                                 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)
 195                         ), false, APIError::MonitorUpdateInProgress, {});
 196                 check_added_monitors!(nodes[0], 1);
 197         }
 198
 199         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 200         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 201         assert_eq!(nodes[0].node.list_channels().len(), 1);
 202
 203         if disconnect {
 204                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
 205                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
 206                 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
 207         }
 208
 209         // ...and make sure we can force-close a frozen channel
 210         let error_message = "Channel force-closed";
 211         nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id(), error_message.to_string()).unwrap();
 212         check_added_monitors!(nodes[0], 1);
 213         check_closed_broadcast!(nodes[0], true);
 214
 215         // TODO: Once we hit the chain with the failure transaction we should check that we get a
 216         // PaymentPathFailed event
 217
 218         assert_eq!(nodes[0].node.list_channels().len(), 0);
 219         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(true) }, [nodes[1].node.get_our_node_id()], 100000);
 220 }
 221
 222 #[test]
 223 fn test_simple_monitor_temporary_update_fail() {
 224         do_test_simple_monitor_temporary_update_fail(false);
 225         do_test_simple_monitor_temporary_update_fail(true);
 226 }
 227
 228 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
 229         let disconnect_flags = 8 | 16;
 230
 231         // Test that we can recover from a temporary monitor update failure with some in-flight
 232         // HTLCs going on at the same time potentially with some disconnection thrown in.
 233         // * First we route a payment, then get a temporary monitor update failure when trying to
 234         //   route a second payment. We then claim the first payment.
 235         // * If disconnect_count is set, we will disconnect at this point (which is likely as
 236         //   InProgress likely indicates net disconnect which resulted in failing to update the
 237         //   ChannelMonitor on a watchtower).
 238         // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
 239         //   immediately, otherwise we wait disconnect and deliver them via the reconnect
 240         //   channel_reestablish processing (ie disconnect_count & 16 makes no sense if
 241         //   disconnect_count & !disconnect_flags is 0).
 242         // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
 243         //   through message sending, potentially disconnect/reconnecting multiple times based on
 244         //   disconnect_count, to get the update_fulfill_htlc through.
 245         // * We then walk through more message exchanges to get the original update_add_htlc
 246         //   through, swapping message ordering based on disconnect_count & 8 and optionally
 247         //   disconnect/reconnecting based on disconnect_count.
 248         let chanmon_cfgs = create_chanmon_cfgs(2);
 249         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 250         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 251         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 252         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
 253
 254         let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
 255
 256         // Now try to send a second payment which will fail to send
 257         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
 258         {
 259                 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 260                 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_2,
 261                                 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)
 262                         ), false, APIError::MonitorUpdateInProgress, {});
 263                 check_added_monitors!(nodes[0], 1);
 264         }
 265
 266         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 267         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 268         assert_eq!(nodes[0].node.list_channels().len(), 1);
 269
 270         // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
 271         // but nodes[0] won't respond since it is frozen.
 272         nodes[1].node.claim_funds(payment_preimage_1);
 273         check_added_monitors!(nodes[1], 1);
 274         expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
 275
 276         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
 277         assert_eq!(events_2.len(), 1);
 278         let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
 279                 MessageSendEvent::UpdateHTLCs { ref 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 } } => {
 280                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
 281                         assert!(update_add_htlcs.is_empty());
 282                         assert_eq!(update_fulfill_htlcs.len(), 1);
 283                         assert!(update_fail_htlcs.is_empty());
 284                         assert!(update_fail_malformed_htlcs.is_empty());
 285                         assert!(update_fee.is_none());
 286
 287                         if (disconnect_count & 16) == 0 {
 288                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
 289                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
 290                                 assert_eq!(events_3.len(), 1);
 291                                 match events_3[0] {
 292                                         Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
 293                                                 assert_eq!(*payment_preimage, payment_preimage_1);
 294                                                 assert_eq!(*payment_hash, payment_hash_1);
 295                                         },
 296                                         _ => panic!("Unexpected event"),
 297                                 }
 298
 299                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
 300                                 check_added_monitors!(nodes[0], 1);
 301                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 302                         }
 303
 304                         (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
 305                 },
 306                 _ => panic!("Unexpected event"),
 307         };
 308
 309         if disconnect_count & !disconnect_flags > 0 {
 310                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
 311                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
 312         }
 313
 314         // Now fix monitor updating...
 315         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
 316         let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
 317         nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
 318         check_added_monitors!(nodes[0], 0);
 319
 320         macro_rules! disconnect_reconnect_peers { () => { {
 321                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
 322                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
 323
 324                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
 325                         features: nodes[1].node.init_features(), networks: None, remote_network_address: None
 326                 }, true).unwrap();
 327                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
 328                 assert_eq!(reestablish_1.len(), 1);
 329                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
 330                         features: nodes[0].node.init_features(), networks: None, remote_network_address: None
 331                 }, false).unwrap();
 332                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
 333                 assert_eq!(reestablish_2.len(), 1);
 334
 335                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
 336                 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
 337                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
 338                 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
 339
 340                 assert!(as_resp.0.is_none());
 341                 assert!(bs_resp.0.is_none());
 342
 343                 (reestablish_1, reestablish_2, as_resp, bs_resp)
 344         } } }
 345
 346         let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
 347                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 348                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 349
 350                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
 351                         features: nodes[1].node.init_features(), networks: None, remote_network_address: None
 352                 }, true).unwrap();
 353                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
 354                 assert_eq!(reestablish_1.len(), 1);
 355                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
 356                         features: nodes[0].node.init_features(), networks: None, remote_network_address: None
 357                 }, false).unwrap();
 358                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
 359                 assert_eq!(reestablish_2.len(), 1);
 360
 361                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
 362                 check_added_monitors!(nodes[0], 0);
 363                 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
 364                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
 365                 check_added_monitors!(nodes[1], 0);
 366                 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
 367
 368                 assert!(as_resp.0.is_none());
 369                 assert!(bs_resp.0.is_none());
 370
 371                 assert!(bs_resp.1.is_none());
 372                 if (disconnect_count & 16) == 0 {
 373                         assert!(bs_resp.2.is_none());
 374
 375                         assert!(as_resp.1.is_some());
 376                         assert!(as_resp.2.is_some());
 377                         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
 378                 } else {
 379                         assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
 380                         assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
 381                         assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
 382                         assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
 383                         assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
 384                         assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
 385
 386                         assert!(as_resp.1.is_none());
 387
 388                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
 389                         let events_3 = nodes[0].node.get_and_clear_pending_events();
 390                         assert_eq!(events_3.len(), 1);
 391                         match events_3[0] {
 392                                 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
 393                                         assert_eq!(*payment_preimage, payment_preimage_1);
 394                                         assert_eq!(*payment_hash, payment_hash_1);
 395                                 },
 396                                 _ => panic!("Unexpected event"),
 397                         }
 398
 399                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
 400                         let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 401                         // No commitment_signed so get_event_msg's assert(len == 1) passes
 402                         check_added_monitors!(nodes[0], 1);
 403
 404                         as_resp.1 = Some(as_resp_raa);
 405                         bs_resp.2 = None;
 406                 }
 407
 408                 if disconnect_count & !disconnect_flags > 1 {
 409                         let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
 410
 411                         if (disconnect_count & 16) == 0 {
 412                                 assert!(reestablish_1 == second_reestablish_1);
 413                                 assert!(reestablish_2 == second_reestablish_2);
 414                         }
 415                         assert!(as_resp == second_as_resp);
 416                         assert!(bs_resp == second_bs_resp);
 417                 }
 418
 419                 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
 420         } else {
 421                 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
 422                 assert_eq!(events_4.len(), 2);
 423                 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
 424                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 425                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 426                                 msg.clone()
 427                         },
 428                         _ => panic!("Unexpected event"),
 429                 })
 430         };
 431
 432         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
 433
 434         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 435         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
 436         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 437         // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
 438         check_added_monitors!(nodes[1], 1);
 439
 440         if disconnect_count & !disconnect_flags > 2 {
 441                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
 442
 443                 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
 444                 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
 445
 446                 assert!(as_resp.2.is_none());
 447                 assert!(bs_resp.2.is_none());
 448         }
 449
 450         let as_commitment_update;
 451         let bs_second_commitment_update;
 452
 453         macro_rules! handle_bs_raa { () => {
 454                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
 455                 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 456                 assert!(as_commitment_update.update_add_htlcs.is_empty());
 457                 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
 458                 assert!(as_commitment_update.update_fail_htlcs.is_empty());
 459                 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
 460                 assert!(as_commitment_update.update_fee.is_none());
 461                 check_added_monitors!(nodes[0], 1);
 462         } }
 463
 464         macro_rules! handle_initial_raa { () => {
 465                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
 466                 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 467                 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
 468                 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
 469                 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
 470                 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
 471                 assert!(bs_second_commitment_update.update_fee.is_none());
 472                 check_added_monitors!(nodes[1], 1);
 473         } }
 474
 475         if (disconnect_count & 8) == 0 {
 476                 handle_bs_raa!();
 477
 478                 if disconnect_count & !disconnect_flags > 3 {
 479                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
 480
 481                         assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
 482                         assert!(bs_resp.1.is_none());
 483
 484                         assert!(as_resp.2.unwrap() == as_commitment_update);
 485                         assert!(bs_resp.2.is_none());
 486
 487                         assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
 488                 }
 489
 490                 handle_initial_raa!();
 491
 492                 if disconnect_count & !disconnect_flags > 4 {
 493                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
 494
 495                         assert!(as_resp.1.is_none());
 496                         assert!(bs_resp.1.is_none());
 497
 498                         assert!(as_resp.2.unwrap() == as_commitment_update);
 499                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
 500                 }
 501         } else {
 502                 handle_initial_raa!();
 503
 504                 if disconnect_count & !disconnect_flags > 3 {
 505                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
 506
 507                         assert!(as_resp.1.is_none());
 508                         assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
 509
 510                         assert!(as_resp.2.is_none());
 511                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
 512
 513                         assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
 514                 }
 515
 516                 handle_bs_raa!();
 517
 518                 if disconnect_count & !disconnect_flags > 4 {
 519                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
 520
 521                         assert!(as_resp.1.is_none());
 522                         assert!(bs_resp.1.is_none());
 523
 524                         assert!(as_resp.2.unwrap() == as_commitment_update);
 525                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
 526                 }
 527         }
 528
 529         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
 530         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 531         // No commitment_signed so get_event_msg's assert(len == 1) passes
 532         check_added_monitors!(nodes[0], 1);
 533
 534         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
 535         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 536         // No commitment_signed so get_event_msg's assert(len == 1) passes
 537         check_added_monitors!(nodes[1], 1);
 538
 539         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
 540         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 541         check_added_monitors!(nodes[1], 1);
 542
 543         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
 544         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 545         check_added_monitors!(nodes[0], 1);
 546         expect_payment_path_successful!(nodes[0]);
 547
 548         expect_pending_htlcs_forwardable!(nodes[1]);
 549
 550         let events_5 = nodes[1].node.get_and_clear_pending_events();
 551         assert_eq!(events_5.len(), 1);
 552         match events_5[0] {
 553                 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
 554                         assert_eq!(payment_hash_2, *payment_hash);
 555                         assert_eq!(amount_msat, 1_000_000);
 556                         assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
 557                         assert_eq!(via_channel_id, Some(channel_id));
 558                         match &purpose {
 559                                 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
 560                                         assert!(payment_preimage.is_none());
 561                                         assert_eq!(payment_secret_2, *payment_secret);
 562                                 },
 563                                 _ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
 564                         }
 565                 },
 566                 _ => panic!("Unexpected event"),
 567         }
 568
 569         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
 570 }
 571
 572 #[test]
 573 fn test_monitor_temporary_update_fail_a() {
 574         do_test_monitor_temporary_update_fail(0);
 575         do_test_monitor_temporary_update_fail(1);
 576         do_test_monitor_temporary_update_fail(2);
 577         do_test_monitor_temporary_update_fail(3);
 578         do_test_monitor_temporary_update_fail(4);
 579         do_test_monitor_temporary_update_fail(5);
 580 }
 581
 582 #[test]
 583 fn test_monitor_temporary_update_fail_b() {
 584         do_test_monitor_temporary_update_fail(2 | 8);
 585         do_test_monitor_temporary_update_fail(3 | 8);
 586         do_test_monitor_temporary_update_fail(4 | 8);
 587         do_test_monitor_temporary_update_fail(5 | 8);
 588 }
 589
 590 #[test]
 591 fn test_monitor_temporary_update_fail_c() {
 592         do_test_monitor_temporary_update_fail(1 | 16);
 593         do_test_monitor_temporary_update_fail(2 | 16);
 594         do_test_monitor_temporary_update_fail(3 | 16);
 595         do_test_monitor_temporary_update_fail(2 | 8 | 16);
 596         do_test_monitor_temporary_update_fail(3 | 8 | 16);
 597 }
 598
 599 #[test]
 600 fn test_monitor_update_fail_cs() {
 601         // Tests handling of a monitor update failure when processing an incoming commitment_signed
 602         let chanmon_cfgs = create_chanmon_cfgs(2);
 603         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 604         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 605         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 606         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
 607
 608         let (route, our_payment_hash, payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
 609         {
 610                 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
 611                         RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
 612                 check_added_monitors!(nodes[0], 1);
 613         }
 614
 615         let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
 616         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
 617
 618         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 619         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
 620         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 621         check_added_monitors!(nodes[1], 1);
 622         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 623
 624         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
 625         let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
 626         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
 627         check_added_monitors!(nodes[1], 0);
 628         let responses = nodes[1].node.get_and_clear_pending_msg_events();
 629         assert_eq!(responses.len(), 2);
 630
 631         match responses[0] {
 632                 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
 633                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
 634                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
 635                         check_added_monitors!(nodes[0], 1);
 636                 },
 637                 _ => panic!("Unexpected event"),
 638         }
 639         match responses[1] {
 640                 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
 641                         assert!(updates.update_add_htlcs.is_empty());
 642                         assert!(updates.update_fulfill_htlcs.is_empty());
 643                         assert!(updates.update_fail_htlcs.is_empty());
 644                         assert!(updates.update_fail_malformed_htlcs.is_empty());
 645                         assert!(updates.update_fee.is_none());
 646                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
 647
 648                         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 649                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
 650                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 651                         check_added_monitors!(nodes[0], 1);
 652                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 653                 },
 654                 _ => panic!("Unexpected event"),
 655         }
 656
 657         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
 658         let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
 659         nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
 660         check_added_monitors!(nodes[0], 0);
 661
 662         let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 663         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
 664         check_added_monitors!(nodes[1], 1);
 665
 666         expect_pending_htlcs_forwardable!(nodes[1]);
 667
 668         let events = nodes[1].node.get_and_clear_pending_events();
 669         assert_eq!(events.len(), 1);
 670         match events[0] {
 671                 Event::PaymentClaimable { payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
 672                         assert_eq!(payment_hash, our_payment_hash);
 673                         assert_eq!(amount_msat, 1_000_000);
 674                         assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
 675                         assert_eq!(via_channel_id, Some(channel_id));
 676                         match &purpose {
 677                                 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
 678                                         assert!(payment_preimage.is_none());
 679                                         assert_eq!(our_payment_secret, *payment_secret);
 680                                 },
 681                                 _ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
 682                         }
 683                 },
 684                 _ => panic!("Unexpected event"),
 685         };
 686
 687         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
 688 }
 689
 690 #[test]
 691 fn test_monitor_update_fail_no_rebroadcast() {
 692         // Tests handling of a monitor update failure when no message rebroadcasting on
 693         // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
 694         // fuzz tests.
 695         let chanmon_cfgs = create_chanmon_cfgs(2);
 696         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 697         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 698         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 699         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
 700
 701         let (route, our_payment_hash, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
 702         {
 703                 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
 704                         RecipientOnionFields::secret_only(payment_secret_1), PaymentId(our_payment_hash.0)).unwrap();
 705                 check_added_monitors!(nodes[0], 1);
 706         }
 707
 708         let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
 709         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
 710         let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
 711
 712         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 713         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
 714         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 715         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 716         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 717         check_added_monitors!(nodes[1], 1);
 718
 719         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
 720         let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
 721         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
 722         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 723         check_added_monitors!(nodes[1], 0);
 724         expect_pending_htlcs_forwardable!(nodes[1]);
 725
 726         let events = nodes[1].node.get_and_clear_pending_events();
 727         assert_eq!(events.len(), 1);
 728         match events[0] {
 729                 Event::PaymentClaimable { payment_hash, .. } => {
 730                         assert_eq!(payment_hash, our_payment_hash);
 731                 },
 732                 _ => panic!("Unexpected event"),
 733         }
 734
 735         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
 736 }
 737
 738 #[test]
 739 fn test_monitor_update_raa_while_paused() {
 740         // Tests handling of an RAA while monitor updating has already been marked failed.
 741         // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
 742         let chanmon_cfgs = create_chanmon_cfgs(2);
 743         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 744         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 745         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 746         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
 747
 748         send_payment(&nodes[0], &[&nodes[1]], 5000000);
 749         let (route, our_payment_hash_1, payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
 750         {
 751                 nodes[0].node.send_payment_with_route(&route, our_payment_hash_1,
 752                         RecipientOnionFields::secret_only(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
 753                 check_added_monitors!(nodes[0], 1);
 754         }
 755         let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
 756
 757         let (route, our_payment_hash_2, payment_preimage_2, our_payment_secret_2) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000000);
 758         {
 759                 nodes[1].node.send_payment_with_route(&route, our_payment_hash_2,
 760                         RecipientOnionFields::secret_only(our_payment_secret_2), PaymentId(our_payment_hash_2.0)).unwrap();
 761                 check_added_monitors!(nodes[1], 1);
 762         }
 763         let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
 764
 765         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
 766         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
 767         check_added_monitors!(nodes[1], 1);
 768         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 769
 770         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 771         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 772         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
 773         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
 774         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 775         check_added_monitors!(nodes[0], 1);
 776         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 777
 778         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
 779         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 780         check_added_monitors!(nodes[0], 1);
 781
 782         let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
 783         nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
 784         check_added_monitors!(nodes[0], 0);
 785
 786         let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 787         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
 788         check_added_monitors!(nodes[1], 1);
 789         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 790
 791         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
 792         check_added_monitors!(nodes[1], 1);
 793         let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 794
 795         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
 796         check_added_monitors!(nodes[0], 1);
 797         let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 798
 799         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
 800         check_added_monitors!(nodes[0], 1);
 801         expect_pending_htlcs_forwardable!(nodes[0]);
 802         expect_payment_claimable!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
 803
 804         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
 805         check_added_monitors!(nodes[1], 1);
 806         expect_pending_htlcs_forwardable!(nodes[1]);
 807         expect_payment_claimable!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
 808
 809         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
 810         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
 811 }
 812
 813 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
 814         // Tests handling of a monitor update failure when processing an incoming RAA
 815         let chanmon_cfgs = create_chanmon_cfgs(3);
 816         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 817         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 818         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 819         create_announced_chan_between_nodes(&nodes, 0, 1);
 820         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 821
 822         // Rebalance a bit so that we can send backwards from 2 to 1.
 823         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
 824
 825         // Route a first payment that we'll fail backwards
 826         let (_, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
 827
 828         // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
 829         nodes[2].node.fail_htlc_backwards(&payment_hash_1);
 830         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
 831         check_added_monitors!(nodes[2], 1);
 832
 833         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 834         assert!(updates.update_add_htlcs.is_empty());
 835         assert!(updates.update_fulfill_htlcs.is_empty());
 836         assert_eq!(updates.update_fail_htlcs.len(), 1);
 837         assert!(updates.update_fail_malformed_htlcs.is_empty());
 838         assert!(updates.update_fee.is_none());
 839         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
 840
 841         let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
 842         check_added_monitors!(nodes[0], 0);
 843
 844         // While the second channel is AwaitingRAA, forward a second payment to get it into the
 845         // holding cell.
 846         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
 847         {
 848                 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
 849                         RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
 850                 check_added_monitors!(nodes[0], 1);
 851         }
 852
 853         let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
 854         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
 855         commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
 856
 857         expect_pending_htlcs_forwardable!(nodes[1]);
 858         check_added_monitors!(nodes[1], 0);
 859         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 860
 861         // Now fail monitor updating.
 862         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
 863         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
 864         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 865         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 866         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 867         check_added_monitors!(nodes[1], 1);
 868
 869         // Forward a third payment which will also be added to the holding cell, despite the channel
 870         // being paused waiting a monitor update.
 871         let (route, payment_hash_3, _, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
 872         {
 873                 nodes[0].node.send_payment_with_route(&route, payment_hash_3,
 874                         RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
 875                 check_added_monitors!(nodes[0], 1);
 876         }
 877
 878         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed); // We succeed in updating the monitor for the first channel
 879         send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
 880         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
 881         commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
 882         check_added_monitors!(nodes[1], 0);
 883
 884         // Call forward_pending_htlcs and check that the new HTLC was simply added to the holding cell
 885         // and not forwarded.
 886         expect_pending_htlcs_forwardable!(nodes[1]);
 887         check_added_monitors!(nodes[1], 0);
 888         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 889
 890         let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
 891                 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
 892                 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
 893                 nodes[2].node.send_payment_with_route(&route, payment_hash_4,
 894                         RecipientOnionFields::secret_only(payment_secret_4), PaymentId(payment_hash_4.0)).unwrap();
 895                 check_added_monitors!(nodes[2], 1);
 896
 897                 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
 898                 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
 899                 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
 900                 check_added_monitors!(nodes[1], 1);
 901                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 902                 (Some(payment_preimage_4), Some(payment_hash_4))
 903         } else { (None, None) };
 904
 905         // Restore monitor updating, ensuring we immediately get a fail-back update and a
 906         // update_add update.
 907         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
 908         let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
 909         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
 910         check_added_monitors!(nodes[1], 0);
 911         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_2.2 }]);
 912         check_added_monitors!(nodes[1], 1);
 913
 914         let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
 915         if test_ignore_second_cs {
 916                 assert_eq!(events_3.len(), 3);
 917         } else {
 918                 assert_eq!(events_3.len(), 2);
 919         }
 920
 921         // Note that the ordering of the events for different nodes is non-prescriptive, though the
 922         // ordering of the two events that both go to nodes[2] have to stay in the same order.
 923         let nodes_0_event = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &mut events_3);
 924         let messages_a = match nodes_0_event {
 925                 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
 926                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
 927                         assert!(updates.update_fulfill_htlcs.is_empty());
 928                         assert_eq!(updates.update_fail_htlcs.len(), 1);
 929                         assert!(updates.update_fail_malformed_htlcs.is_empty());
 930                         assert!(updates.update_add_htlcs.is_empty());
 931                         assert!(updates.update_fee.is_none());
 932                         (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
 933                 },
 934                 _ => panic!("Unexpected event type!"),
 935         };
 936
 937         let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events_3);
 938         let send_event_b = SendEvent::from_event(nodes_2_event);
 939         assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
 940
 941         let raa = if test_ignore_second_cs {
 942                 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events_3);
 943                 match nodes_2_event {
 944                         MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
 945                                 assert_eq!(node_id, nodes[2].node.get_our_node_id());
 946                                 Some(msg.clone())
 947                         },
 948                         _ => panic!("Unexpected event"),
 949                 }
 950         } else { None };
 951
 952         // Now deliver the new messages...
 953
 954         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
 955         commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
 956         expect_payment_failed!(nodes[0], payment_hash_1, true);
 957
 958         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
 959         let as_cs;
 960         if test_ignore_second_cs {
 961                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
 962                 check_added_monitors!(nodes[2], 1);
 963                 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 964                 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
 965                 check_added_monitors!(nodes[2], 1);
 966                 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 967                 assert!(bs_cs.update_add_htlcs.is_empty());
 968                 assert!(bs_cs.update_fail_htlcs.is_empty());
 969                 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
 970                 assert!(bs_cs.update_fulfill_htlcs.is_empty());
 971                 assert!(bs_cs.update_fee.is_none());
 972
 973                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
 974                 check_added_monitors!(nodes[1], 1);
 975                 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
 976
 977                 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
 978                 check_added_monitors!(nodes[1], 1);
 979         } else {
 980                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
 981                 check_added_monitors!(nodes[2], 1);
 982
 983                 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
 984                 // As both messages are for nodes[1], they're in order.
 985                 assert_eq!(bs_revoke_and_commit.len(), 2);
 986                 match bs_revoke_and_commit[0] {
 987                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 988                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 989                                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
 990                                 check_added_monitors!(nodes[1], 1);
 991                         },
 992                         _ => panic!("Unexpected event"),
 993                 }
 994
 995                 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
 996
 997                 match bs_revoke_and_commit[1] {
 998                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
 999                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1000                                 assert!(updates.update_add_htlcs.is_empty());
1001                                 assert!(updates.update_fail_htlcs.is_empty());
1002                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
1003                                 assert!(updates.update_fulfill_htlcs.is_empty());
1004                                 assert!(updates.update_fee.is_none());
1005                                 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1006                                 check_added_monitors!(nodes[1], 1);
1007                         },
1008                         _ => panic!("Unexpected event"),
1009                 }
1010         }
1011
1012         assert_eq!(as_cs.update_add_htlcs.len(), 1);
1013         assert!(as_cs.update_fail_htlcs.is_empty());
1014         assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1015         assert!(as_cs.update_fulfill_htlcs.is_empty());
1016         assert!(as_cs.update_fee.is_none());
1017         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1018
1019
1020         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1021         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1022         check_added_monitors!(nodes[2], 1);
1023         let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1024
1025         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1026         check_added_monitors!(nodes[2], 1);
1027         let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1028
1029         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1030         check_added_monitors!(nodes[1], 1);
1031         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1032
1033         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1034         check_added_monitors!(nodes[1], 1);
1035         let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1036
1037         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1038         check_added_monitors!(nodes[2], 1);
1039         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1040
1041         expect_pending_htlcs_forwardable!(nodes[2]);
1042
1043         let events_6 = nodes[2].node.get_and_clear_pending_events();
1044         assert_eq!(events_6.len(), 2);
1045         match events_6[0] {
1046                 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1047                 _ => panic!("Unexpected event"),
1048         };
1049         match events_6[1] {
1050                 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1051                 _ => panic!("Unexpected event"),
1052         };
1053
1054         if test_ignore_second_cs {
1055                 expect_pending_htlcs_forwardable!(nodes[1]);
1056                 check_added_monitors!(nodes[1], 1);
1057
1058                 send_event = SendEvent::from_node(&nodes[1]);
1059                 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1060                 assert_eq!(send_event.msgs.len(), 1);
1061                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1062                 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1063
1064                 expect_pending_htlcs_forwardable!(nodes[0]);
1065
1066                 let events_9 = nodes[0].node.get_and_clear_pending_events();
1067                 assert_eq!(events_9.len(), 1);
1068                 match events_9[0] {
1069                         Event::PaymentClaimable { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1070                         _ => panic!("Unexpected event"),
1071                 };
1072                 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1073         }
1074
1075         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1076 }
1077
1078 #[test]
1079 fn test_monitor_update_fail_raa() {
1080         do_test_monitor_update_fail_raa(false);
1081         do_test_monitor_update_fail_raa(true);
1082 }
1083
1084 #[test]
1085 fn test_monitor_update_fail_reestablish() {
1086         // Simple test for message retransmission after monitor update failure on
1087         // channel_reestablish generating a monitor update (which comes from freeing holding cell
1088         // HTLCs).
1089         let chanmon_cfgs = create_chanmon_cfgs(3);
1090         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1091         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1092         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1093         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1094         create_announced_chan_between_nodes(&nodes, 1, 2);
1095
1096         let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
1097
1098         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1099         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1100
1101         nodes[2].node.claim_funds(payment_preimage);
1102         check_added_monitors!(nodes[2], 1);
1103         expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
1104
1105         let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1106         assert!(updates.update_add_htlcs.is_empty());
1107         assert!(updates.update_fail_htlcs.is_empty());
1108         assert!(updates.update_fail_malformed_htlcs.is_empty());
1109         assert!(updates.update_fee.is_none());
1110         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1111         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1112         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
1113         check_added_monitors!(nodes[1], 1);
1114         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1115         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1116
1117         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1118         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1119                 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1120         }, true).unwrap();
1121         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1122                 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1123         }, false).unwrap();
1124
1125         let as_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1126         let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1127
1128         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1129
1130         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1131         assert_eq!(
1132                 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1133                         .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1134
1135         nodes[1].node.get_and_clear_pending_msg_events(); // Free the holding cell
1136         check_added_monitors!(nodes[1], 1);
1137
1138         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1139         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1140
1141         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1142                 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1143         }, true).unwrap();
1144         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1145                 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1146         }, false).unwrap();
1147
1148         assert_eq!(get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap(), as_reestablish);
1149         assert_eq!(get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap(), bs_reestablish);
1150
1151         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1152         assert_eq!(
1153                 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1154                         .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1155
1156         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1157         check_added_monitors!(nodes[1], 0);
1158         assert_eq!(
1159                 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1160                         .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1161
1162         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1163         let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1164         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1165         check_added_monitors!(nodes[1], 0);
1166
1167         updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1168         assert!(updates.update_add_htlcs.is_empty());
1169         assert!(updates.update_fail_htlcs.is_empty());
1170         assert!(updates.update_fail_malformed_htlcs.is_empty());
1171         assert!(updates.update_fee.is_none());
1172         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1173         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1174         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1175         expect_payment_sent!(nodes[0], payment_preimage);
1176 }
1177
1178 #[test]
1179 fn raa_no_response_awaiting_raa_state() {
1180         // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1181         // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1182         // in question (assuming it intends to respond with a CS after monitor updating is restored).
1183         // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1184         let chanmon_cfgs = create_chanmon_cfgs(2);
1185         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1186         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1187         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1188         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1189
1190         let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1191         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1192         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1193
1194         // Queue up two payments - one will be delivered right away, one immediately goes into the
1195         // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1196         // immediately after a CS. By setting failing the monitor update failure from the CS (which
1197         // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1198         // generation during RAA while in monitor-update-failed state.
1199         {
1200                 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1201                         RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1202                 check_added_monitors!(nodes[0], 1);
1203                 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1204                         RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1205                 check_added_monitors!(nodes[0], 0);
1206         }
1207
1208         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1209         assert_eq!(events.len(), 1);
1210         let payment_event = SendEvent::from_event(events.pop().unwrap());
1211         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1212         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1213         check_added_monitors!(nodes[1], 1);
1214
1215         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1216         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1217         check_added_monitors!(nodes[0], 1);
1218         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1219         assert_eq!(events.len(), 1);
1220         let payment_event = SendEvent::from_event(events.pop().unwrap());
1221
1222         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1223         check_added_monitors!(nodes[0], 1);
1224         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1225
1226         // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1227         // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1228         // then restore channel monitor updates.
1229         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1230         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1231         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1232         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1233         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1234         check_added_monitors!(nodes[1], 1);
1235         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1236
1237         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1238         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1239         check_added_monitors!(nodes[1], 1);
1240
1241         let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1242         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1243         // nodes[1] should be AwaitingRAA here!
1244         check_added_monitors!(nodes[1], 0);
1245         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1246         expect_pending_htlcs_forwardable!(nodes[1]);
1247         expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1248
1249         // We send a third payment here, which is somewhat of a redundant test, but the
1250         // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1251         // commitment transaction states) whereas here we can explicitly check for it.
1252         {
1253                 nodes[0].node.send_payment_with_route(&route, payment_hash_3,
1254                         RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1255                 check_added_monitors!(nodes[0], 0);
1256                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1257         }
1258         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1259         check_added_monitors!(nodes[0], 1);
1260         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1261         assert_eq!(events.len(), 1);
1262         let payment_event = SendEvent::from_event(events.pop().unwrap());
1263
1264         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1265         check_added_monitors!(nodes[0], 1);
1266         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1267
1268         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1269         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1270         check_added_monitors!(nodes[1], 1);
1271         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1272
1273         // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1274         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1275         check_added_monitors!(nodes[1], 1);
1276         expect_pending_htlcs_forwardable!(nodes[1]);
1277         expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1278         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1279
1280         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1281         check_added_monitors!(nodes[0], 1);
1282
1283         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1284         check_added_monitors!(nodes[0], 1);
1285         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1286
1287         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1288         check_added_monitors!(nodes[1], 1);
1289         expect_pending_htlcs_forwardable!(nodes[1]);
1290         expect_payment_claimable!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1291
1292         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1293         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1294         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1295 }
1296
1297 #[test]
1298 fn claim_while_disconnected_monitor_update_fail() {
1299         // Test for claiming a payment while disconnected and then having the resulting
1300         // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1301         // contrived case for nodes with network instability.
1302         // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1303         // code introduced a regression in this test (specifically, this caught a removal of the
1304         // channel_reestablish handling ensuring the order was sensical given the messages used).
1305         let chanmon_cfgs = create_chanmon_cfgs(2);
1306         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1307         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1308         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1309         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1310
1311         // Forward a payment for B to claim
1312         let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1313
1314         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1315         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1316
1317         nodes[1].node.claim_funds(payment_preimage_1);
1318         check_added_monitors!(nodes[1], 1);
1319         expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1320
1321         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1322                 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1323         }, true).unwrap();
1324         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1325                 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1326         }, false).unwrap();
1327
1328         let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1329         let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1330
1331         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1332         let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1333
1334         // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1335         // update.
1336         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1337
1338         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1339         let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1340         check_added_monitors!(nodes[1], 1);
1341         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1342
1343         // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1344         // the monitor still failed
1345         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1346         {
1347                 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1348                         RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1349                 check_added_monitors!(nodes[0], 1);
1350         }
1351
1352         let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1353         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1354         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1355         check_added_monitors!(nodes[1], 1);
1356         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1357         // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1358         // until we've channel_monitor_update'd and updated for the new commitment transaction.
1359
1360         // Now un-fail the monitor, which will result in B sending its original commitment update,
1361         // receiving the commitment update from A, and the resulting commitment dances.
1362         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1363         let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1364         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1365         check_added_monitors!(nodes[1], 0);
1366
1367         let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1368         assert_eq!(bs_msgs.len(), 2);
1369
1370         match bs_msgs[0] {
1371                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1372                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1373                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1374                         expect_payment_sent(&nodes[0], payment_preimage_1, None, false, false);
1375                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1376                         check_added_monitors!(nodes[0], 1);
1377
1378                         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1379                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1380                         check_added_monitors!(nodes[1], 1);
1381                 },
1382                 _ => panic!("Unexpected event"),
1383         }
1384
1385         match bs_msgs[1] {
1386                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1387                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1388                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1389                         check_added_monitors!(nodes[0], 1);
1390                 },
1391                 _ => panic!("Unexpected event"),
1392         }
1393
1394         let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1395
1396         let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1397         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1398         check_added_monitors!(nodes[0], 1);
1399         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1400
1401         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1402         check_added_monitors!(nodes[1], 1);
1403         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1404         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1405         check_added_monitors!(nodes[1], 1);
1406
1407         expect_pending_htlcs_forwardable!(nodes[1]);
1408         expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1409
1410         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1411         check_added_monitors!(nodes[0], 1);
1412         expect_payment_path_successful!(nodes[0]);
1413
1414         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1415 }
1416
1417 #[test]
1418 fn monitor_failed_no_reestablish_response() {
1419         // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1420         // response to a commitment_signed.
1421         // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1422         // debug_assert!() failure in channel_reestablish handling.
1423         let chanmon_cfgs = create_chanmon_cfgs(2);
1424         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1425         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1426         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1427         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1428         {
1429                 let mut node_0_per_peer_lock;
1430                 let mut node_0_peer_state_lock;
1431                 get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, channel_id).context_mut().announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1432         }
1433         {
1434                 let mut node_1_per_peer_lock;
1435                 let mut node_1_peer_state_lock;
1436                 get_channel_ref!(nodes[1], nodes[0], node_1_per_peer_lock, node_1_peer_state_lock, channel_id).context_mut().announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1437         }
1438
1439         // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1440         // on receipt).
1441         let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1442         {
1443                 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1444                         RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1445                 check_added_monitors!(nodes[0], 1);
1446         }
1447
1448         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1449         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1450         assert_eq!(events.len(), 1);
1451         let payment_event = SendEvent::from_event(events.pop().unwrap());
1452         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1453         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1454         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1455         check_added_monitors!(nodes[1], 1);
1456
1457         // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1458         // is still failing to update monitors.
1459         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1460         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1461
1462         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1463                 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1464         }, true).unwrap();
1465         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1466                 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1467         }, false).unwrap();
1468
1469         let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1470         let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1471
1472         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1473         let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1474         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1475         let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1476
1477         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1478         let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1479         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1480         check_added_monitors!(nodes[1], 0);
1481         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1482
1483         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1484         check_added_monitors!(nodes[0], 1);
1485         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1486         check_added_monitors!(nodes[0], 1);
1487
1488         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1489         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1490         check_added_monitors!(nodes[1], 1);
1491
1492         expect_pending_htlcs_forwardable!(nodes[1]);
1493         expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1494
1495         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1496 }
1497
1498 #[test]
1499 fn first_message_on_recv_ordering() {
1500         // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1501         // messages, we're willing to flip the order of response messages if neccessary in resposne to
1502         // a commitment_signed which needs to send an RAA first.
1503         // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1504         // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1505         // response. To do this, we start routing two payments, with the final RAA for the first being
1506         // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1507         // have no pending response but will want to send a RAA/CS (with the updates for the second
1508         // payment applied).
1509         // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1510         let chanmon_cfgs = create_chanmon_cfgs(2);
1511         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1512         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1513         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1514         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1515
1516         // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1517         // can deliver it and fail the monitor update.
1518         let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1519         {
1520                 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1521                         RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1522                 check_added_monitors!(nodes[0], 1);
1523         }
1524
1525         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1526         assert_eq!(events.len(), 1);
1527         let payment_event = SendEvent::from_event(events.pop().unwrap());
1528         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1529         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1530         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1531         check_added_monitors!(nodes[1], 1);
1532         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1533
1534         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1535         check_added_monitors!(nodes[0], 1);
1536         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1537         check_added_monitors!(nodes[0], 1);
1538
1539         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1540
1541         // Route the second payment, generating an update_add_htlc/commitment_signed
1542         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1543         {
1544                 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1545                         RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1546                 check_added_monitors!(nodes[0], 1);
1547         }
1548         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1549         assert_eq!(events.len(), 1);
1550         let payment_event = SendEvent::from_event(events.pop().unwrap());
1551         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1552
1553         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1554
1555         // Deliver the final RAA for the first payment, which does not require a response. RAAs
1556         // generally require a commitment_signed, so the fact that we're expecting an opposite response
1557         // to the next message also tests resetting the delivery order.
1558         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1559         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1560         check_added_monitors!(nodes[1], 1);
1561
1562         // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1563         // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1564         // appropriate HTLC acceptance).
1565         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1566         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1567         check_added_monitors!(nodes[1], 1);
1568         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1569
1570         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1571         let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1572         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1573         check_added_monitors!(nodes[1], 0);
1574
1575         expect_pending_htlcs_forwardable!(nodes[1]);
1576         expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1577
1578         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1579         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1580         check_added_monitors!(nodes[0], 1);
1581         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1582         check_added_monitors!(nodes[0], 1);
1583
1584         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1585         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1586         check_added_monitors!(nodes[1], 1);
1587
1588         expect_pending_htlcs_forwardable!(nodes[1]);
1589         expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1590
1591         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1592         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1593 }
1594
1595 #[test]
1596 fn test_monitor_update_fail_claim() {
1597         // Basic test for monitor update failures when processing claim_funds calls.
1598         // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1599         // update to claim the payment. We then send two payments C->B->A, which are held at B.
1600         // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1601         // the payments from C onwards to A.
1602         let chanmon_cfgs = create_chanmon_cfgs(3);
1603         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1604         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1605         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1606         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1607         create_announced_chan_between_nodes(&nodes, 1, 2);
1608
1609         // Rebalance a bit so that we can send backwards from 3 to 2.
1610         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1611
1612         let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1613
1614         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1615         // As long as the preimage isn't on-chain, we shouldn't expose the `PaymentClaimed` event to
1616         // users nor send the preimage to peers in the new commitment update.
1617         nodes[1].node.claim_funds(payment_preimage_1);
1618         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1619         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1620         check_added_monitors!(nodes[1], 1);
1621
1622         // Note that at this point there is a pending commitment transaction update for A being held by
1623         // B. Even when we go to send the payment from C through B to A, B will not update this
1624         // already-signed commitment transaction and will instead wait for it to resolve before
1625         // forwarding the payment onwards.
1626
1627         let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1_000_000);
1628         {
1629                 nodes[2].node.send_payment_with_route(&route, payment_hash_2,
1630                         RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1631                 check_added_monitors!(nodes[2], 1);
1632         }
1633
1634         // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1635         // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1636         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1637
1638         let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1639         assert_eq!(events.len(), 1);
1640         let payment_event = SendEvent::from_event(events.pop().unwrap());
1641         nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1642         let events = nodes[1].node.get_and_clear_pending_msg_events();
1643         assert_eq!(events.len(), 0);
1644         commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1645         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1646
1647         let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1648         nodes[2].node.send_payment_with_route(&route, payment_hash_3,
1649                 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1650         check_added_monitors!(nodes[2], 1);
1651
1652         let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1653         assert_eq!(events.len(), 1);
1654         let payment_event = SendEvent::from_event(events.pop().unwrap());
1655         nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1656         let events = nodes[1].node.get_and_clear_pending_msg_events();
1657         assert_eq!(events.len(), 0);
1658         commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1659
1660         // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1661         let channel_id = chan_1.2;
1662         let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1663         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1664         expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1665         check_added_monitors!(nodes[1], 0);
1666
1667         let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1668         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1669         commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1670         expect_payment_sent!(nodes[0], payment_preimage_1);
1671
1672         // Get the payment forwards, note that they were batched into one commitment update.
1673         nodes[1].node.process_pending_htlc_forwards();
1674         check_added_monitors!(nodes[1], 1);
1675         let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1676         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1677         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1678         commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1679         expect_pending_htlcs_forwardable!(nodes[0]);
1680
1681         let events = nodes[0].node.get_and_clear_pending_events();
1682         assert_eq!(events.len(), 2);
1683         match events[0] {
1684                 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id, .. } => {
1685                         assert_eq!(payment_hash_2, *payment_hash);
1686                         assert_eq!(1_000_000, amount_msat);
1687                         assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1688                         assert_eq!(via_channel_id, Some(channel_id));
1689                         assert_eq!(via_user_channel_id, Some(42));
1690                         match &purpose {
1691                                 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
1692                                         assert!(payment_preimage.is_none());
1693                                         assert_eq!(payment_secret_2, *payment_secret);
1694                                 },
1695                                 _ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
1696                         }
1697                 },
1698                 _ => panic!("Unexpected event"),
1699         }
1700         match events[1] {
1701                 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
1702                         assert_eq!(payment_hash_3, *payment_hash);
1703                         assert_eq!(1_000_000, amount_msat);
1704                         assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1705                         assert_eq!(via_channel_id, Some(channel_id));
1706                         match &purpose {
1707                                 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
1708                                         assert!(payment_preimage.is_none());
1709                                         assert_eq!(payment_secret_3, *payment_secret);
1710                                 },
1711                                 _ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
1712                         }
1713                 },
1714                 _ => panic!("Unexpected event"),
1715         }
1716 }
1717
1718 #[test]
1719 fn test_monitor_update_on_pending_forwards() {
1720         // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1721         // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1722         // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1723         // from C to A will be pending a forward to A.
1724         let chanmon_cfgs = create_chanmon_cfgs(3);
1725         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1726         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1727         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1728         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1729         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1730
1731         // Rebalance a bit so that we can send backwards from 3 to 1.
1732         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1733
1734         let (_, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1735         nodes[2].node.fail_htlc_backwards(&payment_hash_1);
1736         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
1737         check_added_monitors!(nodes[2], 1);
1738
1739         let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1740         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1741         commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1742         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1743
1744         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
1745         {
1746                 nodes[2].node.send_payment_with_route(&route, payment_hash_2,
1747                         RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1748                 check_added_monitors!(nodes[2], 1);
1749         }
1750
1751         let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1752         assert_eq!(events.len(), 1);
1753         let payment_event = SendEvent::from_event(events.pop().unwrap());
1754         nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1755         commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1756
1757         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1758         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_2.2 }]);
1759         check_added_monitors!(nodes[1], 1);
1760
1761         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1762         let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1763         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1764         check_added_monitors!(nodes[1], 0);
1765
1766         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1767         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1768         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1769         commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1770
1771         let events = nodes[0].node.get_and_clear_pending_events();
1772         assert_eq!(events.len(), 3);
1773         if let Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } = events[1] {
1774                 assert_eq!(payment_hash, payment_hash_1);
1775                 assert!(payment_failed_permanently);
1776         } else { panic!("Unexpected event!"); }
1777         match events[2] {
1778                 Event::PaymentFailed { payment_hash, .. } => {
1779                         assert_eq!(payment_hash, payment_hash_1);
1780                 },
1781                 _ => panic!("Unexpected event"),
1782         }
1783         match events[0] {
1784                 Event::PendingHTLCsForwardable { .. } => { },
1785                 _ => panic!("Unexpected event"),
1786         };
1787         nodes[0].node.process_pending_htlc_forwards();
1788         expect_payment_claimable!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1789
1790         claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1791 }
1792
1793 #[test]
1794 fn monitor_update_claim_fail_no_response() {
1795         // Test for claim_funds resulting in both a monitor update failure and no message response (due
1796         // to channel being AwaitingRAA).
1797         // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1798         // code was broken.
1799         let chanmon_cfgs = create_chanmon_cfgs(2);
1800         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1801         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1802         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1803         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1804
1805         // Forward a payment for B to claim
1806         let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1807
1808         // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1809         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1810         {
1811                 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1812                         RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1813                 check_added_monitors!(nodes[0], 1);
1814         }
1815
1816         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1817         assert_eq!(events.len(), 1);
1818         let payment_event = SendEvent::from_event(events.pop().unwrap());
1819         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1820         let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1821
1822         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1823         nodes[1].node.claim_funds(payment_preimage_1);
1824         check_added_monitors!(nodes[1], 1);
1825
1826         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1827
1828         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1829         let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1830         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1831         expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1832         check_added_monitors!(nodes[1], 0);
1833         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1834
1835         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1836         check_added_monitors!(nodes[1], 1);
1837         expect_pending_htlcs_forwardable!(nodes[1]);
1838         expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1839
1840         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1841         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1842         commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1843         expect_payment_sent!(nodes[0], payment_preimage_1);
1844
1845         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1846 }
1847
1848 // restore_b_before_conf has no meaning if !confirm_a_first
1849 // restore_b_before_lock has no meaning if confirm_a_first
1850 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool, restore_b_before_lock: bool) {
1851         // Test that if the monitor update generated by funding_transaction_generated fails we continue
1852         // the channel setup happily after the update is restored.
1853         let chanmon_cfgs = create_chanmon_cfgs(2);
1854         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1855         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1856         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1857
1858         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None, None).unwrap();
1859         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
1860         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
1861
1862         let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
1863
1864         nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
1865         check_added_monitors!(nodes[0], 0);
1866
1867         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1868         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1869         let channel_id = ChannelId::v1_from_funding_outpoint(OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index });
1870         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1871         check_added_monitors!(nodes[1], 1);
1872
1873         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1874         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id()));
1875         check_added_monitors!(nodes[0], 1);
1876         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1877         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1878         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1879         let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1880         nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1881         check_added_monitors!(nodes[0], 0);
1882         expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
1883
1884         let events = nodes[0].node.get_and_clear_pending_events();
1885         assert_eq!(events.len(), 0);
1886         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1887         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1888
1889         if confirm_a_first {
1890                 confirm_transaction(&nodes[0], &funding_tx);
1891                 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id()));
1892                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1893                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1894         } else {
1895                 assert!(!restore_b_before_conf);
1896                 confirm_transaction(&nodes[1], &funding_tx);
1897                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1898         }
1899
1900         // Make sure nodes[1] isn't stupid enough to re-send the ChannelReady on reconnect
1901         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1902         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1903         let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
1904         reconnect_args.send_channel_ready.1 = confirm_a_first;
1905         reconnect_nodes(reconnect_args);
1906
1907         // But we want to re-emit ChannelPending
1908         expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
1909         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1910         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1911
1912         if !restore_b_before_conf {
1913                 confirm_transaction(&nodes[1], &funding_tx);
1914                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1915                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1916         }
1917         if !confirm_a_first && !restore_b_before_lock {
1918                 confirm_transaction(&nodes[0], &funding_tx);
1919                 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id()));
1920                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1921                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1922         }
1923
1924         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1925         let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1926         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1927         check_added_monitors!(nodes[1], 0);
1928
1929         let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1930                 if !restore_b_before_lock {
1931                         let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1932                         (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1933                 } else {
1934                         nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendChannelReady, nodes[0].node.get_our_node_id()));
1935                         confirm_transaction(&nodes[0], &funding_tx);
1936                         let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1937                         (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready))
1938                 }
1939         } else {
1940                 if restore_b_before_conf {
1941                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1942                         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1943                         confirm_transaction(&nodes[1], &funding_tx);
1944                 }
1945                 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1946                 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1947         };
1948         for node in nodes.iter() {
1949                 assert!(node.gossip_sync.handle_channel_announcement(&announcement).unwrap());
1950                 node.gossip_sync.handle_channel_update(&as_update).unwrap();
1951                 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
1952         }
1953
1954         if !restore_b_before_lock {
1955                 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
1956         } else {
1957                 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
1958         }
1959
1960
1961         send_payment(&nodes[0], &[&nodes[1]], 8000000);
1962         close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1963         check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1964         check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1965 }
1966
1967 #[test]
1968 fn during_funding_monitor_fail() {
1969         do_during_funding_monitor_fail(true, true, false);
1970         do_during_funding_monitor_fail(true, false, false);
1971         do_during_funding_monitor_fail(false, false, false);
1972         do_during_funding_monitor_fail(false, false, true);
1973 }
1974
1975 #[test]
1976 fn test_path_paused_mpp() {
1977         // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1978         // monitor update
1979         let chanmon_cfgs = create_chanmon_cfgs(4);
1980         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1981         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1982         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1983
1984         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
1985         let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2);
1986         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
1987         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
1988
1989         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
1990
1991         // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1992         let path = route.paths[0].clone();
1993         route.paths.push(path);
1994         route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
1995         route.paths[0].hops[0].short_channel_id = chan_1_id;
1996         route.paths[0].hops[1].short_channel_id = chan_3_id;
1997         route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
1998         route.paths[1].hops[0].short_channel_id = chan_2_ann.contents.short_channel_id;
1999         route.paths[1].hops[1].short_channel_id = chan_4_id;
2000
2001         // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
2002         // (for the path 0 -> 2 -> 3) fails.
2003         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2004         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2005
2006         // Now check that we get the right return value, indicating that the first path succeeded but
2007         // the second got a MonitorUpdateInProgress err. This implies
2008         // PaymentSendFailure::PartialFailure as some paths succeeded, preventing retry.
2009         if let Err(PaymentSendFailure::PartialFailure { results, ..}) = nodes[0].node.send_payment_with_route(
2010                 &route, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
2011         ) {
2012                 assert_eq!(results.len(), 2);
2013                 if let Ok(()) = results[0] {} else { panic!(); }
2014                 if let Err(APIError::MonitorUpdateInProgress) = results[1] {} else { panic!(); }
2015         } else { panic!(); }
2016         check_added_monitors!(nodes[0], 2);
2017         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2018
2019         // Pass the first HTLC of the payment along to nodes[3].
2020         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2021         assert_eq!(events.len(), 1);
2022         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false, None);
2023
2024         // And check that, after we successfully update the monitor for chan_2 we can pass the second
2025         // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
2026         let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
2027         nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2028         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2029         assert_eq!(events.len(), 1);
2030         pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true, None);
2031
2032         claim_payment_along_route(
2033                 ClaimAlongRouteArgs::new(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], payment_preimage)
2034         );
2035 }
2036
2037 #[test]
2038 fn test_pending_update_fee_ack_on_reconnect() {
2039         // In early versions of our automated fee update patch, nodes did not correctly use the
2040         // previous channel feerate after sending an undelivered revoke_and_ack when re-sending an
2041         // undelivered commitment_signed.
2042         //
2043         // B sends A new HTLC + CS, not delivered
2044         // A sends B update_fee + CS
2045         // B receives the CS and sends RAA, previously causing B to lock in the new feerate
2046         // reconnect
2047         // B resends initial CS, using the original fee
2048
2049         let chanmon_cfgs = create_chanmon_cfgs(2);
2050         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2051         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2052         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2053
2054         create_announced_chan_between_nodes(&nodes, 0, 1);
2055         send_payment(&nodes[0], &[&nodes[1]], 100_000_00);
2056
2057         let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[1], nodes[0], 1_000_000);
2058         nodes[1].node.send_payment_with_route(&route, payment_hash,
2059                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
2060         check_added_monitors!(nodes[1], 1);
2061         let bs_initial_send_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2062         // bs_initial_send_msgs are not delivered until they are re-generated after reconnect
2063
2064         {
2065                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2066                 *feerate_lock *= 2;
2067         }
2068         nodes[0].node.timer_tick_occurred();
2069         check_added_monitors!(nodes[0], 1);
2070         let as_update_fee_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2071         assert!(as_update_fee_msgs.update_fee.is_some());
2072
2073         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_update_fee_msgs.update_fee.as_ref().unwrap());
2074         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_fee_msgs.commitment_signed);
2075         check_added_monitors!(nodes[1], 1);
2076         let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2077         // bs_first_raa is not delivered until it is re-generated after reconnect
2078
2079         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2080         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2081
2082         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
2083                 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
2084         }, true).unwrap();
2085         let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2086         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
2087                 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
2088         }, false).unwrap();
2089         let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2090
2091         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2092         let bs_resend_msgs = nodes[1].node.get_and_clear_pending_msg_events();
2093         assert_eq!(bs_resend_msgs.len(), 3);
2094         if let MessageSendEvent::UpdateHTLCs { ref updates, .. } = bs_resend_msgs[0] {
2095                 assert_eq!(*updates, bs_initial_send_msgs);
2096         } else { panic!(); }
2097         if let MessageSendEvent::SendRevokeAndACK { ref msg, .. } = bs_resend_msgs[1] {
2098                 assert_eq!(*msg, bs_first_raa);
2099         } else { panic!(); }
2100         if let MessageSendEvent::SendChannelUpdate { .. } = bs_resend_msgs[2] { } else { panic!(); }
2101
2102         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2103         get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
2104
2105         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.update_add_htlcs[0]);
2106         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.commitment_signed);
2107         check_added_monitors!(nodes[0], 1);
2108         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2109         check_added_monitors!(nodes[1], 1);
2110         let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()).commitment_signed;
2111
2112         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2113         check_added_monitors!(nodes[0], 1);
2114         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id()).commitment_signed);
2115         check_added_monitors!(nodes[1], 1);
2116         let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2117
2118         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2119         check_added_monitors!(nodes[0], 1);
2120         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2121         check_added_monitors!(nodes[0], 1);
2122
2123         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2124         check_added_monitors!(nodes[1], 1);
2125
2126         expect_pending_htlcs_forwardable!(nodes[0]);
2127         expect_payment_claimable!(nodes[0], payment_hash, payment_secret, 1_000_000);
2128
2129         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
2130 }
2131
2132 #[test]
2133 fn test_fail_htlc_on_broadcast_after_claim() {
2134         // In an earlier version of 7e78fa660cec8a73286c94c1073ee588140e7a01 we'd also fail the inbound
2135         // channel backwards if we received an HTLC failure after a HTLC fulfillment. Here we test a
2136         // specific case of that by having the HTLC failure come from the ChannelMonitor after a dust
2137         // HTLC was not included in a confirmed commitment transaction.
2138         //
2139         // We first forward a payment, then claim it with an update_fulfill_htlc message, closing the
2140         // channel immediately before commitment occurs. After the commitment transaction reaches
2141         // ANTI_REORG_DELAY confirmations, will will try to fail the HTLC which was already fulfilled.
2142         let chanmon_cfgs = create_chanmon_cfgs(3);
2143         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2144         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2145         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2146
2147         create_announced_chan_between_nodes(&nodes, 0, 1);
2148         let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2149
2150         let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 2000);
2151
2152         let bs_txn = get_local_commitment_txn!(nodes[2], chan_id_2);
2153         assert_eq!(bs_txn.len(), 1);
2154
2155         nodes[2].node.claim_funds(payment_preimage);
2156         check_added_monitors!(nodes[2], 1);
2157         expect_payment_claimed!(nodes[2], payment_hash, 2000);
2158
2159         let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2160         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
2161         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2162         check_added_monitors!(nodes[1], 1);
2163         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2164
2165         mine_transaction(&nodes[1], &bs_txn[0]);
2166         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[2].node.get_our_node_id()], 100000);
2167         check_closed_broadcast!(nodes[1], true);
2168         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2169         check_added_monitors!(nodes[1], 1);
2170         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_id_2 }]);
2171
2172         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
2173         expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2174         commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, true, true);
2175         expect_payment_path_successful!(nodes[0]);
2176 }
2177
2178 fn do_update_fee_resend_test(deliver_update: bool, parallel_updates: bool) {
2179         // In early versions we did not handle resending of update_fee on reconnect correctly. The
2180         // chanmon_consistency fuzz target, of course, immediately found it, but we test a few cases
2181         // explicitly here.
2182         let chanmon_cfgs = create_chanmon_cfgs(2);
2183         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2184         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2185         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2186
2187         create_announced_chan_between_nodes(&nodes, 0, 1);
2188         send_payment(&nodes[0], &[&nodes[1]], 1000);
2189
2190         {
2191                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2192                 *feerate_lock += 20;
2193         }
2194         nodes[0].node.timer_tick_occurred();
2195         check_added_monitors!(nodes[0], 1);
2196         let update_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2197         assert!(update_msgs.update_fee.is_some());
2198         if deliver_update {
2199                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2200         }
2201
2202         if parallel_updates {
2203                 {
2204                         let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2205                         *feerate_lock += 20;
2206                 }
2207                 nodes[0].node.timer_tick_occurred();
2208                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2209         }
2210
2211         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2212         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2213
2214         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
2215                 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
2216         }, true).unwrap();
2217         let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2218         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
2219                 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
2220         }, false).unwrap();
2221         let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2222
2223         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2224         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
2225         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2226
2227         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2228         let mut as_reconnect_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2229         assert_eq!(as_reconnect_msgs.len(), 2);
2230         if let MessageSendEvent::SendChannelUpdate { .. } = as_reconnect_msgs.pop().unwrap() {} else { panic!(); }
2231         let update_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = as_reconnect_msgs.pop().unwrap()
2232                 { updates } else { panic!(); };
2233         assert!(update_msgs.update_fee.is_some());
2234         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2235         if parallel_updates {
2236                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update_msgs.commitment_signed);
2237                 check_added_monitors!(nodes[1], 1);
2238                 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2239                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2240                 check_added_monitors!(nodes[0], 1);
2241                 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2242
2243                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2244                 check_added_monitors!(nodes[0], 1);
2245                 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2246
2247                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_second_update.update_fee.as_ref().unwrap());
2248                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
2249                 check_added_monitors!(nodes[1], 1);
2250                 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2251
2252                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2253                 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2254                 check_added_monitors!(nodes[1], 1);
2255
2256                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2257                 check_added_monitors!(nodes[0], 1);
2258
2259                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs.commitment_signed);
2260                 check_added_monitors!(nodes[0], 1);
2261                 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2262
2263                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2264                 check_added_monitors!(nodes[1], 1);
2265         } else {
2266                 commitment_signed_dance!(nodes[1], nodes[0], update_msgs.commitment_signed, false);
2267         }
2268
2269         send_payment(&nodes[0], &[&nodes[1]], 1000);
2270 }
2271 #[test]
2272 fn update_fee_resend_test() {
2273         do_update_fee_resend_test(false, false);
2274         do_update_fee_resend_test(true, false);
2275         do_update_fee_resend_test(false, true);
2276         do_update_fee_resend_test(true, true);
2277 }
2278
2279 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2280         // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2281         // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2282         // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2283         // which failed in such a case).
2284         let chanmon_cfgs = create_chanmon_cfgs(2);
2285         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2286         let persister;
2287         let new_chain_monitor;
2288         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2289         let nodes_0_deserialized;
2290         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2291
2292         let chan_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 15_000_000, 7_000_000_000).2;
2293         let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
2294         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2295
2296         // Do a really complicated dance to get an HTLC into the holding cell, with
2297         // MonitorUpdateInProgress set but AwaitingRemoteRevoke unset. When this test was written, any
2298         // attempts to send an HTLC while MonitorUpdateInProgress is set are immediately
2299         // failed-backwards. Thus, the only way to get an AddHTLC into the holding cell is to add it
2300         // while AwaitingRemoteRevoke is set but MonitorUpdateInProgress is unset, and then swap the
2301         // flags.
2302         //
2303         // We do this by:
2304         //  a) routing a payment from node B to node A,
2305         //  b) sending a payment from node A to node B without delivering any of the generated messages,
2306         //     putting node A in AwaitingRemoteRevoke,
2307         //  c) sending a second payment from node A to node B, which is immediately placed in the
2308         //     holding cell,
2309         //  d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2310         //     when we try to persist the payment preimage,
2311         //  e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2312         //     clearing AwaitingRemoteRevoke on node A.
2313         //
2314         // Note that because, at the end, MonitorUpdateInProgress is still set, the HTLC generated in
2315         // (c) will not be freed from the holding cell.
2316         let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[1], &[&nodes[0]], 100_000);
2317
2318         nodes[0].node.send_payment_with_route(&route, payment_hash_1,
2319                 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
2320         check_added_monitors!(nodes[0], 1);
2321         let send = SendEvent::from_node(&nodes[0]);
2322         assert_eq!(send.msgs.len(), 1);
2323
2324         nodes[0].node.send_payment_with_route(&route, payment_hash_2,
2325                 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
2326         check_added_monitors!(nodes[0], 0);
2327
2328         let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
2329         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2330         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2331         nodes[0].node.claim_funds(payment_preimage_0);
2332         check_added_monitors!(nodes[0], 1);
2333
2334         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2335         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2336         check_added_monitors!(nodes[1], 1);
2337
2338         let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2339
2340         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2341         check_added_monitors!(nodes[0], 1);
2342
2343         if disconnect {
2344                 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2345                 // disconnect the peers. Note that the fuzzer originally found this issue because
2346                 // deserializing a ChannelManager in this state causes an assertion failure.
2347                 if reload_a {
2348                         reload_node!(nodes[0], &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
2349                         persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2350                         persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2351                 } else {
2352                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2353                 }
2354                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2355
2356                 // Now reconnect the two
2357                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
2358                         features: nodes[1].node.init_features(), networks: None, remote_network_address: None
2359                 }, true).unwrap();
2360                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2361                 assert_eq!(reestablish_1.len(), 1);
2362                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
2363                         features: nodes[0].node.init_features(), networks: None, remote_network_address: None
2364                 }, false).unwrap();
2365                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2366                 assert_eq!(reestablish_2.len(), 1);
2367
2368                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2369                 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2370                 check_added_monitors!(nodes[1], 0);
2371
2372                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2373                 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2374
2375                 assert!(resp_0.0.is_none());
2376                 assert!(resp_0.1.is_none());
2377                 assert!(resp_0.2.is_none());
2378                 assert!(resp_1.0.is_none());
2379                 assert!(resp_1.1.is_none());
2380
2381                 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2382                 // moment).
2383                 if let Some(pending_cs) = resp_1.2 {
2384                         assert!(pending_cs.update_add_htlcs.is_empty());
2385                         assert!(pending_cs.update_fail_htlcs.is_empty());
2386                         assert!(pending_cs.update_fulfill_htlcs.is_empty());
2387                         assert_eq!(pending_cs.commitment_signed, cs);
2388                 } else { panic!(); }
2389
2390                 if reload_a {
2391                         // The two pending monitor updates were replayed (but are still pending).
2392                         check_added_monitors(&nodes[0], 2);
2393                 } else {
2394                         // There should be no monitor updates as we are still pending awaiting a failed one.
2395                         check_added_monitors(&nodes[0], 0);
2396                 }
2397                 check_added_monitors(&nodes[1], 0);
2398         }
2399
2400         // If we finish updating the monitor, we should free the holding cell right away (this did
2401         // not occur prior to #756).
2402         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2403         let (funding_txo, mon_id, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2404         nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_txo, mon_id);
2405         expect_payment_claimed!(nodes[0], payment_hash_0, 100_000);
2406
2407         // New outbound messages should be generated immediately upon a call to
2408         // get_and_clear_pending_msg_events (but not before).
2409         check_added_monitors!(nodes[0], 0);
2410         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2411         check_added_monitors!(nodes[0], 1);
2412         assert_eq!(events.len(), 1);
2413
2414         // Deliver the pending in-flight CS
2415         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2416         check_added_monitors!(nodes[0], 1);
2417
2418         let commitment_msg = match events.pop().unwrap() {
2419                 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2420                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
2421                         assert!(updates.update_fail_htlcs.is_empty());
2422                         assert!(updates.update_fail_malformed_htlcs.is_empty());
2423                         assert!(updates.update_fee.is_none());
2424                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2425                         nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2426                         expect_payment_sent(&nodes[1], payment_preimage_0, None, false, false);
2427                         assert_eq!(updates.update_add_htlcs.len(), 1);
2428                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2429                         updates.commitment_signed
2430                 },
2431                 _ => panic!("Unexpected event type!"),
2432         };
2433
2434         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2435         check_added_monitors!(nodes[1], 1);
2436
2437         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2438         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2439         expect_pending_htlcs_forwardable!(nodes[1]);
2440         expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2441         check_added_monitors!(nodes[1], 1);
2442
2443         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false, false);
2444
2445         let events = nodes[1].node.get_and_clear_pending_events();
2446         assert_eq!(events.len(), 2);
2447         match events[0] {
2448                 Event::PendingHTLCsForwardable { .. } => { },
2449                 _ => panic!("Unexpected event"),
2450         };
2451         match events[1] {
2452                 Event::PaymentPathSuccessful { .. } => { },
2453                 _ => panic!("Unexpected event"),
2454         };
2455
2456         nodes[1].node.process_pending_htlc_forwards();
2457         expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2458
2459         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2460         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2461 }
2462 #[test]
2463 fn channel_holding_cell_serialize() {
2464         do_channel_holding_cell_serialize(true, true);
2465         do_channel_holding_cell_serialize(true, false);
2466         do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2467 }
2468
2469 #[derive(PartialEq)]
2470 enum HTLCStatusAtDupClaim {
2471         Received,
2472         HoldingCell,
2473         Cleared,
2474 }
2475 fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_fails: bool) {
2476         // When receiving an update_fulfill_htlc message, we immediately forward the claim backwards
2477         // along the payment path before waiting for a full commitment_signed dance. This is great, but
2478         // can cause duplicative claims if a node sends an update_fulfill_htlc message, disconnects,
2479         // reconnects, and then has to re-send its update_fulfill_htlc message again.
2480         // In previous code, we didn't handle the double-claim correctly, spuriously closing the
2481         // channel on which the inbound HTLC was received.
2482         let chanmon_cfgs = create_chanmon_cfgs(3);
2483         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2484         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2485         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2486
2487         create_announced_chan_between_nodes(&nodes, 0, 1);
2488         let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2489
2490         let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
2491
2492         let mut as_raa = None;
2493         if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2494                 // In order to get the HTLC claim into the holding cell at nodes[1], we need nodes[1] to be
2495                 // awaiting a remote revoke_and_ack from nodes[0].
2496                 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
2497                 nodes[0].node.send_payment_with_route(&route, second_payment_hash,
2498                         RecipientOnionFields::secret_only(second_payment_secret), PaymentId(second_payment_hash.0)).unwrap();
2499                 check_added_monitors!(nodes[0], 1);
2500
2501                 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
2502                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
2503                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
2504                 check_added_monitors!(nodes[1], 1);
2505
2506                 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2507                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2508                 check_added_monitors!(nodes[0], 1);
2509                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
2510                 check_added_monitors!(nodes[0], 1);
2511
2512                 as_raa = Some(get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2513         }
2514
2515         let fulfill_msg = msgs::UpdateFulfillHTLC {
2516                 channel_id: chan_id_2,
2517                 htlc_id: 0,
2518                 payment_preimage,
2519         };
2520         if second_fails {
2521                 nodes[2].node.fail_htlc_backwards(&payment_hash);
2522                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash }]);
2523                 check_added_monitors!(nodes[2], 1);
2524                 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2525         } else {
2526                 nodes[2].node.claim_funds(payment_preimage);
2527                 check_added_monitors!(nodes[2], 1);
2528                 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
2529
2530                 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2531                 assert_eq!(cs_updates.update_fulfill_htlcs.len(), 1);
2532                 // Check that the message we're about to deliver matches the one generated:
2533                 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
2534         }
2535         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
2536         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2537         check_added_monitors!(nodes[1], 1);
2538
2539         let mut bs_updates = None;
2540         if htlc_status != HTLCStatusAtDupClaim::HoldingCell {
2541                 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2542                 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2543                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2544                 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2545                 if htlc_status == HTLCStatusAtDupClaim::Cleared {
2546                         commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2547                         expect_payment_path_successful!(nodes[0]);
2548                 }
2549         } else {
2550                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2551         }
2552
2553         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
2554         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2555
2556         if second_fails {
2557                 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
2558                 reconnect_args.pending_htlc_fails.0 = 1;
2559                 reconnect_nodes(reconnect_args);
2560                 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_id_2 }]);
2561         } else {
2562                 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
2563                 reconnect_args.pending_htlc_claims.0 = 1;
2564                 reconnect_nodes(reconnect_args);
2565         }
2566
2567         if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2568                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa.unwrap());
2569                 check_added_monitors!(nodes[1], 1);
2570                 expect_pending_htlcs_forwardable_ignore!(nodes[1]); // We finally receive the second payment, but don't claim it
2571
2572                 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2573                 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2574                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2575                 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2576         }
2577         if htlc_status != HTLCStatusAtDupClaim::Cleared {
2578                 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2579                 expect_payment_path_successful!(nodes[0]);
2580         }
2581 }
2582
2583 #[test]
2584 fn test_reconnect_dup_htlc_claims() {
2585         do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, false);
2586         do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, false);
2587         do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, false);
2588         do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, true);
2589         do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, true);
2590         do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, true);
2591 }
2592
2593 #[test]
2594 fn test_temporary_error_during_shutdown() {
2595         // Test that temporary failures when updating the monitor's shutdown script delay cooperative
2596         // close.
2597         let mut config = test_default_channel_config();
2598         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2599
2600         let chanmon_cfgs = create_chanmon_cfgs(2);
2601         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2602         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
2603         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2604
2605         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
2606
2607         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2608         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2609
2610         nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
2611         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
2612         check_added_monitors!(nodes[1], 1);
2613
2614         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id()));
2615         check_added_monitors!(nodes[0], 1);
2616
2617         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2618
2619         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2620         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2621
2622         let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2623         nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2624         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id()));
2625
2626         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2627
2628         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2629         let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2630         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2631
2632         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id()));
2633         let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
2634         let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2635
2636         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_a.unwrap());
2637         let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
2638         assert!(none_b.is_none());
2639         let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2640
2641         assert_eq!(txn_a, txn_b);
2642         assert_eq!(txn_a.len(), 1);
2643         check_spends!(txn_a[0], funding_tx);
2644         check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
2645         check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
2646 }
2647
2648 #[test]
2649 fn double_temp_error() {
2650         // Test that it's OK to have multiple `ChainMonitor::update_channel` calls fail in a row.
2651         let chanmon_cfgs = create_chanmon_cfgs(2);
2652         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2653         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2654         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2655
2656         let (_, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1);
2657
2658         let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2659         let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2660
2661         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2662         // `claim_funds` results in a ChannelMonitorUpdate.
2663         nodes[1].node.claim_funds(payment_preimage_1);
2664         check_added_monitors!(nodes[1], 1);
2665         let (funding_tx, latest_update_1, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2666
2667         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2668         // Previously, this would've panicked due to a double-call to `Channel::monitor_update_failed`,
2669         // which had some asserts that prevented it from being called twice.
2670         nodes[1].node.claim_funds(payment_preimage_2);
2671         check_added_monitors!(nodes[1], 1);
2672         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2673
2674         let (_, latest_update_2, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2675         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_1);
2676         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2677         check_added_monitors!(nodes[1], 0);
2678         nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_2);
2679
2680         // Complete the first HTLC. Note that as a side-effect we handle the monitor update completions
2681         // and get both PaymentClaimed events at once.
2682         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
2683
2684         let events = nodes[1].node.get_and_clear_pending_events();
2685         assert_eq!(events.len(), 2);
2686         match events[0] {
2687                 Event::PaymentClaimed { amount_msat: 1_000_000, payment_hash, .. } => assert_eq!(payment_hash, payment_hash_1),
2688                 _ => panic!("Unexpected Event: {:?}", events[0]),
2689         }
2690         match events[1] {
2691                 Event::PaymentClaimed { amount_msat: 1_000_000, payment_hash, .. } => assert_eq!(payment_hash, payment_hash_2),
2692                 _ => panic!("Unexpected Event: {:?}", events[1]),
2693         }
2694
2695         assert_eq!(msg_events.len(), 1);
2696         let (update_fulfill_1, commitment_signed_b1, node_id) = {
2697                 match &msg_events[0] {
2698                         &MessageSendEvent::UpdateHTLCs { ref 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 } } => {
2699                                 assert!(update_add_htlcs.is_empty());
2700                                 assert_eq!(update_fulfill_htlcs.len(), 1);
2701                                 assert!(update_fail_htlcs.is_empty());
2702                                 assert!(update_fail_malformed_htlcs.is_empty());
2703                                 assert!(update_fee.is_none());
2704                                 (update_fulfill_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2705                         },
2706                         _ => panic!("Unexpected event"),
2707                 }
2708         };
2709         assert_eq!(node_id, nodes[0].node.get_our_node_id());
2710         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_1);
2711         check_added_monitors!(nodes[0], 0);
2712         expect_payment_sent(&nodes[0], payment_preimage_1, None, false, false);
2713         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_b1);
2714         check_added_monitors!(nodes[0], 1);
2715         nodes[0].node.process_pending_htlc_forwards();
2716         let (raa_a1, commitment_signed_a1) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2717         check_added_monitors!(nodes[1], 0);
2718         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2719         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_a1);
2720         check_added_monitors!(nodes[1], 1);
2721         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed_a1);
2722         check_added_monitors!(nodes[1], 1);
2723
2724         // Complete the second HTLC.
2725         let ((update_fulfill_2, commitment_signed_b2), raa_b2) = {
2726                 let events = nodes[1].node.get_and_clear_pending_msg_events();
2727                 assert_eq!(events.len(), 2);
2728                 (match &events[0] {
2729                         MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2730                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2731                                 assert!(updates.update_add_htlcs.is_empty());
2732                                 assert!(updates.update_fail_htlcs.is_empty());
2733                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
2734                                 assert!(updates.update_fee.is_none());
2735                                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2736                                 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2737                         },
2738                         _ => panic!("Unexpected event"),
2739                 },
2740                  match events[1] {
2741                          MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2742                                  assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2743                                  (*msg).clone()
2744                          },
2745                          _ => panic!("Unexpected event"),
2746                  })
2747         };
2748         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_b2);
2749         check_added_monitors!(nodes[0], 1);
2750         expect_payment_path_successful!(nodes[0]);
2751
2752         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_2);
2753         check_added_monitors!(nodes[0], 0);
2754         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2755         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed_b2, false);
2756         expect_payment_sent!(nodes[0], payment_preimage_2);
2757 }
2758
2759 fn do_test_outbound_reload_without_init_mon(use_0conf: bool) {
2760         // Test that if the monitor update generated in funding_signed is stored async and we restart
2761         // with the latest ChannelManager but the ChannelMonitor persistence never completed we happily
2762         // drop the channel and move on.
2763         let chanmon_cfgs = create_chanmon_cfgs(2);
2764         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2765
2766         let persister;
2767         let new_chain_monitor;
2768
2769         let mut chan_config = test_default_channel_config();
2770         chan_config.manually_accept_inbound_channels = true;
2771         chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2772
2773         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2774         let nodes_0_deserialized;
2775
2776         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2777
2778         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None, None).unwrap();
2779         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
2780
2781         let events = nodes[1].node.get_and_clear_pending_events();
2782         assert_eq!(events.len(), 1);
2783         match events[0] {
2784                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2785                         if use_0conf {
2786                                 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2787                         } else {
2788                                 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2789                         }
2790                 },
2791                 _ => panic!("Unexpected event"),
2792         };
2793
2794         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
2795
2796         let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2797
2798         nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2799         check_added_monitors!(nodes[0], 0);
2800
2801         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2802         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2803         check_added_monitors!(nodes[1], 1);
2804         expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
2805
2806         let bs_signed_locked = nodes[1].node.get_and_clear_pending_msg_events();
2807         assert_eq!(bs_signed_locked.len(), if use_0conf { 2 } else { 1 });
2808         match &bs_signed_locked[0] {
2809                 MessageSendEvent::SendFundingSigned { msg, .. } => {
2810                         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2811
2812                         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &msg);
2813                         check_added_monitors!(nodes[0], 1);
2814                 }
2815                 _ => panic!("Unexpected event"),
2816         }
2817         if use_0conf {
2818                 match &bs_signed_locked[1] {
2819                         MessageSendEvent::SendChannelReady { msg, .. } => {
2820                                 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &msg);
2821                         }
2822                         _ => panic!("Unexpected event"),
2823                 }
2824         }
2825
2826         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
2827         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2828         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2829
2830         // nodes[0] is now waiting on the first ChannelMonitor persistence to complete in order to
2831         // broadcast the funding transaction. If nodes[0] restarts at this point with the
2832         // ChannelMonitor lost, we should simply discard the channel.
2833
2834         // The test framework checks that watched_txn/outputs match the monitor set, which they will
2835         // not, so we have to clear them here.
2836         nodes[0].chain_source.watched_txn.lock().unwrap().clear();
2837         nodes[0].chain_source.watched_outputs.lock().unwrap().clear();
2838
2839         reload_node!(nodes[0], &nodes[0].node.encode(), &[], persister, new_chain_monitor, nodes_0_deserialized);
2840         check_closed_event!(nodes[0], 1, ClosureReason::DisconnectedPeer, [nodes[1].node.get_our_node_id()], 100000);
2841         assert!(nodes[0].node.list_channels().is_empty());
2842 }
2843
2844 #[test]
2845 fn test_outbound_reload_without_init_mon() {
2846         do_test_outbound_reload_without_init_mon(true);
2847         do_test_outbound_reload_without_init_mon(false);
2848 }
2849
2850 fn do_test_inbound_reload_without_init_mon(use_0conf: bool, lock_commitment: bool) {
2851         // Test that if the monitor update generated by funding_transaction_generated is stored async
2852         // and we restart with the latest ChannelManager but the ChannelMonitor persistence never
2853         // completed we happily drop the channel and move on.
2854         let chanmon_cfgs = create_chanmon_cfgs(2);
2855         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2856
2857         let persister;
2858         let new_chain_monitor;
2859
2860         let mut chan_config = test_default_channel_config();
2861         chan_config.manually_accept_inbound_channels = true;
2862         chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2863
2864         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2865         let nodes_1_deserialized;
2866
2867         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2868
2869         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None, None).unwrap();
2870         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
2871
2872         let events = nodes[1].node.get_and_clear_pending_events();
2873         assert_eq!(events.len(), 1);
2874         match events[0] {
2875                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2876                         if use_0conf {
2877                                 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2878                         } else {
2879                                 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2880                         }
2881                 },
2882                 _ => panic!("Unexpected event"),
2883         };
2884
2885         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
2886
2887         let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2888
2889         nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2890         check_added_monitors!(nodes[0], 0);
2891
2892         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2893         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2894         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2895         check_added_monitors!(nodes[1], 1);
2896
2897         // nodes[1] happily sends its funding_signed even though its awaiting the persistence of the
2898         // initial ChannelMonitor, but it will decline to send its channel_ready even if the funding
2899         // transaction is confirmed.
2900         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
2901
2902         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
2903         check_added_monitors!(nodes[0], 1);
2904         expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
2905
2906         let as_funding_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2907         if lock_commitment {
2908                 confirm_transaction(&nodes[0], &as_funding_tx[0]);
2909                 confirm_transaction(&nodes[1], &as_funding_tx[0]);
2910         }
2911         if use_0conf || lock_commitment {
2912                 let as_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
2913                 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_ready);
2914         }
2915         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2916
2917         // nodes[1] is now waiting on the first ChannelMonitor persistence to complete in order to
2918         // move the channel to ready (or is waiting on the funding transaction to confirm). If nodes[1]
2919         // restarts at this point with the ChannelMonitor lost, we should simply discard the channel.
2920
2921         // The test framework checks that watched_txn/outputs match the monitor set, which they will
2922         // not, so we have to clear them here.
2923         nodes[1].chain_source.watched_txn.lock().unwrap().clear();
2924         nodes[1].chain_source.watched_outputs.lock().unwrap().clear();
2925
2926         reload_node!(nodes[1], &nodes[1].node.encode(), &[], persister, new_chain_monitor, nodes_1_deserialized);
2927
2928         check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer, [nodes[0].node.get_our_node_id()], 100000);
2929         assert!(nodes[1].node.list_channels().is_empty());
2930 }
2931
2932 #[test]
2933 fn test_inbound_reload_without_init_mon() {
2934         do_test_inbound_reload_without_init_mon(true, true);
2935         do_test_inbound_reload_without_init_mon(true, false);
2936         do_test_inbound_reload_without_init_mon(false, true);
2937         do_test_inbound_reload_without_init_mon(false, false);
2938 }
2939
2940 #[test]
2941 fn test_blocked_chan_preimage_release() {
2942         // Test that even if a channel's `ChannelMonitorUpdate` flow is blocked waiting on an event to
2943         // be handled HTLC preimage `ChannelMonitorUpdate`s will still go out.
2944         let chanmon_cfgs = create_chanmon_cfgs(3);
2945         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2946         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2947         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2948
2949         create_announced_chan_between_nodes(&nodes, 0, 1);
2950         let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2951
2952         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5_000_000);
2953
2954         // Tee up two payments in opposite directions across nodes[1], one it sent to generate a
2955         // PaymentSent event and one it forwards.
2956         let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[1], &[&nodes[2]], 1_000_000);
2957         let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[2], &[&nodes[1], &nodes[0]], 1_000_000);
2958
2959         // Claim the first payment to get a `PaymentSent` event (but don't handle it yet).
2960         nodes[2].node.claim_funds(payment_preimage_1);
2961         check_added_monitors(&nodes[2], 1);
2962         expect_payment_claimed!(nodes[2], payment_hash_1, 1_000_000);
2963
2964         let cs_htlc_fulfill_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2965         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_htlc_fulfill_updates.update_fulfill_htlcs[0]);
2966         do_commitment_signed_dance(&nodes[1], &nodes[2], &cs_htlc_fulfill_updates.commitment_signed, false, false);
2967         check_added_monitors(&nodes[1], 0);
2968
2969         // Now claim the second payment on nodes[0], which will ultimately result in nodes[1] trying to
2970         // claim an HTLC on its channel with nodes[2], but that channel is blocked on the above
2971         // `PaymentSent` event.
2972         nodes[0].node.claim_funds(payment_preimage_2);
2973         check_added_monitors(&nodes[0], 1);
2974         expect_payment_claimed!(nodes[0], payment_hash_2, 1_000_000);
2975
2976         let as_htlc_fulfill_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2977         nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &as_htlc_fulfill_updates.update_fulfill_htlcs[0]);
2978         check_added_monitors(&nodes[1], 1); // We generate only a preimage monitor update
2979         assert!(get_monitor!(nodes[1], chan_id_2).get_stored_preimages().contains_key(&payment_hash_2));
2980         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2981
2982         // Finish the CS dance between nodes[0] and nodes[1]. Note that until the event handling, the
2983         // update_fulfill_htlc + CS is held, even though the preimage is already on disk for the
2984         // channel.
2985         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_htlc_fulfill_updates.commitment_signed);
2986         check_added_monitors(&nodes[1], 1);
2987         let (a, raa) = do_main_commitment_signed_dance(&nodes[1], &nodes[0], false);
2988         assert!(a.is_none());
2989
2990         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
2991         check_added_monitors(&nodes[1], 0);
2992         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2993
2994         let events = nodes[1].node.get_and_clear_pending_events();
2995         assert_eq!(events.len(), 3);
2996         if let Event::PaymentSent { .. } = events[0] {} else { panic!(); }
2997         if let Event::PaymentPathSuccessful { .. } = events[2] {} else { panic!(); }
2998         if let Event::PaymentForwarded { .. } = events[1] {} else { panic!(); }
2999
3000         // The event processing should release the last RAA updates on both channels.
3001         check_added_monitors(&nodes[1], 2);
3002
3003         // When we fetch the next update the message getter will generate the next update for nodes[2],
3004         // generating a further monitor update.
3005         let bs_htlc_fulfill_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3006         check_added_monitors(&nodes[1], 1);
3007
3008         nodes[2].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_htlc_fulfill_updates.update_fulfill_htlcs[0]);
3009         do_commitment_signed_dance(&nodes[2], &nodes[1], &bs_htlc_fulfill_updates.commitment_signed, false, false);
3010         expect_payment_sent(&nodes[2], payment_preimage_2, None, true, true);
3011 }
3012
3013 fn do_test_inverted_mon_completion_order(with_latest_manager: bool, complete_bc_commitment_dance: bool) {
3014         // When we forward a payment and receive `update_fulfill_htlc`+`commitment_signed` messages
3015         // from the downstream channel, we immediately claim the HTLC on the upstream channel, before
3016         // even doing a `commitment_signed` dance on the downstream channel. This implies that our
3017         // `ChannelMonitorUpdate`s are generated in the right order - first we ensure we'll get our
3018         // money, then we write the update that resolves the downstream node claiming their money. This
3019         // is safe as long as `ChannelMonitorUpdate`s complete in the order in which they are
3020         // generated, but of course this may not be the case. For asynchronous update writes, we have
3021         // to ensure monitor updates can block each other, preventing the inversion all together.
3022         let chanmon_cfgs = create_chanmon_cfgs(3);
3023         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3024
3025         let persister;
3026         let new_chain_monitor;
3027         let nodes_1_deserialized;
3028
3029         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3030         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3031
3032         let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
3033         let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;
3034
3035         // Route a payment from A, through B, to C, then claim it on C. Once we pass B the
3036         // `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
3037         // on the B<->C channel but leave the A<->B monitor update pending, then reload B.
3038         let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
3039
3040         let mon_ab = get_monitor!(nodes[1], chan_id_ab).encode();
3041         let mut manager_b = Vec::new();
3042         if !with_latest_manager {
3043                 manager_b = nodes[1].node.encode();
3044         }
3045
3046         nodes[2].node.claim_funds(payment_preimage);
3047         check_added_monitors(&nodes[2], 1);
3048         expect_payment_claimed!(nodes[2], payment_hash, 100_000);
3049
3050         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3051         let cs_updates = get_htlc_update_msgs(&nodes[2], &nodes[1].node.get_our_node_id());
3052         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
3053
3054         // B generates a new monitor update for the A <-> B channel, but doesn't send the new messages
3055         // for it since the monitor update is marked in-progress.
3056         check_added_monitors(&nodes[1], 1);
3057         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3058
3059         // Now step the Commitment Signed Dance between B and C forward a bit (or fully), ensuring we
3060         // won't get the preimage when the nodes reconnect and we have to get it from the
3061         // ChannelMonitor.
3062         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &cs_updates.commitment_signed);
3063         check_added_monitors(&nodes[1], 1);
3064         if complete_bc_commitment_dance {
3065                 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3066                 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3067                 check_added_monitors(&nodes[2], 1);
3068                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3069                 check_added_monitors(&nodes[2], 1);
3070                 let cs_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3071
3072                 // At this point node B still hasn't persisted the `ChannelMonitorUpdate` with the
3073                 // preimage in the A <-> B channel, which will prevent it from persisting the
3074                 // `ChannelMonitorUpdate` for the B<->C channel here to avoid "losing" the preimage.
3075                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &cs_raa);
3076                 check_added_monitors(&nodes[1], 0);
3077                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3078         }
3079
3080         // Now reload node B
3081         if with_latest_manager {
3082                 manager_b = nodes[1].node.encode();
3083         }
3084
3085         let mon_bc = get_monitor!(nodes[1], chan_id_bc).encode();
3086         reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, new_chain_monitor, nodes_1_deserialized);
3087
3088         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3089         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3090
3091         if with_latest_manager {
3092                 // If we used the latest ChannelManager to reload from, we should have both channels still
3093                 // live. The B <-> C channel's final RAA ChannelMonitorUpdate must still be blocked as
3094                 // before - the ChannelMonitorUpdate for the A <-> B channel hasn't completed.
3095                 // When we call `timer_tick_occurred` we will get that monitor update back, which we'll
3096                 // complete after reconnecting to our peers.
3097                 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3098                 nodes[1].node.timer_tick_occurred();
3099                 check_added_monitors(&nodes[1], 1);
3100                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3101
3102                 // Now reconnect B to both A and C. If the B <-> C commitment signed dance wasn't run to
3103                 // the end go ahead and do that, though the
3104                 // `pending_responding_commitment_signed_dup_monitor` in `reconnect_args` indicates that we
3105                 // expect to *not* receive the final RAA ChannelMonitorUpdate.
3106                 if complete_bc_commitment_dance {
3107                         reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[2]));
3108                 } else {
3109                         let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
3110                         reconnect_args.pending_responding_commitment_signed.1 = true;
3111                         reconnect_args.pending_responding_commitment_signed_dup_monitor.1 = true;
3112                         reconnect_args.pending_raa = (false, true);
3113                         reconnect_nodes(reconnect_args);
3114                 }
3115
3116                 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
3117
3118                 // (Finally) complete the A <-> B ChannelMonitorUpdate, ensuring the preimage is durably on
3119                 // disk in the proper ChannelMonitor, unblocking the B <-> C ChannelMonitor updating
3120                 // process.
3121                 let (outpoint, _, ab_update_id) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_ab).unwrap().clone();
3122                 nodes[1].chain_monitor.chain_monitor.channel_monitor_updated(outpoint, ab_update_id).unwrap();
3123
3124                 // When we fetch B's HTLC update messages next (now that the ChannelMonitorUpdate has
3125                 // completed), it will also release the final RAA ChannelMonitorUpdate on the B <-> C
3126                 // channel.
3127         } else {
3128                 // If the ChannelManager used in the reload was stale, check that the B <-> C channel was
3129                 // closed.
3130                 //
3131                 // Note that this will also process the ChannelMonitorUpdates which were queued up when we
3132                 // reloaded the ChannelManager. This will re-emit the A<->B preimage as well as the B<->C
3133                 // force-closure ChannelMonitorUpdate. Once the A<->B preimage update completes, the claim
3134                 // commitment update will be allowed to go out.
3135                 check_added_monitors(&nodes[1], 0);
3136                 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3137                 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3138                 check_closed_event(&nodes[1], 1, ClosureReason::OutdatedChannelManager, false, &[nodes[2].node.get_our_node_id()], 100_000);
3139                 check_added_monitors(&nodes[1], 2);
3140
3141                 nodes[1].node.timer_tick_occurred();
3142                 check_added_monitors(&nodes[1], 0);
3143
3144                 // Don't bother to reconnect B to C - that channel has been closed. We don't need to
3145                 // exchange any messages here even though there's a pending commitment update because the
3146                 // ChannelMonitorUpdate hasn't yet completed.
3147                 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
3148
3149                 let (outpoint, _, ab_update_id) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_ab).unwrap().clone();
3150                 nodes[1].chain_monitor.chain_monitor.channel_monitor_updated(outpoint, ab_update_id).unwrap();
3151
3152                 // The ChannelMonitorUpdate which was completed prior to the reconnect only contained the
3153                 // preimage (as it was a replay of the original ChannelMonitorUpdate from before we
3154                 // restarted). When we go to fetch the commitment transaction updates we'll poll the
3155                 // ChannelMonitorUpdate completion, then generate (and complete) a new ChannelMonitorUpdate
3156                 // with the actual commitment transaction, which will allow us to fulfill the HTLC with
3157                 // node A.
3158         }
3159
3160         let bs_updates = get_htlc_update_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
3161         check_added_monitors(&nodes[1], 1);
3162
3163         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
3164         do_commitment_signed_dance(&nodes[0], &nodes[1], &bs_updates.commitment_signed, false, false);
3165
3166         expect_payment_forwarded!(nodes[1], &nodes[0], &nodes[2], Some(1_000), false, !with_latest_manager);
3167
3168         // Finally, check that the payment was, ultimately, seen as sent by node A.
3169         expect_payment_sent(&nodes[0], payment_preimage, None, true, true);
3170 }
3171
3172 #[test]
3173 fn test_inverted_mon_completion_order() {
3174         do_test_inverted_mon_completion_order(true, true);
3175         do_test_inverted_mon_completion_order(true, false);
3176         do_test_inverted_mon_completion_order(false, true);
3177         do_test_inverted_mon_completion_order(false, false);
3178 }
3179
3180 fn do_test_durable_preimages_on_closed_channel(close_chans_before_reload: bool, close_only_a: bool, hold_post_reload_mon_update: bool) {
3181         // Test that we can apply a `ChannelMonitorUpdate` with a payment preimage even if the channel
3182         // is force-closed between when we generate the update on reload and when we go to handle the
3183         // update or prior to generating the update at all.
3184
3185         if !close_chans_before_reload && close_only_a {
3186                 // If we're not closing, it makes no sense to "only close A"
3187                 panic!();
3188         }
3189
3190         let chanmon_cfgs = create_chanmon_cfgs(3);
3191         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3192
3193         let persister;
3194         let new_chain_monitor;
3195         let nodes_1_deserialized;
3196
3197         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3198         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3199
3200         let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
3201         let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;
3202
3203         // Route a payment from A, through B, to C, then claim it on C. Once we pass B the
3204         // `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
3205         // on the B<->C channel but leave the A<->B monitor update pending, then reload B.
3206         let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
3207
3208         let mon_ab = get_monitor!(nodes[1], chan_id_ab).encode();
3209
3210         nodes[2].node.claim_funds(payment_preimage);
3211         check_added_monitors(&nodes[2], 1);
3212         expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
3213
3214         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3215         let cs_updates = get_htlc_update_msgs(&nodes[2], &nodes[1].node.get_our_node_id());
3216         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
3217
3218         // B generates a new monitor update for the A <-> B channel, but doesn't send the new messages
3219         // for it since the monitor update is marked in-progress.
3220         check_added_monitors(&nodes[1], 1);
3221         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3222
3223         // Now step the Commitment Signed Dance between B and C forward a bit, ensuring we won't get
3224         // the preimage when the nodes reconnect, at which point we have to ensure we get it from the
3225         // ChannelMonitor.
3226         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &cs_updates.commitment_signed);
3227         check_added_monitors(&nodes[1], 1);
3228         let _ = get_revoke_commit_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3229
3230         let mon_bc = get_monitor!(nodes[1], chan_id_bc).encode();
3231         let error_message = "Channel force-closed";
3232
3233         if close_chans_before_reload {
3234                 if !close_only_a {
3235                         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3236                         nodes[1].node.force_close_broadcasting_latest_txn(&chan_id_bc, &nodes[2].node.get_our_node_id(), error_message.to_string()).unwrap();
3237                         check_closed_broadcast(&nodes[1], 1, true);
3238                         check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(true) }, false, &[nodes[2].node.get_our_node_id()], 100000);
3239                 }
3240
3241                 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3242                 nodes[1].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[0].node.get_our_node_id(), error_message.to_string()).unwrap();
3243                 check_closed_broadcast(&nodes[1], 1, true);
3244                 check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(true) }, false, &[nodes[0].node.get_our_node_id()], 100000);
3245         }
3246
3247         // Now reload node B
3248         let manager_b = nodes[1].node.encode();
3249         reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, new_chain_monitor, nodes_1_deserialized);
3250
3251         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3252         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3253
3254         if close_chans_before_reload {
3255                 // If the channels were already closed, B will rebroadcast its closing transactions here.
3256                 let bs_close_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3257                 if close_only_a {
3258                         assert_eq!(bs_close_txn.len(), 2);
3259                 } else {
3260                         assert_eq!(bs_close_txn.len(), 3);
3261                 }
3262         }
3263         let error_message = "Channel force-closed";
3264
3265         nodes[0].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[1].node.get_our_node_id(), error_message.to_string()).unwrap();
3266         check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(true) }, false, &[nodes[1].node.get_our_node_id()], 100000);
3267         let as_closing_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3268         assert_eq!(as_closing_tx.len(), 1);
3269
3270         // In order to give A's closing transaction to B without processing background events first,
3271         // use the _without_consistency_checks utility method. This is similar to connecting blocks
3272         // during startup prior to the node being full initialized.
3273         mine_transaction_without_consistency_checks(&nodes[1], &as_closing_tx[0]);
3274
3275         // After a timer tick a payment preimage ChannelMonitorUpdate is applied to the A<->B
3276         // ChannelMonitor (possible twice), even though the channel has since been closed.
3277         check_added_monitors(&nodes[1], 0);
3278         let mons_added = if close_chans_before_reload { if !close_only_a { 4 } else { 3 } } else { 2 };
3279         if hold_post_reload_mon_update {
3280                 for _ in 0..mons_added {
3281                         persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3282                 }
3283         }
3284         nodes[1].node.timer_tick_occurred();
3285         check_added_monitors(&nodes[1], mons_added);
3286
3287         // Finally, check that B created a payment preimage transaction and close out the payment.
3288         let bs_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3289         assert_eq!(bs_txn.len(), if close_chans_before_reload && !close_only_a { 2 } else { 1 });
3290         let bs_preimage_tx = &bs_txn[0];
3291         check_spends!(bs_preimage_tx, as_closing_tx[0]);
3292
3293         if !close_chans_before_reload {
3294                 check_closed_broadcast(&nodes[1], 1, true);
3295                 check_closed_event(&nodes[1], 1, ClosureReason::CommitmentTxConfirmed, false, &[nodes[0].node.get_our_node_id()], 100000);
3296         } else {
3297                 // While we forwarded the payment a while ago, we don't want to process events too early or
3298                 // we'll run background tasks we wanted to test individually.
3299                 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], None, true, !close_only_a);
3300         }
3301
3302         mine_transactions(&nodes[0], &[&as_closing_tx[0], bs_preimage_tx]);
3303         check_closed_broadcast(&nodes[0], 1, true);
3304         expect_payment_sent(&nodes[0], payment_preimage, None, true, true);
3305
3306         if !close_chans_before_reload || close_only_a {
3307                 // Make sure the B<->C channel is still alive and well by sending a payment over it.
3308                 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
3309                 reconnect_args.pending_responding_commitment_signed.1 = true;
3310                 if !close_chans_before_reload {
3311                         // TODO: If the A<->B channel was closed before we reloaded, the `ChannelManager`
3312                         // will consider the forwarded payment complete and allow the B<->C
3313                         // `ChannelMonitorUpdate` to complete, wiping the payment preimage. This should not
3314                         // be allowed, and needs fixing.
3315                         reconnect_args.pending_responding_commitment_signed_dup_monitor.1 = true;
3316                 }
3317                 reconnect_args.pending_raa.1 = true;
3318
3319                 reconnect_nodes(reconnect_args);
3320                 let (outpoint, ab_update_id, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_ab).unwrap().clone();
3321                 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, ab_update_id);
3322                 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), true, false);
3323                 if !close_chans_before_reload {
3324                         // Once we call `process_pending_events` the final `ChannelMonitor` for the B<->C
3325                         // channel will fly, removing the payment preimage from it.
3326                         check_added_monitors(&nodes[1], 1);
3327                 }
3328                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3329                 send_payment(&nodes[1], &[&nodes[2]], 100_000);
3330         }
3331 }
3332
3333 #[test]
3334 fn test_durable_preimages_on_closed_channel() {
3335         do_test_durable_preimages_on_closed_channel(true, true, true);
3336         do_test_durable_preimages_on_closed_channel(true, true, false);
3337         do_test_durable_preimages_on_closed_channel(true, false, true);
3338         do_test_durable_preimages_on_closed_channel(true, false, false);
3339         do_test_durable_preimages_on_closed_channel(false, false, true);
3340         do_test_durable_preimages_on_closed_channel(false, false, false);
3341 }
3342
3343 #[test]
3344 fn test_sync_async_persist_doesnt_hang() {
3345         // Previously, we checked if a channel was a candidate for making forward progress based on if
3346         // the `MonitorEvent::Completed` matched the channel's latest monitor update id. However, this
3347         // could lead to a rare race when `ChannelMonitor`s were being persisted both synchronously and
3348         // asynchronously leading to channel hangs.
3349         //
3350         // To hit this case, we need to generate a `MonitorEvent::Completed` prior to a new channel
3351         // update, but which is only processed after the channel update.
3352         let chanmon_cfgs = create_chanmon_cfgs(2);
3353         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3354         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3355         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3356
3357         let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
3358
3359         // Send two payments from A to B, then claim the first, marking the very last
3360         // ChannelMonitorUpdate as InProgress...
3361         let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
3362         let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
3363
3364         nodes[1].node.claim_funds(payment_preimage_1);
3365         check_added_monitors(&nodes[1], 1);
3366         expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
3367
3368         let bs_updates = get_htlc_update_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
3369         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
3370         expect_payment_sent(&nodes[0], payment_preimage_1, None, false, false);
3371         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
3372         check_added_monitors(&nodes[0], 1);
3373         let (as_raa, as_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3374
3375         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
3376         check_added_monitors(&nodes[1], 1);
3377         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs);
3378         check_added_monitors(&nodes[1], 1);
3379
3380         let bs_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3381         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3382         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_final_raa);
3383         check_added_monitors(&nodes[0], 1);
3384
3385         // Immediately complete the monitor update, but before the ChannelManager has a chance to see
3386         // the MonitorEvent::Completed, create a channel update by receiving a claim on the second
3387         // payment.
3388         let (outpoint, _, ab_update_id) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_ab).unwrap().clone();
3389         nodes[0].chain_monitor.chain_monitor.channel_monitor_updated(outpoint, ab_update_id).unwrap();
3390
3391         nodes[1].node.claim_funds(payment_preimage_2);
3392         check_added_monitors(&nodes[1], 1);
3393         expect_payment_claimed!(nodes[1], payment_hash_2, 1_000_000);
3394
3395         let bs_updates = get_htlc_update_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
3396         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
3397         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
3398         check_added_monitors(&nodes[0], 1);
3399
3400         // At this point, we have completed an extra `ChannelMonitorUpdate` but the `ChannelManager`
3401         // hasn't yet seen our `MonitorEvent::Completed`. When we call
3402         // `get_and_clear_pending_msg_events` here, the `ChannelManager` finally sees that event and
3403         // should return the channel to normal operation.
3404         let (as_raa, as_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3405
3406         // Now that we've completed our test, process the events we have queued up (which we were not
3407         // able to check until now as they would have caused the `ChannelManager` to look at the
3408         // pending `MonitorEvent`s).
3409         let pending_events = nodes[0].node.get_and_clear_pending_events();
3410         assert_eq!(pending_events.len(), 2);
3411         if let Event::PaymentPathSuccessful { ref payment_hash, ..} = pending_events[1] {
3412                 assert_eq!(payment_hash.unwrap(), payment_hash_1);
3413         } else { panic!(); }
3414         if let Event::PaymentSent { ref payment_hash, ..} = pending_events[0] {
3415                 assert_eq!(*payment_hash, payment_hash_2);
3416         } else { panic!(); }
3417
3418         // Finally, complete the claiming of the second payment
3419         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
3420         check_added_monitors(&nodes[1], 1);
3421         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs);
3422         check_added_monitors(&nodes[1], 1);
3423
3424         let bs_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3425         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_final_raa);
3426         check_added_monitors(&nodes[0], 1);
3427         expect_payment_path_successful!(nodes[0]);
3428 }
3429
3430 fn do_test_reload_mon_update_completion_actions(close_during_reload: bool) {
3431         // Test that if a `ChannelMonitorUpdate` completes but a `ChannelManager` isn't serialized
3432         // before restart we run the monitor update completion action on startup.
3433         let chanmon_cfgs = create_chanmon_cfgs(3);
3434         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3435
3436         let persister;
3437         let new_chain_monitor;
3438         let nodes_1_deserialized;
3439
3440         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3441         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3442
3443         let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
3444         let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;
3445
3446         // Route a payment from A, through B, to C, then claim it on C. Once we pass B the
3447         // `update_fulfill_htlc`+`commitment_signed` we have a monitor update for both of B's channels.
3448         // We complete the commitment signed dance on the B<->C channel but leave the A<->B monitor
3449         // update pending, then reload B. At that point, the final monitor update on the B<->C channel
3450         // is still pending because it can't fly until the preimage is persisted on the A<->B monitor.
3451         let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
3452
3453         nodes[2].node.claim_funds(payment_preimage);
3454         check_added_monitors(&nodes[2], 1);
3455         expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
3456
3457         chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3458         let cs_updates = get_htlc_update_msgs(&nodes[2], &nodes[1].node.get_our_node_id());
3459         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
3460
3461         // B generates a new monitor update for the A <-> B channel, but doesn't send the new messages
3462         // for it since the monitor update is marked in-progress.
3463         check_added_monitors(&nodes[1], 1);
3464         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3465
3466         // Now step the Commitment Signed Dance between B and C and check that after the final RAA B
3467         // doesn't let the preimage-removing monitor update fly.
3468         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &cs_updates.commitment_signed);
3469         check_added_monitors(&nodes[1], 1);
3470         let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3471
3472         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
3473         check_added_monitors(&nodes[2], 1);
3474         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
3475         check_added_monitors(&nodes[2], 1);
3476
3477         let cs_final_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3478         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &cs_final_raa);
3479         check_added_monitors(&nodes[1], 0);
3480
3481         // Finally, reload node B and check that after we call `process_pending_events` once we realize
3482         // we've completed the A<->B preimage-including monitor update and so can release the B<->C
3483         // preimage-removing monitor update.
3484         let mon_ab = get_monitor!(nodes[1], chan_id_ab).encode();
3485         let mon_bc = get_monitor!(nodes[1], chan_id_bc).encode();
3486         let manager_b = nodes[1].node.encode();
3487         reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, new_chain_monitor, nodes_1_deserialized);
3488
3489         let error_message = "Channel force-closed";
3490         if close_during_reload {
3491                 // Test that we still free the B<->C channel if the A<->B channel closed while we reloaded
3492                 // (as learned about during the on-reload block connection).
3493                 nodes[0].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[1].node.get_our_node_id(), error_message.to_string()).unwrap();
3494                 check_added_monitors!(nodes[0], 1);
3495                 check_closed_broadcast!(nodes[0], true);
3496                 check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(true) }, false, &[nodes[1].node.get_our_node_id()], 100_000);
3497                 let as_closing_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3498                 mine_transaction_without_consistency_checks(&nodes[1], &as_closing_tx[0]);
3499         }
3500
3501         let bc_update_id = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_bc).unwrap().2;
3502         let mut events = nodes[1].node.get_and_clear_pending_events();
3503         assert_eq!(events.len(), if close_during_reload { 2 } else { 1 });
3504         expect_payment_forwarded(events.pop().unwrap(), &nodes[1], &nodes[0], &nodes[2], Some(1000),
3505                 None, close_during_reload, false, false);
3506         if close_during_reload {
3507                 match events[0] {
3508                         Event::ChannelClosed { .. } => {},
3509                         _ => panic!(),
3510                 }
3511                 check_closed_broadcast!(nodes[1], true);
3512         }
3513
3514         // Once we run event processing the monitor should free, check that it was indeed the B<->C
3515         // channel which was updated.
3516         check_added_monitors(&nodes[1], if close_during_reload { 2 } else { 1 });
3517         let post_ev_bc_update_id = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_bc).unwrap().2;
3518         assert!(bc_update_id != post_ev_bc_update_id);
3519
3520         // Finally, check that there's nothing left to do on B<->C reconnect and the channel operates
3521         // fine.
3522         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3523         reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[2]));
3524         send_payment(&nodes[1], &[&nodes[2]], 100_000);
3525 }
3526
3527 #[test]
3528 fn test_reload_mon_update_completion_actions() {
3529         do_test_reload_mon_update_completion_actions(true);
3530         do_test_reload_mon_update_completion_actions(false);
3531 }
3532
3533 fn do_test_glacial_peer_cant_hang(hold_chan_a: bool) {
3534         // Test that if a peer manages to send an `update_fulfill_htlc` message without a
3535         // `commitment_signed`, disconnects, then replays the `update_fulfill_htlc` message it doesn't
3536         // result in a channel hang. This was previously broken as the `DuplicateClaim` case wasn't
3537         // handled when claiming an HTLC and handling wasn't added when completion actions were added
3538         // (which must always complete at some point).
3539         let chanmon_cfgs = create_chanmon_cfgs(3);
3540         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3541
3542         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3543         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3544
3545         create_announced_chan_between_nodes(&nodes, 0, 1);
3546         create_announced_chan_between_nodes(&nodes, 1, 2);
3547
3548         // Route a payment from A, through B, to C, then claim it on C. Replay the
3549         // `update_fulfill_htlc` twice on B to check that B doesn't hang.
3550         let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
3551
3552         nodes[2].node.claim_funds(payment_preimage);
3553         check_added_monitors(&nodes[2], 1);
3554         expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
3555
3556         let cs_updates = get_htlc_update_msgs(&nodes[2], &nodes[1].node.get_our_node_id());
3557         if hold_chan_a {
3558                 // The first update will be on the A <-> B channel, which we allow to complete.
3559                 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3560         }
3561         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
3562         check_added_monitors(&nodes[1], 1);
3563
3564         if !hold_chan_a {
3565                 let bs_updates = get_htlc_update_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
3566                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
3567                 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
3568                 expect_payment_sent!(&nodes[0], payment_preimage);
3569         }
3570
3571         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
3572         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3573
3574         let mut reconnect = ReconnectArgs::new(&nodes[1], &nodes[2]);
3575         reconnect.pending_htlc_claims = (1, 0);
3576         reconnect_nodes(reconnect);
3577
3578         if !hold_chan_a {
3579                 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
3580                 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
3581         } else {
3582                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3583                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3584
3585                 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[1], nodes[2], 1_000_000);
3586
3587                 nodes[1].node.send_payment_with_route(&route, payment_hash_2,
3588                         RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
3589                 check_added_monitors(&nodes[1], 0);
3590
3591                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3592                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3593         }
3594 }
3595
3596 #[test]
3597 fn test_glacial_peer_cant_hang() {
3598         do_test_glacial_peer_cant_hang(false);
3599         do_test_glacial_peer_cant_hang(true);
3600 }