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