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