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