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