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