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