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