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