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