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

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