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