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