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::constants::genesis_block;
16 use bitcoin::hash_types::BlockHash;
17 use bitcoin::network::Network;
18 use crate::chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor};
19 use crate::chain::transaction::OutPoint;
20 use crate::chain::{ChannelMonitorUpdateStatus, Listen, Watch};
21 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason, HTLCDestination};
22 use crate::ln::channelmanager::{RAACommitmentOrder, PaymentSendFailure, PaymentId, RecipientOnionFields};
23 use crate::ln::channel::{AnnouncementSigsState, ChannelPhase};
25 use crate::ln::types::ChannelId;
26 use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
27 use crate::util::test_channel_signer::TestChannelSigner;
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 crate::prelude::*;
39 use crate::sync::{Arc, Mutex};
42 fn test_monitor_and_persister_update_fail() {
43 // Test that if both updating the `ChannelMonitor` and persisting the updated
44 // `ChannelMonitor` fail, then the failure from updating the `ChannelMonitor`
45 // one that gets returned.
46 let chanmon_cfgs = create_chanmon_cfgs(2);
47 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
48 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
49 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
51 // Create some initial channel
52 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
53 let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
55 // Rebalance the network to generate htlc in the two directions
56 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
58 // Route an HTLC from node 0 to node 1 (but don't settle)
59 let (preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
61 // Make a copy of the ChainMonitor so we can capture the error it returns on a
62 // bogus update. Note that if instead we updated the nodes[0]'s ChainMonitor
63 // directly, the node would fail to be `Drop`'d at the end because its
64 // ChannelManager and ChainMonitor would be out of sync.
65 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
66 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
67 let persister = test_utils::TestPersister::new();
68 let tx_broadcaster = TestBroadcaster {
69 txn_broadcasted: Mutex::new(Vec::new()),
70 // Because we will connect a block at height 200 below, we need the TestBroadcaster to know
71 // that we are at height 200 so that it doesn't think we're violating the time lock
72 // requirements of transactions broadcasted at that point.
73 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 200); 200])),
77 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
78 let new_monitor = <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(
79 &mut io::Cursor::new(&monitor.encode()), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
80 assert!(new_monitor == *monitor);
83 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
84 assert_eq!(chain_mon.watch_channel(outpoint, new_monitor), Ok(ChannelMonitorUpdateStatus::Completed));
87 chain_mon.chain_monitor.block_connected(&create_dummy_block(BlockHash::all_zeros(), 42, Vec::new()), 200);
89 // Try to update ChannelMonitor
90 nodes[1].node.claim_funds(preimage);
91 expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
92 check_added_monitors!(nodes[1], 1);
94 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
95 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
96 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
99 let mut node_0_per_peer_lock;
100 let mut node_0_peer_state_lock;
101 if let ChannelPhase::Funded(ref mut channel) = get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan.2) {
102 if let Ok(Some(update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
103 // Check that the persister returns InProgress (and will never actually complete)
104 // as the monitor update errors.
105 if let ChannelMonitorUpdateStatus::InProgress = chain_mon.chain_monitor.update_channel(outpoint, &update) {} else { panic!("Expected monitor paused"); }
106 logger.assert_log_regex("lightning::chain::chainmonitor", regex::Regex::new("Failed to update ChannelMonitor for channel [0-9a-f]*.").unwrap(), 1);
108 // Apply the monitor update to the original ChainMonitor, ensuring the
109 // ChannelManager and ChannelMonitor aren't out of sync.
110 assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, &update),
111 ChannelMonitorUpdateStatus::Completed);
112 } else { assert!(false); }
118 check_added_monitors!(nodes[0], 1);
119 expect_payment_sent(&nodes[0], preimage, None, false, false);
122 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
123 // Test that we can recover from a simple temporary monitor update failure optionally with
124 // a disconnect in between
125 let chanmon_cfgs = create_chanmon_cfgs(2);
126 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
127 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
128 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
129 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
131 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
133 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
136 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_1,
137 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)
138 ), false, APIError::MonitorUpdateInProgress, {});
139 check_added_monitors!(nodes[0], 1);
142 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
143 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
144 assert_eq!(nodes[0].node.list_channels().len(), 1);
147 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
148 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
149 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
150 reconnect_args.send_channel_ready = (true, true);
151 reconnect_nodes(reconnect_args);
154 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
155 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
156 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
157 check_added_monitors!(nodes[0], 0);
159 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
160 assert_eq!(events_2.len(), 1);
161 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
162 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
163 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
164 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
166 expect_pending_htlcs_forwardable!(nodes[1]);
168 let events_3 = nodes[1].node.get_and_clear_pending_events();
169 assert_eq!(events_3.len(), 1);
171 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
172 assert_eq!(payment_hash_1, *payment_hash);
173 assert_eq!(amount_msat, 1_000_000);
174 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
175 assert_eq!(via_channel_id, Some(channel_id));
177 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
178 assert!(payment_preimage.is_none());
179 assert_eq!(payment_secret_1, *payment_secret);
181 _ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
184 _ => panic!("Unexpected event"),
187 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
189 // Now set it to failed again...
190 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
192 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
193 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_2,
194 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)
195 ), false, APIError::MonitorUpdateInProgress, {});
196 check_added_monitors!(nodes[0], 1);
199 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
200 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
201 assert_eq!(nodes[0].node.list_channels().len(), 1);
204 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
205 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
206 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
209 // ...and make sure we can force-close a frozen channel
210 let error_message = "Channel force-closed";
211 nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id(), error_message.to_string()).unwrap();
212 check_added_monitors!(nodes[0], 1);
213 check_closed_broadcast!(nodes[0], true);
215 // TODO: Once we hit the chain with the failure transaction we should check that we get a
216 // PaymentPathFailed event
218 assert_eq!(nodes[0].node.list_channels().len(), 0);
219 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(true) }, [nodes[1].node.get_our_node_id()], 100000);
223 fn test_simple_monitor_temporary_update_fail() {
224 do_test_simple_monitor_temporary_update_fail(false);
225 do_test_simple_monitor_temporary_update_fail(true);
228 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
229 let disconnect_flags = 8 | 16;
231 // Test that we can recover from a temporary monitor update failure with some in-flight
232 // HTLCs going on at the same time potentially with some disconnection thrown in.
233 // * First we route a payment, then get a temporary monitor update failure when trying to
234 // route a second payment. We then claim the first payment.
235 // * If disconnect_count is set, we will disconnect at this point (which is likely as
236 // InProgress likely indicates net disconnect which resulted in failing to update the
237 // ChannelMonitor on a watchtower).
238 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
239 // immediately, otherwise we wait disconnect and deliver them via the reconnect
240 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
241 // disconnect_count & !disconnect_flags is 0).
242 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
243 // through message sending, potentially disconnect/reconnecting multiple times based on
244 // disconnect_count, to get the update_fulfill_htlc through.
245 // * We then walk through more message exchanges to get the original update_add_htlc
246 // through, swapping message ordering based on disconnect_count & 8 and optionally
247 // disconnect/reconnecting based on disconnect_count.
248 let chanmon_cfgs = create_chanmon_cfgs(2);
249 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
250 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
251 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
252 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
254 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
256 // Now try to send a second payment which will fail to send
257 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
259 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
260 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_2,
261 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)
262 ), false, APIError::MonitorUpdateInProgress, {});
263 check_added_monitors!(nodes[0], 1);
266 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
267 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
268 assert_eq!(nodes[0].node.list_channels().len(), 1);
270 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
271 // but nodes[0] won't respond since it is frozen.
272 nodes[1].node.claim_funds(payment_preimage_1);
273 check_added_monitors!(nodes[1], 1);
274 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
276 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
277 assert_eq!(events_2.len(), 1);
278 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
279 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 } } => {
280 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
281 assert!(update_add_htlcs.is_empty());
282 assert_eq!(update_fulfill_htlcs.len(), 1);
283 assert!(update_fail_htlcs.is_empty());
284 assert!(update_fail_malformed_htlcs.is_empty());
285 assert!(update_fee.is_none());
287 if (disconnect_count & 16) == 0 {
288 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
289 let events_3 = nodes[0].node.get_and_clear_pending_events();
290 assert_eq!(events_3.len(), 1);
292 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
293 assert_eq!(*payment_preimage, payment_preimage_1);
294 assert_eq!(*payment_hash, payment_hash_1);
296 _ => panic!("Unexpected event"),
299 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
300 check_added_monitors!(nodes[0], 1);
301 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
304 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
306 _ => panic!("Unexpected event"),
309 if disconnect_count & !disconnect_flags > 0 {
310 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
311 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
314 // Now fix monitor updating...
315 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
316 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
317 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
318 check_added_monitors!(nodes[0], 0);
320 macro_rules! disconnect_reconnect_peers { () => { {
321 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
322 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
324 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
325 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
327 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
328 assert_eq!(reestablish_1.len(), 1);
329 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
330 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
332 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
333 assert_eq!(reestablish_2.len(), 1);
335 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
336 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
337 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
338 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
340 assert!(as_resp.0.is_none());
341 assert!(bs_resp.0.is_none());
343 (reestablish_1, reestablish_2, as_resp, bs_resp)
346 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
347 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
348 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
350 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
351 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
353 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
354 assert_eq!(reestablish_1.len(), 1);
355 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
356 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
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 check_added_monitors!(nodes[0], 0);
363 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
364 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
365 check_added_monitors!(nodes[1], 0);
366 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
368 assert!(as_resp.0.is_none());
369 assert!(bs_resp.0.is_none());
371 assert!(bs_resp.1.is_none());
372 if (disconnect_count & 16) == 0 {
373 assert!(bs_resp.2.is_none());
375 assert!(as_resp.1.is_some());
376 assert!(as_resp.2.is_some());
377 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
379 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
380 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
381 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
382 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
383 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
384 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
386 assert!(as_resp.1.is_none());
388 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
389 let events_3 = nodes[0].node.get_and_clear_pending_events();
390 assert_eq!(events_3.len(), 1);
392 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
393 assert_eq!(*payment_preimage, payment_preimage_1);
394 assert_eq!(*payment_hash, payment_hash_1);
396 _ => panic!("Unexpected event"),
399 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
400 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
401 // No commitment_signed so get_event_msg's assert(len == 1) passes
402 check_added_monitors!(nodes[0], 1);
404 as_resp.1 = Some(as_resp_raa);
408 if disconnect_count & !disconnect_flags > 1 {
409 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
411 if (disconnect_count & 16) == 0 {
412 assert!(reestablish_1 == second_reestablish_1);
413 assert!(reestablish_2 == second_reestablish_2);
415 assert!(as_resp == second_as_resp);
416 assert!(bs_resp == second_bs_resp);
419 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
421 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
422 assert_eq!(events_4.len(), 2);
423 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
424 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
425 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
428 _ => panic!("Unexpected event"),
432 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
434 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
435 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
436 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
437 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
438 check_added_monitors!(nodes[1], 1);
440 if disconnect_count & !disconnect_flags > 2 {
441 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
443 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
444 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
446 assert!(as_resp.2.is_none());
447 assert!(bs_resp.2.is_none());
450 let as_commitment_update;
451 let bs_second_commitment_update;
453 macro_rules! handle_bs_raa { () => {
454 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
455 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
456 assert!(as_commitment_update.update_add_htlcs.is_empty());
457 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
458 assert!(as_commitment_update.update_fail_htlcs.is_empty());
459 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
460 assert!(as_commitment_update.update_fee.is_none());
461 check_added_monitors!(nodes[0], 1);
464 macro_rules! handle_initial_raa { () => {
465 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
466 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
467 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
468 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
469 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
470 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
471 assert!(bs_second_commitment_update.update_fee.is_none());
472 check_added_monitors!(nodes[1], 1);
475 if (disconnect_count & 8) == 0 {
478 if disconnect_count & !disconnect_flags > 3 {
479 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
481 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
482 assert!(bs_resp.1.is_none());
484 assert!(as_resp.2.unwrap() == as_commitment_update);
485 assert!(bs_resp.2.is_none());
487 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
490 handle_initial_raa!();
492 if disconnect_count & !disconnect_flags > 4 {
493 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
495 assert!(as_resp.1.is_none());
496 assert!(bs_resp.1.is_none());
498 assert!(as_resp.2.unwrap() == as_commitment_update);
499 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
502 handle_initial_raa!();
504 if disconnect_count & !disconnect_flags > 3 {
505 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
507 assert!(as_resp.1.is_none());
508 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
510 assert!(as_resp.2.is_none());
511 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
513 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
518 if disconnect_count & !disconnect_flags > 4 {
519 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
521 assert!(as_resp.1.is_none());
522 assert!(bs_resp.1.is_none());
524 assert!(as_resp.2.unwrap() == as_commitment_update);
525 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
529 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
530 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
531 // No commitment_signed so get_event_msg's assert(len == 1) passes
532 check_added_monitors!(nodes[0], 1);
534 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
535 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
536 // No commitment_signed so get_event_msg's assert(len == 1) passes
537 check_added_monitors!(nodes[1], 1);
539 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
540 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
541 check_added_monitors!(nodes[1], 1);
543 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
544 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
545 check_added_monitors!(nodes[0], 1);
546 expect_payment_path_successful!(nodes[0]);
548 expect_pending_htlcs_forwardable!(nodes[1]);
550 let events_5 = nodes[1].node.get_and_clear_pending_events();
551 assert_eq!(events_5.len(), 1);
553 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
554 assert_eq!(payment_hash_2, *payment_hash);
555 assert_eq!(amount_msat, 1_000_000);
556 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
557 assert_eq!(via_channel_id, Some(channel_id));
559 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
560 assert!(payment_preimage.is_none());
561 assert_eq!(payment_secret_2, *payment_secret);
563 _ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
566 _ => panic!("Unexpected event"),
569 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
573 fn test_monitor_temporary_update_fail_a() {
574 do_test_monitor_temporary_update_fail(0);
575 do_test_monitor_temporary_update_fail(1);
576 do_test_monitor_temporary_update_fail(2);
577 do_test_monitor_temporary_update_fail(3);
578 do_test_monitor_temporary_update_fail(4);
579 do_test_monitor_temporary_update_fail(5);
583 fn test_monitor_temporary_update_fail_b() {
584 do_test_monitor_temporary_update_fail(2 | 8);
585 do_test_monitor_temporary_update_fail(3 | 8);
586 do_test_monitor_temporary_update_fail(4 | 8);
587 do_test_monitor_temporary_update_fail(5 | 8);
591 fn test_monitor_temporary_update_fail_c() {
592 do_test_monitor_temporary_update_fail(1 | 16);
593 do_test_monitor_temporary_update_fail(2 | 16);
594 do_test_monitor_temporary_update_fail(3 | 16);
595 do_test_monitor_temporary_update_fail(2 | 8 | 16);
596 do_test_monitor_temporary_update_fail(3 | 8 | 16);
600 fn test_monitor_update_fail_cs() {
601 // Tests handling of a monitor update failure when processing an incoming commitment_signed
602 let chanmon_cfgs = create_chanmon_cfgs(2);
603 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
604 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
605 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
606 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
608 let (route, our_payment_hash, payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
610 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
611 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
612 check_added_monitors!(nodes[0], 1);
615 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
616 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
618 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
619 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
620 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
621 check_added_monitors!(nodes[1], 1);
622 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
624 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
625 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
626 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
627 check_added_monitors!(nodes[1], 0);
628 let responses = nodes[1].node.get_and_clear_pending_msg_events();
629 assert_eq!(responses.len(), 2);
632 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
633 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
634 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
635 check_added_monitors!(nodes[0], 1);
637 _ => panic!("Unexpected event"),
640 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
641 assert!(updates.update_add_htlcs.is_empty());
642 assert!(updates.update_fulfill_htlcs.is_empty());
643 assert!(updates.update_fail_htlcs.is_empty());
644 assert!(updates.update_fail_malformed_htlcs.is_empty());
645 assert!(updates.update_fee.is_none());
646 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
648 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
649 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
650 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
651 check_added_monitors!(nodes[0], 1);
652 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
654 _ => panic!("Unexpected event"),
657 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
658 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
659 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
660 check_added_monitors!(nodes[0], 0);
662 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
663 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
664 check_added_monitors!(nodes[1], 1);
666 expect_pending_htlcs_forwardable!(nodes[1]);
668 let events = nodes[1].node.get_and_clear_pending_events();
669 assert_eq!(events.len(), 1);
671 Event::PaymentClaimable { payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
672 assert_eq!(payment_hash, our_payment_hash);
673 assert_eq!(amount_msat, 1_000_000);
674 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
675 assert_eq!(via_channel_id, Some(channel_id));
677 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
678 assert!(payment_preimage.is_none());
679 assert_eq!(our_payment_secret, *payment_secret);
681 _ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
684 _ => panic!("Unexpected event"),
687 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
691 fn test_monitor_update_fail_no_rebroadcast() {
692 // Tests handling of a monitor update failure when no message rebroadcasting on
693 // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
695 let chanmon_cfgs = create_chanmon_cfgs(2);
696 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
697 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
698 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
699 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
701 let (route, our_payment_hash, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
703 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
704 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(our_payment_hash.0)).unwrap();
705 check_added_monitors!(nodes[0], 1);
708 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
709 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
710 let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
712 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
713 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
714 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
715 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
716 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
717 check_added_monitors!(nodes[1], 1);
719 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
720 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
721 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
722 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
723 check_added_monitors!(nodes[1], 0);
724 expect_pending_htlcs_forwardable!(nodes[1]);
726 let events = nodes[1].node.get_and_clear_pending_events();
727 assert_eq!(events.len(), 1);
729 Event::PaymentClaimable { payment_hash, .. } => {
730 assert_eq!(payment_hash, our_payment_hash);
732 _ => panic!("Unexpected event"),
735 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
739 fn test_monitor_update_raa_while_paused() {
740 // Tests handling of an RAA while monitor updating has already been marked failed.
741 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
742 let chanmon_cfgs = create_chanmon_cfgs(2);
743 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
744 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
745 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
746 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
748 send_payment(&nodes[0], &[&nodes[1]], 5000000);
749 let (route, our_payment_hash_1, payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
751 nodes[0].node.send_payment_with_route(&route, our_payment_hash_1,
752 RecipientOnionFields::secret_only(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
753 check_added_monitors!(nodes[0], 1);
755 let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
757 let (route, our_payment_hash_2, payment_preimage_2, our_payment_secret_2) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000000);
759 nodes[1].node.send_payment_with_route(&route, our_payment_hash_2,
760 RecipientOnionFields::secret_only(our_payment_secret_2), PaymentId(our_payment_hash_2.0)).unwrap();
761 check_added_monitors!(nodes[1], 1);
763 let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
765 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
766 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
767 check_added_monitors!(nodes[1], 1);
768 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
770 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
771 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
772 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
773 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
774 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
775 check_added_monitors!(nodes[0], 1);
776 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
778 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
779 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
780 check_added_monitors!(nodes[0], 1);
782 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
783 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
784 check_added_monitors!(nodes[0], 0);
786 let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
787 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
788 check_added_monitors!(nodes[1], 1);
789 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
791 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
792 check_added_monitors!(nodes[1], 1);
793 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
795 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
796 check_added_monitors!(nodes[0], 1);
797 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
799 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
800 check_added_monitors!(nodes[0], 1);
801 expect_pending_htlcs_forwardable!(nodes[0]);
802 expect_payment_claimable!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
804 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
805 check_added_monitors!(nodes[1], 1);
806 expect_pending_htlcs_forwardable!(nodes[1]);
807 expect_payment_claimable!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
809 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
810 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
813 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
814 // Tests handling of a monitor update failure when processing an incoming RAA
815 let chanmon_cfgs = create_chanmon_cfgs(3);
816 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
817 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
818 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
819 create_announced_chan_between_nodes(&nodes, 0, 1);
820 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
822 // Rebalance a bit so that we can send backwards from 2 to 1.
823 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
825 // Route a first payment that we'll fail backwards
826 let (_, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
828 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
829 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
830 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
831 check_added_monitors!(nodes[2], 1);
833 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
834 assert!(updates.update_add_htlcs.is_empty());
835 assert!(updates.update_fulfill_htlcs.is_empty());
836 assert_eq!(updates.update_fail_htlcs.len(), 1);
837 assert!(updates.update_fail_malformed_htlcs.is_empty());
838 assert!(updates.update_fee.is_none());
839 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
841 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
842 check_added_monitors!(nodes[0], 0);
844 // While the second channel is AwaitingRAA, forward a second payment to get it into the
846 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
848 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
849 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
850 check_added_monitors!(nodes[0], 1);
853 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
854 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
855 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
857 expect_pending_htlcs_forwardable!(nodes[1]);
858 check_added_monitors!(nodes[1], 0);
859 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
861 // Now fail monitor updating.
862 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
863 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
864 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
865 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
866 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
867 check_added_monitors!(nodes[1], 1);
869 // Forward a third payment which will also be added to the holding cell, despite the channel
870 // being paused waiting a monitor update.
871 let (route, payment_hash_3, _, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
873 nodes[0].node.send_payment_with_route(&route, payment_hash_3,
874 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
875 check_added_monitors!(nodes[0], 1);
878 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed); // We succeed in updating the monitor for the first channel
879 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
880 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
881 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
882 check_added_monitors!(nodes[1], 0);
884 // Call forward_pending_htlcs and check that the new HTLC was simply added to the holding cell
885 // and not forwarded.
886 expect_pending_htlcs_forwardable!(nodes[1]);
887 check_added_monitors!(nodes[1], 0);
888 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
890 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
891 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
892 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
893 nodes[2].node.send_payment_with_route(&route, payment_hash_4,
894 RecipientOnionFields::secret_only(payment_secret_4), PaymentId(payment_hash_4.0)).unwrap();
895 check_added_monitors!(nodes[2], 1);
897 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
898 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
899 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
900 check_added_monitors!(nodes[1], 1);
901 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
902 (Some(payment_preimage_4), Some(payment_hash_4))
903 } else { (None, None) };
905 // Restore monitor updating, ensuring we immediately get a fail-back update and a
906 // update_add update.
907 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
908 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
909 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
910 check_added_monitors!(nodes[1], 0);
911 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 }]);
912 check_added_monitors!(nodes[1], 1);
914 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
915 if test_ignore_second_cs {
916 assert_eq!(events_3.len(), 3);
918 assert_eq!(events_3.len(), 2);
921 // Note that the ordering of the events for different nodes is non-prescriptive, though the
922 // ordering of the two events that both go to nodes[2] have to stay in the same order.
923 let nodes_0_event = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &mut events_3);
924 let messages_a = match nodes_0_event {
925 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
926 assert_eq!(node_id, nodes[0].node.get_our_node_id());
927 assert!(updates.update_fulfill_htlcs.is_empty());
928 assert_eq!(updates.update_fail_htlcs.len(), 1);
929 assert!(updates.update_fail_malformed_htlcs.is_empty());
930 assert!(updates.update_add_htlcs.is_empty());
931 assert!(updates.update_fee.is_none());
932 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
934 _ => panic!("Unexpected event type!"),
937 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events_3);
938 let send_event_b = SendEvent::from_event(nodes_2_event);
939 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
941 let raa = if test_ignore_second_cs {
942 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events_3);
943 match nodes_2_event {
944 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
945 assert_eq!(node_id, nodes[2].node.get_our_node_id());
948 _ => panic!("Unexpected event"),
952 // Now deliver the new messages...
954 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
955 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
956 expect_payment_failed!(nodes[0], payment_hash_1, true);
958 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
960 if test_ignore_second_cs {
961 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
962 check_added_monitors!(nodes[2], 1);
963 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
964 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
965 check_added_monitors!(nodes[2], 1);
966 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
967 assert!(bs_cs.update_add_htlcs.is_empty());
968 assert!(bs_cs.update_fail_htlcs.is_empty());
969 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
970 assert!(bs_cs.update_fulfill_htlcs.is_empty());
971 assert!(bs_cs.update_fee.is_none());
973 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
974 check_added_monitors!(nodes[1], 1);
975 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
977 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
978 check_added_monitors!(nodes[1], 1);
980 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
981 check_added_monitors!(nodes[2], 1);
983 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
984 // As both messages are for nodes[1], they're in order.
985 assert_eq!(bs_revoke_and_commit.len(), 2);
986 match bs_revoke_and_commit[0] {
987 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
988 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
989 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
990 check_added_monitors!(nodes[1], 1);
992 _ => panic!("Unexpected event"),
995 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
997 match bs_revoke_and_commit[1] {
998 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
999 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1000 assert!(updates.update_add_htlcs.is_empty());
1001 assert!(updates.update_fail_htlcs.is_empty());
1002 assert!(updates.update_fail_malformed_htlcs.is_empty());
1003 assert!(updates.update_fulfill_htlcs.is_empty());
1004 assert!(updates.update_fee.is_none());
1005 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1006 check_added_monitors!(nodes[1], 1);
1008 _ => panic!("Unexpected event"),
1012 assert_eq!(as_cs.update_add_htlcs.len(), 1);
1013 assert!(as_cs.update_fail_htlcs.is_empty());
1014 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1015 assert!(as_cs.update_fulfill_htlcs.is_empty());
1016 assert!(as_cs.update_fee.is_none());
1017 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1020 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1021 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1022 check_added_monitors!(nodes[2], 1);
1023 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1025 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1026 check_added_monitors!(nodes[2], 1);
1027 let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1029 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1030 check_added_monitors!(nodes[1], 1);
1031 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1033 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1034 check_added_monitors!(nodes[1], 1);
1035 let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1037 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1038 check_added_monitors!(nodes[2], 1);
1039 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1041 expect_pending_htlcs_forwardable!(nodes[2]);
1043 let events_6 = nodes[2].node.get_and_clear_pending_events();
1044 assert_eq!(events_6.len(), 2);
1046 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1047 _ => panic!("Unexpected event"),
1050 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1051 _ => panic!("Unexpected event"),
1054 if test_ignore_second_cs {
1055 expect_pending_htlcs_forwardable!(nodes[1]);
1056 check_added_monitors!(nodes[1], 1);
1058 send_event = SendEvent::from_node(&nodes[1]);
1059 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1060 assert_eq!(send_event.msgs.len(), 1);
1061 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1062 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1064 expect_pending_htlcs_forwardable!(nodes[0]);
1066 let events_9 = nodes[0].node.get_and_clear_pending_events();
1067 assert_eq!(events_9.len(), 1);
1069 Event::PaymentClaimable { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1070 _ => panic!("Unexpected event"),
1072 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1075 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1079 fn test_monitor_update_fail_raa() {
1080 do_test_monitor_update_fail_raa(false);
1081 do_test_monitor_update_fail_raa(true);
1085 fn test_monitor_update_fail_reestablish() {
1086 // Simple test for message retransmission after monitor update failure on
1087 // channel_reestablish generating a monitor update (which comes from freeing holding cell
1089 let chanmon_cfgs = create_chanmon_cfgs(3);
1090 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1091 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1092 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1093 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1094 create_announced_chan_between_nodes(&nodes, 1, 2);
1096 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
1098 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1099 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1101 nodes[2].node.claim_funds(payment_preimage);
1102 check_added_monitors!(nodes[2], 1);
1103 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
1105 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1106 assert!(updates.update_add_htlcs.is_empty());
1107 assert!(updates.update_fail_htlcs.is_empty());
1108 assert!(updates.update_fail_malformed_htlcs.is_empty());
1109 assert!(updates.update_fee.is_none());
1110 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1111 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1112 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
1113 check_added_monitors!(nodes[1], 1);
1114 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1115 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1117 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1118 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1119 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1121 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1122 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1125 let as_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1126 let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1128 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1130 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1132 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1133 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1135 nodes[1].node.get_and_clear_pending_msg_events(); // Free the holding cell
1136 check_added_monitors!(nodes[1], 1);
1138 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1139 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1141 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1142 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1144 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1145 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1148 assert_eq!(get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap(), as_reestablish);
1149 assert_eq!(get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap(), bs_reestablish);
1151 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1153 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1154 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1156 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1157 check_added_monitors!(nodes[1], 0);
1159 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1160 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1162 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1163 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1164 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1165 check_added_monitors!(nodes[1], 0);
1167 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1168 assert!(updates.update_add_htlcs.is_empty());
1169 assert!(updates.update_fail_htlcs.is_empty());
1170 assert!(updates.update_fail_malformed_htlcs.is_empty());
1171 assert!(updates.update_fee.is_none());
1172 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1173 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1174 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1175 expect_payment_sent!(nodes[0], payment_preimage);
1179 fn raa_no_response_awaiting_raa_state() {
1180 // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1181 // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1182 // in question (assuming it intends to respond with a CS after monitor updating is restored).
1183 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1184 let chanmon_cfgs = create_chanmon_cfgs(2);
1185 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1186 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1187 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1188 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1190 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1191 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1192 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1194 // Queue up two payments - one will be delivered right away, one immediately goes into the
1195 // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1196 // immediately after a CS. By setting failing the monitor update failure from the CS (which
1197 // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1198 // generation during RAA while in monitor-update-failed state.
1200 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1201 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1202 check_added_monitors!(nodes[0], 1);
1203 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1204 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1205 check_added_monitors!(nodes[0], 0);
1208 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1209 assert_eq!(events.len(), 1);
1210 let payment_event = SendEvent::from_event(events.pop().unwrap());
1211 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1212 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1213 check_added_monitors!(nodes[1], 1);
1215 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1216 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1217 check_added_monitors!(nodes[0], 1);
1218 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1219 assert_eq!(events.len(), 1);
1220 let payment_event = SendEvent::from_event(events.pop().unwrap());
1222 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1223 check_added_monitors!(nodes[0], 1);
1224 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1226 // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1227 // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1228 // then restore channel monitor updates.
1229 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1230 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1231 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1232 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1233 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1234 check_added_monitors!(nodes[1], 1);
1235 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1237 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1238 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1239 check_added_monitors!(nodes[1], 1);
1241 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1242 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1243 // nodes[1] should be AwaitingRAA here!
1244 check_added_monitors!(nodes[1], 0);
1245 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1246 expect_pending_htlcs_forwardable!(nodes[1]);
1247 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1249 // We send a third payment here, which is somewhat of a redundant test, but the
1250 // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1251 // commitment transaction states) whereas here we can explicitly check for it.
1253 nodes[0].node.send_payment_with_route(&route, payment_hash_3,
1254 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1255 check_added_monitors!(nodes[0], 0);
1256 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1258 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1259 check_added_monitors!(nodes[0], 1);
1260 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1261 assert_eq!(events.len(), 1);
1262 let payment_event = SendEvent::from_event(events.pop().unwrap());
1264 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1265 check_added_monitors!(nodes[0], 1);
1266 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1268 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1269 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1270 check_added_monitors!(nodes[1], 1);
1271 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1273 // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1274 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1275 check_added_monitors!(nodes[1], 1);
1276 expect_pending_htlcs_forwardable!(nodes[1]);
1277 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1278 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1280 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1281 check_added_monitors!(nodes[0], 1);
1283 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1284 check_added_monitors!(nodes[0], 1);
1285 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1287 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1288 check_added_monitors!(nodes[1], 1);
1289 expect_pending_htlcs_forwardable!(nodes[1]);
1290 expect_payment_claimable!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1292 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1293 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1294 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1298 fn claim_while_disconnected_monitor_update_fail() {
1299 // Test for claiming a payment while disconnected and then having the resulting
1300 // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1301 // contrived case for nodes with network instability.
1302 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1303 // code introduced a regression in this test (specifically, this caught a removal of the
1304 // channel_reestablish handling ensuring the order was sensical given the messages used).
1305 let chanmon_cfgs = create_chanmon_cfgs(2);
1306 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1307 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1308 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1309 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1311 // Forward a payment for B to claim
1312 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1314 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1315 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1317 nodes[1].node.claim_funds(payment_preimage_1);
1318 check_added_monitors!(nodes[1], 1);
1319 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1321 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1322 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1324 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1325 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
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_with_route(&route, payment_hash_2,
1348 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1349 check_added_monitors!(nodes[0], 1);
1352 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1353 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1354 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1355 check_added_monitors!(nodes[1], 1);
1356 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1357 // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1358 // until we've channel_monitor_update'd and updated for the new commitment transaction.
1360 // Now un-fail the monitor, which will result in B sending its original commitment update,
1361 // receiving the commitment update from A, and the resulting commitment dances.
1362 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1363 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1364 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1365 check_added_monitors!(nodes[1], 0);
1367 let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1368 assert_eq!(bs_msgs.len(), 2);
1371 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1372 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1373 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1374 expect_payment_sent(&nodes[0], payment_preimage_1, None, false, false);
1375 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1376 check_added_monitors!(nodes[0], 1);
1378 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1379 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1380 check_added_monitors!(nodes[1], 1);
1382 _ => panic!("Unexpected event"),
1386 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1387 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1388 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1389 check_added_monitors!(nodes[0], 1);
1391 _ => panic!("Unexpected event"),
1394 let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1396 let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1397 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1398 check_added_monitors!(nodes[0], 1);
1399 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1401 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1402 check_added_monitors!(nodes[1], 1);
1403 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1404 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1405 check_added_monitors!(nodes[1], 1);
1407 expect_pending_htlcs_forwardable!(nodes[1]);
1408 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1410 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1411 check_added_monitors!(nodes[0], 1);
1412 expect_payment_path_successful!(nodes[0]);
1414 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1418 fn monitor_failed_no_reestablish_response() {
1419 // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1420 // response to a commitment_signed.
1421 // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1422 // debug_assert!() failure in channel_reestablish handling.
1423 let chanmon_cfgs = create_chanmon_cfgs(2);
1424 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1425 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1426 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1427 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1429 let mut node_0_per_peer_lock;
1430 let mut node_0_peer_state_lock;
1431 get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, channel_id).context_mut().announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1434 let mut node_1_per_peer_lock;
1435 let mut node_1_peer_state_lock;
1436 get_channel_ref!(nodes[1], nodes[0], node_1_per_peer_lock, node_1_peer_state_lock, channel_id).context_mut().announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1439 // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1441 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1443 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1444 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1445 check_added_monitors!(nodes[0], 1);
1448 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1449 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1450 assert_eq!(events.len(), 1);
1451 let payment_event = SendEvent::from_event(events.pop().unwrap());
1452 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1453 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1454 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1455 check_added_monitors!(nodes[1], 1);
1457 // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1458 // is still failing to update monitors.
1459 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1460 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1462 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1463 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1465 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1466 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1469 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1470 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1472 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1473 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1474 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1475 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1477 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1478 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1479 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1480 check_added_monitors!(nodes[1], 0);
1481 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1483 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1484 check_added_monitors!(nodes[0], 1);
1485 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1486 check_added_monitors!(nodes[0], 1);
1488 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1489 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1490 check_added_monitors!(nodes[1], 1);
1492 expect_pending_htlcs_forwardable!(nodes[1]);
1493 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1495 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1499 fn first_message_on_recv_ordering() {
1500 // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1501 // messages, we're willing to flip the order of response messages if neccessary in resposne to
1502 // a commitment_signed which needs to send an RAA first.
1503 // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1504 // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1505 // response. To do this, we start routing two payments, with the final RAA for the first being
1506 // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1507 // have no pending response but will want to send a RAA/CS (with the updates for the second
1508 // payment applied).
1509 // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1510 let chanmon_cfgs = create_chanmon_cfgs(2);
1511 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1512 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1513 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1514 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1516 // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1517 // can deliver it and fail the monitor update.
1518 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1520 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1521 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1522 check_added_monitors!(nodes[0], 1);
1525 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1526 assert_eq!(events.len(), 1);
1527 let payment_event = SendEvent::from_event(events.pop().unwrap());
1528 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1529 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1530 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1531 check_added_monitors!(nodes[1], 1);
1532 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1534 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1535 check_added_monitors!(nodes[0], 1);
1536 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1537 check_added_monitors!(nodes[0], 1);
1539 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1541 // Route the second payment, generating an update_add_htlc/commitment_signed
1542 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1544 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1545 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1546 check_added_monitors!(nodes[0], 1);
1548 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1549 assert_eq!(events.len(), 1);
1550 let payment_event = SendEvent::from_event(events.pop().unwrap());
1551 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1553 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1555 // Deliver the final RAA for the first payment, which does not require a response. RAAs
1556 // generally require a commitment_signed, so the fact that we're expecting an opposite response
1557 // to the next message also tests resetting the delivery order.
1558 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1559 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1560 check_added_monitors!(nodes[1], 1);
1562 // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1563 // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1564 // appropriate HTLC acceptance).
1565 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1566 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1567 check_added_monitors!(nodes[1], 1);
1568 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1570 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1571 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1572 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1573 check_added_monitors!(nodes[1], 0);
1575 expect_pending_htlcs_forwardable!(nodes[1]);
1576 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1578 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1579 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1580 check_added_monitors!(nodes[0], 1);
1581 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1582 check_added_monitors!(nodes[0], 1);
1584 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1585 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1586 check_added_monitors!(nodes[1], 1);
1588 expect_pending_htlcs_forwardable!(nodes[1]);
1589 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1591 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1592 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1596 fn test_monitor_update_fail_claim() {
1597 // Basic test for monitor update failures when processing claim_funds calls.
1598 // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1599 // update to claim the payment. We then send two payments C->B->A, which are held at B.
1600 // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1601 // the payments from C onwards to A.
1602 let chanmon_cfgs = create_chanmon_cfgs(3);
1603 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1604 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1605 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1606 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1607 create_announced_chan_between_nodes(&nodes, 1, 2);
1609 // Rebalance a bit so that we can send backwards from 3 to 2.
1610 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1612 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1614 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1615 nodes[1].node.claim_funds(payment_preimage_1);
1616 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1617 check_added_monitors!(nodes[1], 1);
1619 // Note that at this point there is a pending commitment transaction update for A being held by
1620 // B. Even when we go to send the payment from C through B to A, B will not update this
1621 // already-signed commitment transaction and will instead wait for it to resolve before
1622 // forwarding the payment onwards.
1624 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1_000_000);
1626 nodes[2].node.send_payment_with_route(&route, payment_hash_2,
1627 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1628 check_added_monitors!(nodes[2], 1);
1631 // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1632 // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1633 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1635 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1636 assert_eq!(events.len(), 1);
1637 let payment_event = SendEvent::from_event(events.pop().unwrap());
1638 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1639 let events = nodes[1].node.get_and_clear_pending_msg_events();
1640 assert_eq!(events.len(), 0);
1641 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1642 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1644 let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1645 nodes[2].node.send_payment_with_route(&route, payment_hash_3,
1646 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1647 check_added_monitors!(nodes[2], 1);
1649 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1650 assert_eq!(events.len(), 1);
1651 let payment_event = SendEvent::from_event(events.pop().unwrap());
1652 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1653 let events = nodes[1].node.get_and_clear_pending_msg_events();
1654 assert_eq!(events.len(), 0);
1655 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1657 // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1658 let channel_id = chan_1.2;
1659 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1660 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1661 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1662 check_added_monitors!(nodes[1], 0);
1664 let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1665 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1666 commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1667 expect_payment_sent!(nodes[0], payment_preimage_1);
1669 // Get the payment forwards, note that they were batched into one commitment update.
1670 nodes[1].node.process_pending_htlc_forwards();
1671 check_added_monitors!(nodes[1], 1);
1672 let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1673 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1674 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1675 commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1676 expect_pending_htlcs_forwardable!(nodes[0]);
1678 let events = nodes[0].node.get_and_clear_pending_events();
1679 assert_eq!(events.len(), 2);
1681 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id, .. } => {
1682 assert_eq!(payment_hash_2, *payment_hash);
1683 assert_eq!(1_000_000, amount_msat);
1684 assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1685 assert_eq!(via_channel_id, Some(channel_id));
1686 assert_eq!(via_user_channel_id, Some(42));
1688 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
1689 assert!(payment_preimage.is_none());
1690 assert_eq!(payment_secret_2, *payment_secret);
1692 _ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
1695 _ => panic!("Unexpected event"),
1698 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
1699 assert_eq!(payment_hash_3, *payment_hash);
1700 assert_eq!(1_000_000, amount_msat);
1701 assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1702 assert_eq!(via_channel_id, Some(channel_id));
1704 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
1705 assert!(payment_preimage.is_none());
1706 assert_eq!(payment_secret_3, *payment_secret);
1708 _ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
1711 _ => panic!("Unexpected event"),
1716 fn test_monitor_update_on_pending_forwards() {
1717 // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1718 // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1719 // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1720 // from C to A will be pending a forward to A.
1721 let chanmon_cfgs = create_chanmon_cfgs(3);
1722 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1723 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1724 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1725 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1726 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1728 // Rebalance a bit so that we can send backwards from 3 to 1.
1729 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1731 let (_, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1732 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
1733 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
1734 check_added_monitors!(nodes[2], 1);
1736 let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1737 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1738 commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1739 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1741 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
1743 nodes[2].node.send_payment_with_route(&route, payment_hash_2,
1744 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1745 check_added_monitors!(nodes[2], 1);
1748 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1749 assert_eq!(events.len(), 1);
1750 let payment_event = SendEvent::from_event(events.pop().unwrap());
1751 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1752 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1754 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1755 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 }]);
1756 check_added_monitors!(nodes[1], 1);
1758 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1759 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1760 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1761 check_added_monitors!(nodes[1], 0);
1763 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1764 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1765 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1766 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1768 let events = nodes[0].node.get_and_clear_pending_events();
1769 assert_eq!(events.len(), 3);
1770 if let Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } = events[1] {
1771 assert_eq!(payment_hash, payment_hash_1);
1772 assert!(payment_failed_permanently);
1773 } else { panic!("Unexpected event!"); }
1775 Event::PaymentFailed { payment_hash, .. } => {
1776 assert_eq!(payment_hash, payment_hash_1);
1778 _ => panic!("Unexpected event"),
1781 Event::PendingHTLCsForwardable { .. } => { },
1782 _ => panic!("Unexpected event"),
1784 nodes[0].node.process_pending_htlc_forwards();
1785 expect_payment_claimable!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1787 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1791 fn monitor_update_claim_fail_no_response() {
1792 // Test for claim_funds resulting in both a monitor update failure and no message response (due
1793 // to channel being AwaitingRAA).
1794 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1796 let chanmon_cfgs = create_chanmon_cfgs(2);
1797 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1798 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1799 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1800 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1802 // Forward a payment for B to claim
1803 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1805 // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1806 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1808 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1809 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1810 check_added_monitors!(nodes[0], 1);
1813 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1814 assert_eq!(events.len(), 1);
1815 let payment_event = SendEvent::from_event(events.pop().unwrap());
1816 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1817 let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1819 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1820 nodes[1].node.claim_funds(payment_preimage_1);
1821 check_added_monitors!(nodes[1], 1);
1823 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1825 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1826 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1827 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1828 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1829 check_added_monitors!(nodes[1], 0);
1830 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1832 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1833 check_added_monitors!(nodes[1], 1);
1834 expect_pending_htlcs_forwardable!(nodes[1]);
1835 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1837 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1838 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1839 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1840 expect_payment_sent!(nodes[0], payment_preimage_1);
1842 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1845 // restore_b_before_conf has no meaning if !confirm_a_first
1846 // restore_b_before_lock has no meaning if confirm_a_first
1847 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool, restore_b_before_lock: bool) {
1848 // Test that if the monitor update generated by funding_transaction_generated fails we continue
1849 // the channel setup happily after the update is restored.
1850 let chanmon_cfgs = create_chanmon_cfgs(2);
1851 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1852 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1853 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1855 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None, None).unwrap();
1856 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()));
1857 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()));
1859 let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
1861 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
1862 check_added_monitors!(nodes[0], 0);
1864 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1865 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1866 let channel_id = ChannelId::v1_from_funding_outpoint(OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index });
1867 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1868 check_added_monitors!(nodes[1], 1);
1870 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1871 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()));
1872 check_added_monitors!(nodes[0], 1);
1873 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1874 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1875 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1876 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1877 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1878 check_added_monitors!(nodes[0], 0);
1879 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
1881 let events = nodes[0].node.get_and_clear_pending_events();
1882 assert_eq!(events.len(), 0);
1883 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1884 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1886 if confirm_a_first {
1887 confirm_transaction(&nodes[0], &funding_tx);
1888 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()));
1889 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1890 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1892 assert!(!restore_b_before_conf);
1893 confirm_transaction(&nodes[1], &funding_tx);
1894 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1897 // Make sure nodes[1] isn't stupid enough to re-send the ChannelReady on reconnect
1898 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1899 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1900 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
1901 reconnect_args.send_channel_ready.1 = confirm_a_first;
1902 reconnect_nodes(reconnect_args);
1904 // But we want to re-emit ChannelPending
1905 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
1906 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1907 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1909 if !restore_b_before_conf {
1910 confirm_transaction(&nodes[1], &funding_tx);
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());
1914 if !confirm_a_first && !restore_b_before_lock {
1915 confirm_transaction(&nodes[0], &funding_tx);
1916 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()));
1917 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1918 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1921 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1922 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1923 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1924 check_added_monitors!(nodes[1], 0);
1926 let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1927 if !restore_b_before_lock {
1928 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1929 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1931 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()));
1932 confirm_transaction(&nodes[0], &funding_tx);
1933 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1934 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready))
1937 if restore_b_before_conf {
1938 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1939 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1940 confirm_transaction(&nodes[1], &funding_tx);
1942 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1943 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1945 for node in nodes.iter() {
1946 assert!(node.gossip_sync.handle_channel_announcement(&announcement).unwrap());
1947 node.gossip_sync.handle_channel_update(&as_update).unwrap();
1948 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
1951 if !restore_b_before_lock {
1952 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
1954 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
1958 send_payment(&nodes[0], &[&nodes[1]], 8000000);
1959 close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1960 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1961 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1965 fn during_funding_monitor_fail() {
1966 do_during_funding_monitor_fail(true, true, false);
1967 do_during_funding_monitor_fail(true, false, false);
1968 do_during_funding_monitor_fail(false, false, false);
1969 do_during_funding_monitor_fail(false, false, true);
1973 fn test_path_paused_mpp() {
1974 // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1976 let chanmon_cfgs = create_chanmon_cfgs(4);
1977 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1978 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1979 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1981 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
1982 let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2);
1983 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
1984 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
1986 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
1988 // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1989 let path = route.paths[0].clone();
1990 route.paths.push(path);
1991 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
1992 route.paths[0].hops[0].short_channel_id = chan_1_id;
1993 route.paths[0].hops[1].short_channel_id = chan_3_id;
1994 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
1995 route.paths[1].hops[0].short_channel_id = chan_2_ann.contents.short_channel_id;
1996 route.paths[1].hops[1].short_channel_id = chan_4_id;
1998 // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
1999 // (for the path 0 -> 2 -> 3) fails.
2000 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2001 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2003 // Now check that we get the right return value, indicating that the first path succeeded but
2004 // the second got a MonitorUpdateInProgress err. This implies
2005 // PaymentSendFailure::PartialFailure as some paths succeeded, preventing retry.
2006 if let Err(PaymentSendFailure::PartialFailure { results, ..}) = nodes[0].node.send_payment_with_route(
2007 &route, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
2009 assert_eq!(results.len(), 2);
2010 if let Ok(()) = results[0] {} else { panic!(); }
2011 if let Err(APIError::MonitorUpdateInProgress) = results[1] {} else { panic!(); }
2012 } else { panic!(); }
2013 check_added_monitors!(nodes[0], 2);
2014 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2016 // Pass the first HTLC of the payment along to nodes[3].
2017 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2018 assert_eq!(events.len(), 1);
2019 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false, None);
2021 // And check that, after we successfully update the monitor for chan_2 we can pass the second
2022 // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
2023 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
2024 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2025 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2026 assert_eq!(events.len(), 1);
2027 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true, None);
2029 claim_payment_along_route(
2030 ClaimAlongRouteArgs::new(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], payment_preimage)
2035 fn test_pending_update_fee_ack_on_reconnect() {
2036 // In early versions of our automated fee update patch, nodes did not correctly use the
2037 // previous channel feerate after sending an undelivered revoke_and_ack when re-sending an
2038 // undelivered commitment_signed.
2040 // B sends A new HTLC + CS, not delivered
2041 // A sends B update_fee + CS
2042 // B receives the CS and sends RAA, previously causing B to lock in the new feerate
2044 // B resends initial CS, using the original fee
2046 let chanmon_cfgs = create_chanmon_cfgs(2);
2047 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2048 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2049 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2051 create_announced_chan_between_nodes(&nodes, 0, 1);
2052 send_payment(&nodes[0], &[&nodes[1]], 100_000_00);
2054 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[1], nodes[0], 1_000_000);
2055 nodes[1].node.send_payment_with_route(&route, payment_hash,
2056 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
2057 check_added_monitors!(nodes[1], 1);
2058 let bs_initial_send_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2059 // bs_initial_send_msgs are not delivered until they are re-generated after reconnect
2062 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2065 nodes[0].node.timer_tick_occurred();
2066 check_added_monitors!(nodes[0], 1);
2067 let as_update_fee_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2068 assert!(as_update_fee_msgs.update_fee.is_some());
2070 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_update_fee_msgs.update_fee.as_ref().unwrap());
2071 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_fee_msgs.commitment_signed);
2072 check_added_monitors!(nodes[1], 1);
2073 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2074 // bs_first_raa is not delivered until it is re-generated after reconnect
2076 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2077 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2079 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
2080 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
2082 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2083 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
2084 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
2086 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2088 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2089 let bs_resend_msgs = nodes[1].node.get_and_clear_pending_msg_events();
2090 assert_eq!(bs_resend_msgs.len(), 3);
2091 if let MessageSendEvent::UpdateHTLCs { ref updates, .. } = bs_resend_msgs[0] {
2092 assert_eq!(*updates, bs_initial_send_msgs);
2093 } else { panic!(); }
2094 if let MessageSendEvent::SendRevokeAndACK { ref msg, .. } = bs_resend_msgs[1] {
2095 assert_eq!(*msg, bs_first_raa);
2096 } else { panic!(); }
2097 if let MessageSendEvent::SendChannelUpdate { .. } = bs_resend_msgs[2] { } else { panic!(); }
2099 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2100 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
2102 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.update_add_htlcs[0]);
2103 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.commitment_signed);
2104 check_added_monitors!(nodes[0], 1);
2105 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()));
2106 check_added_monitors!(nodes[1], 1);
2107 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()).commitment_signed;
2109 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2110 check_added_monitors!(nodes[0], 1);
2111 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);
2112 check_added_monitors!(nodes[1], 1);
2113 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2115 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2116 check_added_monitors!(nodes[0], 1);
2117 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2118 check_added_monitors!(nodes[0], 1);
2120 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()));
2121 check_added_monitors!(nodes[1], 1);
2123 expect_pending_htlcs_forwardable!(nodes[0]);
2124 expect_payment_claimable!(nodes[0], payment_hash, payment_secret, 1_000_000);
2126 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
2130 fn test_fail_htlc_on_broadcast_after_claim() {
2131 // In an earlier version of 7e78fa660cec8a73286c94c1073ee588140e7a01 we'd also fail the inbound
2132 // channel backwards if we received an HTLC failure after a HTLC fulfillment. Here we test a
2133 // specific case of that by having the HTLC failure come from the ChannelMonitor after a dust
2134 // HTLC was not included in a confirmed commitment transaction.
2136 // We first forward a payment, then claim it with an update_fulfill_htlc message, closing the
2137 // channel immediately before commitment occurs. After the commitment transaction reaches
2138 // ANTI_REORG_DELAY confirmations, will will try to fail the HTLC which was already fulfilled.
2139 let chanmon_cfgs = create_chanmon_cfgs(3);
2140 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2141 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2142 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2144 create_announced_chan_between_nodes(&nodes, 0, 1);
2145 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2147 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 2000);
2149 let bs_txn = get_local_commitment_txn!(nodes[2], chan_id_2);
2150 assert_eq!(bs_txn.len(), 1);
2152 nodes[2].node.claim_funds(payment_preimage);
2153 check_added_monitors!(nodes[2], 1);
2154 expect_payment_claimed!(nodes[2], payment_hash, 2000);
2156 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2157 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
2158 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2159 check_added_monitors!(nodes[1], 1);
2160 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2162 mine_transaction(&nodes[1], &bs_txn[0]);
2163 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[2].node.get_our_node_id()], 100000);
2164 check_closed_broadcast!(nodes[1], true);
2165 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2166 check_added_monitors!(nodes[1], 1);
2167 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 }]);
2169 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
2170 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2171 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, true, true);
2172 expect_payment_path_successful!(nodes[0]);
2175 fn do_update_fee_resend_test(deliver_update: bool, parallel_updates: bool) {
2176 // In early versions we did not handle resending of update_fee on reconnect correctly. The
2177 // chanmon_consistency fuzz target, of course, immediately found it, but we test a few cases
2179 let chanmon_cfgs = create_chanmon_cfgs(2);
2180 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2181 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2182 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2184 create_announced_chan_between_nodes(&nodes, 0, 1);
2185 send_payment(&nodes[0], &[&nodes[1]], 1000);
2188 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2189 *feerate_lock += 20;
2191 nodes[0].node.timer_tick_occurred();
2192 check_added_monitors!(nodes[0], 1);
2193 let update_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2194 assert!(update_msgs.update_fee.is_some());
2196 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2199 if parallel_updates {
2201 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2202 *feerate_lock += 20;
2204 nodes[0].node.timer_tick_occurred();
2205 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2208 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2209 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2211 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
2212 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
2214 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2215 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
2216 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
2218 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2220 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2221 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
2222 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2224 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2225 let mut as_reconnect_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2226 assert_eq!(as_reconnect_msgs.len(), 2);
2227 if let MessageSendEvent::SendChannelUpdate { .. } = as_reconnect_msgs.pop().unwrap() {} else { panic!(); }
2228 let update_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = as_reconnect_msgs.pop().unwrap()
2229 { updates } else { panic!(); };
2230 assert!(update_msgs.update_fee.is_some());
2231 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2232 if parallel_updates {
2233 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update_msgs.commitment_signed);
2234 check_added_monitors!(nodes[1], 1);
2235 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2236 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2237 check_added_monitors!(nodes[0], 1);
2238 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2240 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2241 check_added_monitors!(nodes[0], 1);
2242 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2244 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_second_update.update_fee.as_ref().unwrap());
2245 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
2246 check_added_monitors!(nodes[1], 1);
2247 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2249 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2250 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2251 check_added_monitors!(nodes[1], 1);
2253 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2254 check_added_monitors!(nodes[0], 1);
2256 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs.commitment_signed);
2257 check_added_monitors!(nodes[0], 1);
2258 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2260 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2261 check_added_monitors!(nodes[1], 1);
2263 commitment_signed_dance!(nodes[1], nodes[0], update_msgs.commitment_signed, false);
2266 send_payment(&nodes[0], &[&nodes[1]], 1000);
2269 fn update_fee_resend_test() {
2270 do_update_fee_resend_test(false, false);
2271 do_update_fee_resend_test(true, false);
2272 do_update_fee_resend_test(false, true);
2273 do_update_fee_resend_test(true, true);
2276 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2277 // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2278 // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2279 // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2280 // which failed in such a case).
2281 let chanmon_cfgs = create_chanmon_cfgs(2);
2282 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2284 let new_chain_monitor;
2285 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2286 let nodes_0_deserialized;
2287 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2289 let chan_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 15_000_000, 7_000_000_000).2;
2290 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
2291 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2293 // Do a really complicated dance to get an HTLC into the holding cell, with
2294 // MonitorUpdateInProgress set but AwaitingRemoteRevoke unset. When this test was written, any
2295 // attempts to send an HTLC while MonitorUpdateInProgress is set are immediately
2296 // failed-backwards. Thus, the only way to get an AddHTLC into the holding cell is to add it
2297 // while AwaitingRemoteRevoke is set but MonitorUpdateInProgress is unset, and then swap the
2301 // a) routing a payment from node B to node A,
2302 // b) sending a payment from node A to node B without delivering any of the generated messages,
2303 // putting node A in AwaitingRemoteRevoke,
2304 // c) sending a second payment from node A to node B, which is immediately placed in the
2306 // d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2307 // when we try to persist the payment preimage,
2308 // e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2309 // clearing AwaitingRemoteRevoke on node A.
2311 // Note that because, at the end, MonitorUpdateInProgress is still set, the HTLC generated in
2312 // (c) will not be freed from the holding cell.
2313 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[1], &[&nodes[0]], 100_000);
2315 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
2316 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
2317 check_added_monitors!(nodes[0], 1);
2318 let send = SendEvent::from_node(&nodes[0]);
2319 assert_eq!(send.msgs.len(), 1);
2321 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
2322 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
2323 check_added_monitors!(nodes[0], 0);
2325 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
2326 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2327 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2328 nodes[0].node.claim_funds(payment_preimage_0);
2329 check_added_monitors!(nodes[0], 1);
2331 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2332 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2333 check_added_monitors!(nodes[1], 1);
2335 let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2337 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2338 check_added_monitors!(nodes[0], 1);
2341 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2342 // disconnect the peers. Note that the fuzzer originally found this issue because
2343 // deserializing a ChannelManager in this state causes an assertion failure.
2345 reload_node!(nodes[0], &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
2346 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2347 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2349 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2351 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2353 // Now reconnect the two
2354 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
2355 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
2357 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2358 assert_eq!(reestablish_1.len(), 1);
2359 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
2360 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
2362 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2363 assert_eq!(reestablish_2.len(), 1);
2365 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2366 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2367 check_added_monitors!(nodes[1], 0);
2369 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2370 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2372 assert!(resp_0.0.is_none());
2373 assert!(resp_0.1.is_none());
2374 assert!(resp_0.2.is_none());
2375 assert!(resp_1.0.is_none());
2376 assert!(resp_1.1.is_none());
2378 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2380 if let Some(pending_cs) = resp_1.2 {
2381 assert!(pending_cs.update_add_htlcs.is_empty());
2382 assert!(pending_cs.update_fail_htlcs.is_empty());
2383 assert!(pending_cs.update_fulfill_htlcs.is_empty());
2384 assert_eq!(pending_cs.commitment_signed, cs);
2385 } else { panic!(); }
2388 // The two pending monitor updates were replayed (but are still pending).
2389 check_added_monitors(&nodes[0], 2);
2391 // There should be no monitor updates as we are still pending awaiting a failed one.
2392 check_added_monitors(&nodes[0], 0);
2394 check_added_monitors(&nodes[1], 0);
2397 // If we finish updating the monitor, we should free the holding cell right away (this did
2398 // not occur prior to #756).
2399 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2400 let (funding_txo, mon_id, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2401 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_txo, mon_id);
2402 expect_payment_claimed!(nodes[0], payment_hash_0, 100_000);
2404 // New outbound messages should be generated immediately upon a call to
2405 // get_and_clear_pending_msg_events (but not before).
2406 check_added_monitors!(nodes[0], 0);
2407 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2408 check_added_monitors!(nodes[0], 1);
2409 assert_eq!(events.len(), 1);
2411 // Deliver the pending in-flight CS
2412 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2413 check_added_monitors!(nodes[0], 1);
2415 let commitment_msg = match events.pop().unwrap() {
2416 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2417 assert_eq!(node_id, nodes[1].node.get_our_node_id());
2418 assert!(updates.update_fail_htlcs.is_empty());
2419 assert!(updates.update_fail_malformed_htlcs.is_empty());
2420 assert!(updates.update_fee.is_none());
2421 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2422 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2423 expect_payment_sent(&nodes[1], payment_preimage_0, None, false, false);
2424 assert_eq!(updates.update_add_htlcs.len(), 1);
2425 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2426 updates.commitment_signed
2428 _ => panic!("Unexpected event type!"),
2431 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2432 check_added_monitors!(nodes[1], 1);
2434 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2435 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2436 expect_pending_htlcs_forwardable!(nodes[1]);
2437 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2438 check_added_monitors!(nodes[1], 1);
2440 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false, false);
2442 let events = nodes[1].node.get_and_clear_pending_events();
2443 assert_eq!(events.len(), 2);
2445 Event::PendingHTLCsForwardable { .. } => { },
2446 _ => panic!("Unexpected event"),
2449 Event::PaymentPathSuccessful { .. } => { },
2450 _ => panic!("Unexpected event"),
2453 nodes[1].node.process_pending_htlc_forwards();
2454 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2456 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2457 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2460 fn channel_holding_cell_serialize() {
2461 do_channel_holding_cell_serialize(true, true);
2462 do_channel_holding_cell_serialize(true, false);
2463 do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2466 #[derive(PartialEq)]
2467 enum HTLCStatusAtDupClaim {
2472 fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_fails: bool) {
2473 // When receiving an update_fulfill_htlc message, we immediately forward the claim backwards
2474 // along the payment path before waiting for a full commitment_signed dance. This is great, but
2475 // can cause duplicative claims if a node sends an update_fulfill_htlc message, disconnects,
2476 // reconnects, and then has to re-send its update_fulfill_htlc message again.
2477 // In previous code, we didn't handle the double-claim correctly, spuriously closing the
2478 // channel on which the inbound HTLC was received.
2479 let chanmon_cfgs = create_chanmon_cfgs(3);
2480 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2481 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2482 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2484 create_announced_chan_between_nodes(&nodes, 0, 1);
2485 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2487 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
2489 let mut as_raa = None;
2490 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2491 // In order to get the HTLC claim into the holding cell at nodes[1], we need nodes[1] to be
2492 // awaiting a remote revoke_and_ack from nodes[0].
2493 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
2494 nodes[0].node.send_payment_with_route(&route, second_payment_hash,
2495 RecipientOnionFields::secret_only(second_payment_secret), PaymentId(second_payment_hash.0)).unwrap();
2496 check_added_monitors!(nodes[0], 1);
2498 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
2499 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
2500 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
2501 check_added_monitors!(nodes[1], 1);
2503 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2504 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2505 check_added_monitors!(nodes[0], 1);
2506 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
2507 check_added_monitors!(nodes[0], 1);
2509 as_raa = Some(get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2512 let fulfill_msg = msgs::UpdateFulfillHTLC {
2513 channel_id: chan_id_2,
2518 nodes[2].node.fail_htlc_backwards(&payment_hash);
2519 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash }]);
2520 check_added_monitors!(nodes[2], 1);
2521 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2523 nodes[2].node.claim_funds(payment_preimage);
2524 check_added_monitors!(nodes[2], 1);
2525 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
2527 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2528 assert_eq!(cs_updates.update_fulfill_htlcs.len(), 1);
2529 // Check that the message we're about to deliver matches the one generated:
2530 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
2532 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
2533 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2534 check_added_monitors!(nodes[1], 1);
2536 let mut bs_updates = None;
2537 if htlc_status != HTLCStatusAtDupClaim::HoldingCell {
2538 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2539 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2540 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2541 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2542 if htlc_status == HTLCStatusAtDupClaim::Cleared {
2543 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2544 expect_payment_path_successful!(nodes[0]);
2547 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2550 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
2551 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2554 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
2555 reconnect_args.pending_htlc_fails.0 = 1;
2556 reconnect_nodes(reconnect_args);
2557 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 }]);
2559 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
2560 reconnect_args.pending_htlc_claims.0 = 1;
2561 reconnect_nodes(reconnect_args);
2564 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2565 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa.unwrap());
2566 check_added_monitors!(nodes[1], 1);
2567 expect_pending_htlcs_forwardable_ignore!(nodes[1]); // We finally receive the second payment, but don't claim it
2569 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2570 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2571 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2572 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2574 if htlc_status != HTLCStatusAtDupClaim::Cleared {
2575 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2576 expect_payment_path_successful!(nodes[0]);
2581 fn test_reconnect_dup_htlc_claims() {
2582 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, false);
2583 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, false);
2584 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, false);
2585 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, true);
2586 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, true);
2587 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, true);
2591 fn test_temporary_error_during_shutdown() {
2592 // Test that temporary failures when updating the monitor's shutdown script delay cooperative
2594 let mut config = test_default_channel_config();
2595 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2597 let chanmon_cfgs = create_chanmon_cfgs(2);
2598 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2599 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
2600 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2602 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
2604 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2605 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2607 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
2608 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()));
2609 check_added_monitors!(nodes[1], 1);
2611 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()));
2612 check_added_monitors!(nodes[0], 1);
2614 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2616 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2617 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2619 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2620 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2621 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()));
2623 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2625 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2626 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2627 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2629 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()));
2630 let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
2631 let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2633 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_a.unwrap());
2634 let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
2635 assert!(none_b.is_none());
2636 let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2638 assert_eq!(txn_a, txn_b);
2639 assert_eq!(txn_a.len(), 1);
2640 check_spends!(txn_a[0], funding_tx);
2641 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
2642 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
2646 fn double_temp_error() {
2647 // Test that it's OK to have multiple `ChainMonitor::update_channel` calls fail in a row.
2648 let chanmon_cfgs = create_chanmon_cfgs(2);
2649 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2650 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2651 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2653 let (_, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1);
2655 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2656 let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2658 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2659 // `claim_funds` results in a ChannelMonitorUpdate.
2660 nodes[1].node.claim_funds(payment_preimage_1);
2661 check_added_monitors!(nodes[1], 1);
2662 let (funding_tx, latest_update_1, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2664 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2665 // Previously, this would've panicked due to a double-call to `Channel::monitor_update_failed`,
2666 // which had some asserts that prevented it from being called twice.
2667 nodes[1].node.claim_funds(payment_preimage_2);
2668 check_added_monitors!(nodes[1], 1);
2669 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2671 let (_, latest_update_2, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2672 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_1);
2673 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2674 check_added_monitors!(nodes[1], 0);
2675 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_2);
2677 // Complete the first HTLC. Note that as a side-effect we handle the monitor update completions
2678 // and get both PaymentClaimed events at once.
2679 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
2681 let events = nodes[1].node.get_and_clear_pending_events();
2682 assert_eq!(events.len(), 2);
2684 Event::PaymentClaimed { amount_msat: 1_000_000, payment_hash, .. } => assert_eq!(payment_hash, payment_hash_1),
2685 _ => panic!("Unexpected Event: {:?}", events[0]),
2688 Event::PaymentClaimed { amount_msat: 1_000_000, payment_hash, .. } => assert_eq!(payment_hash, payment_hash_2),
2689 _ => panic!("Unexpected Event: {:?}", events[1]),
2692 assert_eq!(msg_events.len(), 1);
2693 let (update_fulfill_1, commitment_signed_b1, node_id) = {
2694 match &msg_events[0] {
2695 &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 } } => {
2696 assert!(update_add_htlcs.is_empty());
2697 assert_eq!(update_fulfill_htlcs.len(), 1);
2698 assert!(update_fail_htlcs.is_empty());
2699 assert!(update_fail_malformed_htlcs.is_empty());
2700 assert!(update_fee.is_none());
2701 (update_fulfill_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2703 _ => panic!("Unexpected event"),
2706 assert_eq!(node_id, nodes[0].node.get_our_node_id());
2707 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_1);
2708 check_added_monitors!(nodes[0], 0);
2709 expect_payment_sent(&nodes[0], payment_preimage_1, None, false, false);
2710 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_b1);
2711 check_added_monitors!(nodes[0], 1);
2712 nodes[0].node.process_pending_htlc_forwards();
2713 let (raa_a1, commitment_signed_a1) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2714 check_added_monitors!(nodes[1], 0);
2715 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2716 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_a1);
2717 check_added_monitors!(nodes[1], 1);
2718 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed_a1);
2719 check_added_monitors!(nodes[1], 1);
2721 // Complete the second HTLC.
2722 let ((update_fulfill_2, commitment_signed_b2), raa_b2) = {
2723 let events = nodes[1].node.get_and_clear_pending_msg_events();
2724 assert_eq!(events.len(), 2);
2726 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2727 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2728 assert!(updates.update_add_htlcs.is_empty());
2729 assert!(updates.update_fail_htlcs.is_empty());
2730 assert!(updates.update_fail_malformed_htlcs.is_empty());
2731 assert!(updates.update_fee.is_none());
2732 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2733 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2735 _ => panic!("Unexpected event"),
2738 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2739 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2742 _ => panic!("Unexpected event"),
2745 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_b2);
2746 check_added_monitors!(nodes[0], 1);
2747 expect_payment_path_successful!(nodes[0]);
2749 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_2);
2750 check_added_monitors!(nodes[0], 0);
2751 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2752 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed_b2, false);
2753 expect_payment_sent!(nodes[0], payment_preimage_2);
2756 fn do_test_outbound_reload_without_init_mon(use_0conf: bool) {
2757 // Test that if the monitor update generated in funding_signed is stored async and we restart
2758 // with the latest ChannelManager but the ChannelMonitor persistence never completed we happily
2759 // drop the channel and move on.
2760 let chanmon_cfgs = create_chanmon_cfgs(2);
2761 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2764 let new_chain_monitor;
2766 let mut chan_config = test_default_channel_config();
2767 chan_config.manually_accept_inbound_channels = true;
2768 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2770 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2771 let nodes_0_deserialized;
2773 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2775 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None, None).unwrap();
2776 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()));
2778 let events = nodes[1].node.get_and_clear_pending_events();
2779 assert_eq!(events.len(), 1);
2781 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2783 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2785 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2788 _ => panic!("Unexpected event"),
2791 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()));
2793 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2795 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2796 check_added_monitors!(nodes[0], 0);
2798 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2799 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2800 check_added_monitors!(nodes[1], 1);
2801 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
2803 let bs_signed_locked = nodes[1].node.get_and_clear_pending_msg_events();
2804 assert_eq!(bs_signed_locked.len(), if use_0conf { 2 } else { 1 });
2805 match &bs_signed_locked[0] {
2806 MessageSendEvent::SendFundingSigned { msg, .. } => {
2807 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2809 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &msg);
2810 check_added_monitors!(nodes[0], 1);
2812 _ => panic!("Unexpected event"),
2815 match &bs_signed_locked[1] {
2816 MessageSendEvent::SendChannelReady { msg, .. } => {
2817 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &msg);
2819 _ => panic!("Unexpected event"),
2823 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
2824 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2825 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2827 // nodes[0] is now waiting on the first ChannelMonitor persistence to complete in order to
2828 // broadcast the funding transaction. If nodes[0] restarts at this point with the
2829 // ChannelMonitor lost, we should simply discard the channel.
2831 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2832 // not, so we have to clear them here.
2833 nodes[0].chain_source.watched_txn.lock().unwrap().clear();
2834 nodes[0].chain_source.watched_outputs.lock().unwrap().clear();
2836 reload_node!(nodes[0], &nodes[0].node.encode(), &[], persister, new_chain_monitor, nodes_0_deserialized);
2837 check_closed_event!(nodes[0], 1, ClosureReason::DisconnectedPeer, [nodes[1].node.get_our_node_id()], 100000);
2838 assert!(nodes[0].node.list_channels().is_empty());
2842 fn test_outbound_reload_without_init_mon() {
2843 do_test_outbound_reload_without_init_mon(true);
2844 do_test_outbound_reload_without_init_mon(false);
2847 fn do_test_inbound_reload_without_init_mon(use_0conf: bool, lock_commitment: bool) {
2848 // Test that if the monitor update generated by funding_transaction_generated is stored async
2849 // and we restart with the latest ChannelManager but the ChannelMonitor persistence never
2850 // completed we happily drop the channel and move on.
2851 let chanmon_cfgs = create_chanmon_cfgs(2);
2852 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2855 let new_chain_monitor;
2857 let mut chan_config = test_default_channel_config();
2858 chan_config.manually_accept_inbound_channels = true;
2859 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2861 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2862 let nodes_1_deserialized;
2864 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2866 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None, None).unwrap();
2867 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()));
2869 let events = nodes[1].node.get_and_clear_pending_events();
2870 assert_eq!(events.len(), 1);
2872 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2874 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2876 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2879 _ => panic!("Unexpected event"),
2882 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()));
2884 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2886 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2887 check_added_monitors!(nodes[0], 0);
2889 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2890 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2891 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2892 check_added_monitors!(nodes[1], 1);
2894 // nodes[1] happily sends its funding_signed even though its awaiting the persistence of the
2895 // initial ChannelMonitor, but it will decline to send its channel_ready even if the funding
2896 // transaction is confirmed.
2897 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
2899 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
2900 check_added_monitors!(nodes[0], 1);
2901 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
2903 let as_funding_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2904 if lock_commitment {
2905 confirm_transaction(&nodes[0], &as_funding_tx[0]);
2906 confirm_transaction(&nodes[1], &as_funding_tx[0]);
2908 if use_0conf || lock_commitment {
2909 let as_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
2910 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_ready);
2912 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2914 // nodes[1] is now waiting on the first ChannelMonitor persistence to complete in order to
2915 // move the channel to ready (or is waiting on the funding transaction to confirm). If nodes[1]
2916 // restarts at this point with the ChannelMonitor lost, we should simply discard the channel.
2918 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2919 // not, so we have to clear them here.
2920 nodes[1].chain_source.watched_txn.lock().unwrap().clear();
2921 nodes[1].chain_source.watched_outputs.lock().unwrap().clear();
2923 reload_node!(nodes[1], &nodes[1].node.encode(), &[], persister, new_chain_monitor, nodes_1_deserialized);
2925 check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer, [nodes[0].node.get_our_node_id()], 100000);
2926 assert!(nodes[1].node.list_channels().is_empty());
2930 fn test_inbound_reload_without_init_mon() {
2931 do_test_inbound_reload_without_init_mon(true, true);
2932 do_test_inbound_reload_without_init_mon(true, false);
2933 do_test_inbound_reload_without_init_mon(false, true);
2934 do_test_inbound_reload_without_init_mon(false, false);
2938 fn test_blocked_chan_preimage_release() {
2939 // Test that even if a channel's `ChannelMonitorUpdate` flow is blocked waiting on an event to
2940 // be handled HTLC preimage `ChannelMonitorUpdate`s will still go out.
2941 let chanmon_cfgs = create_chanmon_cfgs(3);
2942 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2943 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2944 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2946 create_announced_chan_between_nodes(&nodes, 0, 1);
2947 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2949 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5_000_000);
2951 // Tee up two payments in opposite directions across nodes[1], one it sent to generate a
2952 // PaymentSent event and one it forwards.
2953 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[1], &[&nodes[2]], 1_000_000);
2954 let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[2], &[&nodes[1], &nodes[0]], 1_000_000);
2956 // Claim the first payment to get a `PaymentSent` event (but don't handle it yet).
2957 nodes[2].node.claim_funds(payment_preimage_1);
2958 check_added_monitors(&nodes[2], 1);
2959 expect_payment_claimed!(nodes[2], payment_hash_1, 1_000_000);
2961 let cs_htlc_fulfill_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2962 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_htlc_fulfill_updates.update_fulfill_htlcs[0]);
2963 do_commitment_signed_dance(&nodes[1], &nodes[2], &cs_htlc_fulfill_updates.commitment_signed, false, false);
2964 check_added_monitors(&nodes[1], 0);
2966 // Now claim the second payment on nodes[0], which will ultimately result in nodes[1] trying to
2967 // claim an HTLC on its channel with nodes[2], but that channel is blocked on the above
2968 // `PaymentSent` event.
2969 nodes[0].node.claim_funds(payment_preimage_2);
2970 check_added_monitors(&nodes[0], 1);
2971 expect_payment_claimed!(nodes[0], payment_hash_2, 1_000_000);
2973 let as_htlc_fulfill_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2974 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &as_htlc_fulfill_updates.update_fulfill_htlcs[0]);
2975 check_added_monitors(&nodes[1], 1); // We generate only a preimage monitor update
2976 assert!(get_monitor!(nodes[1], chan_id_2).get_stored_preimages().contains_key(&payment_hash_2));
2977 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2979 // Finish the CS dance between nodes[0] and nodes[1]. Note that until the event handling, the
2980 // update_fulfill_htlc + CS is held, even though the preimage is already on disk for the
2982 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_htlc_fulfill_updates.commitment_signed);
2983 check_added_monitors(&nodes[1], 1);
2984 let (a, raa) = do_main_commitment_signed_dance(&nodes[1], &nodes[0], false);
2985 assert!(a.is_none());
2987 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
2988 check_added_monitors(&nodes[1], 0);
2989 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2991 let events = nodes[1].node.get_and_clear_pending_events();
2992 assert_eq!(events.len(), 3);
2993 if let Event::PaymentSent { .. } = events[0] {} else { panic!(); }
2994 if let Event::PaymentPathSuccessful { .. } = events[2] {} else { panic!(); }
2995 if let Event::PaymentForwarded { .. } = events[1] {} else { panic!(); }
2997 // The event processing should release the last RAA updates on both channels.
2998 check_added_monitors(&nodes[1], 2);
3000 // When we fetch the next update the message getter will generate the next update for nodes[2],
3001 // generating a further monitor update.
3002 let bs_htlc_fulfill_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3003 check_added_monitors(&nodes[1], 1);
3005 nodes[2].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_htlc_fulfill_updates.update_fulfill_htlcs[0]);
3006 do_commitment_signed_dance(&nodes[2], &nodes[1], &bs_htlc_fulfill_updates.commitment_signed, false, false);
3007 expect_payment_sent(&nodes[2], payment_preimage_2, None, true, true);
3010 fn do_test_inverted_mon_completion_order(with_latest_manager: bool, complete_bc_commitment_dance: bool) {
3011 // When we forward a payment and receive `update_fulfill_htlc`+`commitment_signed` messages
3012 // from the downstream channel, we immediately claim the HTLC on the upstream channel, before
3013 // even doing a `commitment_signed` dance on the downstream channel. This implies that our
3014 // `ChannelMonitorUpdate`s are generated in the right order - first we ensure we'll get our
3015 // money, then we write the update that resolves the downstream node claiming their money. This
3016 // is safe as long as `ChannelMonitorUpdate`s complete in the order in which they are
3017 // generated, but of course this may not be the case. For asynchronous update writes, we have
3018 // to ensure monitor updates can block each other, preventing the inversion all together.
3019 let chanmon_cfgs = create_chanmon_cfgs(3);
3020 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3023 let new_chain_monitor;
3024 let nodes_1_deserialized;
3026 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3027 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3029 let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
3030 let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;
3032 // Route a payment from A, through B, to C, then claim it on C. Once we pass B the
3033 // `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
3034 // on the B<->C channel but leave the A<->B monitor update pending, then reload B.
3035 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
3037 let mon_ab = get_monitor!(nodes[1], chan_id_ab).encode();
3038 let mut manager_b = Vec::new();
3039 if !with_latest_manager {
3040 manager_b = nodes[1].node.encode();
3043 nodes[2].node.claim_funds(payment_preimage);
3044 check_added_monitors(&nodes[2], 1);
3045 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
3047 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3048 let cs_updates = get_htlc_update_msgs(&nodes[2], &nodes[1].node.get_our_node_id());
3049 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
3051 // B generates a new monitor update for the A <-> B channel, but doesn't send the new messages
3052 // for it since the monitor update is marked in-progress.
3053 check_added_monitors(&nodes[1], 1);
3054 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3056 // Now step the Commitment Signed Dance between B and C forward a bit (or fully), ensuring we
3057 // won't get the preimage when the nodes reconnect and we have to get it from the
3059 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &cs_updates.commitment_signed);
3060 check_added_monitors(&nodes[1], 1);
3061 if complete_bc_commitment_dance {
3062 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3063 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3064 check_added_monitors(&nodes[2], 1);
3065 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3066 check_added_monitors(&nodes[2], 1);
3067 let cs_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3069 // At this point node B still hasn't persisted the `ChannelMonitorUpdate` with the
3070 // preimage in the A <-> B channel, which will prevent it from persisting the
3071 // `ChannelMonitorUpdate` for the B<->C channel here to avoid "losing" the preimage.
3072 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &cs_raa);
3073 check_added_monitors(&nodes[1], 0);
3074 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3077 // Now reload node B
3078 if with_latest_manager {
3079 manager_b = nodes[1].node.encode();
3082 let mon_bc = get_monitor!(nodes[1], chan_id_bc).encode();
3083 reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, new_chain_monitor, nodes_1_deserialized);
3085 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3086 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3088 if with_latest_manager {
3089 // If we used the latest ChannelManager to reload from, we should have both channels still
3090 // live. The B <-> C channel's final RAA ChannelMonitorUpdate must still be blocked as
3091 // before - the ChannelMonitorUpdate for the A <-> B channel hasn't completed.
3092 // When we call `timer_tick_occurred` we will get that monitor update back, which we'll
3093 // complete after reconnecting to our peers.
3094 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3095 nodes[1].node.timer_tick_occurred();
3096 check_added_monitors(&nodes[1], 1);
3097 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3099 // Now reconnect B to both A and C. If the B <-> C commitment signed dance wasn't run to
3100 // the end go ahead and do that, though the
3101 // `pending_responding_commitment_signed_dup_monitor` in `reconnect_args` indicates that we
3102 // expect to *not* receive the final RAA ChannelMonitorUpdate.
3103 if complete_bc_commitment_dance {
3104 reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[2]));
3106 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
3107 reconnect_args.pending_responding_commitment_signed.1 = true;
3108 reconnect_args.pending_responding_commitment_signed_dup_monitor.1 = true;
3109 reconnect_args.pending_raa = (false, true);
3110 reconnect_nodes(reconnect_args);
3113 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
3115 // (Finally) complete the A <-> B ChannelMonitorUpdate, ensuring the preimage is durably on
3116 // disk in the proper ChannelMonitor, unblocking the B <-> C ChannelMonitor updating
3118 let (outpoint, _, ab_update_id) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_ab).unwrap().clone();
3119 nodes[1].chain_monitor.chain_monitor.channel_monitor_updated(outpoint, ab_update_id).unwrap();
3121 // When we fetch B's HTLC update messages next (now that the ChannelMonitorUpdate has
3122 // completed), it will also release the final RAA ChannelMonitorUpdate on the B <-> C
3125 // If the ChannelManager used in the reload was stale, check that the B <-> C channel was
3128 // Note that this will also process the ChannelMonitorUpdates which were queued up when we
3129 // reloaded the ChannelManager. This will re-emit the A<->B preimage as well as the B<->C
3130 // force-closure ChannelMonitorUpdate. Once the A<->B preimage update completes, the claim
3131 // commitment update will be allowed to go out.
3132 check_added_monitors(&nodes[1], 0);
3133 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3134 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3135 check_closed_event(&nodes[1], 1, ClosureReason::OutdatedChannelManager, false, &[nodes[2].node.get_our_node_id()], 100_000);
3136 check_added_monitors(&nodes[1], 2);
3138 nodes[1].node.timer_tick_occurred();
3139 check_added_monitors(&nodes[1], 0);
3141 // Don't bother to reconnect B to C - that channel has been closed. We don't need to
3142 // exchange any messages here even though there's a pending commitment update because the
3143 // ChannelMonitorUpdate hasn't yet completed.
3144 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
3146 let (outpoint, _, ab_update_id) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_ab).unwrap().clone();
3147 nodes[1].chain_monitor.chain_monitor.channel_monitor_updated(outpoint, ab_update_id).unwrap();
3149 // The ChannelMonitorUpdate which was completed prior to the reconnect only contained the
3150 // preimage (as it was a replay of the original ChannelMonitorUpdate from before we
3151 // restarted). When we go to fetch the commitment transaction updates we'll poll the
3152 // ChannelMonitorUpdate completion, then generate (and complete) a new ChannelMonitorUpdate
3153 // with the actual commitment transaction, which will allow us to fulfill the HTLC with
3157 let bs_updates = get_htlc_update_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
3158 check_added_monitors(&nodes[1], 1);
3160 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
3161 do_commitment_signed_dance(&nodes[0], &nodes[1], &bs_updates.commitment_signed, false, false);
3163 expect_payment_forwarded!(nodes[1], &nodes[0], &nodes[2], Some(1_000), false, !with_latest_manager);
3165 // Finally, check that the payment was, ultimately, seen as sent by node A.
3166 expect_payment_sent(&nodes[0], payment_preimage, None, true, true);
3170 fn test_inverted_mon_completion_order() {
3171 do_test_inverted_mon_completion_order(true, true);
3172 do_test_inverted_mon_completion_order(true, false);
3173 do_test_inverted_mon_completion_order(false, true);
3174 do_test_inverted_mon_completion_order(false, false);
3177 fn do_test_durable_preimages_on_closed_channel(close_chans_before_reload: bool, close_only_a: bool, hold_post_reload_mon_update: bool) {
3178 // Test that we can apply a `ChannelMonitorUpdate` with a payment preimage even if the channel
3179 // is force-closed between when we generate the update on reload and when we go to handle the
3180 // update or prior to generating the update at all.
3182 if !close_chans_before_reload && close_only_a {
3183 // If we're not closing, it makes no sense to "only close A"
3187 let chanmon_cfgs = create_chanmon_cfgs(3);
3188 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3191 let new_chain_monitor;
3192 let nodes_1_deserialized;
3194 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3195 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3197 let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
3198 let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;
3200 // Route a payment from A, through B, to C, then claim it on C. Once we pass B the
3201 // `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
3202 // on the B<->C channel but leave the A<->B monitor update pending, then reload B.
3203 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
3205 let mon_ab = get_monitor!(nodes[1], chan_id_ab).encode();
3207 nodes[2].node.claim_funds(payment_preimage);
3208 check_added_monitors(&nodes[2], 1);
3209 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
3211 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3212 let cs_updates = get_htlc_update_msgs(&nodes[2], &nodes[1].node.get_our_node_id());
3213 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
3215 // B generates a new monitor update for the A <-> B channel, but doesn't send the new messages
3216 // for it since the monitor update is marked in-progress.
3217 check_added_monitors(&nodes[1], 1);
3218 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3220 // Now step the Commitment Signed Dance between B and C forward a bit, ensuring we won't get
3221 // the preimage when the nodes reconnect, at which point we have to ensure we get it from the
3223 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &cs_updates.commitment_signed);
3224 check_added_monitors(&nodes[1], 1);
3225 let _ = get_revoke_commit_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3227 let mon_bc = get_monitor!(nodes[1], chan_id_bc).encode();
3228 let error_message = "Channel force-closed";
3230 if close_chans_before_reload {
3232 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3233 nodes[1].node.force_close_broadcasting_latest_txn(&chan_id_bc, &nodes[2].node.get_our_node_id(), error_message.to_string()).unwrap();
3234 check_closed_broadcast(&nodes[1], 1, true);
3235 check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(true) }, false, &[nodes[2].node.get_our_node_id()], 100000);
3238 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3239 nodes[1].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[0].node.get_our_node_id(), error_message.to_string()).unwrap();
3240 check_closed_broadcast(&nodes[1], 1, true);
3241 check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(true) }, false, &[nodes[0].node.get_our_node_id()], 100000);
3244 // Now reload node B
3245 let manager_b = nodes[1].node.encode();
3246 reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, new_chain_monitor, nodes_1_deserialized);
3248 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3249 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3251 if close_chans_before_reload {
3252 // If the channels were already closed, B will rebroadcast its closing transactions here.
3253 let bs_close_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3255 assert_eq!(bs_close_txn.len(), 2);
3257 assert_eq!(bs_close_txn.len(), 3);
3260 let error_message = "Channel force-closed";
3262 nodes[0].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[1].node.get_our_node_id(), error_message.to_string()).unwrap();
3263 check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(true) }, false, &[nodes[1].node.get_our_node_id()], 100000);
3264 let as_closing_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3265 assert_eq!(as_closing_tx.len(), 1);
3267 // In order to give A's closing transaction to B without processing background events first,
3268 // use the _without_consistency_checks utility method. This is similar to connecting blocks
3269 // during startup prior to the node being full initialized.
3270 mine_transaction_without_consistency_checks(&nodes[1], &as_closing_tx[0]);
3272 // After a timer tick a payment preimage ChannelMonitorUpdate is applied to the A<->B
3273 // ChannelMonitor (possible twice), even though the channel has since been closed.
3274 check_added_monitors(&nodes[1], 0);
3275 let mons_added = if close_chans_before_reload { if !close_only_a { 4 } else { 3 } } else { 2 };
3276 if hold_post_reload_mon_update {
3277 for _ in 0..mons_added {
3278 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3281 nodes[1].node.timer_tick_occurred();
3282 check_added_monitors(&nodes[1], mons_added);
3284 // Finally, check that B created a payment preimage transaction and close out the payment.
3285 let bs_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3286 assert_eq!(bs_txn.len(), if close_chans_before_reload && !close_only_a { 2 } else { 1 });
3287 let bs_preimage_tx = &bs_txn[0];
3288 check_spends!(bs_preimage_tx, as_closing_tx[0]);
3290 if !close_chans_before_reload {
3291 check_closed_broadcast(&nodes[1], 1, true);
3292 check_closed_event(&nodes[1], 1, ClosureReason::CommitmentTxConfirmed, false, &[nodes[0].node.get_our_node_id()], 100000);
3294 // While we forwarded the payment a while ago, we don't want to process events too early or
3295 // we'll run background tasks we wanted to test individually.
3296 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], None, true, !close_only_a);
3299 mine_transactions(&nodes[0], &[&as_closing_tx[0], bs_preimage_tx]);
3300 check_closed_broadcast(&nodes[0], 1, true);
3301 expect_payment_sent(&nodes[0], payment_preimage, None, true, true);
3303 if !close_chans_before_reload || close_only_a {
3304 // Make sure the B<->C channel is still alive and well by sending a payment over it.
3305 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
3306 reconnect_args.pending_responding_commitment_signed.1 = true;
3307 if !close_chans_before_reload {
3308 // TODO: If the A<->B channel was closed before we reloaded, the `ChannelManager`
3309 // will consider the forwarded payment complete and allow the B<->C
3310 // `ChannelMonitorUpdate` to complete, wiping the payment preimage. This should not
3311 // be allowed, and needs fixing.
3312 reconnect_args.pending_responding_commitment_signed_dup_monitor.1 = true;
3314 reconnect_args.pending_raa.1 = true;
3316 reconnect_nodes(reconnect_args);
3317 let (outpoint, ab_update_id, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_ab).unwrap().clone();
3318 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, ab_update_id);
3319 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), true, false);
3320 if !close_chans_before_reload {
3321 // Once we call `process_pending_events` the final `ChannelMonitor` for the B<->C
3322 // channel will fly, removing the payment preimage from it.
3323 check_added_monitors(&nodes[1], 1);
3325 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3326 send_payment(&nodes[1], &[&nodes[2]], 100_000);
3331 fn test_durable_preimages_on_closed_channel() {
3332 do_test_durable_preimages_on_closed_channel(true, true, true);
3333 do_test_durable_preimages_on_closed_channel(true, true, false);
3334 do_test_durable_preimages_on_closed_channel(true, false, true);
3335 do_test_durable_preimages_on_closed_channel(true, false, false);
3336 do_test_durable_preimages_on_closed_channel(false, false, true);
3337 do_test_durable_preimages_on_closed_channel(false, false, false);
3341 fn test_sync_async_persist_doesnt_hang() {
3342 // Previously, we checked if a channel was a candidate for making forward progress based on if
3343 // the `MonitorEvent::Completed` matched the channel's latest monitor update id. However, this
3344 // could lead to a rare race when `ChannelMonitor`s were being persisted both synchronously and
3345 // asynchronously leading to channel hangs.
3347 // To hit this case, we need to generate a `MonitorEvent::Completed` prior to a new channel
3348 // update, but which is only processed after the channel update.
3349 let chanmon_cfgs = create_chanmon_cfgs(2);
3350 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3351 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3352 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3354 let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
3356 // Send two payments from A to B, then claim the first, marking the very last
3357 // ChannelMonitorUpdate as InProgress...
3358 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
3359 let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
3361 nodes[1].node.claim_funds(payment_preimage_1);
3362 check_added_monitors(&nodes[1], 1);
3363 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
3365 let bs_updates = get_htlc_update_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
3366 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
3367 expect_payment_sent(&nodes[0], payment_preimage_1, None, false, false);
3368 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
3369 check_added_monitors(&nodes[0], 1);
3370 let (as_raa, as_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3372 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
3373 check_added_monitors(&nodes[1], 1);
3374 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs);
3375 check_added_monitors(&nodes[1], 1);
3377 let bs_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3378 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3379 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_final_raa);
3380 check_added_monitors(&nodes[0], 1);
3382 // Immediately complete the monitor update, but before the ChannelManager has a chance to see
3383 // the MonitorEvent::Completed, create a channel update by receiving a claim on the second
3385 let (outpoint, _, ab_update_id) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_ab).unwrap().clone();
3386 nodes[0].chain_monitor.chain_monitor.channel_monitor_updated(outpoint, ab_update_id).unwrap();
3388 nodes[1].node.claim_funds(payment_preimage_2);
3389 check_added_monitors(&nodes[1], 1);
3390 expect_payment_claimed!(nodes[1], payment_hash_2, 1_000_000);
3392 let bs_updates = get_htlc_update_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
3393 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
3394 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
3395 check_added_monitors(&nodes[0], 1);
3397 // At this point, we have completed an extra `ChannelMonitorUpdate` but the `ChannelManager`
3398 // hasn't yet seen our `MonitorEvent::Completed`. When we call
3399 // `get_and_clear_pending_msg_events` here, the `ChannelManager` finally sees that event and
3400 // should return the channel to normal operation.
3401 let (as_raa, as_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3403 // Now that we've completed our test, process the events we have queued up (which we were not
3404 // able to check until now as they would have caused the `ChannelManager` to look at the
3405 // pending `MonitorEvent`s).
3406 let pending_events = nodes[0].node.get_and_clear_pending_events();
3407 assert_eq!(pending_events.len(), 2);
3408 if let Event::PaymentPathSuccessful { ref payment_hash, ..} = pending_events[1] {
3409 assert_eq!(payment_hash.unwrap(), payment_hash_1);
3410 } else { panic!(); }
3411 if let Event::PaymentSent { ref payment_hash, ..} = pending_events[0] {
3412 assert_eq!(*payment_hash, payment_hash_2);
3413 } else { panic!(); }
3415 // Finally, complete the claiming of the second payment
3416 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
3417 check_added_monitors(&nodes[1], 1);
3418 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs);
3419 check_added_monitors(&nodes[1], 1);
3421 let bs_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3422 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_final_raa);
3423 check_added_monitors(&nodes[0], 1);
3424 expect_payment_path_successful!(nodes[0]);
3427 fn do_test_reload_mon_update_completion_actions(close_during_reload: bool) {
3428 // Test that if a `ChannelMonitorUpdate` completes but a `ChannelManager` isn't serialized
3429 // before restart we run the monitor update completion action on startup.
3430 let chanmon_cfgs = create_chanmon_cfgs(3);
3431 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3434 let new_chain_monitor;
3435 let nodes_1_deserialized;
3437 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3438 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3440 let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
3441 let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;
3443 // Route a payment from A, through B, to C, then claim it on C. Once we pass B the
3444 // `update_fulfill_htlc`+`commitment_signed` we have a monitor update for both of B's channels.
3445 // We complete the commitment signed dance on the B<->C channel but leave the A<->B monitor
3446 // update pending, then reload B. At that point, the final monitor update on the B<->C channel
3447 // is still pending because it can't fly until the preimage is persisted on the A<->B monitor.
3448 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
3450 nodes[2].node.claim_funds(payment_preimage);
3451 check_added_monitors(&nodes[2], 1);
3452 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
3454 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3455 let cs_updates = get_htlc_update_msgs(&nodes[2], &nodes[1].node.get_our_node_id());
3456 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
3458 // B generates a new monitor update for the A <-> B channel, but doesn't send the new messages
3459 // for it since the monitor update is marked in-progress.
3460 check_added_monitors(&nodes[1], 1);
3461 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3463 // Now step the Commitment Signed Dance between B and C and check that after the final RAA B
3464 // doesn't let the preimage-removing monitor update fly.
3465 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &cs_updates.commitment_signed);
3466 check_added_monitors(&nodes[1], 1);
3467 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3469 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
3470 check_added_monitors(&nodes[2], 1);
3471 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
3472 check_added_monitors(&nodes[2], 1);
3474 let cs_final_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3475 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &cs_final_raa);
3476 check_added_monitors(&nodes[1], 0);
3478 // Finally, reload node B and check that after we call `process_pending_events` once we realize
3479 // we've completed the A<->B preimage-including monitor update and so can release the B<->C
3480 // preimage-removing monitor update.
3481 let mon_ab = get_monitor!(nodes[1], chan_id_ab).encode();
3482 let mon_bc = get_monitor!(nodes[1], chan_id_bc).encode();
3483 let manager_b = nodes[1].node.encode();
3484 reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, new_chain_monitor, nodes_1_deserialized);
3486 let error_message = "Channel force-closed";
3487 if close_during_reload {
3488 // Test that we still free the B<->C channel if the A<->B channel closed while we reloaded
3489 // (as learned about during the on-reload block connection).
3490 nodes[0].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[1].node.get_our_node_id(), error_message.to_string()).unwrap();
3491 check_added_monitors!(nodes[0], 1);
3492 check_closed_broadcast!(nodes[0], true);
3493 check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(true) }, false, &[nodes[1].node.get_our_node_id()], 100_000);
3494 let as_closing_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3495 mine_transaction_without_consistency_checks(&nodes[1], &as_closing_tx[0]);
3498 let bc_update_id = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_bc).unwrap().2;
3499 let mut events = nodes[1].node.get_and_clear_pending_events();
3500 assert_eq!(events.len(), if close_during_reload { 2 } else { 1 });
3501 expect_payment_forwarded(events.pop().unwrap(), &nodes[1], &nodes[0], &nodes[2], Some(1000),
3502 None, close_during_reload, false, false);
3503 if close_during_reload {
3505 Event::ChannelClosed { .. } => {},
3508 check_closed_broadcast!(nodes[1], true);
3511 // Once we run event processing the monitor should free, check that it was indeed the B<->C
3512 // channel which was updated.
3513 check_added_monitors(&nodes[1], if close_during_reload { 2 } else { 1 });
3514 let post_ev_bc_update_id = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_bc).unwrap().2;
3515 assert!(bc_update_id != post_ev_bc_update_id);
3517 // Finally, check that there's nothing left to do on B<->C reconnect and the channel operates
3519 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3520 reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[2]));
3521 send_payment(&nodes[1], &[&nodes[2]], 100_000);
3525 fn test_reload_mon_update_completion_actions() {
3526 do_test_reload_mon_update_completion_actions(true);
3527 do_test_reload_mon_update_completion_actions(false);
3530 fn do_test_glacial_peer_cant_hang(hold_chan_a: bool) {
3531 // Test that if a peer manages to send an `update_fulfill_htlc` message without a
3532 // `commitment_signed`, disconnects, then replays the `update_fulfill_htlc` message it doesn't
3533 // result in a channel hang. This was previously broken as the `DuplicateClaim` case wasn't
3534 // handled when claiming an HTLC and handling wasn't added when completion actions were added
3535 // (which must always complete at some point).
3536 let chanmon_cfgs = create_chanmon_cfgs(3);
3537 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3539 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3540 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3542 create_announced_chan_between_nodes(&nodes, 0, 1);
3543 create_announced_chan_between_nodes(&nodes, 1, 2);
3545 // Route a payment from A, through B, to C, then claim it on C. Replay the
3546 // `update_fulfill_htlc` twice on B to check that B doesn't hang.
3547 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
3549 nodes[2].node.claim_funds(payment_preimage);
3550 check_added_monitors(&nodes[2], 1);
3551 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
3553 let cs_updates = get_htlc_update_msgs(&nodes[2], &nodes[1].node.get_our_node_id());
3555 // The first update will be on the A <-> B channel, which we allow to complete.
3556 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3558 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
3559 check_added_monitors(&nodes[1], 1);
3562 let bs_updates = get_htlc_update_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
3563 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
3564 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
3565 expect_payment_sent!(&nodes[0], payment_preimage);
3568 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
3569 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3571 let mut reconnect = ReconnectArgs::new(&nodes[1], &nodes[2]);
3572 reconnect.pending_htlc_claims = (1, 0);
3573 reconnect_nodes(reconnect);
3576 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
3577 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
3579 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3580 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3582 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[1], nodes[2], 1_000_000);
3584 nodes[1].node.send_payment_with_route(&route, payment_hash_2,
3585 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
3586 check_added_monitors(&nodes[1], 0);
3588 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3589 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3594 fn test_glacial_peer_cant_hang() {
3595 do_test_glacial_peer_cant_hang(false);
3596 do_test_glacial_peer_cant_hang(true);