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

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