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

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