_ 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 ChannelMonitorUpdateErr 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::block::{Block, BlockHeader};
  16 use bitcoin::blockdata::constants::genesis_block;
  17 use bitcoin::hash_types::BlockHash;
  18 use bitcoin::network::constants::Network;
  19 use chain::channelmonitor::ChannelMonitor;
  20 use chain::transaction::OutPoint;
  21 use chain::{ChannelMonitorUpdateErr, Listen, Watch};
  22 use ln::{PaymentPreimage, PaymentHash};
  23 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
  24 use ln::features::InitFeatures;
  25 use ln::msgs;
  26 use ln::msgs::{ChannelMessageHandler, ErrorAction, RoutingMessageHandler};
  27 use util::config::UserConfig;
  28 use util::enforcing_trait_impls::EnforcingSigner;
  29 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason};
  30 use util::errors::APIError;
  31 use util::ser::{ReadableArgs, Writeable};
  32 use util::test_utils::TestBroadcaster;
  33
  34 use bitcoin::hashes::sha256::Hash as Sha256;
  35 use bitcoin::hashes::Hash;
  36
  37 use ln::functional_test_utils::*;
  38
  39 use util::test_utils;
  40
  41 use io;
  42 use prelude::*;
  43 use sync::{Arc, Mutex};
  44
  45 // If persister_fail is true, we have the persister return a PermanentFailure
  46 // instead of the higher-level ChainMonitor.
  47 fn do_test_simple_monitor_permanent_update_fail(persister_fail: bool) {
  48         // Test that we handle a simple permanent monitor update failure
  49         let mut chanmon_cfgs = create_chanmon_cfgs(2);
  50         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  51         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  52         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  53         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
  54
  55         let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
  56
  57         match persister_fail {
  58                 true => chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::PermanentFailure)),
  59                 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::PermanentFailure))
  60         }
  61         unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable {..}, {});
  62         check_added_monitors!(nodes[0], 2);
  63
  64         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
  65         assert_eq!(events_1.len(), 2);
  66         match events_1[0] {
  67                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
  68                 _ => panic!("Unexpected event"),
  69         };
  70         match events_1[1] {
  71                 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
  72                 _ => panic!("Unexpected event"),
  73         };
  74
  75         // TODO: Once we hit the chain with the failure transaction we should check that we get a
  76         // PaymentPathFailed event
  77
  78         assert_eq!(nodes[0].node.list_channels().len(), 0);
  79         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
  80 }
  81
  82 #[test]
  83 fn test_monitor_and_persister_update_fail() {
  84         // Test that if both updating the `ChannelMonitor` and persisting the updated
  85         // `ChannelMonitor` fail, then the failure from updating the `ChannelMonitor`
  86         // one that gets returned.
  87         let chanmon_cfgs = create_chanmon_cfgs(2);
  88         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  89         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  90         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  91
  92         // Create some initial channel
  93         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
  94         let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
  95
  96         // Rebalance the network to generate htlc in the two directions
  97         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
  98
  99         // Route an HTLC from node 0 to node 1 (but don't settle)
 100         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
 101
 102         // Make a copy of the ChainMonitor so we can capture the error it returns on a
 103         // bogus update. Note that if instead we updated the nodes[0]'s ChainMonitor
 104         // directly, the node would fail to be `Drop`'d at the end because its
 105         // ChannelManager and ChainMonitor would be out of sync.
 106         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
 107         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
 108         let persister = test_utils::TestPersister::new();
 109         let tx_broadcaster = TestBroadcaster {
 110                 txn_broadcasted: Mutex::new(Vec::new()),
 111                 // Because we will connect a block at height 200 below, we need the TestBroadcaster to know
 112                 // that we are at height 200 so that it doesn't think we're violating the time lock
 113                 // requirements of transactions broadcasted at that point.
 114                 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 200); 200])),
 115         };
 116         let chain_mon = {
 117                 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
 118                 let mut w = test_utils::TestVecWriter(Vec::new());
 119                 monitor.write(&mut w).unwrap();
 120                 let new_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
 121                         &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
 122                 assert!(new_monitor == *monitor);
 123                 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
 124                 assert!(chain_mon.watch_channel(outpoint, new_monitor).is_ok());
 125                 chain_mon
 126         };
 127         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 128         chain_mon.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
 129
 130         // Set the persister's return value to be a TemporaryFailure.
 131         persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
 132
 133         // Try to update ChannelMonitor
 134         assert!(nodes[1].node.claim_funds(preimage));
 135         check_added_monitors!(nodes[1], 1);
 136         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 137         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 138         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 139         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2) {
 140                 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
 141                         // Check that even though the persister is returning a TemporaryFailure,
 142                         // because the update is bogus, ultimately the error that's returned
 143                         // should be a PermanentFailure.
 144                         if let Err(ChannelMonitorUpdateErr::PermanentFailure) = chain_mon.chain_monitor.update_channel(outpoint, update.clone()) {} else { panic!("Expected monitor error to be permanent"); }
 145                         logger.assert_log_contains("lightning::chain::chainmonitor".to_string(), "Failed to persist channel monitor update: TemporaryFailure".to_string(), 1);
 146                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
 147                 } else { assert!(false); }
 148         } else { assert!(false); };
 149
 150         check_added_monitors!(nodes[0], 1);
 151         let events = nodes[0].node.get_and_clear_pending_events();
 152         assert_eq!(events.len(), 1);
 153 }
 154
 155 #[test]
 156 fn test_simple_monitor_permanent_update_fail() {
 157         do_test_simple_monitor_permanent_update_fail(false);
 158
 159         // Test behavior when the persister returns a PermanentFailure.
 160         do_test_simple_monitor_permanent_update_fail(true);
 161 }
 162
 163 // If persister_fail is true, we have the persister return a TemporaryFailure instead of the
 164 // higher-level ChainMonitor.
 165 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool, persister_fail: bool) {
 166         // Test that we can recover from a simple temporary monitor update failure optionally with
 167         // a disconnect in between
 168         let mut chanmon_cfgs = create_chanmon_cfgs(2);
 169         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 170         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 171         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 172         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
 173
 174         let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
 175
 176         match persister_fail {
 177                 true => chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure)),
 178                 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure))
 179         }
 180
 181         {
 182                 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), false, APIError::MonitorUpdateFailed, {});
 183                 check_added_monitors!(nodes[0], 1);
 184         }
 185
 186         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 187         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 188         assert_eq!(nodes[0].node.list_channels().len(), 1);
 189
 190         if disconnect {
 191                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 192                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 193                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
 194         }
 195
 196         match persister_fail {
 197                 true => chanmon_cfgs[0].persister.set_update_ret(Ok(())),
 198                 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()))
 199         }
 200         let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
 201         nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
 202         check_added_monitors!(nodes[0], 0);
 203
 204         let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
 205         assert_eq!(events_2.len(), 1);
 206         let payment_event = SendEvent::from_event(events_2.pop().unwrap());
 207         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
 208         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 209         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
 210
 211         expect_pending_htlcs_forwardable!(nodes[1]);
 212
 213         let events_3 = nodes[1].node.get_and_clear_pending_events();
 214         assert_eq!(events_3.len(), 1);
 215         match events_3[0] {
 216                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
 217                         assert_eq!(payment_hash_1, *payment_hash);
 218                         assert_eq!(amt, 1000000);
 219                         match &purpose {
 220                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
 221                                         assert!(payment_preimage.is_none());
 222                                         assert_eq!(payment_secret_1, *payment_secret);
 223                                 },
 224                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
 225                         }
 226                 },
 227                 _ => panic!("Unexpected event"),
 228         }
 229
 230         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
 231
 232         // Now set it to failed again...
 233         let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
 234         {
 235                 match persister_fail {
 236                         true => chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure)),
 237                         false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure))
 238                 }
 239                 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)), false, APIError::MonitorUpdateFailed, {});
 240                 check_added_monitors!(nodes[0], 1);
 241         }
 242
 243         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 244         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 245         assert_eq!(nodes[0].node.list_channels().len(), 1);
 246
 247         if disconnect {
 248                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 249                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 250                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
 251         }
 252
 253         // ...and make sure we can force-close a frozen channel
 254         nodes[0].node.force_close_channel(&channel_id).unwrap();
 255         check_added_monitors!(nodes[0], 1);
 256         check_closed_broadcast!(nodes[0], true);
 257
 258         // TODO: Once we hit the chain with the failure transaction we should check that we get a
 259         // PaymentPathFailed event
 260
 261         assert_eq!(nodes[0].node.list_channels().len(), 0);
 262         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
 263 }
 264
 265 #[test]
 266 fn test_simple_monitor_temporary_update_fail() {
 267         do_test_simple_monitor_temporary_update_fail(false, false);
 268         do_test_simple_monitor_temporary_update_fail(true, false);
 269
 270         // Test behavior when the persister returns a TemporaryFailure.
 271         do_test_simple_monitor_temporary_update_fail(false, true);
 272         do_test_simple_monitor_temporary_update_fail(true, true);
 273 }
 274
 275 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
 276         let disconnect_flags = 8 | 16;
 277
 278         // Test that we can recover from a temporary monitor update failure with some in-flight
 279         // HTLCs going on at the same time potentially with some disconnection thrown in.
 280         // * First we route a payment, then get a temporary monitor update failure when trying to
 281         //   route a second payment. We then claim the first payment.
 282         // * If disconnect_count is set, we will disconnect at this point (which is likely as
 283         //   TemporaryFailure likely indicates net disconnect which resulted in failing to update
 284         //   the ChannelMonitor on a watchtower).
 285         // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
 286         //   immediately, otherwise we wait disconnect and deliver them via the reconnect
 287         //   channel_reestablish processing (ie disconnect_count & 16 makes no sense if
 288         //   disconnect_count & !disconnect_flags is 0).
 289         // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
 290         //   through message sending, potentially disconnect/reconnecting multiple times based on
 291         //   disconnect_count, to get the update_fulfill_htlc through.
 292         // * We then walk through more message exchanges to get the original update_add_htlc
 293         //   through, swapping message ordering based on disconnect_count & 8 and optionally
 294         //   disconnect/reconnecting based on disconnect_count.
 295         let chanmon_cfgs = create_chanmon_cfgs(2);
 296         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 297         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 298         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 299         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
 300
 301         let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
 302
 303         // Now try to send a second payment which will fail to send
 304         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
 305         {
 306                 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
 307                 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)), false, APIError::MonitorUpdateFailed, {});
 308                 check_added_monitors!(nodes[0], 1);
 309         }
 310
 311         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 312         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 313         assert_eq!(nodes[0].node.list_channels().len(), 1);
 314
 315         // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
 316         // but nodes[0] won't respond since it is frozen.
 317         assert!(nodes[1].node.claim_funds(payment_preimage_1));
 318         check_added_monitors!(nodes[1], 1);
 319         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
 320         assert_eq!(events_2.len(), 1);
 321         let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
 322                 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 } } => {
 323                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
 324                         assert!(update_add_htlcs.is_empty());
 325                         assert_eq!(update_fulfill_htlcs.len(), 1);
 326                         assert!(update_fail_htlcs.is_empty());
 327                         assert!(update_fail_malformed_htlcs.is_empty());
 328                         assert!(update_fee.is_none());
 329
 330                         if (disconnect_count & 16) == 0 {
 331                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
 332                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
 333                                 assert_eq!(events_3.len(), 1);
 334                                 match events_3[0] {
 335                                         Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
 336                                                 assert_eq!(*payment_preimage, payment_preimage_1);
 337                                                 assert_eq!(*payment_hash, payment_hash_1);
 338                                         },
 339                                         _ => panic!("Unexpected event"),
 340                                 }
 341
 342                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
 343                                 check_added_monitors!(nodes[0], 1);
 344                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 345                                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
 346                         }
 347
 348                         (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
 349                 },
 350                 _ => panic!("Unexpected event"),
 351         };
 352
 353         if disconnect_count & !disconnect_flags > 0 {
 354                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 355                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 356         }
 357
 358         // Now fix monitor updating...
 359         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
 360         let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
 361         nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
 362         check_added_monitors!(nodes[0], 0);
 363
 364         macro_rules! disconnect_reconnect_peers { () => { {
 365                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 366                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 367
 368                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 369                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
 370                 assert_eq!(reestablish_1.len(), 1);
 371                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 372                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
 373                 assert_eq!(reestablish_2.len(), 1);
 374
 375                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
 376                 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
 377                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
 378                 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
 379
 380                 assert!(as_resp.0.is_none());
 381                 assert!(bs_resp.0.is_none());
 382
 383                 (reestablish_1, reestablish_2, as_resp, bs_resp)
 384         } } }
 385
 386         let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
 387                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 388                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 389
 390                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 391                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
 392                 assert_eq!(reestablish_1.len(), 1);
 393                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 394                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
 395                 assert_eq!(reestablish_2.len(), 1);
 396
 397                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
 398                 check_added_monitors!(nodes[0], 0);
 399                 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
 400                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
 401                 check_added_monitors!(nodes[1], 0);
 402                 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
 403
 404                 assert!(as_resp.0.is_none());
 405                 assert!(bs_resp.0.is_none());
 406
 407                 assert!(bs_resp.1.is_none());
 408                 if (disconnect_count & 16) == 0 {
 409                         assert!(bs_resp.2.is_none());
 410
 411                         assert!(as_resp.1.is_some());
 412                         assert!(as_resp.2.is_some());
 413                         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
 414                 } else {
 415                         assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
 416                         assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
 417                         assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
 418                         assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
 419                         assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
 420                         assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
 421
 422                         assert!(as_resp.1.is_none());
 423
 424                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
 425                         let events_3 = nodes[0].node.get_and_clear_pending_events();
 426                         assert_eq!(events_3.len(), 1);
 427                         match events_3[0] {
 428                                 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
 429                                         assert_eq!(*payment_preimage, payment_preimage_1);
 430                                         assert_eq!(*payment_hash, payment_hash_1);
 431                                 },
 432                                 _ => panic!("Unexpected event"),
 433                         }
 434
 435                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
 436                         let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 437                         // No commitment_signed so get_event_msg's assert(len == 1) passes
 438                         check_added_monitors!(nodes[0], 1);
 439
 440                         as_resp.1 = Some(as_resp_raa);
 441                         bs_resp.2 = None;
 442                 }
 443
 444                 if disconnect_count & !disconnect_flags > 1 {
 445                         let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
 446
 447                         if (disconnect_count & 16) == 0 {
 448                                 assert!(reestablish_1 == second_reestablish_1);
 449                                 assert!(reestablish_2 == second_reestablish_2);
 450                         }
 451                         assert!(as_resp == second_as_resp);
 452                         assert!(bs_resp == second_bs_resp);
 453                 }
 454
 455                 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
 456         } else {
 457                 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
 458                 assert_eq!(events_4.len(), 2);
 459                 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
 460                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 461                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 462                                 msg.clone()
 463                         },
 464                         _ => panic!("Unexpected event"),
 465                 })
 466         };
 467
 468         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
 469
 470         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 471         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
 472         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 473         // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
 474         check_added_monitors!(nodes[1], 1);
 475
 476         if disconnect_count & !disconnect_flags > 2 {
 477                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
 478
 479                 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
 480                 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
 481
 482                 assert!(as_resp.2.is_none());
 483                 assert!(bs_resp.2.is_none());
 484         }
 485
 486         let as_commitment_update;
 487         let bs_second_commitment_update;
 488
 489         macro_rules! handle_bs_raa { () => {
 490                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
 491                 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 492                 assert!(as_commitment_update.update_add_htlcs.is_empty());
 493                 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
 494                 assert!(as_commitment_update.update_fail_htlcs.is_empty());
 495                 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
 496                 assert!(as_commitment_update.update_fee.is_none());
 497                 check_added_monitors!(nodes[0], 1);
 498         } }
 499
 500         macro_rules! handle_initial_raa { () => {
 501                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
 502                 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 503                 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
 504                 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
 505                 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
 506                 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
 507                 assert!(bs_second_commitment_update.update_fee.is_none());
 508                 check_added_monitors!(nodes[1], 1);
 509         } }
 510
 511         if (disconnect_count & 8) == 0 {
 512                 handle_bs_raa!();
 513
 514                 if disconnect_count & !disconnect_flags > 3 {
 515                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
 516
 517                         assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
 518                         assert!(bs_resp.1.is_none());
 519
 520                         assert!(as_resp.2.unwrap() == as_commitment_update);
 521                         assert!(bs_resp.2.is_none());
 522
 523                         assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
 524                 }
 525
 526                 handle_initial_raa!();
 527
 528                 if disconnect_count & !disconnect_flags > 4 {
 529                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
 530
 531                         assert!(as_resp.1.is_none());
 532                         assert!(bs_resp.1.is_none());
 533
 534                         assert!(as_resp.2.unwrap() == as_commitment_update);
 535                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
 536                 }
 537         } else {
 538                 handle_initial_raa!();
 539
 540                 if disconnect_count & !disconnect_flags > 3 {
 541                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
 542
 543                         assert!(as_resp.1.is_none());
 544                         assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
 545
 546                         assert!(as_resp.2.is_none());
 547                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
 548
 549                         assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
 550                 }
 551
 552                 handle_bs_raa!();
 553
 554                 if disconnect_count & !disconnect_flags > 4 {
 555                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
 556
 557                         assert!(as_resp.1.is_none());
 558                         assert!(bs_resp.1.is_none());
 559
 560                         assert!(as_resp.2.unwrap() == as_commitment_update);
 561                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
 562                 }
 563         }
 564
 565         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
 566         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 567         // No commitment_signed so get_event_msg's assert(len == 1) passes
 568         check_added_monitors!(nodes[0], 1);
 569
 570         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
 571         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 572         // No commitment_signed so get_event_msg's assert(len == 1) passes
 573         check_added_monitors!(nodes[1], 1);
 574
 575         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
 576         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 577         check_added_monitors!(nodes[1], 1);
 578
 579         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
 580         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 581         check_added_monitors!(nodes[0], 1);
 582
 583         expect_pending_htlcs_forwardable!(nodes[1]);
 584
 585         let events_5 = nodes[1].node.get_and_clear_pending_events();
 586         assert_eq!(events_5.len(), 1);
 587         match events_5[0] {
 588                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
 589                         assert_eq!(payment_hash_2, *payment_hash);
 590                         assert_eq!(amt, 1000000);
 591                         match &purpose {
 592                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
 593                                         assert!(payment_preimage.is_none());
 594                                         assert_eq!(payment_secret_2, *payment_secret);
 595                                 },
 596                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
 597                         }
 598                 },
 599                 _ => panic!("Unexpected event"),
 600         }
 601
 602         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
 603 }
 604
 605 #[test]
 606 fn test_monitor_temporary_update_fail_a() {
 607         do_test_monitor_temporary_update_fail(0);
 608         do_test_monitor_temporary_update_fail(1);
 609         do_test_monitor_temporary_update_fail(2);
 610         do_test_monitor_temporary_update_fail(3);
 611         do_test_monitor_temporary_update_fail(4);
 612         do_test_monitor_temporary_update_fail(5);
 613 }
 614
 615 #[test]
 616 fn test_monitor_temporary_update_fail_b() {
 617         do_test_monitor_temporary_update_fail(2 | 8);
 618         do_test_monitor_temporary_update_fail(3 | 8);
 619         do_test_monitor_temporary_update_fail(4 | 8);
 620         do_test_monitor_temporary_update_fail(5 | 8);
 621 }
 622
 623 #[test]
 624 fn test_monitor_temporary_update_fail_c() {
 625         do_test_monitor_temporary_update_fail(1 | 16);
 626         do_test_monitor_temporary_update_fail(2 | 16);
 627         do_test_monitor_temporary_update_fail(3 | 16);
 628         do_test_monitor_temporary_update_fail(2 | 8 | 16);
 629         do_test_monitor_temporary_update_fail(3 | 8 | 16);
 630 }
 631
 632 #[test]
 633 fn test_monitor_update_fail_cs() {
 634         // Tests handling of a monitor update failure when processing an incoming commitment_signed
 635         let chanmon_cfgs = create_chanmon_cfgs(2);
 636         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 637         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 638         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 639         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
 640
 641         let (route, our_payment_hash, payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
 642         {
 643                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 644                 check_added_monitors!(nodes[0], 1);
 645         }
 646
 647         let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
 648         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
 649
 650         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
 651         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
 652         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 653         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
 654         check_added_monitors!(nodes[1], 1);
 655         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 656
 657         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
 658         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
 659         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
 660         check_added_monitors!(nodes[1], 0);
 661         let responses = nodes[1].node.get_and_clear_pending_msg_events();
 662         assert_eq!(responses.len(), 2);
 663
 664         match responses[0] {
 665                 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
 666                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
 667                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
 668                         check_added_monitors!(nodes[0], 1);
 669                 },
 670                 _ => panic!("Unexpected event"),
 671         }
 672         match responses[1] {
 673                 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
 674                         assert!(updates.update_add_htlcs.is_empty());
 675                         assert!(updates.update_fulfill_htlcs.is_empty());
 676                         assert!(updates.update_fail_htlcs.is_empty());
 677                         assert!(updates.update_fail_malformed_htlcs.is_empty());
 678                         assert!(updates.update_fee.is_none());
 679                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
 680
 681                         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
 682                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
 683                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 684                         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
 685                         check_added_monitors!(nodes[0], 1);
 686                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 687                 },
 688                 _ => panic!("Unexpected event"),
 689         }
 690
 691         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
 692         let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
 693         nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
 694         check_added_monitors!(nodes[0], 0);
 695
 696         let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 697         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
 698         check_added_monitors!(nodes[1], 1);
 699
 700         expect_pending_htlcs_forwardable!(nodes[1]);
 701
 702         let events = nodes[1].node.get_and_clear_pending_events();
 703         assert_eq!(events.len(), 1);
 704         match events[0] {
 705                 Event::PaymentReceived { payment_hash, ref purpose, amt } => {
 706                         assert_eq!(payment_hash, our_payment_hash);
 707                         assert_eq!(amt, 1000000);
 708                         match &purpose {
 709                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
 710                                         assert!(payment_preimage.is_none());
 711                                         assert_eq!(our_payment_secret, *payment_secret);
 712                                 },
 713                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
 714                         }
 715                 },
 716                 _ => panic!("Unexpected event"),
 717         };
 718
 719         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
 720 }
 721
 722 #[test]
 723 fn test_monitor_update_fail_no_rebroadcast() {
 724         // Tests handling of a monitor update failure when no message rebroadcasting on
 725         // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
 726         // fuzz tests.
 727         let chanmon_cfgs = create_chanmon_cfgs(2);
 728         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 729         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 730         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 731         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
 732
 733         let (route, our_payment_hash, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
 734         {
 735                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(payment_secret_1)).unwrap();
 736                 check_added_monitors!(nodes[0], 1);
 737         }
 738
 739         let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
 740         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
 741         let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
 742
 743         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
 744         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
 745         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 746         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
 747         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 748         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 749         check_added_monitors!(nodes[1], 1);
 750
 751         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
 752         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
 753         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
 754         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 755         check_added_monitors!(nodes[1], 0);
 756         expect_pending_htlcs_forwardable!(nodes[1]);
 757
 758         let events = nodes[1].node.get_and_clear_pending_events();
 759         assert_eq!(events.len(), 1);
 760         match events[0] {
 761                 Event::PaymentReceived { payment_hash, .. } => {
 762                         assert_eq!(payment_hash, our_payment_hash);
 763                 },
 764                 _ => panic!("Unexpected event"),
 765         }
 766
 767         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
 768 }
 769
 770 #[test]
 771 fn test_monitor_update_raa_while_paused() {
 772         // Tests handling of an RAA while monitor updating has already been marked failed.
 773         // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
 774         let chanmon_cfgs = create_chanmon_cfgs(2);
 775         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 776         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 777         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 778         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
 779
 780         send_payment(&nodes[0], &[&nodes[1]], 5000000);
 781         let (route, our_payment_hash_1, payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
 782         {
 783                 nodes[0].node.send_payment(&route, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
 784                 check_added_monitors!(nodes[0], 1);
 785         }
 786         let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
 787
 788         let (route, our_payment_hash_2, payment_preimage_2, our_payment_secret_2) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000000);
 789         {
 790                 nodes[1].node.send_payment(&route, our_payment_hash_2, &Some(our_payment_secret_2)).unwrap();
 791                 check_added_monitors!(nodes[1], 1);
 792         }
 793         let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
 794
 795         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
 796         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
 797         check_added_monitors!(nodes[1], 1);
 798         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 799
 800         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
 801         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
 802         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
 803         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 804         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
 805         check_added_monitors!(nodes[0], 1);
 806
 807         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
 808         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 809         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented responses to RAA".to_string(), 1);
 810         check_added_monitors!(nodes[0], 1);
 811
 812         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
 813         let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
 814         nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
 815         check_added_monitors!(nodes[0], 0);
 816
 817         let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 818         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
 819         check_added_monitors!(nodes[1], 1);
 820         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 821
 822         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
 823         check_added_monitors!(nodes[1], 1);
 824         let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 825
 826         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
 827         check_added_monitors!(nodes[0], 1);
 828         let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 829
 830         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
 831         check_added_monitors!(nodes[0], 1);
 832         expect_pending_htlcs_forwardable!(nodes[0]);
 833         expect_payment_received!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
 834
 835         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
 836         check_added_monitors!(nodes[1], 1);
 837         expect_pending_htlcs_forwardable!(nodes[1]);
 838         expect_payment_received!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
 839
 840         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
 841         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
 842 }
 843
 844 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
 845         // Tests handling of a monitor update failure when processing an incoming RAA
 846         let chanmon_cfgs = create_chanmon_cfgs(3);
 847         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 848         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 849         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 850         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 851         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 852
 853         // Rebalance a bit so that we can send backwards from 2 to 1.
 854         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
 855
 856         // Route a first payment that we'll fail backwards
 857         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
 858
 859         // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
 860         assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1));
 861         expect_pending_htlcs_forwardable!(nodes[2]);
 862         check_added_monitors!(nodes[2], 1);
 863
 864         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 865         assert!(updates.update_add_htlcs.is_empty());
 866         assert!(updates.update_fulfill_htlcs.is_empty());
 867         assert_eq!(updates.update_fail_htlcs.len(), 1);
 868         assert!(updates.update_fail_malformed_htlcs.is_empty());
 869         assert!(updates.update_fee.is_none());
 870         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
 871
 872         let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
 873         check_added_monitors!(nodes[0], 0);
 874
 875         // While the second channel is AwaitingRAA, forward a second payment to get it into the
 876         // holding cell.
 877         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
 878         {
 879                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
 880                 check_added_monitors!(nodes[0], 1);
 881         }
 882
 883         let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
 884         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
 885         commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
 886
 887         expect_pending_htlcs_forwardable!(nodes[1]);
 888         check_added_monitors!(nodes[1], 0);
 889         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 890
 891         // Now fail monitor updating.
 892         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
 893         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
 894         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 895         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
 896         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 897         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 898         check_added_monitors!(nodes[1], 1);
 899
 900         // Forward a third payment which will also be added to the holding cell, despite the channel
 901         // being paused waiting a monitor update.
 902         let (route, payment_hash_3, _, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
 903         {
 904                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
 905                 check_added_monitors!(nodes[0], 1);
 906         }
 907
 908         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(())); // We succeed in updating the monitor for the first channel
 909         send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
 910         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
 911         commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
 912         check_added_monitors!(nodes[1], 0);
 913
 914         // Call forward_pending_htlcs and check that the new HTLC was simply added to the holding cell
 915         // and not forwarded.
 916         expect_pending_htlcs_forwardable!(nodes[1]);
 917         check_added_monitors!(nodes[1], 0);
 918         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 919
 920         let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
 921                 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
 922                 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
 923                 nodes[2].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
 924                 check_added_monitors!(nodes[2], 1);
 925
 926                 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
 927                 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
 928                 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
 929                 check_added_monitors!(nodes[1], 1);
 930                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 931                 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
 932                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 933                 (Some(payment_preimage_4), Some(payment_hash_4))
 934         } else { (None, None) };
 935
 936         // Restore monitor updating, ensuring we immediately get a fail-back update and a
 937         // update_add update.
 938         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
 939         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
 940         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
 941         check_added_monitors!(nodes[1], 0);
 942         expect_pending_htlcs_forwardable!(nodes[1]);
 943         check_added_monitors!(nodes[1], 1);
 944
 945         let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
 946         if test_ignore_second_cs {
 947                 assert_eq!(events_3.len(), 3);
 948         } else {
 949                 assert_eq!(events_3.len(), 2);
 950         }
 951
 952         // Note that the ordering of the events for different nodes is non-prescriptive, though the
 953         // ordering of the two events that both go to nodes[2] have to stay in the same order.
 954         let messages_a = match events_3.pop().unwrap() {
 955                 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
 956                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
 957                         assert!(updates.update_fulfill_htlcs.is_empty());
 958                         assert_eq!(updates.update_fail_htlcs.len(), 1);
 959                         assert!(updates.update_fail_malformed_htlcs.is_empty());
 960                         assert!(updates.update_add_htlcs.is_empty());
 961                         assert!(updates.update_fee.is_none());
 962                         (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
 963                 },
 964                 _ => panic!("Unexpected event type!"),
 965         };
 966         let raa = if test_ignore_second_cs {
 967                 match events_3.remove(1) {
 968                         MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
 969                                 assert_eq!(node_id, nodes[2].node.get_our_node_id());
 970                                 Some(msg.clone())
 971                         },
 972                         _ => panic!("Unexpected event"),
 973                 }
 974         } else { None };
 975         let send_event_b = SendEvent::from_event(events_3.remove(0));
 976         assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
 977
 978         // Now deliver the new messages...
 979
 980         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
 981         commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
 982         expect_payment_failed!(nodes[0], payment_hash_1, true);
 983
 984         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
 985         let as_cs;
 986         if test_ignore_second_cs {
 987                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
 988                 check_added_monitors!(nodes[2], 1);
 989                 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 990                 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
 991                 check_added_monitors!(nodes[2], 1);
 992                 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 993                 assert!(bs_cs.update_add_htlcs.is_empty());
 994                 assert!(bs_cs.update_fail_htlcs.is_empty());
 995                 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
 996                 assert!(bs_cs.update_fulfill_htlcs.is_empty());
 997                 assert!(bs_cs.update_fee.is_none());
 998
 999                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1000                 check_added_monitors!(nodes[1], 1);
1001                 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1002
1003                 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
1004                 check_added_monitors!(nodes[1], 1);
1005         } else {
1006                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
1007                 check_added_monitors!(nodes[2], 1);
1008
1009                 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
1010                 assert_eq!(bs_revoke_and_commit.len(), 2);
1011                 match bs_revoke_and_commit[0] {
1012                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1013                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1014                                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
1015                                 check_added_monitors!(nodes[1], 1);
1016                         },
1017                         _ => panic!("Unexpected event"),
1018                 }
1019
1020                 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1021
1022                 match bs_revoke_and_commit[1] {
1023                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1024                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1025                                 assert!(updates.update_add_htlcs.is_empty());
1026                                 assert!(updates.update_fail_htlcs.is_empty());
1027                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
1028                                 assert!(updates.update_fulfill_htlcs.is_empty());
1029                                 assert!(updates.update_fee.is_none());
1030                                 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1031                                 check_added_monitors!(nodes[1], 1);
1032                         },
1033                         _ => panic!("Unexpected event"),
1034                 }
1035         }
1036
1037         assert_eq!(as_cs.update_add_htlcs.len(), 1);
1038         assert!(as_cs.update_fail_htlcs.is_empty());
1039         assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1040         assert!(as_cs.update_fulfill_htlcs.is_empty());
1041         assert!(as_cs.update_fee.is_none());
1042         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1043
1044
1045         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1046         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1047         check_added_monitors!(nodes[2], 1);
1048         let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1049
1050         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1051         check_added_monitors!(nodes[2], 1);
1052         let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1053
1054         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1055         check_added_monitors!(nodes[1], 1);
1056         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1057
1058         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1059         check_added_monitors!(nodes[1], 1);
1060         let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1061
1062         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1063         check_added_monitors!(nodes[2], 1);
1064         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1065
1066         expect_pending_htlcs_forwardable!(nodes[2]);
1067
1068         let events_6 = nodes[2].node.get_and_clear_pending_events();
1069         assert_eq!(events_6.len(), 2);
1070         match events_6[0] {
1071                 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1072                 _ => panic!("Unexpected event"),
1073         };
1074         match events_6[1] {
1075                 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1076                 _ => panic!("Unexpected event"),
1077         };
1078
1079         if test_ignore_second_cs {
1080                 expect_pending_htlcs_forwardable!(nodes[1]);
1081                 check_added_monitors!(nodes[1], 1);
1082
1083                 send_event = SendEvent::from_node(&nodes[1]);
1084                 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1085                 assert_eq!(send_event.msgs.len(), 1);
1086                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1087                 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1088
1089                 expect_pending_htlcs_forwardable!(nodes[0]);
1090
1091                 let events_9 = nodes[0].node.get_and_clear_pending_events();
1092                 assert_eq!(events_9.len(), 1);
1093                 match events_9[0] {
1094                         Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1095                         _ => panic!("Unexpected event"),
1096                 };
1097                 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1098         }
1099
1100         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1101 }
1102
1103 #[test]
1104 fn test_monitor_update_fail_raa() {
1105         do_test_monitor_update_fail_raa(false);
1106         do_test_monitor_update_fail_raa(true);
1107 }
1108
1109 #[test]
1110 fn test_monitor_update_fail_reestablish() {
1111         // Simple test for message retransmission after monitor update failure on
1112         // channel_reestablish generating a monitor update (which comes from freeing holding cell
1113         // HTLCs).
1114         let chanmon_cfgs = create_chanmon_cfgs(3);
1115         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1116         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1117         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1118         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1119         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1120
1121         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1122
1123         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1124         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1125
1126         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1127         check_added_monitors!(nodes[2], 1);
1128         let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1129         assert!(updates.update_add_htlcs.is_empty());
1130         assert!(updates.update_fail_htlcs.is_empty());
1131         assert!(updates.update_fail_malformed_htlcs.is_empty());
1132         assert!(updates.update_fee.is_none());
1133         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1134         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1135         expect_payment_forwarded!(nodes[1], Some(1000), false);
1136         check_added_monitors!(nodes[1], 1);
1137         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1138         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1139
1140         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1141         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1142         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1143
1144         let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1145         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1146
1147         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1148
1149         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1150         assert_eq!(
1151                 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1152                         .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1153
1154         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1155         check_added_monitors!(nodes[1], 1);
1156
1157         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1158         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1159
1160         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1161         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1162
1163         assert!(as_reestablish == get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id()));
1164         assert!(bs_reestablish == get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()));
1165
1166         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1167         assert_eq!(
1168                 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1169                         .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1170
1171         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1172         check_added_monitors!(nodes[1], 0);
1173         assert_eq!(
1174                 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1175                         .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1176
1177         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1178         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1179         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1180         check_added_monitors!(nodes[1], 0);
1181
1182         updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1183         assert!(updates.update_add_htlcs.is_empty());
1184         assert!(updates.update_fail_htlcs.is_empty());
1185         assert!(updates.update_fail_malformed_htlcs.is_empty());
1186         assert!(updates.update_fee.is_none());
1187         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1188         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1189         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1190
1191         let events = nodes[0].node.get_and_clear_pending_events();
1192         assert_eq!(events.len(), 1);
1193         match events[0] {
1194                 Event::PaymentSent { payment_preimage, .. } => assert_eq!(payment_preimage, our_payment_preimage),
1195                 _ => panic!("Unexpected event"),
1196         }
1197 }
1198
1199 #[test]
1200 fn raa_no_response_awaiting_raa_state() {
1201         // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1202         // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1203         // in question (assuming it intends to respond with a CS after monitor updating is restored).
1204         // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1205         let chanmon_cfgs = create_chanmon_cfgs(2);
1206         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1207         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1208         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1209         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1210
1211         let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1212         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1213         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1214
1215         // Queue up two payments - one will be delivered right away, one immediately goes into the
1216         // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1217         // immediately after a CS. By setting failing the monitor update failure from the CS (which
1218         // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1219         // generation during RAA while in monitor-update-failed state.
1220         {
1221                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1222                 check_added_monitors!(nodes[0], 1);
1223                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1224                 check_added_monitors!(nodes[0], 0);
1225         }
1226
1227         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1228         assert_eq!(events.len(), 1);
1229         let payment_event = SendEvent::from_event(events.pop().unwrap());
1230         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1231         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1232         check_added_monitors!(nodes[1], 1);
1233
1234         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1235         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1236         check_added_monitors!(nodes[0], 1);
1237         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1238         assert_eq!(events.len(), 1);
1239         let payment_event = SendEvent::from_event(events.pop().unwrap());
1240
1241         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1242         check_added_monitors!(nodes[0], 1);
1243         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1244
1245         // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1246         // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1247         // then restore channel monitor updates.
1248         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1249         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1250         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1251         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1252         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1253         check_added_monitors!(nodes[1], 1);
1254
1255         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1256         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1257         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented responses to RAA".to_string(), 1);
1258         check_added_monitors!(nodes[1], 1);
1259
1260         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1261         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1262         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1263         // nodes[1] should be AwaitingRAA here!
1264         check_added_monitors!(nodes[1], 0);
1265         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1266         expect_pending_htlcs_forwardable!(nodes[1]);
1267         expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1268
1269         // We send a third payment here, which is somewhat of a redundant test, but the
1270         // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1271         // commitment transaction states) whereas here we can explicitly check for it.
1272         {
1273                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1274                 check_added_monitors!(nodes[0], 0);
1275                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1276         }
1277         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1278         check_added_monitors!(nodes[0], 1);
1279         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1280         assert_eq!(events.len(), 1);
1281         let payment_event = SendEvent::from_event(events.pop().unwrap());
1282
1283         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
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_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1288         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1289         check_added_monitors!(nodes[1], 1);
1290         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1291
1292         // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1293         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1294         check_added_monitors!(nodes[1], 1);
1295         expect_pending_htlcs_forwardable!(nodes[1]);
1296         expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1297         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1298
1299         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1300         check_added_monitors!(nodes[0], 1);
1301
1302         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1303         check_added_monitors!(nodes[0], 1);
1304         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1305
1306         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1307         check_added_monitors!(nodes[1], 1);
1308         expect_pending_htlcs_forwardable!(nodes[1]);
1309         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1310
1311         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1312         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1313         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1314 }
1315
1316 #[test]
1317 fn claim_while_disconnected_monitor_update_fail() {
1318         // Test for claiming a payment while disconnected and then having the resulting
1319         // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1320         // contrived case for nodes with network instability.
1321         // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1322         // code introduced a regression in this test (specifically, this caught a removal of the
1323         // channel_reestablish handling ensuring the order was sensical given the messages used).
1324         let chanmon_cfgs = create_chanmon_cfgs(2);
1325         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1326         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1327         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1328         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1329
1330         // Forward a payment for B to claim
1331         let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1332
1333         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1334         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1335
1336         assert!(nodes[1].node.claim_funds(payment_preimage_1));
1337         check_added_monitors!(nodes[1], 1);
1338
1339         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1340         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1341
1342         let as_reconnect = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1343         let bs_reconnect = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1344
1345         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1346         let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1347
1348         // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1349         // update.
1350         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1351
1352         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1353         let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1354         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1355         check_added_monitors!(nodes[1], 1);
1356         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1357
1358         // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1359         // the monitor still failed
1360         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1361         {
1362                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1363                 check_added_monitors!(nodes[0], 1);
1364         }
1365
1366         let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1367         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1368         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1369         check_added_monitors!(nodes[1], 1);
1370         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1371         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1372         // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1373         // until we've channel_monitor_update'd and updated for the new commitment transaction.
1374
1375         // Now un-fail the monitor, which will result in B sending its original commitment update,
1376         // receiving the commitment update from A, and the resulting commitment dances.
1377         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1378         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1379         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1380         check_added_monitors!(nodes[1], 0);
1381
1382         let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1383         assert_eq!(bs_msgs.len(), 2);
1384
1385         match bs_msgs[0] {
1386                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1387                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1388                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1389                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1390                         check_added_monitors!(nodes[0], 1);
1391
1392                         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1393                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1394                         check_added_monitors!(nodes[1], 1);
1395                 },
1396                 _ => panic!("Unexpected event"),
1397         }
1398
1399         match bs_msgs[1] {
1400                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1401                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1402                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1403                         check_added_monitors!(nodes[0], 1);
1404                 },
1405                 _ => panic!("Unexpected event"),
1406         }
1407
1408         let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1409
1410         let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1411         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1412         check_added_monitors!(nodes[0], 1);
1413         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1414
1415         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1416         check_added_monitors!(nodes[1], 1);
1417         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1418         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1419         check_added_monitors!(nodes[1], 1);
1420
1421         expect_pending_htlcs_forwardable!(nodes[1]);
1422         expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1423
1424         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1425         check_added_monitors!(nodes[0], 1);
1426
1427         let events = nodes[0].node.get_and_clear_pending_events();
1428         assert_eq!(events.len(), 1);
1429         match events[0] {
1430                 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
1431                         assert_eq!(*payment_preimage, payment_preimage_1);
1432                         assert_eq!(*payment_hash, payment_hash_1);
1433                 },
1434                 _ => panic!("Unexpected event"),
1435         }
1436
1437         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1438 }
1439
1440 #[test]
1441 fn monitor_failed_no_reestablish_response() {
1442         // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1443         // response to a commitment_signed.
1444         // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1445         // debug_assert!() failure in channel_reestablish handling.
1446         let chanmon_cfgs = create_chanmon_cfgs(2);
1447         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1448         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1449         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1450         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1451
1452         // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1453         // on receipt).
1454         let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1455         {
1456                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1457                 check_added_monitors!(nodes[0], 1);
1458         }
1459
1460         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1461         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1462         assert_eq!(events.len(), 1);
1463         let payment_event = SendEvent::from_event(events.pop().unwrap());
1464         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1465         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1466         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1467         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1468         check_added_monitors!(nodes[1], 1);
1469
1470         // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1471         // is still failing to update monitors.
1472         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1473         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1474
1475         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1476         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1477
1478         let as_reconnect = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1479         let bs_reconnect = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1480
1481         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1482         let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1483         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1484         let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1485
1486         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1487         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1488         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1489         check_added_monitors!(nodes[1], 0);
1490         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1491
1492         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1493         check_added_monitors!(nodes[0], 1);
1494         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1495         check_added_monitors!(nodes[0], 1);
1496
1497         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1498         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1499         check_added_monitors!(nodes[1], 1);
1500
1501         expect_pending_htlcs_forwardable!(nodes[1]);
1502         expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1503
1504         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1505 }
1506
1507 #[test]
1508 fn first_message_on_recv_ordering() {
1509         // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1510         // messages, we're willing to flip the order of response messages if neccessary in resposne to
1511         // a commitment_signed which needs to send an RAA first.
1512         // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1513         // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1514         // response. To do this, we start routing two payments, with the final RAA for the first being
1515         // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1516         // have no pending response but will want to send a RAA/CS (with the updates for the second
1517         // payment applied).
1518         // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1519         let chanmon_cfgs = create_chanmon_cfgs(2);
1520         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1521         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1522         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1523         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1524
1525         // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1526         // can deliver it and fail the monitor update.
1527         let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1528         {
1529                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1530                 check_added_monitors!(nodes[0], 1);
1531         }
1532
1533         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1534         assert_eq!(events.len(), 1);
1535         let payment_event = SendEvent::from_event(events.pop().unwrap());
1536         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1537         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1538         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1539         check_added_monitors!(nodes[1], 1);
1540         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1541
1542         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1543         check_added_monitors!(nodes[0], 1);
1544         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1545         check_added_monitors!(nodes[0], 1);
1546
1547         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1548
1549         // Route the second payment, generating an update_add_htlc/commitment_signed
1550         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1551         {
1552                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1553                 check_added_monitors!(nodes[0], 1);
1554         }
1555         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1556         assert_eq!(events.len(), 1);
1557         let payment_event = SendEvent::from_event(events.pop().unwrap());
1558         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1559
1560         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1561
1562         // Deliver the final RAA for the first payment, which does not require a response. RAAs
1563         // generally require a commitment_signed, so the fact that we're expecting an opposite response
1564         // to the next message also tests resetting the delivery order.
1565         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1566         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1567         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1568         check_added_monitors!(nodes[1], 1);
1569
1570         // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1571         // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1572         // appropriate HTLC acceptance).
1573         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1574         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1575         check_added_monitors!(nodes[1], 1);
1576         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1577         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1578
1579         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1580         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1581         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1582         check_added_monitors!(nodes[1], 0);
1583
1584         expect_pending_htlcs_forwardable!(nodes[1]);
1585         expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1586
1587         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1588         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1589         check_added_monitors!(nodes[0], 1);
1590         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1591         check_added_monitors!(nodes[0], 1);
1592
1593         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1594         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1595         check_added_monitors!(nodes[1], 1);
1596
1597         expect_pending_htlcs_forwardable!(nodes[1]);
1598         expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1599
1600         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1601         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1602 }
1603
1604 #[test]
1605 fn test_monitor_update_fail_claim() {
1606         // Basic test for monitor update failures when processing claim_funds calls.
1607         // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1608         // update to claim the payment. We then send two payments C->B->A, which are held at B.
1609         // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1610         // the payments from C onwards to A.
1611         let chanmon_cfgs = create_chanmon_cfgs(3);
1612         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1613         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1614         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1615         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1616         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1617
1618         // Rebalance a bit so that we can send backwards from 3 to 2.
1619         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1620
1621         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1622
1623         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1624         assert!(nodes[1].node.claim_funds(payment_preimage_1));
1625         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1626         check_added_monitors!(nodes[1], 1);
1627
1628         // Note that at this point there is a pending commitment transaction update for A being held by
1629         // B. Even when we go to send the payment from C through B to A, B will not update this
1630         // already-signed commitment transaction and will instead wait for it to resolve before
1631         // forwarding the payment onwards.
1632
1633         let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1_000_000);
1634         {
1635                 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1636                 check_added_monitors!(nodes[2], 1);
1637         }
1638
1639         // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1640         // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1641         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1642
1643         let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1644         assert_eq!(events.len(), 1);
1645         let payment_event = SendEvent::from_event(events.pop().unwrap());
1646         nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1647         let events = nodes[1].node.get_and_clear_pending_msg_events();
1648         assert_eq!(events.len(), 0);
1649         commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1650
1651         let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1652         nodes[2].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1653         check_added_monitors!(nodes[2], 1);
1654
1655         let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1656         assert_eq!(events.len(), 1);
1657         let payment_event = SendEvent::from_event(events.pop().unwrap());
1658         nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1659         let events = nodes[1].node.get_and_clear_pending_msg_events();
1660         assert_eq!(events.len(), 0);
1661         commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1662
1663         // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1664         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1665         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1666         check_added_monitors!(nodes[1], 0);
1667
1668         let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1669         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1670         commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1671         expect_payment_sent!(nodes[0], payment_preimage_1);
1672
1673         // Get the payment forwards, note that they were batched into one commitment update.
1674         expect_pending_htlcs_forwardable!(nodes[1]);
1675         check_added_monitors!(nodes[1], 1);
1676         let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1677         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1678         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1679         commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1680         expect_pending_htlcs_forwardable!(nodes[0]);
1681
1682         let events = nodes[0].node.get_and_clear_pending_events();
1683         assert_eq!(events.len(), 2);
1684         match events[0] {
1685                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1686                         assert_eq!(payment_hash_2, *payment_hash);
1687                         assert_eq!(1_000_000, amt);
1688                         match &purpose {
1689                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1690                                         assert!(payment_preimage.is_none());
1691                                         assert_eq!(payment_secret_2, *payment_secret);
1692                                 },
1693                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
1694                         }
1695                 },
1696                 _ => panic!("Unexpected event"),
1697         }
1698         match events[1] {
1699                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1700                         assert_eq!(payment_hash_3, *payment_hash);
1701                         assert_eq!(1_000_000, amt);
1702                         match &purpose {
1703                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1704                                         assert!(payment_preimage.is_none());
1705                                         assert_eq!(payment_secret_3, *payment_secret);
1706                                 },
1707                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
1708                         }
1709                 },
1710                 _ => panic!("Unexpected event"),
1711         }
1712 }
1713
1714 #[test]
1715 fn test_monitor_update_on_pending_forwards() {
1716         // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1717         // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1718         // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1719         // from C to A will be pending a forward to A.
1720         let chanmon_cfgs = create_chanmon_cfgs(3);
1721         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1722         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1723         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1724         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1725         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1726
1727         // Rebalance a bit so that we can send backwards from 3 to 1.
1728         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1729
1730         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1731         assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1));
1732         expect_pending_htlcs_forwardable!(nodes[2]);
1733         check_added_monitors!(nodes[2], 1);
1734
1735         let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1736         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1737         commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1738         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1739
1740         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
1741         {
1742                 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1743                 check_added_monitors!(nodes[2], 1);
1744         }
1745
1746         let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1747         assert_eq!(events.len(), 1);
1748         let payment_event = SendEvent::from_event(events.pop().unwrap());
1749         nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1750         commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1751
1752         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1753         expect_pending_htlcs_forwardable!(nodes[1]);
1754         check_added_monitors!(nodes[1], 1);
1755         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1756         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1757
1758         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1759         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1760         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1761         check_added_monitors!(nodes[1], 0);
1762
1763         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1764         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1765         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1766         commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1767
1768         let events = nodes[0].node.get_and_clear_pending_events();
1769         assert_eq!(events.len(), 2);
1770         if let Event::PaymentPathFailed { payment_hash, rejected_by_dest, .. } = events[0] {
1771                 assert_eq!(payment_hash, payment_hash_1);
1772                 assert!(rejected_by_dest);
1773         } else { panic!("Unexpected event!"); }
1774         match events[1] {
1775                 Event::PendingHTLCsForwardable { .. } => { },
1776                 _ => panic!("Unexpected event"),
1777         };
1778         nodes[0].node.process_pending_htlc_forwards();
1779         expect_payment_received!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1780
1781         claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1782 }
1783
1784 #[test]
1785 fn monitor_update_claim_fail_no_response() {
1786         // Test for claim_funds resulting in both a monitor update failure and no message response (due
1787         // to channel being AwaitingRAA).
1788         // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1789         // code was broken.
1790         let chanmon_cfgs = create_chanmon_cfgs(2);
1791         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1792         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1793         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1794         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1795
1796         // Forward a payment for B to claim
1797         let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1798
1799         // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1800         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1801         {
1802                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1803                 check_added_monitors!(nodes[0], 1);
1804         }
1805
1806         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1807         assert_eq!(events.len(), 1);
1808         let payment_event = SendEvent::from_event(events.pop().unwrap());
1809         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1810         let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1811
1812         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1813         assert!(nodes[1].node.claim_funds(payment_preimage_1));
1814         check_added_monitors!(nodes[1], 1);
1815         let events = nodes[1].node.get_and_clear_pending_msg_events();
1816         assert_eq!(events.len(), 0);
1817         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1818
1819         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1820         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1821         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1822         check_added_monitors!(nodes[1], 0);
1823         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1824
1825         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1826         check_added_monitors!(nodes[1], 1);
1827         expect_pending_htlcs_forwardable!(nodes[1]);
1828         expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1829
1830         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1831         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1832         commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1833
1834         let events = nodes[0].node.get_and_clear_pending_events();
1835         assert_eq!(events.len(), 1);
1836         match events[0] {
1837                 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
1838                         assert_eq!(*payment_preimage, payment_preimage_1);
1839                         assert_eq!(*payment_hash, payment_hash_1);
1840                 },
1841                 _ => panic!("Unexpected event"),
1842         }
1843
1844         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1845 }
1846
1847 // confirm_a_first and restore_b_before_conf are wholly unrelated to earlier bools and
1848 // restore_b_before_conf has no meaning if !confirm_a_first
1849 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool) {
1850         // Test that if the monitor update generated by funding_transaction_generated fails we continue
1851         // the channel setup happily after the update is restored.
1852         let chanmon_cfgs = create_chanmon_cfgs(2);
1853         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1854         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1855         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1856
1857         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1858         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
1859         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
1860
1861         let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 43);
1862
1863         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_tx.clone()).unwrap();
1864         check_added_monitors!(nodes[0], 0);
1865
1866         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1867         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1868         let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1869         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1870         check_added_monitors!(nodes[1], 1);
1871
1872         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1873         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()));
1874         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1875         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1876         check_added_monitors!(nodes[0], 1);
1877         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1878         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1879         let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1880         nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
1881         check_added_monitors!(nodes[0], 0);
1882
1883         let events = nodes[0].node.get_and_clear_pending_events();
1884         assert_eq!(events.len(), 0);
1885         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1886         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1887
1888         if confirm_a_first {
1889                 confirm_transaction(&nodes[0], &funding_tx);
1890                 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id()));
1891         } else {
1892                 assert!(!restore_b_before_conf);
1893                 confirm_transaction(&nodes[1], &funding_tx);
1894                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1895         }
1896
1897         // Make sure nodes[1] isn't stupid enough to re-send the FundingLocked on reconnect
1898         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1899         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1900         reconnect_nodes(&nodes[0], &nodes[1], (false, confirm_a_first), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1901         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1902         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1903
1904         if !restore_b_before_conf {
1905                 confirm_transaction(&nodes[1], &funding_tx);
1906                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1907                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1908         }
1909
1910         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1911         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1912         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1913         check_added_monitors!(nodes[1], 0);
1914
1915         let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1916                 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
1917
1918                 confirm_transaction(&nodes[0], &funding_tx);
1919                 let (funding_locked, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1920                 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked))
1921         } else {
1922                 if restore_b_before_conf {
1923                         confirm_transaction(&nodes[1], &funding_tx);
1924                 }
1925                 let (funding_locked, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1926                 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &funding_locked))
1927         };
1928         for node in nodes.iter() {
1929                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
1930                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1931                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1932         }
1933
1934         send_payment(&nodes[0], &[&nodes[1]], 8000000);
1935         close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1936         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
1937         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1938 }
1939
1940 #[test]
1941 fn during_funding_monitor_fail() {
1942         do_during_funding_monitor_fail(true, true);
1943         do_during_funding_monitor_fail(true, false);
1944         do_during_funding_monitor_fail(false, false);
1945 }
1946
1947 #[test]
1948 fn test_path_paused_mpp() {
1949         // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1950         // monitor update
1951         let chanmon_cfgs = create_chanmon_cfgs(4);
1952         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1953         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1954         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1955
1956         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1957         let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
1958         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1959         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1960
1961         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
1962
1963         // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1964         let path = route.paths[0].clone();
1965         route.paths.push(path);
1966         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
1967         route.paths[0][0].short_channel_id = chan_1_id;
1968         route.paths[0][1].short_channel_id = chan_3_id;
1969         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
1970         route.paths[1][0].short_channel_id = chan_2_ann.contents.short_channel_id;
1971         route.paths[1][1].short_channel_id = chan_4_id;
1972
1973         // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
1974         // (for the path 0 -> 2 -> 3) fails.
1975         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1976         *nodes[0].chain_monitor.next_update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1977
1978         // Now check that we get the right return value, indicating that the first path succeeded but
1979         // the second got a MonitorUpdateFailed err. This implies PaymentSendFailure::PartialFailure as
1980         // some paths succeeded, preventing retry.
1981         if let Err(PaymentSendFailure::PartialFailure(results)) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)) {
1982                 assert_eq!(results.len(), 2);
1983                 if let Ok(()) = results[0] {} else { panic!(); }
1984                 if let Err(APIError::MonitorUpdateFailed) = results[1] {} else { panic!(); }
1985         } else { panic!(); }
1986         check_added_monitors!(nodes[0], 2);
1987         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1988
1989         // Pass the first HTLC of the payment along to nodes[3].
1990         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1991         assert_eq!(events.len(), 1);
1992         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false, None);
1993
1994         // And check that, after we successfully update the monitor for chan_2 we can pass the second
1995         // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
1996         let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
1997         nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
1998         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1999         assert_eq!(events.len(), 1);
2000         pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true, None);
2001
2002         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
2003 }
2004
2005 #[test]
2006 fn test_pending_update_fee_ack_on_reconnect() {
2007         // In early versions of our automated fee update patch, nodes did not correctly use the
2008         // previous channel feerate after sending an undelivered revoke_and_ack when re-sending an
2009         // undelivered commitment_signed.
2010         //
2011         // B sends A new HTLC + CS, not delivered
2012         // A sends B update_fee + CS
2013         // B receives the CS and sends RAA, previously causing B to lock in the new feerate
2014         // reconnect
2015         // B resends initial CS, using the original fee
2016
2017         let chanmon_cfgs = create_chanmon_cfgs(2);
2018         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2019         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2020         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2021
2022         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2023         send_payment(&nodes[0], &[&nodes[1]], 100_000_00);
2024
2025         let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[1], nodes[0], 1_000_000);
2026         nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
2027         check_added_monitors!(nodes[1], 1);
2028         let bs_initial_send_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2029         // bs_initial_send_msgs are not delivered until they are re-generated after reconnect
2030
2031         {
2032                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2033                 *feerate_lock *= 2;
2034         }
2035         nodes[0].node.timer_tick_occurred();
2036         check_added_monitors!(nodes[0], 1);
2037         let as_update_fee_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2038         assert!(as_update_fee_msgs.update_fee.is_some());
2039
2040         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_update_fee_msgs.update_fee.as_ref().unwrap());
2041         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_fee_msgs.commitment_signed);
2042         check_added_monitors!(nodes[1], 1);
2043         let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2044         // bs_first_raa is not delivered until it is re-generated after reconnect
2045
2046         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2047         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2048
2049         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
2050         let as_connect_msg = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
2051         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
2052         let bs_connect_msg = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
2053
2054         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2055         let bs_resend_msgs = nodes[1].node.get_and_clear_pending_msg_events();
2056         assert_eq!(bs_resend_msgs.len(), 3);
2057         if let MessageSendEvent::UpdateHTLCs { ref updates, .. } = bs_resend_msgs[0] {
2058                 assert_eq!(*updates, bs_initial_send_msgs);
2059         } else { panic!(); }
2060         if let MessageSendEvent::SendRevokeAndACK { ref msg, .. } = bs_resend_msgs[1] {
2061                 assert_eq!(*msg, bs_first_raa);
2062         } else { panic!(); }
2063         if let MessageSendEvent::SendChannelUpdate { .. } = bs_resend_msgs[2] { } else { panic!(); }
2064
2065         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2066         get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
2067
2068         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.update_add_htlcs[0]);
2069         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.commitment_signed);
2070         check_added_monitors!(nodes[0], 1);
2071         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()));
2072         check_added_monitors!(nodes[1], 1);
2073         let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()).commitment_signed;
2074
2075         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2076         check_added_monitors!(nodes[0], 1);
2077         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);
2078         check_added_monitors!(nodes[1], 1);
2079         let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2080
2081         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2082         check_added_monitors!(nodes[0], 1);
2083         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2084         check_added_monitors!(nodes[0], 1);
2085
2086         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()));
2087         check_added_monitors!(nodes[1], 1);
2088
2089         expect_pending_htlcs_forwardable!(nodes[0]);
2090         expect_payment_received!(nodes[0], payment_hash, payment_secret, 1_000_000);
2091
2092         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
2093 }
2094
2095 fn do_update_fee_resend_test(deliver_update: bool, parallel_updates: bool) {
2096         // In early versions we did not handle resending of update_fee on reconnect correctly. The
2097         // chanmon_consistency fuzz target, of course, immediately found it, but we test a few cases
2098         // explicitly here.
2099         let chanmon_cfgs = create_chanmon_cfgs(2);
2100         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2101         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2102         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2103
2104         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2105         send_payment(&nodes[0], &[&nodes[1]], 1000);
2106
2107         {
2108                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2109                 *feerate_lock += 20;
2110         }
2111         nodes[0].node.timer_tick_occurred();
2112         check_added_monitors!(nodes[0], 1);
2113         let update_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2114         assert!(update_msgs.update_fee.is_some());
2115         if deliver_update {
2116                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2117         }
2118
2119         if parallel_updates {
2120                 {
2121                         let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2122                         *feerate_lock += 20;
2123                 }
2124                 nodes[0].node.timer_tick_occurred();
2125                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2126         }
2127
2128         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2129         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2130
2131         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
2132         let as_connect_msg = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
2133         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
2134         let bs_connect_msg = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
2135
2136         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2137         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
2138         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2139
2140         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2141         let mut as_reconnect_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2142         assert_eq!(as_reconnect_msgs.len(), 2);
2143         if let MessageSendEvent::SendChannelUpdate { .. } = as_reconnect_msgs.pop().unwrap() {} else { panic!(); }
2144         let update_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = as_reconnect_msgs.pop().unwrap()
2145                 { updates } else { panic!(); };
2146         assert!(update_msgs.update_fee.is_some());
2147         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2148         if parallel_updates {
2149                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update_msgs.commitment_signed);
2150                 check_added_monitors!(nodes[1], 1);
2151                 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2152                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2153                 check_added_monitors!(nodes[0], 1);
2154                 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2155
2156                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2157                 check_added_monitors!(nodes[0], 1);
2158                 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2159
2160                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_second_update.update_fee.as_ref().unwrap());
2161                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
2162                 check_added_monitors!(nodes[1], 1);
2163                 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2164
2165                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2166                 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2167                 check_added_monitors!(nodes[1], 1);
2168
2169                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2170                 check_added_monitors!(nodes[0], 1);
2171
2172                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs.commitment_signed);
2173                 check_added_monitors!(nodes[0], 1);
2174                 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2175
2176                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2177                 check_added_monitors!(nodes[1], 1);
2178         } else {
2179                 commitment_signed_dance!(nodes[1], nodes[0], update_msgs.commitment_signed, false);
2180         }
2181
2182         send_payment(&nodes[0], &[&nodes[1]], 1000);
2183 }
2184 #[test]
2185 fn update_fee_resend_test() {
2186         do_update_fee_resend_test(false, false);
2187         do_update_fee_resend_test(true, false);
2188         do_update_fee_resend_test(false, true);
2189         do_update_fee_resend_test(true, true);
2190 }
2191
2192 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2193         // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2194         // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2195         // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2196         // which failed in such a case).
2197         let chanmon_cfgs = create_chanmon_cfgs(2);
2198         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2199         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2200         let persister: test_utils::TestPersister;
2201         let new_chain_monitor: test_utils::TestChainMonitor;
2202         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2203         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2204
2205         let chan_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 15_000_000, 7_000_000_000, InitFeatures::known(), InitFeatures::known()).2;
2206         let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
2207         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2208
2209         // Do a really complicated dance to get an HTLC into the holding cell, with MonitorUpdateFailed
2210         // set but AwaitingRemoteRevoke unset. When this test was written, any attempts to send an HTLC
2211         // while MonitorUpdateFailed is set are immediately failed-backwards. Thus, the only way to get
2212         // an AddHTLC into the holding cell is to add it while AwaitingRemoteRevoke is set but
2213         // MonitorUpdateFailed is unset, and then swap the flags.
2214         //
2215         // We do this by:
2216         //  a) routing a payment from node B to node A,
2217         //  b) sending a payment from node A to node B without delivering any of the generated messages,
2218         //     putting node A in AwaitingRemoteRevoke,
2219         //  c) sending a second payment from node A to node B, which is immediately placed in the
2220         //     holding cell,
2221         //  d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2222         //     when we try to persist the payment preimage,
2223         //  e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2224         //     clearing AwaitingRemoteRevoke on node A.
2225         //
2226         // Note that because, at the end, MonitorUpdateFailed is still set, the HTLC generated in (c)
2227         // will not be freed from the holding cell.
2228         let (payment_preimage_0, _, _) = route_payment(&nodes[1], &[&nodes[0]], 100000);
2229
2230         nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
2231         check_added_monitors!(nodes[0], 1);
2232         let send = SendEvent::from_node(&nodes[0]);
2233         assert_eq!(send.msgs.len(), 1);
2234
2235         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
2236         check_added_monitors!(nodes[0], 0);
2237
2238         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2239         assert!(nodes[0].node.claim_funds(payment_preimage_0));
2240         check_added_monitors!(nodes[0], 1);
2241
2242         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2243         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2244         check_added_monitors!(nodes[1], 1);
2245
2246         let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2247
2248         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2249         check_added_monitors!(nodes[0], 1);
2250
2251         if disconnect {
2252                 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2253                 // disconnect the peers. Note that the fuzzer originally found this issue because
2254                 // deserializing a ChannelManager in this state causes an assertion failure.
2255                 if reload_a {
2256                         let nodes_0_serialized = nodes[0].node.encode();
2257                         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
2258                         get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
2259
2260                         persister = test_utils::TestPersister::new();
2261                         let keys_manager = &chanmon_cfgs[0].keys_manager;
2262                         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
2263                         nodes[0].chain_monitor = &new_chain_monitor;
2264                         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
2265                         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
2266                                 &mut chan_0_monitor_read, keys_manager).unwrap();
2267                         assert!(chan_0_monitor_read.is_empty());
2268
2269                         let mut nodes_0_read = &nodes_0_serialized[..];
2270                         let config = UserConfig::default();
2271                         nodes_0_deserialized = {
2272                                 let mut channel_monitors = HashMap::new();
2273                                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
2274                                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
2275                                         default_config: config,
2276                                         keys_manager,
2277                                         fee_estimator: node_cfgs[0].fee_estimator,
2278                                         chain_monitor: nodes[0].chain_monitor,
2279                                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
2280                                         logger: nodes[0].logger,
2281                                         channel_monitors,
2282                                 }).unwrap().1
2283                         };
2284                         nodes[0].node = &nodes_0_deserialized;
2285                         assert!(nodes_0_read.is_empty());
2286
2287                         nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0.clone(), chan_0_monitor).unwrap();
2288                         check_added_monitors!(nodes[0], 1);
2289                 } else {
2290                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2291                 }
2292                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2293
2294                 // Now reconnect the two
2295                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2296                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2297                 assert_eq!(reestablish_1.len(), 1);
2298                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2299                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2300                 assert_eq!(reestablish_2.len(), 1);
2301
2302                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2303                 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2304                 check_added_monitors!(nodes[1], 0);
2305
2306                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2307                 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2308
2309                 assert!(resp_0.0.is_none());
2310                 assert!(resp_0.1.is_none());
2311                 assert!(resp_0.2.is_none());
2312                 assert!(resp_1.0.is_none());
2313                 assert!(resp_1.1.is_none());
2314
2315                 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2316                 // moment).
2317                 if let Some(pending_cs) = resp_1.2 {
2318                         assert!(pending_cs.update_add_htlcs.is_empty());
2319                         assert!(pending_cs.update_fail_htlcs.is_empty());
2320                         assert!(pending_cs.update_fulfill_htlcs.is_empty());
2321                         assert_eq!(pending_cs.commitment_signed, cs);
2322                 } else { panic!(); }
2323
2324                 // There should be no monitor updates as we are still pending awaiting a failed one.
2325                 check_added_monitors!(nodes[0], 0);
2326                 check_added_monitors!(nodes[1], 0);
2327         }
2328
2329         // If we finish updating the monitor, we should free the holding cell right away (this did
2330         // not occur prior to #756).
2331         *nodes[0].chain_monitor.update_ret.lock().unwrap() = None;
2332         let (funding_txo, mon_id) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2333         nodes[0].node.channel_monitor_updated(&funding_txo, mon_id);
2334
2335         // New outbound messages should be generated immediately upon a call to
2336         // get_and_clear_pending_msg_events (but not before).
2337         check_added_monitors!(nodes[0], 0);
2338         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2339         check_added_monitors!(nodes[0], 1);
2340         assert_eq!(events.len(), 1);
2341
2342         // Deliver the pending in-flight CS
2343         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2344         check_added_monitors!(nodes[0], 1);
2345
2346         let commitment_msg = match events.pop().unwrap() {
2347                 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2348                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
2349                         assert!(updates.update_fail_htlcs.is_empty());
2350                         assert!(updates.update_fail_malformed_htlcs.is_empty());
2351                         assert!(updates.update_fee.is_none());
2352                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2353                         nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2354                         expect_payment_sent!(nodes[1], payment_preimage_0);
2355                         assert_eq!(updates.update_add_htlcs.len(), 1);
2356                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2357                         updates.commitment_signed
2358                 },
2359                 _ => panic!("Unexpected event type!"),
2360         };
2361
2362         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2363         check_added_monitors!(nodes[1], 1);
2364
2365         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2366         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2367         expect_pending_htlcs_forwardable!(nodes[1]);
2368         expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2369         check_added_monitors!(nodes[1], 1);
2370
2371         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
2372
2373         expect_pending_htlcs_forwardable!(nodes[1]);
2374         expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2375
2376         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2377         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2378 }
2379 #[test]
2380 fn channel_holding_cell_serialize() {
2381         do_channel_holding_cell_serialize(true, true);
2382         do_channel_holding_cell_serialize(true, false);
2383         do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2384 }
2385
2386 #[derive(PartialEq)]
2387 enum HTLCStatusAtDupClaim {
2388         Received,
2389         HoldingCell,
2390         Cleared,
2391 }
2392 fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_fails: bool) {
2393         // When receiving an update_fulfill_htlc message, we immediately forward the claim backwards
2394         // along the payment path before waiting for a full commitment_signed dance. This is great, but
2395         // can cause duplicative claims if a node sends an update_fulfill_htlc message, disconnects,
2396         // reconnects, and then has to re-send its update_fulfill_htlc message again.
2397         // In previous code, we didn't handle the double-claim correctly, spuriously closing the
2398         // channel on which the inbound HTLC was received.
2399         let chanmon_cfgs = create_chanmon_cfgs(3);
2400         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2401         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2402         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2403
2404         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2405         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;
2406
2407         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
2408
2409         let mut as_raa = None;
2410         if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2411                 // In order to get the HTLC claim into the holding cell at nodes[1], we need nodes[1] to be
2412                 // awaiting a remote revoke_and_ack from nodes[0].
2413                 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
2414                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
2415                 check_added_monitors!(nodes[0], 1);
2416
2417                 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
2418                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
2419                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
2420                 check_added_monitors!(nodes[1], 1);
2421
2422                 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2423                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2424                 check_added_monitors!(nodes[0], 1);
2425                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
2426                 check_added_monitors!(nodes[0], 1);
2427
2428                 as_raa = Some(get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2429         }
2430
2431         let fulfill_msg = msgs::UpdateFulfillHTLC {
2432                 channel_id: chan_2,
2433                 htlc_id: 0,
2434                 payment_preimage,
2435         };
2436         if second_fails {
2437                 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash));
2438                 expect_pending_htlcs_forwardable!(nodes[2]);
2439                 check_added_monitors!(nodes[2], 1);
2440                 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2441         } else {
2442                 assert!(nodes[2].node.claim_funds(payment_preimage));
2443                 check_added_monitors!(nodes[2], 1);
2444                 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2445                 assert_eq!(cs_updates.update_fulfill_htlcs.len(), 1);
2446                 // Check that the message we're about to deliver matches the one generated:
2447                 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
2448         }
2449         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
2450         expect_payment_forwarded!(nodes[1], Some(1000), false);
2451         check_added_monitors!(nodes[1], 1);
2452
2453         let mut bs_updates = None;
2454         if htlc_status != HTLCStatusAtDupClaim::HoldingCell {
2455                 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2456                 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2457                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2458                 expect_payment_sent!(nodes[0], payment_preimage);
2459                 if htlc_status == HTLCStatusAtDupClaim::Cleared {
2460                         commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2461                 }
2462         } else {
2463                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2464         }
2465
2466         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
2467         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2468
2469         if second_fails {
2470                 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
2471                 expect_pending_htlcs_forwardable!(nodes[1]);
2472         } else {
2473                 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2474         }
2475
2476         if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2477                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa.unwrap());
2478                 check_added_monitors!(nodes[1], 1);
2479                 expect_pending_htlcs_forwardable_ignore!(nodes[1]); // We finally receive the second payment, but don't claim it
2480
2481                 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2482                 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2483                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2484                 expect_payment_sent!(nodes[0], payment_preimage);
2485         }
2486         if htlc_status != HTLCStatusAtDupClaim::Cleared {
2487                 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2488         }
2489 }
2490
2491 #[test]
2492 fn test_reconnect_dup_htlc_claims() {
2493         do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, false);
2494         do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, false);
2495         do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, false);
2496         do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, true);
2497         do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, true);
2498         do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, true);
2499 }
2500
2501 #[test]
2502 fn test_temporary_error_during_shutdown() {
2503         // Test that temporary failures when updating the monitor's shutdown script delay cooperative
2504         // close.
2505         let mut config = test_default_channel_config();
2506         config.channel_options.commit_upfront_shutdown_pubkey = false;
2507
2508         let chanmon_cfgs = create_chanmon_cfgs(2);
2509         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2510         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
2511         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2512
2513         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2514
2515         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2516         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2517
2518         nodes[0].node.close_channel(&channel_id).unwrap();
2519         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
2520         check_added_monitors!(nodes[1], 1);
2521
2522         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id()));
2523         check_added_monitors!(nodes[0], 1);
2524
2525         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2526
2527         *nodes[0].chain_monitor.update_ret.lock().unwrap() = None;
2528         *nodes[1].chain_monitor.update_ret.lock().unwrap() = None;
2529
2530         let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2531         nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
2532         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()));
2533
2534         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2535
2536         *nodes[1].chain_monitor.update_ret.lock().unwrap() = None;
2537         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2538         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
2539
2540         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()));
2541         let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
2542         let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2543
2544         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_a.unwrap());
2545         let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
2546         assert!(none_b.is_none());
2547         let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2548
2549         assert_eq!(txn_a, txn_b);
2550         assert_eq!(txn_a.len(), 1);
2551         check_spends!(txn_a[0], funding_tx);
2552         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
2553         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
2554 }
2555
2556 #[test]
2557 fn test_permanent_error_during_sending_shutdown() {
2558         // Test that permanent failures when updating the monitor's shutdown script result in a force
2559         // close when initiating a cooperative close.
2560         let mut config = test_default_channel_config();
2561         config.channel_options.commit_upfront_shutdown_pubkey = false;
2562
2563         let chanmon_cfgs = create_chanmon_cfgs(2);
2564         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2565         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
2566         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2567
2568         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
2569         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::PermanentFailure));
2570
2571         assert!(nodes[0].node.close_channel(&channel_id).is_ok());
2572         check_closed_broadcast!(nodes[0], true);
2573         check_added_monitors!(nodes[0], 2);
2574         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2575 }
2576
2577 #[test]
2578 fn test_permanent_error_during_handling_shutdown() {
2579         // Test that permanent failures when updating the monitor's shutdown script result in a force
2580         // close when handling a cooperative close.
2581         let mut config = test_default_channel_config();
2582         config.channel_options.commit_upfront_shutdown_pubkey = false;
2583
2584         let chanmon_cfgs = create_chanmon_cfgs(2);
2585         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2586         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
2587         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2588
2589         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
2590         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::PermanentFailure));
2591
2592         assert!(nodes[0].node.close_channel(&channel_id).is_ok());
2593         let shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
2594         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &shutdown);
2595         check_closed_broadcast!(nodes[1], true);
2596         check_added_monitors!(nodes[1], 2);
2597         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2598 }
2599
2600 #[test]
2601 fn double_temp_error() {
2602         // Test that it's OK to have multiple `ChainMonitor::update_channel` calls fail in a row.
2603         let chanmon_cfgs = create_chanmon_cfgs(2);
2604         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2605         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2606         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2607
2608         let (_, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2609
2610         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
2611         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
2612
2613         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2614         // `claim_funds` results in a ChannelMonitorUpdate.
2615         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2616         check_added_monitors!(nodes[1], 1);
2617         let (funding_tx, latest_update_1) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2618
2619         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2620         // Previously, this would've panicked due to a double-call to `Channel::monitor_update_failed`,
2621         // which had some asserts that prevented it from being called twice.
2622         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2623         check_added_monitors!(nodes[1], 1);
2624         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
2625
2626         let (_, latest_update_2) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2627         nodes[1].node.channel_monitor_updated(&funding_tx, latest_update_1);
2628         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2629         check_added_monitors!(nodes[1], 0);
2630         nodes[1].node.channel_monitor_updated(&funding_tx, latest_update_2);
2631
2632         // Complete the first HTLC.
2633         let events = nodes[1].node.get_and_clear_pending_msg_events();
2634         assert_eq!(events.len(), 1);
2635         let (update_fulfill_1, commitment_signed_b1, node_id) = {
2636                 match &events[0] {
2637                         &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 } } => {
2638                                 assert!(update_add_htlcs.is_empty());
2639                                 assert_eq!(update_fulfill_htlcs.len(), 1);
2640                                 assert!(update_fail_htlcs.is_empty());
2641                                 assert!(update_fail_malformed_htlcs.is_empty());
2642                                 assert!(update_fee.is_none());
2643                                 (update_fulfill_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2644                         },
2645                         _ => panic!("Unexpected event"),
2646                 }
2647         };
2648         assert_eq!(node_id, nodes[0].node.get_our_node_id());
2649         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_1);
2650         check_added_monitors!(nodes[0], 0);
2651         expect_payment_sent!(nodes[0], payment_preimage_1);
2652         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_b1);
2653         check_added_monitors!(nodes[0], 1);
2654         nodes[0].node.process_pending_htlc_forwards();
2655         let (raa_a1, commitment_signed_a1) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2656         check_added_monitors!(nodes[1], 0);
2657         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2658         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_a1);
2659         check_added_monitors!(nodes[1], 1);
2660         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed_a1);
2661         check_added_monitors!(nodes[1], 1);
2662
2663         // Complete the second HTLC.
2664         let ((update_fulfill_2, commitment_signed_b2), raa_b2) = {
2665                 let events = nodes[1].node.get_and_clear_pending_msg_events();
2666                 assert_eq!(events.len(), 2);
2667                 (match &events[0] {
2668                         MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2669                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2670                                 assert!(updates.update_add_htlcs.is_empty());
2671                                 assert!(updates.update_fail_htlcs.is_empty());
2672                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
2673                                 assert!(updates.update_fee.is_none());
2674                                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2675                                 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2676                         },
2677                         _ => panic!("Unexpected event"),
2678                 },
2679                  match events[1] {
2680                          MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2681                                  assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2682                                  (*msg).clone()
2683                          },
2684                          _ => panic!("Unexpected event"),
2685                  })
2686         };
2687         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_b2);
2688         check_added_monitors!(nodes[0], 1);
2689
2690         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_2);
2691         check_added_monitors!(nodes[0], 0);
2692         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2693         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed_b2, false);
2694         expect_payment_sent!(nodes[0], payment_preimage_2);
2695 }