1 // This file is Copyright its original authors, visible in version control
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
10 //! Functional tests which test the correct handling of ChannelMonitorUpdateStatus returns from
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.
15 use bitcoin::blockdata::block::{Block, BlockHeader};
16 use bitcoin::blockdata::constants::genesis_block;
17 use bitcoin::hash_types::BlockHash;
18 use bitcoin::network::constants::Network;
19 use crate::chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor};
20 use crate::chain::transaction::OutPoint;
21 use crate::chain::{ChannelMonitorUpdateStatus, Listen, Watch};
22 use crate::ln::channelmanager::{self, ChannelManager, RAACommitmentOrder, PaymentSendFailure, PaymentId};
23 use crate::ln::channel::AnnouncementSigsState;
25 use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
26 use crate::util::enforcing_trait_impls::EnforcingSigner;
27 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason, HTLCDestination};
28 use crate::util::errors::APIError;
29 use crate::util::ser::{ReadableArgs, Writeable};
30 use crate::util::test_utils::TestBroadcaster;
32 use crate::ln::functional_test_utils::*;
34 use crate::util::test_utils;
37 use bitcoin::hashes::Hash;
38 use bitcoin::TxMerkleNode;
39 use crate::prelude::*;
40 use crate::sync::{Arc, Mutex};
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, channelmanager::provided_init_features(), channelmanager::provided_init_features());
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);
56 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
57 assert_eq!(events_1.len(), 2);
59 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
60 _ => panic!("Unexpected event"),
63 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
64 _ => panic!("Unexpected event"),
67 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
69 // TODO: Once we hit the chain with the failure transaction we should check that we get a
70 // PaymentPathFailed event
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() });
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);
86 // Create some initial channel
87 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
88 let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
90 // Rebalance the network to generate htlc in the two directions
91 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
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);
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])),
111 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
112 let mut w = test_utils::TestVecWriter(Vec::new());
113 monitor.write(&mut w).unwrap();
114 let new_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
115 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
116 assert!(new_monitor == *monitor);
117 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
118 assert_eq!(chain_mon.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
121 let header = BlockHeader {
123 prev_blockhash: BlockHash::all_zeros(),
124 merkle_root: TxMerkleNode::all_zeros(),
129 chain_mon.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
131 // Set the persister's return value to be a InProgress.
132 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
134 // Try to update ChannelMonitor
135 nodes[1].node.claim_funds(preimage);
136 expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
137 check_added_monitors!(nodes[1], 1);
139 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
140 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
141 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
142 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2) {
143 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
144 // Check that even though the persister is returning a InProgress,
145 // because the update is bogus, ultimately the error that's returned
146 // should be a PermanentFailure.
147 if let ChannelMonitorUpdateStatus::PermanentFailure = chain_mon.chain_monitor.update_channel(outpoint, update.clone()) {} else { panic!("Expected monitor error to be permanent"); }
148 logger.assert_log_regex("lightning::chain::chainmonitor".to_string(), regex::Regex::new("Persistence of ChannelMonitorUpdate for channel [0-9a-f]* in progress").unwrap(), 1);
149 assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, update), ChannelMonitorUpdateStatus::Completed);
150 } else { assert!(false); }
151 } else { assert!(false); };
153 check_added_monitors!(nodes[0], 1);
154 let events = nodes[0].node.get_and_clear_pending_events();
155 assert_eq!(events.len(), 1);
158 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
159 // Test that we can recover from a simple temporary monitor update failure optionally with
160 // a disconnect in between
161 let chanmon_cfgs = create_chanmon_cfgs(2);
162 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
163 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
164 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
165 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
167 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
169 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
172 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)), false, APIError::MonitorUpdateInProgress, {});
173 check_added_monitors!(nodes[0], 1);
176 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
177 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
178 assert_eq!(nodes[0].node.list_channels().len(), 1);
181 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
182 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
183 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
186 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
187 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
188 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
189 check_added_monitors!(nodes[0], 0);
191 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
192 assert_eq!(events_2.len(), 1);
193 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
194 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
195 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
196 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
198 expect_pending_htlcs_forwardable!(nodes[1]);
200 let events_3 = nodes[1].node.get_and_clear_pending_events();
201 assert_eq!(events_3.len(), 1);
203 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
204 assert_eq!(payment_hash_1, *payment_hash);
205 assert_eq!(amount_msat, 1_000_000);
207 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
208 assert!(payment_preimage.is_none());
209 assert_eq!(payment_secret_1, *payment_secret);
211 _ => panic!("expected PaymentPurpose::InvoicePayment")
214 _ => panic!("Unexpected event"),
217 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
219 // Now set it to failed again...
220 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
222 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
223 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)), false, APIError::MonitorUpdateInProgress, {});
224 check_added_monitors!(nodes[0], 1);
227 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
228 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
229 assert_eq!(nodes[0].node.list_channels().len(), 1);
232 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
233 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
234 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
237 // ...and make sure we can force-close a frozen channel
238 nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
239 check_added_monitors!(nodes[0], 1);
240 check_closed_broadcast!(nodes[0], true);
242 // TODO: Once we hit the chain with the failure transaction we should check that we get a
243 // PaymentPathFailed event
245 assert_eq!(nodes[0].node.list_channels().len(), 0);
246 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
250 fn test_simple_monitor_temporary_update_fail() {
251 do_test_simple_monitor_temporary_update_fail(false);
252 do_test_simple_monitor_temporary_update_fail(true);
255 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
256 let disconnect_flags = 8 | 16;
258 // Test that we can recover from a temporary monitor update failure with some in-flight
259 // HTLCs going on at the same time potentially with some disconnection thrown in.
260 // * First we route a payment, then get a temporary monitor update failure when trying to
261 // route a second payment. We then claim the first payment.
262 // * If disconnect_count is set, we will disconnect at this point (which is likely as
263 // InProgress likely indicates net disconnect which resulted in failing to update the
264 // ChannelMonitor on a watchtower).
265 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
266 // immediately, otherwise we wait disconnect and deliver them via the reconnect
267 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
268 // disconnect_count & !disconnect_flags is 0).
269 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
270 // through message sending, potentially disconnect/reconnecting multiple times based on
271 // disconnect_count, to get the update_fulfill_htlc through.
272 // * We then walk through more message exchanges to get the original update_add_htlc
273 // through, swapping message ordering based on disconnect_count & 8 and optionally
274 // disconnect/reconnecting based on disconnect_count.
275 let chanmon_cfgs = create_chanmon_cfgs(2);
276 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
277 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
278 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
279 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
281 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
283 // Now try to send a second payment which will fail to send
284 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
286 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
287 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)), false, APIError::MonitorUpdateInProgress, {});
288 check_added_monitors!(nodes[0], 1);
291 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
292 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
293 assert_eq!(nodes[0].node.list_channels().len(), 1);
295 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
296 // but nodes[0] won't respond since it is frozen.
297 nodes[1].node.claim_funds(payment_preimage_1);
298 check_added_monitors!(nodes[1], 1);
299 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
301 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
302 assert_eq!(events_2.len(), 1);
303 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
304 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 } } => {
305 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
306 assert!(update_add_htlcs.is_empty());
307 assert_eq!(update_fulfill_htlcs.len(), 1);
308 assert!(update_fail_htlcs.is_empty());
309 assert!(update_fail_malformed_htlcs.is_empty());
310 assert!(update_fee.is_none());
312 if (disconnect_count & 16) == 0 {
313 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
314 let events_3 = nodes[0].node.get_and_clear_pending_events();
315 assert_eq!(events_3.len(), 1);
317 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
318 assert_eq!(*payment_preimage, payment_preimage_1);
319 assert_eq!(*payment_hash, payment_hash_1);
321 _ => panic!("Unexpected event"),
324 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
325 check_added_monitors!(nodes[0], 1);
326 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
329 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
331 _ => panic!("Unexpected event"),
334 if disconnect_count & !disconnect_flags > 0 {
335 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
336 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
339 // Now fix monitor updating...
340 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
341 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
342 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
343 check_added_monitors!(nodes[0], 0);
345 macro_rules! disconnect_reconnect_peers { () => { {
346 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
347 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
349 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
350 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
351 assert_eq!(reestablish_1.len(), 1);
352 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
353 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
354 assert_eq!(reestablish_2.len(), 1);
356 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
357 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
358 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
359 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
361 assert!(as_resp.0.is_none());
362 assert!(bs_resp.0.is_none());
364 (reestablish_1, reestablish_2, as_resp, bs_resp)
367 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
368 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
369 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
371 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
372 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
373 assert_eq!(reestablish_1.len(), 1);
374 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
375 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
376 assert_eq!(reestablish_2.len(), 1);
378 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
379 check_added_monitors!(nodes[0], 0);
380 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
381 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
382 check_added_monitors!(nodes[1], 0);
383 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
385 assert!(as_resp.0.is_none());
386 assert!(bs_resp.0.is_none());
388 assert!(bs_resp.1.is_none());
389 if (disconnect_count & 16) == 0 {
390 assert!(bs_resp.2.is_none());
392 assert!(as_resp.1.is_some());
393 assert!(as_resp.2.is_some());
394 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
396 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
397 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
398 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
399 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
400 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
401 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
403 assert!(as_resp.1.is_none());
405 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
406 let events_3 = nodes[0].node.get_and_clear_pending_events();
407 assert_eq!(events_3.len(), 1);
409 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
410 assert_eq!(*payment_preimage, payment_preimage_1);
411 assert_eq!(*payment_hash, payment_hash_1);
413 _ => panic!("Unexpected event"),
416 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
417 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
418 // No commitment_signed so get_event_msg's assert(len == 1) passes
419 check_added_monitors!(nodes[0], 1);
421 as_resp.1 = Some(as_resp_raa);
425 if disconnect_count & !disconnect_flags > 1 {
426 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
428 if (disconnect_count & 16) == 0 {
429 assert!(reestablish_1 == second_reestablish_1);
430 assert!(reestablish_2 == second_reestablish_2);
432 assert!(as_resp == second_as_resp);
433 assert!(bs_resp == second_bs_resp);
436 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
438 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
439 assert_eq!(events_4.len(), 2);
440 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
441 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
442 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
445 _ => panic!("Unexpected event"),
449 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
451 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
452 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
453 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
454 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
455 check_added_monitors!(nodes[1], 1);
457 if disconnect_count & !disconnect_flags > 2 {
458 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
460 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
461 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
463 assert!(as_resp.2.is_none());
464 assert!(bs_resp.2.is_none());
467 let as_commitment_update;
468 let bs_second_commitment_update;
470 macro_rules! handle_bs_raa { () => {
471 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
472 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
473 assert!(as_commitment_update.update_add_htlcs.is_empty());
474 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
475 assert!(as_commitment_update.update_fail_htlcs.is_empty());
476 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
477 assert!(as_commitment_update.update_fee.is_none());
478 check_added_monitors!(nodes[0], 1);
481 macro_rules! handle_initial_raa { () => {
482 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
483 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
484 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
485 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
486 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
487 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
488 assert!(bs_second_commitment_update.update_fee.is_none());
489 check_added_monitors!(nodes[1], 1);
492 if (disconnect_count & 8) == 0 {
495 if disconnect_count & !disconnect_flags > 3 {
496 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
498 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
499 assert!(bs_resp.1.is_none());
501 assert!(as_resp.2.unwrap() == as_commitment_update);
502 assert!(bs_resp.2.is_none());
504 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
507 handle_initial_raa!();
509 if disconnect_count & !disconnect_flags > 4 {
510 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
512 assert!(as_resp.1.is_none());
513 assert!(bs_resp.1.is_none());
515 assert!(as_resp.2.unwrap() == as_commitment_update);
516 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
519 handle_initial_raa!();
521 if disconnect_count & !disconnect_flags > 3 {
522 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
524 assert!(as_resp.1.is_none());
525 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
527 assert!(as_resp.2.is_none());
528 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
530 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
535 if disconnect_count & !disconnect_flags > 4 {
536 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
538 assert!(as_resp.1.is_none());
539 assert!(bs_resp.1.is_none());
541 assert!(as_resp.2.unwrap() == as_commitment_update);
542 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
546 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
547 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
548 // No commitment_signed so get_event_msg's assert(len == 1) passes
549 check_added_monitors!(nodes[0], 1);
551 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
552 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
553 // No commitment_signed so get_event_msg's assert(len == 1) passes
554 check_added_monitors!(nodes[1], 1);
556 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
557 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
558 check_added_monitors!(nodes[1], 1);
560 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
561 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
562 check_added_monitors!(nodes[0], 1);
563 expect_payment_path_successful!(nodes[0]);
565 expect_pending_htlcs_forwardable!(nodes[1]);
567 let events_5 = nodes[1].node.get_and_clear_pending_events();
568 assert_eq!(events_5.len(), 1);
570 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
571 assert_eq!(payment_hash_2, *payment_hash);
572 assert_eq!(amount_msat, 1_000_000);
574 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
575 assert!(payment_preimage.is_none());
576 assert_eq!(payment_secret_2, *payment_secret);
578 _ => panic!("expected PaymentPurpose::InvoicePayment")
581 _ => panic!("Unexpected event"),
584 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
588 fn test_monitor_temporary_update_fail_a() {
589 do_test_monitor_temporary_update_fail(0);
590 do_test_monitor_temporary_update_fail(1);
591 do_test_monitor_temporary_update_fail(2);
592 do_test_monitor_temporary_update_fail(3);
593 do_test_monitor_temporary_update_fail(4);
594 do_test_monitor_temporary_update_fail(5);
598 fn test_monitor_temporary_update_fail_b() {
599 do_test_monitor_temporary_update_fail(2 | 8);
600 do_test_monitor_temporary_update_fail(3 | 8);
601 do_test_monitor_temporary_update_fail(4 | 8);
602 do_test_monitor_temporary_update_fail(5 | 8);
606 fn test_monitor_temporary_update_fail_c() {
607 do_test_monitor_temporary_update_fail(1 | 16);
608 do_test_monitor_temporary_update_fail(2 | 16);
609 do_test_monitor_temporary_update_fail(3 | 16);
610 do_test_monitor_temporary_update_fail(2 | 8 | 16);
611 do_test_monitor_temporary_update_fail(3 | 8 | 16);
615 fn test_monitor_update_fail_cs() {
616 // Tests handling of a monitor update failure when processing an incoming commitment_signed
617 let chanmon_cfgs = create_chanmon_cfgs(2);
618 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
619 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
620 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
621 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
623 let (route, our_payment_hash, payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
625 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
626 check_added_monitors!(nodes[0], 1);
629 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
630 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
632 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
633 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
634 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
635 check_added_monitors!(nodes[1], 1);
636 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
638 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
639 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
640 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
641 check_added_monitors!(nodes[1], 0);
642 let responses = nodes[1].node.get_and_clear_pending_msg_events();
643 assert_eq!(responses.len(), 2);
646 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
647 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
648 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
649 check_added_monitors!(nodes[0], 1);
651 _ => panic!("Unexpected event"),
654 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
655 assert!(updates.update_add_htlcs.is_empty());
656 assert!(updates.update_fulfill_htlcs.is_empty());
657 assert!(updates.update_fail_htlcs.is_empty());
658 assert!(updates.update_fail_malformed_htlcs.is_empty());
659 assert!(updates.update_fee.is_none());
660 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
662 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
663 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
664 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
665 check_added_monitors!(nodes[0], 1);
666 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
668 _ => panic!("Unexpected event"),
671 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
672 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
673 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
674 check_added_monitors!(nodes[0], 0);
676 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
677 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
678 check_added_monitors!(nodes[1], 1);
680 expect_pending_htlcs_forwardable!(nodes[1]);
682 let events = nodes[1].node.get_and_clear_pending_events();
683 assert_eq!(events.len(), 1);
685 Event::PaymentReceived { payment_hash, ref purpose, amount_msat } => {
686 assert_eq!(payment_hash, our_payment_hash);
687 assert_eq!(amount_msat, 1_000_000);
689 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
690 assert!(payment_preimage.is_none());
691 assert_eq!(our_payment_secret, *payment_secret);
693 _ => panic!("expected PaymentPurpose::InvoicePayment")
696 _ => panic!("Unexpected event"),
699 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
703 fn test_monitor_update_fail_no_rebroadcast() {
704 // Tests handling of a monitor update failure when no message rebroadcasting on
705 // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
707 let chanmon_cfgs = create_chanmon_cfgs(2);
708 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
709 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
710 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
711 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
713 let (route, our_payment_hash, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
715 nodes[0].node.send_payment(&route, our_payment_hash, &Some(payment_secret_1), PaymentId(our_payment_hash.0)).unwrap();
716 check_added_monitors!(nodes[0], 1);
719 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
720 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
721 let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
723 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
724 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
725 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
726 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
727 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
728 check_added_monitors!(nodes[1], 1);
730 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
731 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
732 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
733 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
734 check_added_monitors!(nodes[1], 0);
735 expect_pending_htlcs_forwardable!(nodes[1]);
737 let events = nodes[1].node.get_and_clear_pending_events();
738 assert_eq!(events.len(), 1);
740 Event::PaymentReceived { payment_hash, .. } => {
741 assert_eq!(payment_hash, our_payment_hash);
743 _ => panic!("Unexpected event"),
746 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
750 fn test_monitor_update_raa_while_paused() {
751 // Tests handling of an RAA while monitor updating has already been marked failed.
752 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
753 let chanmon_cfgs = create_chanmon_cfgs(2);
754 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
755 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
756 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
757 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
759 send_payment(&nodes[0], &[&nodes[1]], 5000000);
760 let (route, our_payment_hash_1, payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
762 nodes[0].node.send_payment(&route, our_payment_hash_1, &Some(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
763 check_added_monitors!(nodes[0], 1);
765 let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
767 let (route, our_payment_hash_2, payment_preimage_2, our_payment_secret_2) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000000);
769 nodes[1].node.send_payment(&route, our_payment_hash_2, &Some(our_payment_secret_2), PaymentId(our_payment_hash_2.0)).unwrap();
770 check_added_monitors!(nodes[1], 1);
772 let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
774 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
775 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
776 check_added_monitors!(nodes[1], 1);
777 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
779 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
780 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
781 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
782 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
783 check_added_monitors!(nodes[0], 1);
784 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
786 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
787 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
788 check_added_monitors!(nodes[0], 1);
790 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
791 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
792 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
793 check_added_monitors!(nodes[0], 0);
795 let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
796 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
797 check_added_monitors!(nodes[1], 1);
798 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
800 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
801 check_added_monitors!(nodes[1], 1);
802 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
804 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
805 check_added_monitors!(nodes[0], 1);
806 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
808 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
809 check_added_monitors!(nodes[0], 1);
810 expect_pending_htlcs_forwardable!(nodes[0]);
811 expect_payment_received!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
813 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
814 check_added_monitors!(nodes[1], 1);
815 expect_pending_htlcs_forwardable!(nodes[1]);
816 expect_payment_received!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
818 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
819 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
822 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
823 // Tests handling of a monitor update failure when processing an incoming RAA
824 let chanmon_cfgs = create_chanmon_cfgs(3);
825 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
826 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
827 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
828 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
829 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
831 // Rebalance a bit so that we can send backwards from 2 to 1.
832 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
834 // Route a first payment that we'll fail backwards
835 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
837 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
838 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
839 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
840 check_added_monitors!(nodes[2], 1);
842 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
843 assert!(updates.update_add_htlcs.is_empty());
844 assert!(updates.update_fulfill_htlcs.is_empty());
845 assert_eq!(updates.update_fail_htlcs.len(), 1);
846 assert!(updates.update_fail_malformed_htlcs.is_empty());
847 assert!(updates.update_fee.is_none());
848 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
850 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
851 check_added_monitors!(nodes[0], 0);
853 // While the second channel is AwaitingRAA, forward a second payment to get it into the
855 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
857 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
858 check_added_monitors!(nodes[0], 1);
861 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
862 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
863 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
865 expect_pending_htlcs_forwardable!(nodes[1]);
866 check_added_monitors!(nodes[1], 0);
867 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
869 // Now fail monitor updating.
870 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
871 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
872 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
873 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
874 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
875 check_added_monitors!(nodes[1], 1);
877 // Forward a third payment which will also be added to the holding cell, despite the channel
878 // being paused waiting a monitor update.
879 let (route, payment_hash_3, _, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
881 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
882 check_added_monitors!(nodes[0], 1);
885 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed); // We succeed in updating the monitor for the first channel
886 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
887 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
888 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
889 check_added_monitors!(nodes[1], 0);
891 // Call forward_pending_htlcs and check that the new HTLC was simply added to the holding cell
892 // and not forwarded.
893 expect_pending_htlcs_forwardable!(nodes[1]);
894 check_added_monitors!(nodes[1], 0);
895 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
897 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
898 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
899 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
900 nodes[2].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4), PaymentId(payment_hash_4.0)).unwrap();
901 check_added_monitors!(nodes[2], 1);
903 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
904 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
905 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
906 check_added_monitors!(nodes[1], 1);
907 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
908 (Some(payment_preimage_4), Some(payment_hash_4))
909 } else { (None, None) };
911 // Restore monitor updating, ensuring we immediately get a fail-back update and a
912 // update_add update.
913 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
914 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
915 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
916 check_added_monitors!(nodes[1], 0);
917 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 }]);
918 check_added_monitors!(nodes[1], 1);
920 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
921 if test_ignore_second_cs {
922 assert_eq!(events_3.len(), 3);
924 assert_eq!(events_3.len(), 2);
927 // Note that the ordering of the events for different nodes is non-prescriptive, though the
928 // ordering of the two events that both go to nodes[2] have to stay in the same order.
929 let messages_a = match events_3.pop().unwrap() {
930 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
931 assert_eq!(node_id, nodes[0].node.get_our_node_id());
932 assert!(updates.update_fulfill_htlcs.is_empty());
933 assert_eq!(updates.update_fail_htlcs.len(), 1);
934 assert!(updates.update_fail_malformed_htlcs.is_empty());
935 assert!(updates.update_add_htlcs.is_empty());
936 assert!(updates.update_fee.is_none());
937 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
939 _ => panic!("Unexpected event type!"),
941 let raa = if test_ignore_second_cs {
942 match events_3.remove(1) {
943 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
944 assert_eq!(node_id, nodes[2].node.get_our_node_id());
947 _ => panic!("Unexpected event"),
950 let send_event_b = SendEvent::from_event(events_3.remove(0));
951 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
953 // Now deliver the new messages...
955 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
956 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
957 expect_payment_failed!(nodes[0], payment_hash_1, true);
959 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
961 if test_ignore_second_cs {
962 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
963 check_added_monitors!(nodes[2], 1);
964 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
965 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
966 check_added_monitors!(nodes[2], 1);
967 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
968 assert!(bs_cs.update_add_htlcs.is_empty());
969 assert!(bs_cs.update_fail_htlcs.is_empty());
970 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
971 assert!(bs_cs.update_fulfill_htlcs.is_empty());
972 assert!(bs_cs.update_fee.is_none());
974 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
975 check_added_monitors!(nodes[1], 1);
976 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
978 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
979 check_added_monitors!(nodes[1], 1);
981 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
982 check_added_monitors!(nodes[2], 1);
984 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
985 assert_eq!(bs_revoke_and_commit.len(), 2);
986 match bs_revoke_and_commit[0] {
987 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
988 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
989 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
990 check_added_monitors!(nodes[1], 1);
992 _ => panic!("Unexpected event"),
995 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
997 match bs_revoke_and_commit[1] {
998 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
999 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1000 assert!(updates.update_add_htlcs.is_empty());
1001 assert!(updates.update_fail_htlcs.is_empty());
1002 assert!(updates.update_fail_malformed_htlcs.is_empty());
1003 assert!(updates.update_fulfill_htlcs.is_empty());
1004 assert!(updates.update_fee.is_none());
1005 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1006 check_added_monitors!(nodes[1], 1);
1008 _ => panic!("Unexpected event"),
1012 assert_eq!(as_cs.update_add_htlcs.len(), 1);
1013 assert!(as_cs.update_fail_htlcs.is_empty());
1014 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1015 assert!(as_cs.update_fulfill_htlcs.is_empty());
1016 assert!(as_cs.update_fee.is_none());
1017 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1020 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1021 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1022 check_added_monitors!(nodes[2], 1);
1023 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1025 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1026 check_added_monitors!(nodes[2], 1);
1027 let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1029 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1030 check_added_monitors!(nodes[1], 1);
1031 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1033 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1034 check_added_monitors!(nodes[1], 1);
1035 let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1037 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1038 check_added_monitors!(nodes[2], 1);
1039 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1041 expect_pending_htlcs_forwardable!(nodes[2]);
1043 let events_6 = nodes[2].node.get_and_clear_pending_events();
1044 assert_eq!(events_6.len(), 2);
1046 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1047 _ => panic!("Unexpected event"),
1050 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1051 _ => panic!("Unexpected event"),
1054 if test_ignore_second_cs {
1055 expect_pending_htlcs_forwardable!(nodes[1]);
1056 check_added_monitors!(nodes[1], 1);
1058 send_event = SendEvent::from_node(&nodes[1]);
1059 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1060 assert_eq!(send_event.msgs.len(), 1);
1061 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1062 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1064 expect_pending_htlcs_forwardable!(nodes[0]);
1066 let events_9 = nodes[0].node.get_and_clear_pending_events();
1067 assert_eq!(events_9.len(), 1);
1069 Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1070 _ => panic!("Unexpected event"),
1072 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1075 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1079 fn test_monitor_update_fail_raa() {
1080 do_test_monitor_update_fail_raa(false);
1081 do_test_monitor_update_fail_raa(true);
1085 fn test_monitor_update_fail_reestablish() {
1086 // Simple test for message retransmission after monitor update failure on
1087 // channel_reestablish generating a monitor update (which comes from freeing holding cell
1089 let chanmon_cfgs = create_chanmon_cfgs(3);
1090 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1091 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1092 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1093 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1094 create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1096 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
1098 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1099 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1101 nodes[2].node.claim_funds(payment_preimage);
1102 check_added_monitors!(nodes[2], 1);
1103 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
1105 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1106 assert!(updates.update_add_htlcs.is_empty());
1107 assert!(updates.update_fail_htlcs.is_empty());
1108 assert!(updates.update_fail_malformed_htlcs.is_empty());
1109 assert!(updates.update_fee.is_none());
1110 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1111 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1112 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
1113 check_added_monitors!(nodes[1], 1);
1114 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1115 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1117 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1118 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1119 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1121 let as_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1122 let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1124 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1126 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1128 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1129 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1131 nodes[1].node.get_and_clear_pending_msg_events(); // Free the holding cell
1132 check_added_monitors!(nodes[1], 1);
1134 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1135 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1137 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1138 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1140 assert_eq!(get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap(), as_reestablish);
1141 assert_eq!(get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap(), bs_reestablish);
1143 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1145 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1146 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1148 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1149 check_added_monitors!(nodes[1], 0);
1151 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1152 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1154 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1155 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1156 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1157 check_added_monitors!(nodes[1], 0);
1159 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1160 assert!(updates.update_add_htlcs.is_empty());
1161 assert!(updates.update_fail_htlcs.is_empty());
1162 assert!(updates.update_fail_malformed_htlcs.is_empty());
1163 assert!(updates.update_fee.is_none());
1164 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1165 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1166 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1167 expect_payment_sent!(nodes[0], payment_preimage);
1171 fn raa_no_response_awaiting_raa_state() {
1172 // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1173 // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1174 // in question (assuming it intends to respond with a CS after monitor updating is restored).
1175 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1176 let chanmon_cfgs = create_chanmon_cfgs(2);
1177 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1178 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1179 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1180 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1182 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1183 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1184 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1186 // Queue up two payments - one will be delivered right away, one immediately goes into the
1187 // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1188 // immediately after a CS. By setting failing the monitor update failure from the CS (which
1189 // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1190 // generation during RAA while in monitor-update-failed state.
1192 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1193 check_added_monitors!(nodes[0], 1);
1194 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1195 check_added_monitors!(nodes[0], 0);
1198 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1199 assert_eq!(events.len(), 1);
1200 let payment_event = SendEvent::from_event(events.pop().unwrap());
1201 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1202 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1203 check_added_monitors!(nodes[1], 1);
1205 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1206 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1207 check_added_monitors!(nodes[0], 1);
1208 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1209 assert_eq!(events.len(), 1);
1210 let payment_event = SendEvent::from_event(events.pop().unwrap());
1212 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1213 check_added_monitors!(nodes[0], 1);
1214 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1216 // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1217 // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1218 // then restore channel monitor updates.
1219 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1220 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1221 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1222 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1223 check_added_monitors!(nodes[1], 1);
1224 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1226 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1227 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1228 check_added_monitors!(nodes[1], 1);
1230 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1231 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1232 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1233 // nodes[1] should be AwaitingRAA here!
1234 check_added_monitors!(nodes[1], 0);
1235 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1236 expect_pending_htlcs_forwardable!(nodes[1]);
1237 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1239 // We send a third payment here, which is somewhat of a redundant test, but the
1240 // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1241 // commitment transaction states) whereas here we can explicitly check for it.
1243 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1244 check_added_monitors!(nodes[0], 0);
1245 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1247 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1248 check_added_monitors!(nodes[0], 1);
1249 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1250 assert_eq!(events.len(), 1);
1251 let payment_event = SendEvent::from_event(events.pop().unwrap());
1253 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1254 check_added_monitors!(nodes[0], 1);
1255 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1257 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1258 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1259 check_added_monitors!(nodes[1], 1);
1260 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1262 // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1263 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1264 check_added_monitors!(nodes[1], 1);
1265 expect_pending_htlcs_forwardable!(nodes[1]);
1266 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1267 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1269 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1270 check_added_monitors!(nodes[0], 1);
1272 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1273 check_added_monitors!(nodes[0], 1);
1274 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1276 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1277 check_added_monitors!(nodes[1], 1);
1278 expect_pending_htlcs_forwardable!(nodes[1]);
1279 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1281 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1282 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1283 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1287 fn claim_while_disconnected_monitor_update_fail() {
1288 // Test for claiming a payment while disconnected and then having the resulting
1289 // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1290 // contrived case for nodes with network instability.
1291 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1292 // code introduced a regression in this test (specifically, this caught a removal of the
1293 // channel_reestablish handling ensuring the order was sensical given the messages used).
1294 let chanmon_cfgs = create_chanmon_cfgs(2);
1295 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1296 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1297 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1298 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1300 // Forward a payment for B to claim
1301 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1303 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1304 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1306 nodes[1].node.claim_funds(payment_preimage_1);
1307 check_added_monitors!(nodes[1], 1);
1308 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1310 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1311 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1313 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1314 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1316 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1317 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1319 // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1321 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1323 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1324 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1325 check_added_monitors!(nodes[1], 1);
1326 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1328 // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1329 // the monitor still failed
1330 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1332 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1333 check_added_monitors!(nodes[0], 1);
1336 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1337 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1338 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1339 check_added_monitors!(nodes[1], 1);
1340 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1341 // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1342 // until we've channel_monitor_update'd and updated for the new commitment transaction.
1344 // Now un-fail the monitor, which will result in B sending its original commitment update,
1345 // receiving the commitment update from A, and the resulting commitment dances.
1346 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1347 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1348 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1349 check_added_monitors!(nodes[1], 0);
1351 let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1352 assert_eq!(bs_msgs.len(), 2);
1355 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1356 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1357 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1358 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1359 check_added_monitors!(nodes[0], 1);
1361 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1362 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1363 check_added_monitors!(nodes[1], 1);
1365 _ => panic!("Unexpected event"),
1369 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1370 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1371 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1372 check_added_monitors!(nodes[0], 1);
1374 _ => panic!("Unexpected event"),
1377 let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1379 let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1380 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1381 check_added_monitors!(nodes[0], 1);
1382 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1384 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1385 check_added_monitors!(nodes[1], 1);
1386 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1387 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1388 check_added_monitors!(nodes[1], 1);
1390 expect_pending_htlcs_forwardable!(nodes[1]);
1391 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1393 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1394 check_added_monitors!(nodes[0], 1);
1395 expect_payment_sent!(nodes[0], payment_preimage_1);
1397 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1401 fn monitor_failed_no_reestablish_response() {
1402 // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1403 // response to a commitment_signed.
1404 // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1405 // debug_assert!() failure in channel_reestablish handling.
1406 let chanmon_cfgs = create_chanmon_cfgs(2);
1407 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1408 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1409 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1410 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1413 get_channel_ref!(nodes[0], lock, channel_id).announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1414 get_channel_ref!(nodes[1], lock, channel_id).announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1417 // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1419 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1421 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1422 check_added_monitors!(nodes[0], 1);
1425 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1426 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1427 assert_eq!(events.len(), 1);
1428 let payment_event = SendEvent::from_event(events.pop().unwrap());
1429 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1430 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1431 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1432 check_added_monitors!(nodes[1], 1);
1434 // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1435 // is still failing to update monitors.
1436 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1437 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1439 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1440 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1442 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1443 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1445 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1446 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1447 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1448 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1450 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1451 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1452 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1453 check_added_monitors!(nodes[1], 0);
1454 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1456 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1457 check_added_monitors!(nodes[0], 1);
1458 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1459 check_added_monitors!(nodes[0], 1);
1461 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1462 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1463 check_added_monitors!(nodes[1], 1);
1465 expect_pending_htlcs_forwardable!(nodes[1]);
1466 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1468 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1472 fn first_message_on_recv_ordering() {
1473 // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1474 // messages, we're willing to flip the order of response messages if neccessary in resposne to
1475 // a commitment_signed which needs to send an RAA first.
1476 // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1477 // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1478 // response. To do this, we start routing two payments, with the final RAA for the first being
1479 // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1480 // have no pending response but will want to send a RAA/CS (with the updates for the second
1481 // payment applied).
1482 // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1483 let chanmon_cfgs = create_chanmon_cfgs(2);
1484 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1485 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1486 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1487 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1489 // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1490 // can deliver it and fail the monitor update.
1491 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1493 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1494 check_added_monitors!(nodes[0], 1);
1497 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1498 assert_eq!(events.len(), 1);
1499 let payment_event = SendEvent::from_event(events.pop().unwrap());
1500 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1501 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1502 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1503 check_added_monitors!(nodes[1], 1);
1504 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1506 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1507 check_added_monitors!(nodes[0], 1);
1508 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1509 check_added_monitors!(nodes[0], 1);
1511 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1513 // Route the second payment, generating an update_add_htlc/commitment_signed
1514 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1516 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1517 check_added_monitors!(nodes[0], 1);
1519 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1520 assert_eq!(events.len(), 1);
1521 let payment_event = SendEvent::from_event(events.pop().unwrap());
1522 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1524 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1526 // Deliver the final RAA for the first payment, which does not require a response. RAAs
1527 // generally require a commitment_signed, so the fact that we're expecting an opposite response
1528 // to the next message also tests resetting the delivery order.
1529 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1530 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1531 check_added_monitors!(nodes[1], 1);
1533 // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1534 // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1535 // appropriate HTLC acceptance).
1536 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1537 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1538 check_added_monitors!(nodes[1], 1);
1539 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1541 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1542 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1543 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1544 check_added_monitors!(nodes[1], 0);
1546 expect_pending_htlcs_forwardable!(nodes[1]);
1547 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1549 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1550 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1551 check_added_monitors!(nodes[0], 1);
1552 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1553 check_added_monitors!(nodes[0], 1);
1555 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1556 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1557 check_added_monitors!(nodes[1], 1);
1559 expect_pending_htlcs_forwardable!(nodes[1]);
1560 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1562 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1563 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1567 fn test_monitor_update_fail_claim() {
1568 // Basic test for monitor update failures when processing claim_funds calls.
1569 // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1570 // update to claim the payment. We then send two payments C->B->A, which are held at B.
1571 // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1572 // the payments from C onwards to A.
1573 let chanmon_cfgs = create_chanmon_cfgs(3);
1574 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1575 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1576 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1577 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1578 create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1580 // Rebalance a bit so that we can send backwards from 3 to 2.
1581 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1583 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1585 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1586 nodes[1].node.claim_funds(payment_preimage_1);
1587 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1588 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1589 check_added_monitors!(nodes[1], 1);
1591 // Note that at this point there is a pending commitment transaction update for A being held by
1592 // B. Even when we go to send the payment from C through B to A, B will not update this
1593 // already-signed commitment transaction and will instead wait for it to resolve before
1594 // forwarding the payment onwards.
1596 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1_000_000);
1598 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1599 check_added_monitors!(nodes[2], 1);
1602 // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1603 // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1604 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1606 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1607 assert_eq!(events.len(), 1);
1608 let payment_event = SendEvent::from_event(events.pop().unwrap());
1609 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1610 let events = nodes[1].node.get_and_clear_pending_msg_events();
1611 assert_eq!(events.len(), 0);
1612 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1614 let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1615 nodes[2].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1616 check_added_monitors!(nodes[2], 1);
1618 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1619 assert_eq!(events.len(), 1);
1620 let payment_event = SendEvent::from_event(events.pop().unwrap());
1621 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1622 let events = nodes[1].node.get_and_clear_pending_msg_events();
1623 assert_eq!(events.len(), 0);
1624 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1626 // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1627 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1628 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1629 check_added_monitors!(nodes[1], 0);
1631 let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1632 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1633 commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1634 expect_payment_sent!(nodes[0], payment_preimage_1);
1636 // Get the payment forwards, note that they were batched into one commitment update.
1637 expect_pending_htlcs_forwardable!(nodes[1]);
1638 check_added_monitors!(nodes[1], 1);
1639 let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1640 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1641 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1642 commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1643 expect_pending_htlcs_forwardable!(nodes[0]);
1645 let events = nodes[0].node.get_and_clear_pending_events();
1646 assert_eq!(events.len(), 2);
1648 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1649 assert_eq!(payment_hash_2, *payment_hash);
1650 assert_eq!(1_000_000, amount_msat);
1652 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1653 assert!(payment_preimage.is_none());
1654 assert_eq!(payment_secret_2, *payment_secret);
1656 _ => panic!("expected PaymentPurpose::InvoicePayment")
1659 _ => panic!("Unexpected event"),
1662 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1663 assert_eq!(payment_hash_3, *payment_hash);
1664 assert_eq!(1_000_000, amount_msat);
1666 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1667 assert!(payment_preimage.is_none());
1668 assert_eq!(payment_secret_3, *payment_secret);
1670 _ => panic!("expected PaymentPurpose::InvoicePayment")
1673 _ => panic!("Unexpected event"),
1678 fn test_monitor_update_on_pending_forwards() {
1679 // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1680 // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1681 // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1682 // from C to A will be pending a forward to A.
1683 let chanmon_cfgs = create_chanmon_cfgs(3);
1684 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1685 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1686 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1687 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1688 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1690 // Rebalance a bit so that we can send backwards from 3 to 1.
1691 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1693 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1694 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
1695 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
1696 check_added_monitors!(nodes[2], 1);
1698 let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1699 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1700 commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1701 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1703 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
1705 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1706 check_added_monitors!(nodes[2], 1);
1709 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1710 assert_eq!(events.len(), 1);
1711 let payment_event = SendEvent::from_event(events.pop().unwrap());
1712 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1713 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1715 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1716 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 }]);
1717 check_added_monitors!(nodes[1], 1);
1718 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1720 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1721 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1722 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1723 check_added_monitors!(nodes[1], 0);
1725 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1726 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1727 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1728 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1730 let events = nodes[0].node.get_and_clear_pending_events();
1731 assert_eq!(events.len(), 2);
1732 if let Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } = events[0] {
1733 assert_eq!(payment_hash, payment_hash_1);
1734 assert!(payment_failed_permanently);
1735 } else { panic!("Unexpected event!"); }
1737 Event::PendingHTLCsForwardable { .. } => { },
1738 _ => panic!("Unexpected event"),
1740 nodes[0].node.process_pending_htlc_forwards();
1741 expect_payment_received!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1743 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1747 fn monitor_update_claim_fail_no_response() {
1748 // Test for claim_funds resulting in both a monitor update failure and no message response (due
1749 // to channel being AwaitingRAA).
1750 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1752 let chanmon_cfgs = create_chanmon_cfgs(2);
1753 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1754 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1755 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1756 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1758 // Forward a payment for B to claim
1759 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1761 // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1762 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1764 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1765 check_added_monitors!(nodes[0], 1);
1768 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1769 assert_eq!(events.len(), 1);
1770 let payment_event = SendEvent::from_event(events.pop().unwrap());
1771 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1772 let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1774 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1775 nodes[1].node.claim_funds(payment_preimage_1);
1776 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1777 check_added_monitors!(nodes[1], 1);
1779 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1781 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1782 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1783 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1784 check_added_monitors!(nodes[1], 0);
1785 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1787 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1788 check_added_monitors!(nodes[1], 1);
1789 expect_pending_htlcs_forwardable!(nodes[1]);
1790 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1792 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1793 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1794 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1795 expect_payment_sent!(nodes[0], payment_preimage_1);
1797 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1800 // restore_b_before_conf has no meaning if !confirm_a_first
1801 // restore_b_before_lock has no meaning if confirm_a_first
1802 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool, restore_b_before_lock: bool) {
1803 // Test that if the monitor update generated by funding_transaction_generated fails we continue
1804 // the channel setup happily after the update is restored.
1805 let chanmon_cfgs = create_chanmon_cfgs(2);
1806 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1807 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1808 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1810 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1811 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
1812 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
1814 let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
1816 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
1817 check_added_monitors!(nodes[0], 0);
1819 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1820 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1821 let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1822 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1823 check_added_monitors!(nodes[1], 1);
1825 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1826 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()));
1827 check_added_monitors!(nodes[0], 1);
1828 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1829 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1830 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1831 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1832 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1833 check_added_monitors!(nodes[0], 0);
1835 let events = nodes[0].node.get_and_clear_pending_events();
1836 assert_eq!(events.len(), 0);
1837 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1838 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1840 if confirm_a_first {
1841 confirm_transaction(&nodes[0], &funding_tx);
1842 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()));
1843 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1844 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1846 assert!(!restore_b_before_conf);
1847 confirm_transaction(&nodes[1], &funding_tx);
1848 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1851 // Make sure nodes[1] isn't stupid enough to re-send the ChannelReady on reconnect
1852 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1853 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1854 reconnect_nodes(&nodes[0], &nodes[1], (false, confirm_a_first), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1855 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1856 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1858 if !restore_b_before_conf {
1859 confirm_transaction(&nodes[1], &funding_tx);
1860 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1861 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1863 if !confirm_a_first && !restore_b_before_lock {
1864 confirm_transaction(&nodes[0], &funding_tx);
1865 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()));
1866 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1867 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1870 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1871 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1872 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1873 check_added_monitors!(nodes[1], 0);
1875 let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1876 if !restore_b_before_lock {
1877 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1878 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1880 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()));
1881 confirm_transaction(&nodes[0], &funding_tx);
1882 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1883 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready))
1886 if restore_b_before_conf {
1887 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1888 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1889 confirm_transaction(&nodes[1], &funding_tx);
1891 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1892 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1894 for node in nodes.iter() {
1895 assert!(node.gossip_sync.handle_channel_announcement(&announcement).unwrap());
1896 node.gossip_sync.handle_channel_update(&as_update).unwrap();
1897 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
1900 if !restore_b_before_lock {
1901 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
1903 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
1907 send_payment(&nodes[0], &[&nodes[1]], 8000000);
1908 close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1909 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
1910 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1914 fn during_funding_monitor_fail() {
1915 do_during_funding_monitor_fail(true, true, false);
1916 do_during_funding_monitor_fail(true, false, false);
1917 do_during_funding_monitor_fail(false, false, false);
1918 do_during_funding_monitor_fail(false, false, true);
1922 fn test_path_paused_mpp() {
1923 // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1925 let chanmon_cfgs = create_chanmon_cfgs(4);
1926 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1927 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1928 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1930 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
1931 let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1932 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
1933 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
1935 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
1937 // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1938 let path = route.paths[0].clone();
1939 route.paths.push(path);
1940 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
1941 route.paths[0][0].short_channel_id = chan_1_id;
1942 route.paths[0][1].short_channel_id = chan_3_id;
1943 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
1944 route.paths[1][0].short_channel_id = chan_2_ann.contents.short_channel_id;
1945 route.paths[1][1].short_channel_id = chan_4_id;
1947 // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
1948 // (for the path 0 -> 2 -> 3) fails.
1949 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1950 chanmon_cfgs[0].persister.set_next_update_ret(Some(ChannelMonitorUpdateStatus::InProgress));
1952 // Now check that we get the right return value, indicating that the first path succeeded but
1953 // the second got a MonitorUpdateInProgress err. This implies
1954 // PaymentSendFailure::PartialFailure as some paths succeeded, preventing retry.
1955 if let Err(PaymentSendFailure::PartialFailure { results, ..}) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)) {
1956 assert_eq!(results.len(), 2);
1957 if let Ok(()) = results[0] {} else { panic!(); }
1958 if let Err(APIError::MonitorUpdateInProgress) = results[1] {} else { panic!(); }
1959 } else { panic!(); }
1960 check_added_monitors!(nodes[0], 2);
1961 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1963 // Pass the first HTLC of the payment along to nodes[3].
1964 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1965 assert_eq!(events.len(), 1);
1966 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false, None);
1968 // And check that, after we successfully update the monitor for chan_2 we can pass the second
1969 // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
1970 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
1971 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1972 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1973 assert_eq!(events.len(), 1);
1974 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true, None);
1976 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
1980 fn test_pending_update_fee_ack_on_reconnect() {
1981 // In early versions of our automated fee update patch, nodes did not correctly use the
1982 // previous channel feerate after sending an undelivered revoke_and_ack when re-sending an
1983 // undelivered commitment_signed.
1985 // B sends A new HTLC + CS, not delivered
1986 // A sends B update_fee + CS
1987 // B receives the CS and sends RAA, previously causing B to lock in the new feerate
1989 // B resends initial CS, using the original fee
1991 let chanmon_cfgs = create_chanmon_cfgs(2);
1992 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1993 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1994 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1996 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1997 send_payment(&nodes[0], &[&nodes[1]], 100_000_00);
1999 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[1], nodes[0], 1_000_000);
2000 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
2001 check_added_monitors!(nodes[1], 1);
2002 let bs_initial_send_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2003 // bs_initial_send_msgs are not delivered until they are re-generated after reconnect
2006 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2009 nodes[0].node.timer_tick_occurred();
2010 check_added_monitors!(nodes[0], 1);
2011 let as_update_fee_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2012 assert!(as_update_fee_msgs.update_fee.is_some());
2014 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_update_fee_msgs.update_fee.as_ref().unwrap());
2015 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_fee_msgs.commitment_signed);
2016 check_added_monitors!(nodes[1], 1);
2017 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2018 // bs_first_raa is not delivered until it is re-generated after reconnect
2020 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2021 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2023 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2024 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2025 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2026 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2028 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2029 let bs_resend_msgs = nodes[1].node.get_and_clear_pending_msg_events();
2030 assert_eq!(bs_resend_msgs.len(), 3);
2031 if let MessageSendEvent::UpdateHTLCs { ref updates, .. } = bs_resend_msgs[0] {
2032 assert_eq!(*updates, bs_initial_send_msgs);
2033 } else { panic!(); }
2034 if let MessageSendEvent::SendRevokeAndACK { ref msg, .. } = bs_resend_msgs[1] {
2035 assert_eq!(*msg, bs_first_raa);
2036 } else { panic!(); }
2037 if let MessageSendEvent::SendChannelUpdate { .. } = bs_resend_msgs[2] { } else { panic!(); }
2039 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2040 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
2042 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.update_add_htlcs[0]);
2043 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.commitment_signed);
2044 check_added_monitors!(nodes[0], 1);
2045 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()));
2046 check_added_monitors!(nodes[1], 1);
2047 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()).commitment_signed;
2049 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2050 check_added_monitors!(nodes[0], 1);
2051 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);
2052 check_added_monitors!(nodes[1], 1);
2053 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2055 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2056 check_added_monitors!(nodes[0], 1);
2057 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2058 check_added_monitors!(nodes[0], 1);
2060 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()));
2061 check_added_monitors!(nodes[1], 1);
2063 expect_pending_htlcs_forwardable!(nodes[0]);
2064 expect_payment_received!(nodes[0], payment_hash, payment_secret, 1_000_000);
2066 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
2070 fn test_fail_htlc_on_broadcast_after_claim() {
2071 // In an earlier version of 7e78fa660cec8a73286c94c1073ee588140e7a01 we'd also fail the inbound
2072 // channel backwards if we received an HTLC failure after a HTLC fulfillment. Here we test a
2073 // specific case of that by having the HTLC failure come from the ChannelMonitor after a dust
2074 // HTLC was not included in a confirmed commitment transaction.
2076 // We first forward a payment, then claim it with an update_fulfill_htlc message, closing the
2077 // channel immediately before commitment occurs. After the commitment transaction reaches
2078 // ANTI_REORG_DELAY confirmations, will will try to fail the HTLC which was already fulfilled.
2079 let chanmon_cfgs = create_chanmon_cfgs(3);
2080 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2081 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2082 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2084 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2085 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2087 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 2000);
2089 let bs_txn = get_local_commitment_txn!(nodes[2], chan_id_2);
2090 assert_eq!(bs_txn.len(), 1);
2092 nodes[2].node.claim_funds(payment_preimage);
2093 check_added_monitors!(nodes[2], 1);
2094 expect_payment_claimed!(nodes[2], payment_hash, 2000);
2096 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2097 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
2098 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2099 check_added_monitors!(nodes[1], 1);
2100 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2102 mine_transaction(&nodes[1], &bs_txn[0]);
2103 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2104 check_closed_broadcast!(nodes[1], true);
2105 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2106 check_added_monitors!(nodes[1], 1);
2107 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 }]);
2109 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
2110 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2111 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, true, true);
2112 expect_payment_path_successful!(nodes[0]);
2115 fn do_update_fee_resend_test(deliver_update: bool, parallel_updates: bool) {
2116 // In early versions we did not handle resending of update_fee on reconnect correctly. The
2117 // chanmon_consistency fuzz target, of course, immediately found it, but we test a few cases
2119 let chanmon_cfgs = create_chanmon_cfgs(2);
2120 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2121 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2122 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2124 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2125 send_payment(&nodes[0], &[&nodes[1]], 1000);
2128 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2129 *feerate_lock += 20;
2131 nodes[0].node.timer_tick_occurred();
2132 check_added_monitors!(nodes[0], 1);
2133 let update_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2134 assert!(update_msgs.update_fee.is_some());
2136 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2139 if parallel_updates {
2141 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2142 *feerate_lock += 20;
2144 nodes[0].node.timer_tick_occurred();
2145 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2148 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2149 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2151 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2152 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2153 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2154 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2156 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2157 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
2158 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2160 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2161 let mut as_reconnect_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2162 assert_eq!(as_reconnect_msgs.len(), 2);
2163 if let MessageSendEvent::SendChannelUpdate { .. } = as_reconnect_msgs.pop().unwrap() {} else { panic!(); }
2164 let update_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = as_reconnect_msgs.pop().unwrap()
2165 { updates } else { panic!(); };
2166 assert!(update_msgs.update_fee.is_some());
2167 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2168 if parallel_updates {
2169 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update_msgs.commitment_signed);
2170 check_added_monitors!(nodes[1], 1);
2171 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2172 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2173 check_added_monitors!(nodes[0], 1);
2174 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2176 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2177 check_added_monitors!(nodes[0], 1);
2178 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2180 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_second_update.update_fee.as_ref().unwrap());
2181 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
2182 check_added_monitors!(nodes[1], 1);
2183 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2185 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2186 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2187 check_added_monitors!(nodes[1], 1);
2189 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2190 check_added_monitors!(nodes[0], 1);
2192 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs.commitment_signed);
2193 check_added_monitors!(nodes[0], 1);
2194 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2196 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2197 check_added_monitors!(nodes[1], 1);
2199 commitment_signed_dance!(nodes[1], nodes[0], update_msgs.commitment_signed, false);
2202 send_payment(&nodes[0], &[&nodes[1]], 1000);
2205 fn update_fee_resend_test() {
2206 do_update_fee_resend_test(false, false);
2207 do_update_fee_resend_test(true, false);
2208 do_update_fee_resend_test(false, true);
2209 do_update_fee_resend_test(true, true);
2212 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2213 // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2214 // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2215 // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2216 // which failed in such a case).
2217 let chanmon_cfgs = create_chanmon_cfgs(2);
2218 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2219 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2220 let persister: test_utils::TestPersister;
2221 let new_chain_monitor: test_utils::TestChainMonitor;
2222 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2223 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2225 let chan_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 15_000_000, 7_000_000_000, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2226 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
2227 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2229 // Do a really complicated dance to get an HTLC into the holding cell, with
2230 // MonitorUpdateInProgress set but AwaitingRemoteRevoke unset. When this test was written, any
2231 // attempts to send an HTLC while MonitorUpdateInProgress is set are immediately
2232 // failed-backwards. Thus, the only way to get an AddHTLC into the holding cell is to add it
2233 // while AwaitingRemoteRevoke is set but MonitorUpdateInProgress is unset, and then swap the
2237 // a) routing a payment from node B to node A,
2238 // b) sending a payment from node A to node B without delivering any of the generated messages,
2239 // putting node A in AwaitingRemoteRevoke,
2240 // c) sending a second payment from node A to node B, which is immediately placed in the
2242 // d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2243 // when we try to persist the payment preimage,
2244 // e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2245 // clearing AwaitingRemoteRevoke on node A.
2247 // Note that because, at the end, MonitorUpdateInProgress is still set, the HTLC generated in
2248 // (c) will not be freed from the holding cell.
2249 let (payment_preimage_0, payment_hash_0, _) = route_payment(&nodes[1], &[&nodes[0]], 100_000);
2251 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
2252 check_added_monitors!(nodes[0], 1);
2253 let send = SendEvent::from_node(&nodes[0]);
2254 assert_eq!(send.msgs.len(), 1);
2256 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
2257 check_added_monitors!(nodes[0], 0);
2259 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2260 nodes[0].node.claim_funds(payment_preimage_0);
2261 check_added_monitors!(nodes[0], 1);
2262 expect_payment_claimed!(nodes[0], payment_hash_0, 100_000);
2264 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2265 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2266 check_added_monitors!(nodes[1], 1);
2268 let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2270 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2271 check_added_monitors!(nodes[0], 1);
2274 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2275 // disconnect the peers. Note that the fuzzer originally found this issue because
2276 // deserializing a ChannelManager in this state causes an assertion failure.
2278 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
2279 reload_node!(nodes[0], &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
2281 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2283 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2285 // Now reconnect the two
2286 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2287 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2288 assert_eq!(reestablish_1.len(), 1);
2289 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2290 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2291 assert_eq!(reestablish_2.len(), 1);
2293 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2294 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2295 check_added_monitors!(nodes[1], 0);
2297 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2298 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2300 assert!(resp_0.0.is_none());
2301 assert!(resp_0.1.is_none());
2302 assert!(resp_0.2.is_none());
2303 assert!(resp_1.0.is_none());
2304 assert!(resp_1.1.is_none());
2306 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2308 if let Some(pending_cs) = resp_1.2 {
2309 assert!(pending_cs.update_add_htlcs.is_empty());
2310 assert!(pending_cs.update_fail_htlcs.is_empty());
2311 assert!(pending_cs.update_fulfill_htlcs.is_empty());
2312 assert_eq!(pending_cs.commitment_signed, cs);
2313 } else { panic!(); }
2315 // There should be no monitor updates as we are still pending awaiting a failed one.
2316 check_added_monitors!(nodes[0], 0);
2317 check_added_monitors!(nodes[1], 0);
2320 // If we finish updating the monitor, we should free the holding cell right away (this did
2321 // not occur prior to #756).
2322 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2323 let (funding_txo, mon_id, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2324 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_txo, mon_id);
2326 // New outbound messages should be generated immediately upon a call to
2327 // get_and_clear_pending_msg_events (but not before).
2328 check_added_monitors!(nodes[0], 0);
2329 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2330 check_added_monitors!(nodes[0], 1);
2331 assert_eq!(events.len(), 1);
2333 // Deliver the pending in-flight CS
2334 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2335 check_added_monitors!(nodes[0], 1);
2337 let commitment_msg = match events.pop().unwrap() {
2338 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2339 assert_eq!(node_id, nodes[1].node.get_our_node_id());
2340 assert!(updates.update_fail_htlcs.is_empty());
2341 assert!(updates.update_fail_malformed_htlcs.is_empty());
2342 assert!(updates.update_fee.is_none());
2343 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2344 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2345 expect_payment_sent_without_paths!(nodes[1], payment_preimage_0);
2346 assert_eq!(updates.update_add_htlcs.len(), 1);
2347 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2348 updates.commitment_signed
2350 _ => panic!("Unexpected event type!"),
2353 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2354 check_added_monitors!(nodes[1], 1);
2356 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2357 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2358 expect_pending_htlcs_forwardable!(nodes[1]);
2359 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2360 check_added_monitors!(nodes[1], 1);
2362 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
2364 let events = nodes[1].node.get_and_clear_pending_events();
2365 assert_eq!(events.len(), 2);
2367 Event::PendingHTLCsForwardable { .. } => { },
2368 _ => panic!("Unexpected event"),
2371 Event::PaymentPathSuccessful { .. } => { },
2372 _ => panic!("Unexpected event"),
2375 nodes[1].node.process_pending_htlc_forwards();
2376 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2378 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2379 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2382 fn channel_holding_cell_serialize() {
2383 do_channel_holding_cell_serialize(true, true);
2384 do_channel_holding_cell_serialize(true, false);
2385 do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2388 #[derive(PartialEq)]
2389 enum HTLCStatusAtDupClaim {
2394 fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_fails: bool) {
2395 // When receiving an update_fulfill_htlc message, we immediately forward the claim backwards
2396 // along the payment path before waiting for a full commitment_signed dance. This is great, but
2397 // can cause duplicative claims if a node sends an update_fulfill_htlc message, disconnects,
2398 // reconnects, and then has to re-send its update_fulfill_htlc message again.
2399 // In previous code, we didn't handle the double-claim correctly, spuriously closing the
2400 // channel on which the inbound HTLC was received.
2401 let chanmon_cfgs = create_chanmon_cfgs(3);
2402 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2403 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2404 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2406 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2407 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2409 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
2411 let mut as_raa = None;
2412 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2413 // In order to get the HTLC claim into the holding cell at nodes[1], we need nodes[1] to be
2414 // awaiting a remote revoke_and_ack from nodes[0].
2415 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
2416 nodes[0].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret), PaymentId(second_payment_hash.0)).unwrap();
2417 check_added_monitors!(nodes[0], 1);
2419 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
2420 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
2421 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
2422 check_added_monitors!(nodes[1], 1);
2424 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2425 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2426 check_added_monitors!(nodes[0], 1);
2427 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
2428 check_added_monitors!(nodes[0], 1);
2430 as_raa = Some(get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2433 let fulfill_msg = msgs::UpdateFulfillHTLC {
2434 channel_id: chan_id_2,
2439 nodes[2].node.fail_htlc_backwards(&payment_hash);
2440 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash }]);
2441 check_added_monitors!(nodes[2], 1);
2442 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2444 nodes[2].node.claim_funds(payment_preimage);
2445 check_added_monitors!(nodes[2], 1);
2446 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
2448 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2449 assert_eq!(cs_updates.update_fulfill_htlcs.len(), 1);
2450 // Check that the message we're about to deliver matches the one generated:
2451 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
2453 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
2454 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2455 check_added_monitors!(nodes[1], 1);
2457 let mut bs_updates = None;
2458 if htlc_status != HTLCStatusAtDupClaim::HoldingCell {
2459 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2460 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2461 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2462 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2463 if htlc_status == HTLCStatusAtDupClaim::Cleared {
2464 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2465 expect_payment_path_successful!(nodes[0]);
2468 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2471 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
2472 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2475 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
2476 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 }]);
2478 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2481 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2482 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa.unwrap());
2483 check_added_monitors!(nodes[1], 1);
2484 expect_pending_htlcs_forwardable_ignore!(nodes[1]); // We finally receive the second payment, but don't claim it
2486 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2487 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2488 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2489 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2491 if htlc_status != HTLCStatusAtDupClaim::Cleared {
2492 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2493 expect_payment_path_successful!(nodes[0]);
2498 fn test_reconnect_dup_htlc_claims() {
2499 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, false);
2500 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, false);
2501 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, false);
2502 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, true);
2503 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, true);
2504 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, true);
2508 fn test_temporary_error_during_shutdown() {
2509 // Test that temporary failures when updating the monitor's shutdown script delay cooperative
2511 let mut config = test_default_channel_config();
2512 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2514 let chanmon_cfgs = create_chanmon_cfgs(2);
2515 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2516 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
2517 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2519 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2521 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2522 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2524 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
2525 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
2526 check_added_monitors!(nodes[1], 1);
2528 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id()));
2529 check_added_monitors!(nodes[0], 1);
2531 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2533 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2534 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2536 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2537 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2538 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()));
2540 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2542 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2543 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2544 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2546 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()));
2547 let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
2548 let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2550 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_a.unwrap());
2551 let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
2552 assert!(none_b.is_none());
2553 let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2555 assert_eq!(txn_a, txn_b);
2556 assert_eq!(txn_a.len(), 1);
2557 check_spends!(txn_a[0], funding_tx);
2558 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
2559 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
2563 fn test_permanent_error_during_sending_shutdown() {
2564 // Test that permanent failures when updating the monitor's shutdown script result in a force
2565 // close when initiating a cooperative close.
2566 let mut config = test_default_channel_config();
2567 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2569 let chanmon_cfgs = create_chanmon_cfgs(2);
2570 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2571 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
2572 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2574 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2575 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2577 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2578 check_closed_broadcast!(nodes[0], true);
2579 check_added_monitors!(nodes[0], 2);
2580 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2584 fn test_permanent_error_during_handling_shutdown() {
2585 // Test that permanent failures when updating the monitor's shutdown script result in a force
2586 // close when handling a cooperative close.
2587 let mut config = test_default_channel_config();
2588 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2590 let chanmon_cfgs = create_chanmon_cfgs(2);
2591 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2592 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
2593 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2595 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2596 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2598 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2599 let shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
2600 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &shutdown);
2601 check_closed_broadcast!(nodes[1], true);
2602 check_added_monitors!(nodes[1], 2);
2603 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2607 fn double_temp_error() {
2608 // Test that it's OK to have multiple `ChainMonitor::update_channel` calls fail in a row.
2609 let chanmon_cfgs = create_chanmon_cfgs(2);
2610 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2611 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2612 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2614 let (_, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2616 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2617 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2619 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2620 // `claim_funds` results in a ChannelMonitorUpdate.
2621 nodes[1].node.claim_funds(payment_preimage_1);
2622 check_added_monitors!(nodes[1], 1);
2623 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
2624 let (funding_tx, latest_update_1, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2626 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2627 // Previously, this would've panicked due to a double-call to `Channel::monitor_update_failed`,
2628 // which had some asserts that prevented it from being called twice.
2629 nodes[1].node.claim_funds(payment_preimage_2);
2630 check_added_monitors!(nodes[1], 1);
2631 expect_payment_claimed!(nodes[1], payment_hash_2, 1_000_000);
2632 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2634 let (_, latest_update_2, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2635 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_1);
2636 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2637 check_added_monitors!(nodes[1], 0);
2638 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_2);
2640 // Complete the first HTLC.
2641 let events = nodes[1].node.get_and_clear_pending_msg_events();
2642 assert_eq!(events.len(), 1);
2643 let (update_fulfill_1, commitment_signed_b1, node_id) = {
2645 &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 } } => {
2646 assert!(update_add_htlcs.is_empty());
2647 assert_eq!(update_fulfill_htlcs.len(), 1);
2648 assert!(update_fail_htlcs.is_empty());
2649 assert!(update_fail_malformed_htlcs.is_empty());
2650 assert!(update_fee.is_none());
2651 (update_fulfill_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2653 _ => panic!("Unexpected event"),
2656 assert_eq!(node_id, nodes[0].node.get_our_node_id());
2657 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_1);
2658 check_added_monitors!(nodes[0], 0);
2659 expect_payment_sent_without_paths!(nodes[0], payment_preimage_1);
2660 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_b1);
2661 check_added_monitors!(nodes[0], 1);
2662 nodes[0].node.process_pending_htlc_forwards();
2663 let (raa_a1, commitment_signed_a1) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2664 check_added_monitors!(nodes[1], 0);
2665 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2666 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_a1);
2667 check_added_monitors!(nodes[1], 1);
2668 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed_a1);
2669 check_added_monitors!(nodes[1], 1);
2671 // Complete the second HTLC.
2672 let ((update_fulfill_2, commitment_signed_b2), raa_b2) = {
2673 let events = nodes[1].node.get_and_clear_pending_msg_events();
2674 assert_eq!(events.len(), 2);
2676 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2677 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2678 assert!(updates.update_add_htlcs.is_empty());
2679 assert!(updates.update_fail_htlcs.is_empty());
2680 assert!(updates.update_fail_malformed_htlcs.is_empty());
2681 assert!(updates.update_fee.is_none());
2682 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2683 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2685 _ => panic!("Unexpected event"),
2688 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2689 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2692 _ => panic!("Unexpected event"),
2695 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_b2);
2696 check_added_monitors!(nodes[0], 1);
2697 expect_payment_path_successful!(nodes[0]);
2699 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_2);
2700 check_added_monitors!(nodes[0], 0);
2701 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2702 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed_b2, false);
2703 expect_payment_sent!(nodes[0], payment_preimage_2);
2706 fn do_test_outbound_reload_without_init_mon(use_0conf: bool) {
2707 // Test that if the monitor update generated in funding_signed is stored async and we restart
2708 // with the latest ChannelManager but the ChannelMonitor persistence never completed we happily
2709 // drop the channel and move on.
2710 let chanmon_cfgs = create_chanmon_cfgs(2);
2711 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2713 let persister: test_utils::TestPersister;
2714 let new_chain_monitor: test_utils::TestChainMonitor;
2715 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2717 let mut chan_config = test_default_channel_config();
2718 chan_config.manually_accept_inbound_channels = true;
2719 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2721 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2722 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2724 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2725 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
2727 let events = nodes[1].node.get_and_clear_pending_events();
2728 assert_eq!(events.len(), 1);
2730 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2732 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2734 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2737 _ => panic!("Unexpected event"),
2740 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
2742 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2744 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2745 check_added_monitors!(nodes[0], 0);
2747 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2748 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2749 check_added_monitors!(nodes[1], 1);
2751 let bs_signed_locked = nodes[1].node.get_and_clear_pending_msg_events();
2752 assert_eq!(bs_signed_locked.len(), if use_0conf { 2 } else { 1 });
2753 match &bs_signed_locked[0] {
2754 MessageSendEvent::SendFundingSigned { msg, .. } => {
2755 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2757 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &msg);
2758 check_added_monitors!(nodes[0], 1);
2760 _ => panic!("Unexpected event"),
2763 match &bs_signed_locked[1] {
2764 MessageSendEvent::SendChannelReady { msg, .. } => {
2765 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &msg);
2767 _ => panic!("Unexpected event"),
2771 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
2772 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2773 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2775 // nodes[0] is now waiting on the first ChannelMonitor persistence to complete in order to
2776 // broadcast the funding transaction. If nodes[0] restarts at this point with the
2777 // ChannelMonitor lost, we should simply discard the channel.
2779 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2780 // not, so we have to clear them here.
2781 nodes[0].chain_source.watched_txn.lock().unwrap().clear();
2782 nodes[0].chain_source.watched_outputs.lock().unwrap().clear();
2784 reload_node!(nodes[0], &nodes[0].node.encode(), &[], persister, new_chain_monitor, nodes_0_deserialized);
2785 check_closed_event!(nodes[0], 1, ClosureReason::DisconnectedPeer);
2786 assert!(nodes[0].node.list_channels().is_empty());
2790 fn test_outbound_reload_without_init_mon() {
2791 do_test_outbound_reload_without_init_mon(true);
2792 do_test_outbound_reload_without_init_mon(false);
2795 fn do_test_inbound_reload_without_init_mon(use_0conf: bool, lock_commitment: bool) {
2796 // Test that if the monitor update generated by funding_transaction_generated is stored async
2797 // and we restart with the latest ChannelManager but the ChannelMonitor persistence never
2798 // completed we happily drop the channel and move on.
2799 let chanmon_cfgs = create_chanmon_cfgs(2);
2800 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2802 let persister: test_utils::TestPersister;
2803 let new_chain_monitor: test_utils::TestChainMonitor;
2804 let nodes_1_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2806 let mut chan_config = test_default_channel_config();
2807 chan_config.manually_accept_inbound_channels = true;
2808 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2810 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2811 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2813 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2814 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
2816 let events = nodes[1].node.get_and_clear_pending_events();
2817 assert_eq!(events.len(), 1);
2819 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2821 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2823 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2826 _ => panic!("Unexpected event"),
2829 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
2831 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2833 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2834 check_added_monitors!(nodes[0], 0);
2836 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2837 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2838 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2839 check_added_monitors!(nodes[1], 1);
2841 // nodes[1] happily sends its funding_signed even though its awaiting the persistence of the
2842 // initial ChannelMonitor, but it will decline to send its channel_ready even if the funding
2843 // transaction is confirmed.
2844 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
2846 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
2847 check_added_monitors!(nodes[0], 1);
2849 let as_funding_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2850 if lock_commitment {
2851 confirm_transaction(&nodes[0], &as_funding_tx[0]);
2852 confirm_transaction(&nodes[1], &as_funding_tx[0]);
2854 if use_0conf || lock_commitment {
2855 let as_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
2856 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_ready);
2858 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2860 // nodes[1] is now waiting on the first ChannelMonitor persistence to complete in order to
2861 // move the channel to ready (or is waiting on the funding transaction to confirm). If nodes[1]
2862 // restarts at this point with the ChannelMonitor lost, we should simply discard the channel.
2864 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2865 // not, so we have to clear them here.
2866 nodes[1].chain_source.watched_txn.lock().unwrap().clear();
2867 nodes[1].chain_source.watched_outputs.lock().unwrap().clear();
2869 reload_node!(nodes[1], &nodes[1].node.encode(), &[], persister, new_chain_monitor, nodes_1_deserialized);
2871 check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
2872 assert!(nodes[1].node.list_channels().is_empty());
2876 fn test_inbound_reload_without_init_mon() {
2877 do_test_inbound_reload_without_init_mon(true, true);
2878 do_test_inbound_reload_without_init_mon(true, false);
2879 do_test_inbound_reload_without_init_mon(false, true);
2880 do_test_inbound_reload_without_init_mon(false, false);