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