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