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