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::{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);
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);
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), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
116 assert!(new_monitor == *monitor);
117 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
118 assert_eq!(chain_mon.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
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]);
143 let mut node_0_per_peer_lock;
144 let mut node_0_peer_state_lock;
145 let mut channel = get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan.2);
146 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
147 // Check that even though the persister is returning a InProgress,
148 // because the update is bogus, ultimately the error that's returned
149 // should be a PermanentFailure.
150 if let ChannelMonitorUpdateStatus::PermanentFailure = chain_mon.chain_monitor.update_channel(outpoint, &update) {} else { panic!("Expected monitor error to be permanent"); }
151 logger.assert_log_regex("lightning::chain::chainmonitor".to_string(), regex::Regex::new("Persistence of ChannelMonitorUpdate for channel [0-9a-f]* in progress").unwrap(), 1);
152 assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::Completed);
153 } else { assert!(false); }
156 check_added_monitors!(nodes[0], 1);
157 let events = nodes[0].node.get_and_clear_pending_events();
158 assert_eq!(events.len(), 1);
161 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
162 // Test that we can recover from a simple temporary monitor update failure optionally with
163 // a disconnect in between
164 let chanmon_cfgs = create_chanmon_cfgs(2);
165 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
166 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
167 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
168 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
170 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
172 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
175 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)), false, APIError::MonitorUpdateInProgress, {});
176 check_added_monitors!(nodes[0], 1);
179 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
180 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
181 assert_eq!(nodes[0].node.list_channels().len(), 1);
184 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
185 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
186 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
189 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
190 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
191 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
192 check_added_monitors!(nodes[0], 0);
194 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
195 assert_eq!(events_2.len(), 1);
196 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
197 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
198 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
199 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
201 expect_pending_htlcs_forwardable!(nodes[1]);
203 let events_3 = nodes[1].node.get_and_clear_pending_events();
204 assert_eq!(events_3.len(), 1);
206 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
207 assert_eq!(payment_hash_1, *payment_hash);
208 assert_eq!(amount_msat, 1_000_000);
209 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
210 assert_eq!(via_channel_id, Some(channel_id));
212 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
213 assert!(payment_preimage.is_none());
214 assert_eq!(payment_secret_1, *payment_secret);
216 _ => panic!("expected PaymentPurpose::InvoicePayment")
219 _ => panic!("Unexpected event"),
222 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
224 // Now set it to failed again...
225 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
227 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
228 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)), false, APIError::MonitorUpdateInProgress, {});
229 check_added_monitors!(nodes[0], 1);
232 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
233 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
234 assert_eq!(nodes[0].node.list_channels().len(), 1);
237 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
238 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
239 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
242 // ...and make sure we can force-close a frozen channel
243 nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
244 check_added_monitors!(nodes[0], 1);
245 check_closed_broadcast!(nodes[0], true);
247 // TODO: Once we hit the chain with the failure transaction we should check that we get a
248 // PaymentPathFailed event
250 assert_eq!(nodes[0].node.list_channels().len(), 0);
251 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
255 fn test_simple_monitor_temporary_update_fail() {
256 do_test_simple_monitor_temporary_update_fail(false);
257 do_test_simple_monitor_temporary_update_fail(true);
260 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
261 let disconnect_flags = 8 | 16;
263 // Test that we can recover from a temporary monitor update failure with some in-flight
264 // HTLCs going on at the same time potentially with some disconnection thrown in.
265 // * First we route a payment, then get a temporary monitor update failure when trying to
266 // route a second payment. We then claim the first payment.
267 // * If disconnect_count is set, we will disconnect at this point (which is likely as
268 // InProgress likely indicates net disconnect which resulted in failing to update the
269 // ChannelMonitor on a watchtower).
270 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
271 // immediately, otherwise we wait disconnect and deliver them via the reconnect
272 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
273 // disconnect_count & !disconnect_flags is 0).
274 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
275 // through message sending, potentially disconnect/reconnecting multiple times based on
276 // disconnect_count, to get the update_fulfill_htlc through.
277 // * We then walk through more message exchanges to get the original update_add_htlc
278 // through, swapping message ordering based on disconnect_count & 8 and optionally
279 // disconnect/reconnecting based on disconnect_count.
280 let chanmon_cfgs = create_chanmon_cfgs(2);
281 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
282 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
283 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
284 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
286 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
288 // Now try to send a second payment which will fail to send
289 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
291 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
292 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)), false, APIError::MonitorUpdateInProgress, {});
293 check_added_monitors!(nodes[0], 1);
296 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
297 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
298 assert_eq!(nodes[0].node.list_channels().len(), 1);
300 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
301 // but nodes[0] won't respond since it is frozen.
302 nodes[1].node.claim_funds(payment_preimage_1);
303 check_added_monitors!(nodes[1], 1);
304 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
306 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
307 assert_eq!(events_2.len(), 1);
308 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
309 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
310 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
311 assert!(update_add_htlcs.is_empty());
312 assert_eq!(update_fulfill_htlcs.len(), 1);
313 assert!(update_fail_htlcs.is_empty());
314 assert!(update_fail_malformed_htlcs.is_empty());
315 assert!(update_fee.is_none());
317 if (disconnect_count & 16) == 0 {
318 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
319 let events_3 = nodes[0].node.get_and_clear_pending_events();
320 assert_eq!(events_3.len(), 1);
322 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
323 assert_eq!(*payment_preimage, payment_preimage_1);
324 assert_eq!(*payment_hash, payment_hash_1);
326 _ => panic!("Unexpected event"),
329 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
330 check_added_monitors!(nodes[0], 1);
331 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
334 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
336 _ => panic!("Unexpected event"),
339 if disconnect_count & !disconnect_flags > 0 {
340 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
341 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
344 // Now fix monitor updating...
345 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
346 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
347 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
348 check_added_monitors!(nodes[0], 0);
350 macro_rules! disconnect_reconnect_peers { () => { {
351 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
352 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
354 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
355 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
356 assert_eq!(reestablish_1.len(), 1);
357 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
358 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
359 assert_eq!(reestablish_2.len(), 1);
361 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
362 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
363 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
364 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
366 assert!(as_resp.0.is_none());
367 assert!(bs_resp.0.is_none());
369 (reestablish_1, reestablish_2, as_resp, bs_resp)
372 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
373 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
374 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
376 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
377 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
378 assert_eq!(reestablish_1.len(), 1);
379 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
380 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
381 assert_eq!(reestablish_2.len(), 1);
383 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
384 check_added_monitors!(nodes[0], 0);
385 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
386 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
387 check_added_monitors!(nodes[1], 0);
388 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
390 assert!(as_resp.0.is_none());
391 assert!(bs_resp.0.is_none());
393 assert!(bs_resp.1.is_none());
394 if (disconnect_count & 16) == 0 {
395 assert!(bs_resp.2.is_none());
397 assert!(as_resp.1.is_some());
398 assert!(as_resp.2.is_some());
399 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
401 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
402 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
403 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
404 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
405 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
406 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
408 assert!(as_resp.1.is_none());
410 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
411 let events_3 = nodes[0].node.get_and_clear_pending_events();
412 assert_eq!(events_3.len(), 1);
414 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
415 assert_eq!(*payment_preimage, payment_preimage_1);
416 assert_eq!(*payment_hash, payment_hash_1);
418 _ => panic!("Unexpected event"),
421 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
422 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
423 // No commitment_signed so get_event_msg's assert(len == 1) passes
424 check_added_monitors!(nodes[0], 1);
426 as_resp.1 = Some(as_resp_raa);
430 if disconnect_count & !disconnect_flags > 1 {
431 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
433 if (disconnect_count & 16) == 0 {
434 assert!(reestablish_1 == second_reestablish_1);
435 assert!(reestablish_2 == second_reestablish_2);
437 assert!(as_resp == second_as_resp);
438 assert!(bs_resp == second_bs_resp);
441 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
443 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
444 assert_eq!(events_4.len(), 2);
445 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
446 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
447 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
450 _ => panic!("Unexpected event"),
454 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
456 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
457 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
458 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
459 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
460 check_added_monitors!(nodes[1], 1);
462 if disconnect_count & !disconnect_flags > 2 {
463 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
465 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
466 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
468 assert!(as_resp.2.is_none());
469 assert!(bs_resp.2.is_none());
472 let as_commitment_update;
473 let bs_second_commitment_update;
475 macro_rules! handle_bs_raa { () => {
476 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
477 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
478 assert!(as_commitment_update.update_add_htlcs.is_empty());
479 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
480 assert!(as_commitment_update.update_fail_htlcs.is_empty());
481 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
482 assert!(as_commitment_update.update_fee.is_none());
483 check_added_monitors!(nodes[0], 1);
486 macro_rules! handle_initial_raa { () => {
487 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
488 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
489 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
490 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
491 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
492 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
493 assert!(bs_second_commitment_update.update_fee.is_none());
494 check_added_monitors!(nodes[1], 1);
497 if (disconnect_count & 8) == 0 {
500 if disconnect_count & !disconnect_flags > 3 {
501 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
503 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
504 assert!(bs_resp.1.is_none());
506 assert!(as_resp.2.unwrap() == as_commitment_update);
507 assert!(bs_resp.2.is_none());
509 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
512 handle_initial_raa!();
514 if disconnect_count & !disconnect_flags > 4 {
515 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
517 assert!(as_resp.1.is_none());
518 assert!(bs_resp.1.is_none());
520 assert!(as_resp.2.unwrap() == as_commitment_update);
521 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
524 handle_initial_raa!();
526 if disconnect_count & !disconnect_flags > 3 {
527 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
529 assert!(as_resp.1.is_none());
530 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
532 assert!(as_resp.2.is_none());
533 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
535 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
540 if disconnect_count & !disconnect_flags > 4 {
541 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
543 assert!(as_resp.1.is_none());
544 assert!(bs_resp.1.is_none());
546 assert!(as_resp.2.unwrap() == as_commitment_update);
547 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
551 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
552 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
553 // No commitment_signed so get_event_msg's assert(len == 1) passes
554 check_added_monitors!(nodes[0], 1);
556 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
557 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
558 // No commitment_signed so get_event_msg's assert(len == 1) passes
559 check_added_monitors!(nodes[1], 1);
561 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
562 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
563 check_added_monitors!(nodes[1], 1);
565 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
566 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
567 check_added_monitors!(nodes[0], 1);
568 expect_payment_path_successful!(nodes[0]);
570 expect_pending_htlcs_forwardable!(nodes[1]);
572 let events_5 = nodes[1].node.get_and_clear_pending_events();
573 assert_eq!(events_5.len(), 1);
575 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
576 assert_eq!(payment_hash_2, *payment_hash);
577 assert_eq!(amount_msat, 1_000_000);
578 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
579 assert_eq!(via_channel_id, Some(channel_id));
581 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
582 assert!(payment_preimage.is_none());
583 assert_eq!(payment_secret_2, *payment_secret);
585 _ => panic!("expected PaymentPurpose::InvoicePayment")
588 _ => panic!("Unexpected event"),
591 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
595 fn test_monitor_temporary_update_fail_a() {
596 do_test_monitor_temporary_update_fail(0);
597 do_test_monitor_temporary_update_fail(1);
598 do_test_monitor_temporary_update_fail(2);
599 do_test_monitor_temporary_update_fail(3);
600 do_test_monitor_temporary_update_fail(4);
601 do_test_monitor_temporary_update_fail(5);
605 fn test_monitor_temporary_update_fail_b() {
606 do_test_monitor_temporary_update_fail(2 | 8);
607 do_test_monitor_temporary_update_fail(3 | 8);
608 do_test_monitor_temporary_update_fail(4 | 8);
609 do_test_monitor_temporary_update_fail(5 | 8);
613 fn test_monitor_temporary_update_fail_c() {
614 do_test_monitor_temporary_update_fail(1 | 16);
615 do_test_monitor_temporary_update_fail(2 | 16);
616 do_test_monitor_temporary_update_fail(3 | 16);
617 do_test_monitor_temporary_update_fail(2 | 8 | 16);
618 do_test_monitor_temporary_update_fail(3 | 8 | 16);
622 fn test_monitor_update_fail_cs() {
623 // Tests handling of a monitor update failure when processing an incoming commitment_signed
624 let chanmon_cfgs = create_chanmon_cfgs(2);
625 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
626 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
627 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
628 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
630 let (route, our_payment_hash, payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
632 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
633 check_added_monitors!(nodes[0], 1);
636 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
637 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
639 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
640 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
641 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
642 check_added_monitors!(nodes[1], 1);
643 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
645 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
646 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
647 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
648 check_added_monitors!(nodes[1], 0);
649 let responses = nodes[1].node.get_and_clear_pending_msg_events();
650 assert_eq!(responses.len(), 2);
653 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
654 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
655 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
656 check_added_monitors!(nodes[0], 1);
658 _ => panic!("Unexpected event"),
661 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
662 assert!(updates.update_add_htlcs.is_empty());
663 assert!(updates.update_fulfill_htlcs.is_empty());
664 assert!(updates.update_fail_htlcs.is_empty());
665 assert!(updates.update_fail_malformed_htlcs.is_empty());
666 assert!(updates.update_fee.is_none());
667 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
669 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
670 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
671 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
672 check_added_monitors!(nodes[0], 1);
673 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
675 _ => panic!("Unexpected event"),
678 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
679 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
680 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
681 check_added_monitors!(nodes[0], 0);
683 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
684 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
685 check_added_monitors!(nodes[1], 1);
687 expect_pending_htlcs_forwardable!(nodes[1]);
689 let events = nodes[1].node.get_and_clear_pending_events();
690 assert_eq!(events.len(), 1);
692 Event::PaymentClaimable { payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
693 assert_eq!(payment_hash, our_payment_hash);
694 assert_eq!(amount_msat, 1_000_000);
695 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
696 assert_eq!(via_channel_id, Some(channel_id));
698 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
699 assert!(payment_preimage.is_none());
700 assert_eq!(our_payment_secret, *payment_secret);
702 _ => panic!("expected PaymentPurpose::InvoicePayment")
705 _ => panic!("Unexpected event"),
708 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
712 fn test_monitor_update_fail_no_rebroadcast() {
713 // Tests handling of a monitor update failure when no message rebroadcasting on
714 // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
716 let chanmon_cfgs = create_chanmon_cfgs(2);
717 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
718 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
719 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
720 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
722 let (route, our_payment_hash, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
724 nodes[0].node.send_payment(&route, our_payment_hash, &Some(payment_secret_1), PaymentId(our_payment_hash.0)).unwrap();
725 check_added_monitors!(nodes[0], 1);
728 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
729 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
730 let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
732 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
733 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
734 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
735 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
736 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
737 check_added_monitors!(nodes[1], 1);
739 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
740 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
741 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
742 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
743 check_added_monitors!(nodes[1], 0);
744 expect_pending_htlcs_forwardable!(nodes[1]);
746 let events = nodes[1].node.get_and_clear_pending_events();
747 assert_eq!(events.len(), 1);
749 Event::PaymentClaimable { payment_hash, .. } => {
750 assert_eq!(payment_hash, our_payment_hash);
752 _ => panic!("Unexpected event"),
755 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
759 fn test_monitor_update_raa_while_paused() {
760 // Tests handling of an RAA while monitor updating has already been marked failed.
761 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
762 let chanmon_cfgs = create_chanmon_cfgs(2);
763 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
764 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
765 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
766 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
768 send_payment(&nodes[0], &[&nodes[1]], 5000000);
769 let (route, our_payment_hash_1, payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
771 nodes[0].node.send_payment(&route, our_payment_hash_1, &Some(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
772 check_added_monitors!(nodes[0], 1);
774 let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
776 let (route, our_payment_hash_2, payment_preimage_2, our_payment_secret_2) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000000);
778 nodes[1].node.send_payment(&route, our_payment_hash_2, &Some(our_payment_secret_2), PaymentId(our_payment_hash_2.0)).unwrap();
779 check_added_monitors!(nodes[1], 1);
781 let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
783 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
784 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
785 check_added_monitors!(nodes[1], 1);
786 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
788 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
789 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
790 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
791 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
792 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
793 check_added_monitors!(nodes[0], 1);
794 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
796 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
797 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
798 check_added_monitors!(nodes[0], 1);
800 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
801 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
802 check_added_monitors!(nodes[0], 0);
804 let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
805 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
806 check_added_monitors!(nodes[1], 1);
807 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
809 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
810 check_added_monitors!(nodes[1], 1);
811 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
813 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
814 check_added_monitors!(nodes[0], 1);
815 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
817 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
818 check_added_monitors!(nodes[0], 1);
819 expect_pending_htlcs_forwardable!(nodes[0]);
820 expect_payment_claimable!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
822 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
823 check_added_monitors!(nodes[1], 1);
824 expect_pending_htlcs_forwardable!(nodes[1]);
825 expect_payment_claimable!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
827 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
828 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
831 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
832 // Tests handling of a monitor update failure when processing an incoming RAA
833 let chanmon_cfgs = create_chanmon_cfgs(3);
834 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
835 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
836 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
837 create_announced_chan_between_nodes(&nodes, 0, 1);
838 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
840 // Rebalance a bit so that we can send backwards from 2 to 1.
841 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
843 // Route a first payment that we'll fail backwards
844 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
846 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
847 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
848 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
849 check_added_monitors!(nodes[2], 1);
851 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
852 assert!(updates.update_add_htlcs.is_empty());
853 assert!(updates.update_fulfill_htlcs.is_empty());
854 assert_eq!(updates.update_fail_htlcs.len(), 1);
855 assert!(updates.update_fail_malformed_htlcs.is_empty());
856 assert!(updates.update_fee.is_none());
857 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
859 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
860 check_added_monitors!(nodes[0], 0);
862 // While the second channel is AwaitingRAA, forward a second payment to get it into the
864 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
866 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
867 check_added_monitors!(nodes[0], 1);
870 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
871 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
872 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
874 expect_pending_htlcs_forwardable!(nodes[1]);
875 check_added_monitors!(nodes[1], 0);
876 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
878 // Now fail monitor updating.
879 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
880 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
881 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
882 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
883 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
884 check_added_monitors!(nodes[1], 1);
886 // Forward a third payment which will also be added to the holding cell, despite the channel
887 // being paused waiting a monitor update.
888 let (route, payment_hash_3, _, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
890 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
891 check_added_monitors!(nodes[0], 1);
894 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed); // We succeed in updating the monitor for the first channel
895 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
896 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
897 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
898 check_added_monitors!(nodes[1], 0);
900 // Call forward_pending_htlcs and check that the new HTLC was simply added to the holding cell
901 // and not forwarded.
902 expect_pending_htlcs_forwardable!(nodes[1]);
903 check_added_monitors!(nodes[1], 0);
904 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
906 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
907 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
908 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
909 nodes[2].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4), PaymentId(payment_hash_4.0)).unwrap();
910 check_added_monitors!(nodes[2], 1);
912 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
913 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
914 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
915 check_added_monitors!(nodes[1], 1);
916 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
917 (Some(payment_preimage_4), Some(payment_hash_4))
918 } else { (None, None) };
920 // Restore monitor updating, ensuring we immediately get a fail-back update and a
921 // update_add update.
922 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
923 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
924 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
925 check_added_monitors!(nodes[1], 0);
926 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
927 check_added_monitors!(nodes[1], 1);
929 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
930 if test_ignore_second_cs {
931 assert_eq!(events_3.len(), 3);
933 assert_eq!(events_3.len(), 2);
936 // Note that the ordering of the events for different nodes is non-prescriptive, though the
937 // ordering of the two events that both go to nodes[2] have to stay in the same order.
938 let (nodes_0_event, events_3) = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &events_3);
939 let messages_a = match nodes_0_event {
940 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
941 assert_eq!(node_id, nodes[0].node.get_our_node_id());
942 assert!(updates.update_fulfill_htlcs.is_empty());
943 assert_eq!(updates.update_fail_htlcs.len(), 1);
944 assert!(updates.update_fail_malformed_htlcs.is_empty());
945 assert!(updates.update_add_htlcs.is_empty());
946 assert!(updates.update_fee.is_none());
947 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
949 _ => panic!("Unexpected event type!"),
952 let (nodes_2_event, events_3) = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &events_3);
953 let send_event_b = SendEvent::from_event(nodes_2_event);
954 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
956 let raa = if test_ignore_second_cs {
957 let (nodes_2_event, _events_3) = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &events_3);
958 match nodes_2_event {
959 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
960 assert_eq!(node_id, nodes[2].node.get_our_node_id());
963 _ => panic!("Unexpected event"),
967 // Now deliver the new messages...
969 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
970 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
971 expect_payment_failed!(nodes[0], payment_hash_1, true);
973 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
975 if test_ignore_second_cs {
976 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
977 check_added_monitors!(nodes[2], 1);
978 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
979 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
980 check_added_monitors!(nodes[2], 1);
981 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
982 assert!(bs_cs.update_add_htlcs.is_empty());
983 assert!(bs_cs.update_fail_htlcs.is_empty());
984 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
985 assert!(bs_cs.update_fulfill_htlcs.is_empty());
986 assert!(bs_cs.update_fee.is_none());
988 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
989 check_added_monitors!(nodes[1], 1);
990 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
992 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
993 check_added_monitors!(nodes[1], 1);
995 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
996 check_added_monitors!(nodes[2], 1);
998 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
999 // As both messages are for nodes[1], they're in order.
1000 assert_eq!(bs_revoke_and_commit.len(), 2);
1001 match bs_revoke_and_commit[0] {
1002 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1003 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1004 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
1005 check_added_monitors!(nodes[1], 1);
1007 _ => panic!("Unexpected event"),
1010 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1012 match bs_revoke_and_commit[1] {
1013 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1014 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1015 assert!(updates.update_add_htlcs.is_empty());
1016 assert!(updates.update_fail_htlcs.is_empty());
1017 assert!(updates.update_fail_malformed_htlcs.is_empty());
1018 assert!(updates.update_fulfill_htlcs.is_empty());
1019 assert!(updates.update_fee.is_none());
1020 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1021 check_added_monitors!(nodes[1], 1);
1023 _ => panic!("Unexpected event"),
1027 assert_eq!(as_cs.update_add_htlcs.len(), 1);
1028 assert!(as_cs.update_fail_htlcs.is_empty());
1029 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1030 assert!(as_cs.update_fulfill_htlcs.is_empty());
1031 assert!(as_cs.update_fee.is_none());
1032 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1035 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1036 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1037 check_added_monitors!(nodes[2], 1);
1038 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1040 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1041 check_added_monitors!(nodes[2], 1);
1042 let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1044 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1045 check_added_monitors!(nodes[1], 1);
1046 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1048 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1049 check_added_monitors!(nodes[1], 1);
1050 let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1052 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1053 check_added_monitors!(nodes[2], 1);
1054 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1056 expect_pending_htlcs_forwardable!(nodes[2]);
1058 let events_6 = nodes[2].node.get_and_clear_pending_events();
1059 assert_eq!(events_6.len(), 2);
1061 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1062 _ => panic!("Unexpected event"),
1065 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1066 _ => panic!("Unexpected event"),
1069 if test_ignore_second_cs {
1070 expect_pending_htlcs_forwardable!(nodes[1]);
1071 check_added_monitors!(nodes[1], 1);
1073 send_event = SendEvent::from_node(&nodes[1]);
1074 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1075 assert_eq!(send_event.msgs.len(), 1);
1076 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1077 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1079 expect_pending_htlcs_forwardable!(nodes[0]);
1081 let events_9 = nodes[0].node.get_and_clear_pending_events();
1082 assert_eq!(events_9.len(), 1);
1084 Event::PaymentClaimable { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1085 _ => panic!("Unexpected event"),
1087 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1090 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1094 fn test_monitor_update_fail_raa() {
1095 do_test_monitor_update_fail_raa(false);
1096 do_test_monitor_update_fail_raa(true);
1100 fn test_monitor_update_fail_reestablish() {
1101 // Simple test for message retransmission after monitor update failure on
1102 // channel_reestablish generating a monitor update (which comes from freeing holding cell
1104 let chanmon_cfgs = create_chanmon_cfgs(3);
1105 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1106 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1107 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1108 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1109 create_announced_chan_between_nodes(&nodes, 1, 2);
1111 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
1113 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1114 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1116 nodes[2].node.claim_funds(payment_preimage);
1117 check_added_monitors!(nodes[2], 1);
1118 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
1120 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1121 assert!(updates.update_add_htlcs.is_empty());
1122 assert!(updates.update_fail_htlcs.is_empty());
1123 assert!(updates.update_fail_malformed_htlcs.is_empty());
1124 assert!(updates.update_fee.is_none());
1125 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1126 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1127 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
1128 check_added_monitors!(nodes[1], 1);
1129 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1130 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1132 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1133 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
1134 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
1136 let as_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1137 let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1139 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1141 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1143 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1144 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1146 nodes[1].node.get_and_clear_pending_msg_events(); // Free the holding cell
1147 check_added_monitors!(nodes[1], 1);
1149 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1150 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1152 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
1153 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
1155 assert_eq!(get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap(), as_reestablish);
1156 assert_eq!(get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap(), bs_reestablish);
1158 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1160 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1161 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1163 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1164 check_added_monitors!(nodes[1], 0);
1166 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1167 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1169 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1170 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1171 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1172 check_added_monitors!(nodes[1], 0);
1174 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1175 assert!(updates.update_add_htlcs.is_empty());
1176 assert!(updates.update_fail_htlcs.is_empty());
1177 assert!(updates.update_fail_malformed_htlcs.is_empty());
1178 assert!(updates.update_fee.is_none());
1179 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1180 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1181 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1182 expect_payment_sent!(nodes[0], payment_preimage);
1186 fn raa_no_response_awaiting_raa_state() {
1187 // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1188 // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1189 // in question (assuming it intends to respond with a CS after monitor updating is restored).
1190 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1191 let chanmon_cfgs = create_chanmon_cfgs(2);
1192 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1193 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1194 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1195 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1197 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1198 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1199 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1201 // Queue up two payments - one will be delivered right away, one immediately goes into the
1202 // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1203 // immediately after a CS. By setting failing the monitor update failure from the CS (which
1204 // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1205 // generation during RAA while in monitor-update-failed state.
1207 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1208 check_added_monitors!(nodes[0], 1);
1209 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1210 check_added_monitors!(nodes[0], 0);
1213 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1214 assert_eq!(events.len(), 1);
1215 let payment_event = SendEvent::from_event(events.pop().unwrap());
1216 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1217 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1218 check_added_monitors!(nodes[1], 1);
1220 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1221 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1222 check_added_monitors!(nodes[0], 1);
1223 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1224 assert_eq!(events.len(), 1);
1225 let payment_event = SendEvent::from_event(events.pop().unwrap());
1227 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1228 check_added_monitors!(nodes[0], 1);
1229 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1231 // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1232 // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1233 // then restore channel monitor updates.
1234 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1235 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1236 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1237 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1238 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1239 check_added_monitors!(nodes[1], 1);
1240 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1242 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1243 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1244 check_added_monitors!(nodes[1], 1);
1246 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1247 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1248 // nodes[1] should be AwaitingRAA here!
1249 check_added_monitors!(nodes[1], 0);
1250 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1251 expect_pending_htlcs_forwardable!(nodes[1]);
1252 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1254 // We send a third payment here, which is somewhat of a redundant test, but the
1255 // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1256 // commitment transaction states) whereas here we can explicitly check for it.
1258 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1259 check_added_monitors!(nodes[0], 0);
1260 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1262 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1263 check_added_monitors!(nodes[0], 1);
1264 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1265 assert_eq!(events.len(), 1);
1266 let payment_event = SendEvent::from_event(events.pop().unwrap());
1268 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1269 check_added_monitors!(nodes[0], 1);
1270 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1272 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1273 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1274 check_added_monitors!(nodes[1], 1);
1275 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1277 // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1278 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1279 check_added_monitors!(nodes[1], 1);
1280 expect_pending_htlcs_forwardable!(nodes[1]);
1281 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1282 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1284 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1285 check_added_monitors!(nodes[0], 1);
1287 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1288 check_added_monitors!(nodes[0], 1);
1289 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1291 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1292 check_added_monitors!(nodes[1], 1);
1293 expect_pending_htlcs_forwardable!(nodes[1]);
1294 expect_payment_claimable!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1296 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1297 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1298 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1302 fn claim_while_disconnected_monitor_update_fail() {
1303 // Test for claiming a payment while disconnected and then having the resulting
1304 // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1305 // contrived case for nodes with network instability.
1306 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1307 // code introduced a regression in this test (specifically, this caught a removal of the
1308 // channel_reestablish handling ensuring the order was sensical given the messages used).
1309 let chanmon_cfgs = create_chanmon_cfgs(2);
1310 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1311 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1312 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1313 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1315 // Forward a payment for B to claim
1316 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1318 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1319 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1321 nodes[1].node.claim_funds(payment_preimage_1);
1322 check_added_monitors!(nodes[1], 1);
1323 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1325 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
1326 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
1328 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1329 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1331 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1332 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1334 // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1336 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1338 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1339 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1340 check_added_monitors!(nodes[1], 1);
1341 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1343 // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1344 // the monitor still failed
1345 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1347 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1348 check_added_monitors!(nodes[0], 1);
1351 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1352 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1353 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1354 check_added_monitors!(nodes[1], 1);
1355 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1356 // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1357 // until we've channel_monitor_update'd and updated for the new commitment transaction.
1359 // Now un-fail the monitor, which will result in B sending its original commitment update,
1360 // receiving the commitment update from A, and the resulting commitment dances.
1361 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1362 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1363 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1364 check_added_monitors!(nodes[1], 0);
1366 let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1367 assert_eq!(bs_msgs.len(), 2);
1370 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1371 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1372 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1373 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1374 check_added_monitors!(nodes[0], 1);
1376 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1377 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1378 check_added_monitors!(nodes[1], 1);
1380 _ => panic!("Unexpected event"),
1384 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1385 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1386 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1387 check_added_monitors!(nodes[0], 1);
1389 _ => panic!("Unexpected event"),
1392 let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1394 let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1395 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1396 check_added_monitors!(nodes[0], 1);
1397 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1399 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1400 check_added_monitors!(nodes[1], 1);
1401 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1402 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1403 check_added_monitors!(nodes[1], 1);
1405 expect_pending_htlcs_forwardable!(nodes[1]);
1406 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1408 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1409 check_added_monitors!(nodes[0], 1);
1410 expect_payment_sent!(nodes[0], payment_preimage_1);
1412 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1416 fn monitor_failed_no_reestablish_response() {
1417 // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1418 // response to a commitment_signed.
1419 // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1420 // debug_assert!() failure in channel_reestablish handling.
1421 let chanmon_cfgs = create_chanmon_cfgs(2);
1422 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1423 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1424 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1425 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1427 let mut node_0_per_peer_lock;
1428 let mut node_0_peer_state_lock;
1429 let mut node_1_per_peer_lock;
1430 let mut node_1_peer_state_lock;
1431 get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, channel_id).announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1432 get_channel_ref!(nodes[1], nodes[0], node_1_per_peer_lock, node_1_peer_state_lock, channel_id).announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1435 // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1437 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1439 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1440 check_added_monitors!(nodes[0], 1);
1443 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1444 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1445 assert_eq!(events.len(), 1);
1446 let payment_event = SendEvent::from_event(events.pop().unwrap());
1447 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1448 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1449 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1450 check_added_monitors!(nodes[1], 1);
1452 // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1453 // is still failing to update monitors.
1454 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1455 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1457 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
1458 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
1460 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1461 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1463 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1464 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1465 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1466 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1468 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1469 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1470 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1471 check_added_monitors!(nodes[1], 0);
1472 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1474 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1475 check_added_monitors!(nodes[0], 1);
1476 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1477 check_added_monitors!(nodes[0], 1);
1479 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1480 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1481 check_added_monitors!(nodes[1], 1);
1483 expect_pending_htlcs_forwardable!(nodes[1]);
1484 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1486 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1490 fn first_message_on_recv_ordering() {
1491 // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1492 // messages, we're willing to flip the order of response messages if neccessary in resposne to
1493 // a commitment_signed which needs to send an RAA first.
1494 // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1495 // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1496 // response. To do this, we start routing two payments, with the final RAA for the first being
1497 // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1498 // have no pending response but will want to send a RAA/CS (with the updates for the second
1499 // payment applied).
1500 // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1501 let chanmon_cfgs = create_chanmon_cfgs(2);
1502 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1503 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1504 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1505 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1507 // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1508 // can deliver it and fail the monitor update.
1509 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1511 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1512 check_added_monitors!(nodes[0], 1);
1515 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1516 assert_eq!(events.len(), 1);
1517 let payment_event = SendEvent::from_event(events.pop().unwrap());
1518 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1519 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1520 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1521 check_added_monitors!(nodes[1], 1);
1522 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1524 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1525 check_added_monitors!(nodes[0], 1);
1526 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1527 check_added_monitors!(nodes[0], 1);
1529 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1531 // Route the second payment, generating an update_add_htlc/commitment_signed
1532 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1534 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1535 check_added_monitors!(nodes[0], 1);
1537 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1538 assert_eq!(events.len(), 1);
1539 let payment_event = SendEvent::from_event(events.pop().unwrap());
1540 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1542 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1544 // Deliver the final RAA for the first payment, which does not require a response. RAAs
1545 // generally require a commitment_signed, so the fact that we're expecting an opposite response
1546 // to the next message also tests resetting the delivery order.
1547 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1548 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1549 check_added_monitors!(nodes[1], 1);
1551 // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1552 // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1553 // appropriate HTLC acceptance).
1554 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1555 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1556 check_added_monitors!(nodes[1], 1);
1557 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1559 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1560 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1561 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1562 check_added_monitors!(nodes[1], 0);
1564 expect_pending_htlcs_forwardable!(nodes[1]);
1565 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1567 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1568 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1569 check_added_monitors!(nodes[0], 1);
1570 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1571 check_added_monitors!(nodes[0], 1);
1573 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1574 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1575 check_added_monitors!(nodes[1], 1);
1577 expect_pending_htlcs_forwardable!(nodes[1]);
1578 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1580 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1581 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1585 fn test_monitor_update_fail_claim() {
1586 // Basic test for monitor update failures when processing claim_funds calls.
1587 // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1588 // update to claim the payment. We then send two payments C->B->A, which are held at B.
1589 // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1590 // the payments from C onwards to A.
1591 let chanmon_cfgs = create_chanmon_cfgs(3);
1592 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1593 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1594 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1595 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1596 create_announced_chan_between_nodes(&nodes, 1, 2);
1598 // Rebalance a bit so that we can send backwards from 3 to 2.
1599 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1601 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1603 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1604 nodes[1].node.claim_funds(payment_preimage_1);
1605 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1606 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1607 check_added_monitors!(nodes[1], 1);
1609 // Note that at this point there is a pending commitment transaction update for A being held by
1610 // B. Even when we go to send the payment from C through B to A, B will not update this
1611 // already-signed commitment transaction and will instead wait for it to resolve before
1612 // forwarding the payment onwards.
1614 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1_000_000);
1616 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1617 check_added_monitors!(nodes[2], 1);
1620 // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1621 // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1622 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1624 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1625 assert_eq!(events.len(), 1);
1626 let payment_event = SendEvent::from_event(events.pop().unwrap());
1627 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1628 let events = nodes[1].node.get_and_clear_pending_msg_events();
1629 assert_eq!(events.len(), 0);
1630 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1632 let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1633 nodes[2].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1634 check_added_monitors!(nodes[2], 1);
1636 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1637 assert_eq!(events.len(), 1);
1638 let payment_event = SendEvent::from_event(events.pop().unwrap());
1639 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1640 let events = nodes[1].node.get_and_clear_pending_msg_events();
1641 assert_eq!(events.len(), 0);
1642 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1644 // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1645 let channel_id = chan_1.2;
1646 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1647 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1648 check_added_monitors!(nodes[1], 0);
1650 let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1651 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1652 commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1653 expect_payment_sent!(nodes[0], payment_preimage_1);
1655 // Get the payment forwards, note that they were batched into one commitment update.
1656 expect_pending_htlcs_forwardable!(nodes[1]);
1657 check_added_monitors!(nodes[1], 1);
1658 let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1659 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1660 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1661 commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1662 expect_pending_htlcs_forwardable!(nodes[0]);
1664 let events = nodes[0].node.get_and_clear_pending_events();
1665 assert_eq!(events.len(), 2);
1667 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id } => {
1668 assert_eq!(payment_hash_2, *payment_hash);
1669 assert_eq!(1_000_000, amount_msat);
1670 assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1671 assert_eq!(via_channel_id, Some(channel_id));
1672 assert_eq!(via_user_channel_id, Some(42));
1674 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1675 assert!(payment_preimage.is_none());
1676 assert_eq!(payment_secret_2, *payment_secret);
1678 _ => panic!("expected PaymentPurpose::InvoicePayment")
1681 _ => panic!("Unexpected event"),
1684 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
1685 assert_eq!(payment_hash_3, *payment_hash);
1686 assert_eq!(1_000_000, amount_msat);
1687 assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1688 assert_eq!(via_channel_id, Some(channel_id));
1690 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1691 assert!(payment_preimage.is_none());
1692 assert_eq!(payment_secret_3, *payment_secret);
1694 _ => panic!("expected PaymentPurpose::InvoicePayment")
1697 _ => panic!("Unexpected event"),
1702 fn test_monitor_update_on_pending_forwards() {
1703 // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1704 // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1705 // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1706 // from C to A will be pending a forward to A.
1707 let chanmon_cfgs = create_chanmon_cfgs(3);
1708 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1709 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1710 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1711 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1712 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1714 // Rebalance a bit so that we can send backwards from 3 to 1.
1715 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1717 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1718 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
1719 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
1720 check_added_monitors!(nodes[2], 1);
1722 let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1723 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1724 commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1725 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1727 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
1729 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1730 check_added_monitors!(nodes[2], 1);
1733 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1734 assert_eq!(events.len(), 1);
1735 let payment_event = SendEvent::from_event(events.pop().unwrap());
1736 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1737 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1739 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1740 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 }]);
1741 check_added_monitors!(nodes[1], 1);
1742 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1744 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1745 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1746 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1747 check_added_monitors!(nodes[1], 0);
1749 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1750 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1751 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1752 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1754 let events = nodes[0].node.get_and_clear_pending_events();
1755 assert_eq!(events.len(), 2);
1756 if let Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } = events[0] {
1757 assert_eq!(payment_hash, payment_hash_1);
1758 assert!(payment_failed_permanently);
1759 } else { panic!("Unexpected event!"); }
1761 Event::PendingHTLCsForwardable { .. } => { },
1762 _ => panic!("Unexpected event"),
1764 nodes[0].node.process_pending_htlc_forwards();
1765 expect_payment_claimable!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1767 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1771 fn monitor_update_claim_fail_no_response() {
1772 // Test for claim_funds resulting in both a monitor update failure and no message response (due
1773 // to channel being AwaitingRAA).
1774 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1776 let chanmon_cfgs = create_chanmon_cfgs(2);
1777 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1778 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1779 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1780 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1782 // Forward a payment for B to claim
1783 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1785 // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1786 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1788 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1789 check_added_monitors!(nodes[0], 1);
1792 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1793 assert_eq!(events.len(), 1);
1794 let payment_event = SendEvent::from_event(events.pop().unwrap());
1795 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1796 let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1798 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1799 nodes[1].node.claim_funds(payment_preimage_1);
1800 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1801 check_added_monitors!(nodes[1], 1);
1803 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1805 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1806 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1807 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1808 check_added_monitors!(nodes[1], 0);
1809 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1811 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1812 check_added_monitors!(nodes[1], 1);
1813 expect_pending_htlcs_forwardable!(nodes[1]);
1814 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1816 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1817 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1818 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1819 expect_payment_sent!(nodes[0], payment_preimage_1);
1821 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1824 // restore_b_before_conf has no meaning if !confirm_a_first
1825 // restore_b_before_lock has no meaning if confirm_a_first
1826 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool, restore_b_before_lock: bool) {
1827 // Test that if the monitor update generated by funding_transaction_generated fails we continue
1828 // the channel setup happily after the update is restored.
1829 let chanmon_cfgs = create_chanmon_cfgs(2);
1830 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1831 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1832 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1834 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1835 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
1836 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
1838 let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
1840 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
1841 check_added_monitors!(nodes[0], 0);
1843 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1844 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1845 let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1846 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1847 check_added_monitors!(nodes[1], 1);
1849 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1850 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()));
1851 check_added_monitors!(nodes[0], 1);
1852 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1853 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1854 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1855 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1856 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1857 check_added_monitors!(nodes[0], 0);
1859 let events = nodes[0].node.get_and_clear_pending_events();
1860 assert_eq!(events.len(), 0);
1861 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1862 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1864 if confirm_a_first {
1865 confirm_transaction(&nodes[0], &funding_tx);
1866 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()));
1867 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1868 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1870 assert!(!restore_b_before_conf);
1871 confirm_transaction(&nodes[1], &funding_tx);
1872 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1875 // Make sure nodes[1] isn't stupid enough to re-send the ChannelReady on reconnect
1876 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1877 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1878 reconnect_nodes(&nodes[0], &nodes[1], (false, confirm_a_first), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1879 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1880 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1882 if !restore_b_before_conf {
1883 confirm_transaction(&nodes[1], &funding_tx);
1884 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1885 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1887 if !confirm_a_first && !restore_b_before_lock {
1888 confirm_transaction(&nodes[0], &funding_tx);
1889 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()));
1890 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1891 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1894 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1895 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1896 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1897 check_added_monitors!(nodes[1], 0);
1899 let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1900 if !restore_b_before_lock {
1901 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1902 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1904 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()));
1905 confirm_transaction(&nodes[0], &funding_tx);
1906 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1907 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready))
1910 if restore_b_before_conf {
1911 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1912 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1913 confirm_transaction(&nodes[1], &funding_tx);
1915 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1916 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1918 for node in nodes.iter() {
1919 assert!(node.gossip_sync.handle_channel_announcement(&announcement).unwrap());
1920 node.gossip_sync.handle_channel_update(&as_update).unwrap();
1921 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
1924 if !restore_b_before_lock {
1925 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
1927 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
1931 send_payment(&nodes[0], &[&nodes[1]], 8000000);
1932 close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1933 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
1934 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1938 fn during_funding_monitor_fail() {
1939 do_during_funding_monitor_fail(true, true, false);
1940 do_during_funding_monitor_fail(true, false, false);
1941 do_during_funding_monitor_fail(false, false, false);
1942 do_during_funding_monitor_fail(false, false, true);
1946 fn test_path_paused_mpp() {
1947 // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1949 let chanmon_cfgs = create_chanmon_cfgs(4);
1950 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1951 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1952 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1954 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
1955 let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2);
1956 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
1957 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
1959 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
1961 // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1962 let path = route.paths[0].clone();
1963 route.paths.push(path);
1964 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
1965 route.paths[0][0].short_channel_id = chan_1_id;
1966 route.paths[0][1].short_channel_id = chan_3_id;
1967 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
1968 route.paths[1][0].short_channel_id = chan_2_ann.contents.short_channel_id;
1969 route.paths[1][1].short_channel_id = chan_4_id;
1971 // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
1972 // (for the path 0 -> 2 -> 3) fails.
1973 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1974 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1976 // Now check that we get the right return value, indicating that the first path succeeded but
1977 // the second got a MonitorUpdateInProgress err. This implies
1978 // PaymentSendFailure::PartialFailure as some paths succeeded, preventing retry.
1979 if let Err(PaymentSendFailure::PartialFailure { results, ..}) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)) {
1980 assert_eq!(results.len(), 2);
1981 if let Ok(()) = results[0] {} else { panic!(); }
1982 if let Err(APIError::MonitorUpdateInProgress) = results[1] {} else { panic!(); }
1983 } else { panic!(); }
1984 check_added_monitors!(nodes[0], 2);
1985 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1987 // Pass the first HTLC of the payment along to nodes[3].
1988 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1989 assert_eq!(events.len(), 1);
1990 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false, None);
1992 // And check that, after we successfully update the monitor for chan_2 we can pass the second
1993 // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
1994 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
1995 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1996 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1997 assert_eq!(events.len(), 1);
1998 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true, None);
2000 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
2004 fn test_pending_update_fee_ack_on_reconnect() {
2005 // In early versions of our automated fee update patch, nodes did not correctly use the
2006 // previous channel feerate after sending an undelivered revoke_and_ack when re-sending an
2007 // undelivered commitment_signed.
2009 // B sends A new HTLC + CS, not delivered
2010 // A sends B update_fee + CS
2011 // B receives the CS and sends RAA, previously causing B to lock in the new feerate
2013 // B resends initial CS, using the original fee
2015 let chanmon_cfgs = create_chanmon_cfgs(2);
2016 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2017 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2018 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2020 create_announced_chan_between_nodes(&nodes, 0, 1);
2021 send_payment(&nodes[0], &[&nodes[1]], 100_000_00);
2023 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[1], nodes[0], 1_000_000);
2024 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
2025 check_added_monitors!(nodes[1], 1);
2026 let bs_initial_send_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2027 // bs_initial_send_msgs are not delivered until they are re-generated after reconnect
2030 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2033 nodes[0].node.timer_tick_occurred();
2034 check_added_monitors!(nodes[0], 1);
2035 let as_update_fee_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2036 assert!(as_update_fee_msgs.update_fee.is_some());
2038 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_update_fee_msgs.update_fee.as_ref().unwrap());
2039 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_fee_msgs.commitment_signed);
2040 check_added_monitors!(nodes[1], 1);
2041 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2042 // bs_first_raa is not delivered until it is re-generated after reconnect
2044 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2045 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2047 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
2048 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2049 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
2050 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2052 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2053 let bs_resend_msgs = nodes[1].node.get_and_clear_pending_msg_events();
2054 assert_eq!(bs_resend_msgs.len(), 3);
2055 if let MessageSendEvent::UpdateHTLCs { ref updates, .. } = bs_resend_msgs[0] {
2056 assert_eq!(*updates, bs_initial_send_msgs);
2057 } else { panic!(); }
2058 if let MessageSendEvent::SendRevokeAndACK { ref msg, .. } = bs_resend_msgs[1] {
2059 assert_eq!(*msg, bs_first_raa);
2060 } else { panic!(); }
2061 if let MessageSendEvent::SendChannelUpdate { .. } = bs_resend_msgs[2] { } else { panic!(); }
2063 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2064 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
2066 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.update_add_htlcs[0]);
2067 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.commitment_signed);
2068 check_added_monitors!(nodes[0], 1);
2069 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()));
2070 check_added_monitors!(nodes[1], 1);
2071 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()).commitment_signed;
2073 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2074 check_added_monitors!(nodes[0], 1);
2075 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);
2076 check_added_monitors!(nodes[1], 1);
2077 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2079 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2080 check_added_monitors!(nodes[0], 1);
2081 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2082 check_added_monitors!(nodes[0], 1);
2084 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()));
2085 check_added_monitors!(nodes[1], 1);
2087 expect_pending_htlcs_forwardable!(nodes[0]);
2088 expect_payment_claimable!(nodes[0], payment_hash, payment_secret, 1_000_000);
2090 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
2094 fn test_fail_htlc_on_broadcast_after_claim() {
2095 // In an earlier version of 7e78fa660cec8a73286c94c1073ee588140e7a01 we'd also fail the inbound
2096 // channel backwards if we received an HTLC failure after a HTLC fulfillment. Here we test a
2097 // specific case of that by having the HTLC failure come from the ChannelMonitor after a dust
2098 // HTLC was not included in a confirmed commitment transaction.
2100 // We first forward a payment, then claim it with an update_fulfill_htlc message, closing the
2101 // channel immediately before commitment occurs. After the commitment transaction reaches
2102 // ANTI_REORG_DELAY confirmations, will will try to fail the HTLC which was already fulfilled.
2103 let chanmon_cfgs = create_chanmon_cfgs(3);
2104 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2105 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2106 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2108 create_announced_chan_between_nodes(&nodes, 0, 1);
2109 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2111 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 2000);
2113 let bs_txn = get_local_commitment_txn!(nodes[2], chan_id_2);
2114 assert_eq!(bs_txn.len(), 1);
2116 nodes[2].node.claim_funds(payment_preimage);
2117 check_added_monitors!(nodes[2], 1);
2118 expect_payment_claimed!(nodes[2], payment_hash, 2000);
2120 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2121 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
2122 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2123 check_added_monitors!(nodes[1], 1);
2124 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2126 mine_transaction(&nodes[1], &bs_txn[0]);
2127 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2128 check_closed_broadcast!(nodes[1], true);
2129 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2130 check_added_monitors!(nodes[1], 1);
2131 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 }]);
2133 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
2134 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2135 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, true, true);
2136 expect_payment_path_successful!(nodes[0]);
2139 fn do_update_fee_resend_test(deliver_update: bool, parallel_updates: bool) {
2140 // In early versions we did not handle resending of update_fee on reconnect correctly. The
2141 // chanmon_consistency fuzz target, of course, immediately found it, but we test a few cases
2143 let chanmon_cfgs = create_chanmon_cfgs(2);
2144 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2145 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2146 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2148 create_announced_chan_between_nodes(&nodes, 0, 1);
2149 send_payment(&nodes[0], &[&nodes[1]], 1000);
2152 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2153 *feerate_lock += 20;
2155 nodes[0].node.timer_tick_occurred();
2156 check_added_monitors!(nodes[0], 1);
2157 let update_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2158 assert!(update_msgs.update_fee.is_some());
2160 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2163 if parallel_updates {
2165 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2166 *feerate_lock += 20;
2168 nodes[0].node.timer_tick_occurred();
2169 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2172 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2173 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2175 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
2176 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2177 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
2178 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2180 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2181 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
2182 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2184 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2185 let mut as_reconnect_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2186 assert_eq!(as_reconnect_msgs.len(), 2);
2187 if let MessageSendEvent::SendChannelUpdate { .. } = as_reconnect_msgs.pop().unwrap() {} else { panic!(); }
2188 let update_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = as_reconnect_msgs.pop().unwrap()
2189 { updates } else { panic!(); };
2190 assert!(update_msgs.update_fee.is_some());
2191 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2192 if parallel_updates {
2193 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update_msgs.commitment_signed);
2194 check_added_monitors!(nodes[1], 1);
2195 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2196 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2197 check_added_monitors!(nodes[0], 1);
2198 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2200 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2201 check_added_monitors!(nodes[0], 1);
2202 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2204 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_second_update.update_fee.as_ref().unwrap());
2205 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
2206 check_added_monitors!(nodes[1], 1);
2207 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2209 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2210 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2211 check_added_monitors!(nodes[1], 1);
2213 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2214 check_added_monitors!(nodes[0], 1);
2216 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs.commitment_signed);
2217 check_added_monitors!(nodes[0], 1);
2218 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2220 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2221 check_added_monitors!(nodes[1], 1);
2223 commitment_signed_dance!(nodes[1], nodes[0], update_msgs.commitment_signed, false);
2226 send_payment(&nodes[0], &[&nodes[1]], 1000);
2229 fn update_fee_resend_test() {
2230 do_update_fee_resend_test(false, false);
2231 do_update_fee_resend_test(true, false);
2232 do_update_fee_resend_test(false, true);
2233 do_update_fee_resend_test(true, true);
2236 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2237 // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2238 // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2239 // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2240 // which failed in such a case).
2241 let chanmon_cfgs = create_chanmon_cfgs(2);
2242 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2243 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2244 let persister: test_utils::TestPersister;
2245 let new_chain_monitor: test_utils::TestChainMonitor;
2246 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
2247 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2249 let chan_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 15_000_000, 7_000_000_000).2;
2250 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
2251 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2253 // Do a really complicated dance to get an HTLC into the holding cell, with
2254 // MonitorUpdateInProgress set but AwaitingRemoteRevoke unset. When this test was written, any
2255 // attempts to send an HTLC while MonitorUpdateInProgress is set are immediately
2256 // failed-backwards. Thus, the only way to get an AddHTLC into the holding cell is to add it
2257 // while AwaitingRemoteRevoke is set but MonitorUpdateInProgress is unset, and then swap the
2261 // a) routing a payment from node B to node A,
2262 // b) sending a payment from node A to node B without delivering any of the generated messages,
2263 // putting node A in AwaitingRemoteRevoke,
2264 // c) sending a second payment from node A to node B, which is immediately placed in the
2266 // d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2267 // when we try to persist the payment preimage,
2268 // e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2269 // clearing AwaitingRemoteRevoke on node A.
2271 // Note that because, at the end, MonitorUpdateInProgress is still set, the HTLC generated in
2272 // (c) will not be freed from the holding cell.
2273 let (payment_preimage_0, payment_hash_0, _) = route_payment(&nodes[1], &[&nodes[0]], 100_000);
2275 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
2276 check_added_monitors!(nodes[0], 1);
2277 let send = SendEvent::from_node(&nodes[0]);
2278 assert_eq!(send.msgs.len(), 1);
2280 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
2281 check_added_monitors!(nodes[0], 0);
2283 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2284 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2285 nodes[0].node.claim_funds(payment_preimage_0);
2286 check_added_monitors!(nodes[0], 1);
2287 expect_payment_claimed!(nodes[0], payment_hash_0, 100_000);
2289 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2290 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2291 check_added_monitors!(nodes[1], 1);
2293 let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2295 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2296 check_added_monitors!(nodes[0], 1);
2299 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2300 // disconnect the peers. Note that the fuzzer originally found this issue because
2301 // deserializing a ChannelManager in this state causes an assertion failure.
2303 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
2304 reload_node!(nodes[0], &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
2306 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2308 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2310 // Now reconnect the two
2311 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
2312 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2313 assert_eq!(reestablish_1.len(), 1);
2314 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
2315 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2316 assert_eq!(reestablish_2.len(), 1);
2318 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2319 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2320 check_added_monitors!(nodes[1], 0);
2322 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2323 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2325 assert!(resp_0.0.is_none());
2326 assert!(resp_0.1.is_none());
2327 assert!(resp_0.2.is_none());
2328 assert!(resp_1.0.is_none());
2329 assert!(resp_1.1.is_none());
2331 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2333 if let Some(pending_cs) = resp_1.2 {
2334 assert!(pending_cs.update_add_htlcs.is_empty());
2335 assert!(pending_cs.update_fail_htlcs.is_empty());
2336 assert!(pending_cs.update_fulfill_htlcs.is_empty());
2337 assert_eq!(pending_cs.commitment_signed, cs);
2338 } else { panic!(); }
2340 // There should be no monitor updates as we are still pending awaiting a failed one.
2341 check_added_monitors!(nodes[0], 0);
2342 check_added_monitors!(nodes[1], 0);
2345 // If we finish updating the monitor, we should free the holding cell right away (this did
2346 // not occur prior to #756).
2347 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2348 let (funding_txo, mon_id, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2349 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_txo, mon_id);
2351 // New outbound messages should be generated immediately upon a call to
2352 // get_and_clear_pending_msg_events (but not before).
2353 check_added_monitors!(nodes[0], 0);
2354 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2355 check_added_monitors!(nodes[0], 1);
2356 assert_eq!(events.len(), 1);
2358 // Deliver the pending in-flight CS
2359 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2360 check_added_monitors!(nodes[0], 1);
2362 let commitment_msg = match events.pop().unwrap() {
2363 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2364 assert_eq!(node_id, nodes[1].node.get_our_node_id());
2365 assert!(updates.update_fail_htlcs.is_empty());
2366 assert!(updates.update_fail_malformed_htlcs.is_empty());
2367 assert!(updates.update_fee.is_none());
2368 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2369 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2370 expect_payment_sent_without_paths!(nodes[1], payment_preimage_0);
2371 assert_eq!(updates.update_add_htlcs.len(), 1);
2372 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2373 updates.commitment_signed
2375 _ => panic!("Unexpected event type!"),
2378 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2379 check_added_monitors!(nodes[1], 1);
2381 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2382 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2383 expect_pending_htlcs_forwardable!(nodes[1]);
2384 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2385 check_added_monitors!(nodes[1], 1);
2387 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
2389 let events = nodes[1].node.get_and_clear_pending_events();
2390 assert_eq!(events.len(), 2);
2392 Event::PendingHTLCsForwardable { .. } => { },
2393 _ => panic!("Unexpected event"),
2396 Event::PaymentPathSuccessful { .. } => { },
2397 _ => panic!("Unexpected event"),
2400 nodes[1].node.process_pending_htlc_forwards();
2401 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2403 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2404 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2407 fn channel_holding_cell_serialize() {
2408 do_channel_holding_cell_serialize(true, true);
2409 do_channel_holding_cell_serialize(true, false);
2410 do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2413 #[derive(PartialEq)]
2414 enum HTLCStatusAtDupClaim {
2419 fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_fails: bool) {
2420 // When receiving an update_fulfill_htlc message, we immediately forward the claim backwards
2421 // along the payment path before waiting for a full commitment_signed dance. This is great, but
2422 // can cause duplicative claims if a node sends an update_fulfill_htlc message, disconnects,
2423 // reconnects, and then has to re-send its update_fulfill_htlc message again.
2424 // In previous code, we didn't handle the double-claim correctly, spuriously closing the
2425 // channel on which the inbound HTLC was received.
2426 let chanmon_cfgs = create_chanmon_cfgs(3);
2427 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2428 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2429 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2431 create_announced_chan_between_nodes(&nodes, 0, 1);
2432 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2434 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
2436 let mut as_raa = None;
2437 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2438 // In order to get the HTLC claim into the holding cell at nodes[1], we need nodes[1] to be
2439 // awaiting a remote revoke_and_ack from nodes[0].
2440 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
2441 nodes[0].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret), PaymentId(second_payment_hash.0)).unwrap();
2442 check_added_monitors!(nodes[0], 1);
2444 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
2445 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
2446 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
2447 check_added_monitors!(nodes[1], 1);
2449 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2450 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2451 check_added_monitors!(nodes[0], 1);
2452 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
2453 check_added_monitors!(nodes[0], 1);
2455 as_raa = Some(get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2458 let fulfill_msg = msgs::UpdateFulfillHTLC {
2459 channel_id: chan_id_2,
2464 nodes[2].node.fail_htlc_backwards(&payment_hash);
2465 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash }]);
2466 check_added_monitors!(nodes[2], 1);
2467 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2469 nodes[2].node.claim_funds(payment_preimage);
2470 check_added_monitors!(nodes[2], 1);
2471 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
2473 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2474 assert_eq!(cs_updates.update_fulfill_htlcs.len(), 1);
2475 // Check that the message we're about to deliver matches the one generated:
2476 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
2478 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
2479 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2480 check_added_monitors!(nodes[1], 1);
2482 let mut bs_updates = None;
2483 if htlc_status != HTLCStatusAtDupClaim::HoldingCell {
2484 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2485 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2486 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2487 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2488 if htlc_status == HTLCStatusAtDupClaim::Cleared {
2489 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2490 expect_payment_path_successful!(nodes[0]);
2493 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2496 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
2497 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2500 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
2501 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 }]);
2503 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2506 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2507 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa.unwrap());
2508 check_added_monitors!(nodes[1], 1);
2509 expect_pending_htlcs_forwardable_ignore!(nodes[1]); // We finally receive the second payment, but don't claim it
2511 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2512 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2513 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2514 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2516 if htlc_status != HTLCStatusAtDupClaim::Cleared {
2517 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2518 expect_payment_path_successful!(nodes[0]);
2523 fn test_reconnect_dup_htlc_claims() {
2524 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, false);
2525 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, false);
2526 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, false);
2527 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, true);
2528 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, true);
2529 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, true);
2533 fn test_temporary_error_during_shutdown() {
2534 // Test that temporary failures when updating the monitor's shutdown script delay cooperative
2536 let mut config = test_default_channel_config();
2537 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2539 let chanmon_cfgs = create_chanmon_cfgs(2);
2540 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2541 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
2542 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2544 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
2546 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2547 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2549 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
2550 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
2551 check_added_monitors!(nodes[1], 1);
2553 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id()));
2554 check_added_monitors!(nodes[0], 1);
2556 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2558 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2559 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2561 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2562 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2563 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()));
2565 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2567 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2568 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2569 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2571 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()));
2572 let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
2573 let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2575 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_a.unwrap());
2576 let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
2577 assert!(none_b.is_none());
2578 let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2580 assert_eq!(txn_a, txn_b);
2581 assert_eq!(txn_a.len(), 1);
2582 check_spends!(txn_a[0], funding_tx);
2583 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
2584 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
2588 fn test_permanent_error_during_sending_shutdown() {
2589 // Test that permanent failures when updating the monitor's shutdown script result in a force
2590 // close when initiating a cooperative close.
2591 let mut config = test_default_channel_config();
2592 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2594 let chanmon_cfgs = create_chanmon_cfgs(2);
2595 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2596 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
2597 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2599 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
2600 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2602 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2603 check_closed_broadcast!(nodes[0], true);
2604 check_added_monitors!(nodes[0], 2);
2605 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2609 fn test_permanent_error_during_handling_shutdown() {
2610 // Test that permanent failures when updating the monitor's shutdown script result in a force
2611 // close when handling a cooperative close.
2612 let mut config = test_default_channel_config();
2613 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2615 let chanmon_cfgs = create_chanmon_cfgs(2);
2616 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2617 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
2618 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2620 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
2621 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2623 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2624 let shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
2625 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &shutdown);
2626 check_closed_broadcast!(nodes[1], true);
2627 check_added_monitors!(nodes[1], 2);
2628 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2632 fn double_temp_error() {
2633 // Test that it's OK to have multiple `ChainMonitor::update_channel` calls fail in a row.
2634 let chanmon_cfgs = create_chanmon_cfgs(2);
2635 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2636 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2637 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2639 let (_, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1);
2641 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2642 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2644 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2645 // `claim_funds` results in a ChannelMonitorUpdate.
2646 nodes[1].node.claim_funds(payment_preimage_1);
2647 check_added_monitors!(nodes[1], 1);
2648 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
2649 let (funding_tx, latest_update_1, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2651 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2652 // Previously, this would've panicked due to a double-call to `Channel::monitor_update_failed`,
2653 // which had some asserts that prevented it from being called twice.
2654 nodes[1].node.claim_funds(payment_preimage_2);
2655 check_added_monitors!(nodes[1], 1);
2656 expect_payment_claimed!(nodes[1], payment_hash_2, 1_000_000);
2657 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2659 let (_, latest_update_2, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2660 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_1);
2661 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2662 check_added_monitors!(nodes[1], 0);
2663 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_2);
2665 // Complete the first HTLC.
2666 let events = nodes[1].node.get_and_clear_pending_msg_events();
2667 assert_eq!(events.len(), 1);
2668 let (update_fulfill_1, commitment_signed_b1, node_id) = {
2670 &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 } } => {
2671 assert!(update_add_htlcs.is_empty());
2672 assert_eq!(update_fulfill_htlcs.len(), 1);
2673 assert!(update_fail_htlcs.is_empty());
2674 assert!(update_fail_malformed_htlcs.is_empty());
2675 assert!(update_fee.is_none());
2676 (update_fulfill_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2678 _ => panic!("Unexpected event"),
2681 assert_eq!(node_id, nodes[0].node.get_our_node_id());
2682 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_1);
2683 check_added_monitors!(nodes[0], 0);
2684 expect_payment_sent_without_paths!(nodes[0], payment_preimage_1);
2685 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_b1);
2686 check_added_monitors!(nodes[0], 1);
2687 nodes[0].node.process_pending_htlc_forwards();
2688 let (raa_a1, commitment_signed_a1) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2689 check_added_monitors!(nodes[1], 0);
2690 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2691 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_a1);
2692 check_added_monitors!(nodes[1], 1);
2693 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed_a1);
2694 check_added_monitors!(nodes[1], 1);
2696 // Complete the second HTLC.
2697 let ((update_fulfill_2, commitment_signed_b2), raa_b2) = {
2698 let events = nodes[1].node.get_and_clear_pending_msg_events();
2699 assert_eq!(events.len(), 2);
2701 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2702 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2703 assert!(updates.update_add_htlcs.is_empty());
2704 assert!(updates.update_fail_htlcs.is_empty());
2705 assert!(updates.update_fail_malformed_htlcs.is_empty());
2706 assert!(updates.update_fee.is_none());
2707 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2708 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2710 _ => panic!("Unexpected event"),
2713 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2714 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2717 _ => panic!("Unexpected event"),
2720 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_b2);
2721 check_added_monitors!(nodes[0], 1);
2722 expect_payment_path_successful!(nodes[0]);
2724 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_2);
2725 check_added_monitors!(nodes[0], 0);
2726 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2727 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed_b2, false);
2728 expect_payment_sent!(nodes[0], payment_preimage_2);
2731 fn do_test_outbound_reload_without_init_mon(use_0conf: bool) {
2732 // Test that if the monitor update generated in funding_signed is stored async and we restart
2733 // with the latest ChannelManager but the ChannelMonitor persistence never completed we happily
2734 // drop the channel and move on.
2735 let chanmon_cfgs = create_chanmon_cfgs(2);
2736 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2738 let persister: test_utils::TestPersister;
2739 let new_chain_monitor: test_utils::TestChainMonitor;
2740 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
2742 let mut chan_config = test_default_channel_config();
2743 chan_config.manually_accept_inbound_channels = true;
2744 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2746 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2747 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2749 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2750 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
2752 let events = nodes[1].node.get_and_clear_pending_events();
2753 assert_eq!(events.len(), 1);
2755 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2757 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2759 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2762 _ => panic!("Unexpected event"),
2765 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
2767 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2769 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2770 check_added_monitors!(nodes[0], 0);
2772 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2773 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2774 check_added_monitors!(nodes[1], 1);
2776 let bs_signed_locked = nodes[1].node.get_and_clear_pending_msg_events();
2777 assert_eq!(bs_signed_locked.len(), if use_0conf { 2 } else { 1 });
2778 match &bs_signed_locked[0] {
2779 MessageSendEvent::SendFundingSigned { msg, .. } => {
2780 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2782 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &msg);
2783 check_added_monitors!(nodes[0], 1);
2785 _ => panic!("Unexpected event"),
2788 match &bs_signed_locked[1] {
2789 MessageSendEvent::SendChannelReady { msg, .. } => {
2790 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &msg);
2792 _ => panic!("Unexpected event"),
2796 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
2797 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2798 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2800 // nodes[0] is now waiting on the first ChannelMonitor persistence to complete in order to
2801 // broadcast the funding transaction. If nodes[0] restarts at this point with the
2802 // ChannelMonitor lost, we should simply discard the channel.
2804 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2805 // not, so we have to clear them here.
2806 nodes[0].chain_source.watched_txn.lock().unwrap().clear();
2807 nodes[0].chain_source.watched_outputs.lock().unwrap().clear();
2809 reload_node!(nodes[0], &nodes[0].node.encode(), &[], persister, new_chain_monitor, nodes_0_deserialized);
2810 check_closed_event!(nodes[0], 1, ClosureReason::DisconnectedPeer);
2811 assert!(nodes[0].node.list_channels().is_empty());
2815 fn test_outbound_reload_without_init_mon() {
2816 do_test_outbound_reload_without_init_mon(true);
2817 do_test_outbound_reload_without_init_mon(false);
2820 fn do_test_inbound_reload_without_init_mon(use_0conf: bool, lock_commitment: bool) {
2821 // Test that if the monitor update generated by funding_transaction_generated is stored async
2822 // and we restart with the latest ChannelManager but the ChannelMonitor persistence never
2823 // completed we happily drop the channel and move on.
2824 let chanmon_cfgs = create_chanmon_cfgs(2);
2825 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2827 let persister: test_utils::TestPersister;
2828 let new_chain_monitor: test_utils::TestChainMonitor;
2829 let nodes_1_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
2831 let mut chan_config = test_default_channel_config();
2832 chan_config.manually_accept_inbound_channels = true;
2833 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2835 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2836 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2838 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2839 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
2841 let events = nodes[1].node.get_and_clear_pending_events();
2842 assert_eq!(events.len(), 1);
2844 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2846 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2848 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2851 _ => panic!("Unexpected event"),
2854 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
2856 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2858 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2859 check_added_monitors!(nodes[0], 0);
2861 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2862 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2863 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2864 check_added_monitors!(nodes[1], 1);
2866 // nodes[1] happily sends its funding_signed even though its awaiting the persistence of the
2867 // initial ChannelMonitor, but it will decline to send its channel_ready even if the funding
2868 // transaction is confirmed.
2869 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
2871 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
2872 check_added_monitors!(nodes[0], 1);
2874 let as_funding_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2875 if lock_commitment {
2876 confirm_transaction(&nodes[0], &as_funding_tx[0]);
2877 confirm_transaction(&nodes[1], &as_funding_tx[0]);
2879 if use_0conf || lock_commitment {
2880 let as_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
2881 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_ready);
2883 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2885 // nodes[1] is now waiting on the first ChannelMonitor persistence to complete in order to
2886 // move the channel to ready (or is waiting on the funding transaction to confirm). If nodes[1]
2887 // restarts at this point with the ChannelMonitor lost, we should simply discard the channel.
2889 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2890 // not, so we have to clear them here.
2891 nodes[1].chain_source.watched_txn.lock().unwrap().clear();
2892 nodes[1].chain_source.watched_outputs.lock().unwrap().clear();
2894 reload_node!(nodes[1], &nodes[1].node.encode(), &[], persister, new_chain_monitor, nodes_1_deserialized);
2896 check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
2897 assert!(nodes[1].node.list_channels().is_empty());
2901 fn test_inbound_reload_without_init_mon() {
2902 do_test_inbound_reload_without_init_mon(true, true);
2903 do_test_inbound_reload_without_init_mon(true, false);
2904 do_test_inbound_reload_without_init_mon(false, true);
2905 do_test_inbound_reload_without_init_mon(false, false);