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