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::constants::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::msgs::{ChannelMessageHandler, RoutingMessageHandler};
26 use crate::util::test_channel_signer::TestChannelSigner;
27 use crate::util::errors::APIError;
28 use crate::util::ser::{ReadableArgs, Writeable};
29 use crate::util::test_utils::TestBroadcaster;
31 use crate::ln::functional_test_utils::*;
33 use crate::util::test_utils;
36 use bitcoin::hashes::Hash;
37 use crate::prelude::*;
38 use crate::sync::{Arc, Mutex};
41 fn test_monitor_and_persister_update_fail() {
42 // Test that if both updating the `ChannelMonitor` and persisting the updated
43 // `ChannelMonitor` fail, then the failure from updating the `ChannelMonitor`
44 // one that gets returned.
45 let chanmon_cfgs = create_chanmon_cfgs(2);
46 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
47 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
48 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
50 // Create some initial channel
51 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
52 let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
54 // Rebalance the network to generate htlc in the two directions
55 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
57 // Route an HTLC from node 0 to node 1 (but don't settle)
58 let (preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
60 // Make a copy of the ChainMonitor so we can capture the error it returns on a
61 // bogus update. Note that if instead we updated the nodes[0]'s ChainMonitor
62 // directly, the node would fail to be `Drop`'d at the end because its
63 // ChannelManager and ChainMonitor would be out of sync.
64 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
65 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
66 let persister = test_utils::TestPersister::new();
67 let tx_broadcaster = TestBroadcaster {
68 txn_broadcasted: Mutex::new(Vec::new()),
69 // Because we will connect a block at height 200 below, we need the TestBroadcaster to know
70 // that we are at height 200 so that it doesn't think we're violating the time lock
71 // requirements of transactions broadcasted at that point.
72 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 200); 200])),
76 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
77 let new_monitor = <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(
78 &mut io::Cursor::new(&monitor.encode()), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
79 assert!(new_monitor == *monitor);
82 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
83 assert_eq!(chain_mon.watch_channel(outpoint, new_monitor), Ok(ChannelMonitorUpdateStatus::Completed));
86 chain_mon.chain_monitor.block_connected(&create_dummy_block(BlockHash::all_zeros(), 42, Vec::new()), 200);
88 // Try to update ChannelMonitor
89 nodes[1].node.claim_funds(preimage);
90 expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
91 check_added_monitors!(nodes[1], 1);
93 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
94 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
95 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
98 let mut node_0_per_peer_lock;
99 let mut node_0_peer_state_lock;
100 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) {
101 if let Ok(Some(update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
102 // Check that the persister returns InProgress (and will never actually complete)
103 // as the monitor update errors.
104 if let ChannelMonitorUpdateStatus::InProgress = chain_mon.chain_monitor.update_channel(outpoint, &update) {} else { panic!("Expected monitor paused"); }
105 logger.assert_log_regex("lightning::chain::chainmonitor", regex::Regex::new("Failed to update ChannelMonitor for channel [0-9a-f]*.").unwrap(), 1);
107 // Apply the monitor update to the original ChainMonitor, ensuring the
108 // ChannelManager and ChannelMonitor aren't out of sync.
109 assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, &update),
110 ChannelMonitorUpdateStatus::Completed);
111 } else { assert!(false); }
117 check_added_monitors!(nodes[0], 1);
118 expect_payment_sent(&nodes[0], preimage, None, false, false);
121 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
122 // Test that we can recover from a simple temporary monitor update failure optionally with
123 // a disconnect in between
124 let chanmon_cfgs = create_chanmon_cfgs(2);
125 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
126 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
127 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
128 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
130 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
132 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
135 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_1,
136 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)
137 ), false, APIError::MonitorUpdateInProgress, {});
138 check_added_monitors!(nodes[0], 1);
141 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
142 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
143 assert_eq!(nodes[0].node.list_channels().len(), 1);
146 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
147 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
148 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
149 reconnect_args.send_channel_ready = (true, true);
150 reconnect_nodes(reconnect_args);
153 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
154 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
155 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
156 check_added_monitors!(nodes[0], 0);
158 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
159 assert_eq!(events_2.len(), 1);
160 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
161 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
162 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
163 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
165 expect_pending_htlcs_forwardable!(nodes[1]);
167 let events_3 = nodes[1].node.get_and_clear_pending_events();
168 assert_eq!(events_3.len(), 1);
170 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
171 assert_eq!(payment_hash_1, *payment_hash);
172 assert_eq!(amount_msat, 1_000_000);
173 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
174 assert_eq!(via_channel_id, Some(channel_id));
176 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
177 assert!(payment_preimage.is_none());
178 assert_eq!(payment_secret_1, *payment_secret);
180 _ => panic!("expected PaymentPurpose::InvoicePayment")
183 _ => panic!("Unexpected event"),
186 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
188 // Now set it to failed again...
189 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
191 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
192 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_2,
193 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)
194 ), false, APIError::MonitorUpdateInProgress, {});
195 check_added_monitors!(nodes[0], 1);
198 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
199 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
200 assert_eq!(nodes[0].node.list_channels().len(), 1);
203 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
204 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
205 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
208 // ...and make sure we can force-close a frozen channel
209 nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
210 check_added_monitors!(nodes[0], 1);
211 check_closed_broadcast!(nodes[0], true);
213 // TODO: Once we hit the chain with the failure transaction we should check that we get a
214 // PaymentPathFailed event
216 assert_eq!(nodes[0].node.list_channels().len(), 0);
217 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
221 fn test_simple_monitor_temporary_update_fail() {
222 do_test_simple_monitor_temporary_update_fail(false);
223 do_test_simple_monitor_temporary_update_fail(true);
226 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
227 let disconnect_flags = 8 | 16;
229 // Test that we can recover from a temporary monitor update failure with some in-flight
230 // HTLCs going on at the same time potentially with some disconnection thrown in.
231 // * First we route a payment, then get a temporary monitor update failure when trying to
232 // route a second payment. We then claim the first payment.
233 // * If disconnect_count is set, we will disconnect at this point (which is likely as
234 // InProgress likely indicates net disconnect which resulted in failing to update the
235 // ChannelMonitor on a watchtower).
236 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
237 // immediately, otherwise we wait disconnect and deliver them via the reconnect
238 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
239 // disconnect_count & !disconnect_flags is 0).
240 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
241 // through message sending, potentially disconnect/reconnecting multiple times based on
242 // disconnect_count, to get the update_fulfill_htlc through.
243 // * We then walk through more message exchanges to get the original update_add_htlc
244 // through, swapping message ordering based on disconnect_count & 8 and optionally
245 // disconnect/reconnecting based on disconnect_count.
246 let chanmon_cfgs = create_chanmon_cfgs(2);
247 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
248 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
249 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
250 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
252 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
254 // Now try to send a second payment which will fail to send
255 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
257 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
258 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_2,
259 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)
260 ), false, APIError::MonitorUpdateInProgress, {});
261 check_added_monitors!(nodes[0], 1);
264 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
265 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
266 assert_eq!(nodes[0].node.list_channels().len(), 1);
268 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
269 // but nodes[0] won't respond since it is frozen.
270 nodes[1].node.claim_funds(payment_preimage_1);
271 check_added_monitors!(nodes[1], 1);
272 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
274 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
275 assert_eq!(events_2.len(), 1);
276 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
277 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 } } => {
278 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
279 assert!(update_add_htlcs.is_empty());
280 assert_eq!(update_fulfill_htlcs.len(), 1);
281 assert!(update_fail_htlcs.is_empty());
282 assert!(update_fail_malformed_htlcs.is_empty());
283 assert!(update_fee.is_none());
285 if (disconnect_count & 16) == 0 {
286 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
287 let events_3 = nodes[0].node.get_and_clear_pending_events();
288 assert_eq!(events_3.len(), 1);
290 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
291 assert_eq!(*payment_preimage, payment_preimage_1);
292 assert_eq!(*payment_hash, payment_hash_1);
294 _ => panic!("Unexpected event"),
297 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
298 check_added_monitors!(nodes[0], 1);
299 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
302 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
304 _ => panic!("Unexpected event"),
307 if disconnect_count & !disconnect_flags > 0 {
308 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
309 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
312 // Now fix monitor updating...
313 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
314 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
315 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
316 check_added_monitors!(nodes[0], 0);
318 macro_rules! disconnect_reconnect_peers { () => { {
319 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
320 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
322 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
323 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
325 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
326 assert_eq!(reestablish_1.len(), 1);
327 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
328 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
330 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
331 assert_eq!(reestablish_2.len(), 1);
333 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
334 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
335 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
336 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
338 assert!(as_resp.0.is_none());
339 assert!(bs_resp.0.is_none());
341 (reestablish_1, reestablish_2, as_resp, bs_resp)
344 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
345 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
346 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
348 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
349 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
351 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
352 assert_eq!(reestablish_1.len(), 1);
353 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
354 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
356 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
357 assert_eq!(reestablish_2.len(), 1);
359 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
360 check_added_monitors!(nodes[0], 0);
361 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
362 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
363 check_added_monitors!(nodes[1], 0);
364 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
366 assert!(as_resp.0.is_none());
367 assert!(bs_resp.0.is_none());
369 assert!(bs_resp.1.is_none());
370 if (disconnect_count & 16) == 0 {
371 assert!(bs_resp.2.is_none());
373 assert!(as_resp.1.is_some());
374 assert!(as_resp.2.is_some());
375 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
377 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
378 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
379 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
380 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
381 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
382 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
384 assert!(as_resp.1.is_none());
386 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
387 let events_3 = nodes[0].node.get_and_clear_pending_events();
388 assert_eq!(events_3.len(), 1);
390 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
391 assert_eq!(*payment_preimage, payment_preimage_1);
392 assert_eq!(*payment_hash, payment_hash_1);
394 _ => panic!("Unexpected event"),
397 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
398 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
399 // No commitment_signed so get_event_msg's assert(len == 1) passes
400 check_added_monitors!(nodes[0], 1);
402 as_resp.1 = Some(as_resp_raa);
406 if disconnect_count & !disconnect_flags > 1 {
407 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
409 if (disconnect_count & 16) == 0 {
410 assert!(reestablish_1 == second_reestablish_1);
411 assert!(reestablish_2 == second_reestablish_2);
413 assert!(as_resp == second_as_resp);
414 assert!(bs_resp == second_bs_resp);
417 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
419 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
420 assert_eq!(events_4.len(), 2);
421 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
422 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
423 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
426 _ => panic!("Unexpected event"),
430 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
432 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
433 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
434 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
435 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
436 check_added_monitors!(nodes[1], 1);
438 if disconnect_count & !disconnect_flags > 2 {
439 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
441 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
442 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
444 assert!(as_resp.2.is_none());
445 assert!(bs_resp.2.is_none());
448 let as_commitment_update;
449 let bs_second_commitment_update;
451 macro_rules! handle_bs_raa { () => {
452 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
453 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
454 assert!(as_commitment_update.update_add_htlcs.is_empty());
455 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
456 assert!(as_commitment_update.update_fail_htlcs.is_empty());
457 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
458 assert!(as_commitment_update.update_fee.is_none());
459 check_added_monitors!(nodes[0], 1);
462 macro_rules! handle_initial_raa { () => {
463 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
464 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
465 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
466 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
467 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
468 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
469 assert!(bs_second_commitment_update.update_fee.is_none());
470 check_added_monitors!(nodes[1], 1);
473 if (disconnect_count & 8) == 0 {
476 if disconnect_count & !disconnect_flags > 3 {
477 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
479 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
480 assert!(bs_resp.1.is_none());
482 assert!(as_resp.2.unwrap() == as_commitment_update);
483 assert!(bs_resp.2.is_none());
485 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
488 handle_initial_raa!();
490 if disconnect_count & !disconnect_flags > 4 {
491 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
493 assert!(as_resp.1.is_none());
494 assert!(bs_resp.1.is_none());
496 assert!(as_resp.2.unwrap() == as_commitment_update);
497 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
500 handle_initial_raa!();
502 if disconnect_count & !disconnect_flags > 3 {
503 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
505 assert!(as_resp.1.is_none());
506 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
508 assert!(as_resp.2.is_none());
509 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
511 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
516 if disconnect_count & !disconnect_flags > 4 {
517 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
519 assert!(as_resp.1.is_none());
520 assert!(bs_resp.1.is_none());
522 assert!(as_resp.2.unwrap() == as_commitment_update);
523 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
527 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
528 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
529 // No commitment_signed so get_event_msg's assert(len == 1) passes
530 check_added_monitors!(nodes[0], 1);
532 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
533 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
534 // No commitment_signed so get_event_msg's assert(len == 1) passes
535 check_added_monitors!(nodes[1], 1);
537 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
538 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
539 check_added_monitors!(nodes[1], 1);
541 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
542 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
543 check_added_monitors!(nodes[0], 1);
544 expect_payment_path_successful!(nodes[0]);
546 expect_pending_htlcs_forwardable!(nodes[1]);
548 let events_5 = nodes[1].node.get_and_clear_pending_events();
549 assert_eq!(events_5.len(), 1);
551 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
552 assert_eq!(payment_hash_2, *payment_hash);
553 assert_eq!(amount_msat, 1_000_000);
554 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
555 assert_eq!(via_channel_id, Some(channel_id));
557 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
558 assert!(payment_preimage.is_none());
559 assert_eq!(payment_secret_2, *payment_secret);
561 _ => panic!("expected PaymentPurpose::InvoicePayment")
564 _ => panic!("Unexpected event"),
567 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
571 fn test_monitor_temporary_update_fail_a() {
572 do_test_monitor_temporary_update_fail(0);
573 do_test_monitor_temporary_update_fail(1);
574 do_test_monitor_temporary_update_fail(2);
575 do_test_monitor_temporary_update_fail(3);
576 do_test_monitor_temporary_update_fail(4);
577 do_test_monitor_temporary_update_fail(5);
581 fn test_monitor_temporary_update_fail_b() {
582 do_test_monitor_temporary_update_fail(2 | 8);
583 do_test_monitor_temporary_update_fail(3 | 8);
584 do_test_monitor_temporary_update_fail(4 | 8);
585 do_test_monitor_temporary_update_fail(5 | 8);
589 fn test_monitor_temporary_update_fail_c() {
590 do_test_monitor_temporary_update_fail(1 | 16);
591 do_test_monitor_temporary_update_fail(2 | 16);
592 do_test_monitor_temporary_update_fail(3 | 16);
593 do_test_monitor_temporary_update_fail(2 | 8 | 16);
594 do_test_monitor_temporary_update_fail(3 | 8 | 16);
598 fn test_monitor_update_fail_cs() {
599 // Tests handling of a monitor update failure when processing an incoming commitment_signed
600 let chanmon_cfgs = create_chanmon_cfgs(2);
601 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
602 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
603 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
604 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
606 let (route, our_payment_hash, payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
608 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
609 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
610 check_added_monitors!(nodes[0], 1);
613 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
614 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
616 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
617 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
618 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
619 check_added_monitors!(nodes[1], 1);
620 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
622 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
623 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
624 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
625 check_added_monitors!(nodes[1], 0);
626 let responses = nodes[1].node.get_and_clear_pending_msg_events();
627 assert_eq!(responses.len(), 2);
630 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
631 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
632 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
633 check_added_monitors!(nodes[0], 1);
635 _ => panic!("Unexpected event"),
638 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
639 assert!(updates.update_add_htlcs.is_empty());
640 assert!(updates.update_fulfill_htlcs.is_empty());
641 assert!(updates.update_fail_htlcs.is_empty());
642 assert!(updates.update_fail_malformed_htlcs.is_empty());
643 assert!(updates.update_fee.is_none());
644 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
646 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
647 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
648 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
649 check_added_monitors!(nodes[0], 1);
650 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
652 _ => panic!("Unexpected event"),
655 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
656 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
657 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
658 check_added_monitors!(nodes[0], 0);
660 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
661 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
662 check_added_monitors!(nodes[1], 1);
664 expect_pending_htlcs_forwardable!(nodes[1]);
666 let events = nodes[1].node.get_and_clear_pending_events();
667 assert_eq!(events.len(), 1);
669 Event::PaymentClaimable { payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
670 assert_eq!(payment_hash, our_payment_hash);
671 assert_eq!(amount_msat, 1_000_000);
672 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
673 assert_eq!(via_channel_id, Some(channel_id));
675 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
676 assert!(payment_preimage.is_none());
677 assert_eq!(our_payment_secret, *payment_secret);
679 _ => panic!("expected PaymentPurpose::InvoicePayment")
682 _ => panic!("Unexpected event"),
685 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
689 fn test_monitor_update_fail_no_rebroadcast() {
690 // Tests handling of a monitor update failure when no message rebroadcasting on
691 // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
693 let chanmon_cfgs = create_chanmon_cfgs(2);
694 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
695 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
696 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
697 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
699 let (route, our_payment_hash, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
701 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
702 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(our_payment_hash.0)).unwrap();
703 check_added_monitors!(nodes[0], 1);
706 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
707 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
708 let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
710 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
711 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
712 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
713 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
714 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
715 check_added_monitors!(nodes[1], 1);
717 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
718 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
719 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
720 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
721 check_added_monitors!(nodes[1], 0);
722 expect_pending_htlcs_forwardable!(nodes[1]);
724 let events = nodes[1].node.get_and_clear_pending_events();
725 assert_eq!(events.len(), 1);
727 Event::PaymentClaimable { payment_hash, .. } => {
728 assert_eq!(payment_hash, our_payment_hash);
730 _ => panic!("Unexpected event"),
733 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
737 fn test_monitor_update_raa_while_paused() {
738 // Tests handling of an RAA while monitor updating has already been marked failed.
739 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
740 let chanmon_cfgs = create_chanmon_cfgs(2);
741 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
742 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
743 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
744 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
746 send_payment(&nodes[0], &[&nodes[1]], 5000000);
747 let (route, our_payment_hash_1, payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
749 nodes[0].node.send_payment_with_route(&route, our_payment_hash_1,
750 RecipientOnionFields::secret_only(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
751 check_added_monitors!(nodes[0], 1);
753 let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
755 let (route, our_payment_hash_2, payment_preimage_2, our_payment_secret_2) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000000);
757 nodes[1].node.send_payment_with_route(&route, our_payment_hash_2,
758 RecipientOnionFields::secret_only(our_payment_secret_2), PaymentId(our_payment_hash_2.0)).unwrap();
759 check_added_monitors!(nodes[1], 1);
761 let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
763 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
764 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
765 check_added_monitors!(nodes[1], 1);
766 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
768 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
769 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
770 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
771 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
772 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
773 check_added_monitors!(nodes[0], 1);
774 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
776 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
777 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
778 check_added_monitors!(nodes[0], 1);
780 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
781 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
782 check_added_monitors!(nodes[0], 0);
784 let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
785 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
786 check_added_monitors!(nodes[1], 1);
787 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
789 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
790 check_added_monitors!(nodes[1], 1);
791 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
793 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
794 check_added_monitors!(nodes[0], 1);
795 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
797 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
798 check_added_monitors!(nodes[0], 1);
799 expect_pending_htlcs_forwardable!(nodes[0]);
800 expect_payment_claimable!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
802 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
803 check_added_monitors!(nodes[1], 1);
804 expect_pending_htlcs_forwardable!(nodes[1]);
805 expect_payment_claimable!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
807 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
808 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
811 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
812 // Tests handling of a monitor update failure when processing an incoming RAA
813 let chanmon_cfgs = create_chanmon_cfgs(3);
814 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
815 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
816 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
817 create_announced_chan_between_nodes(&nodes, 0, 1);
818 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
820 // Rebalance a bit so that we can send backwards from 2 to 1.
821 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
823 // Route a first payment that we'll fail backwards
824 let (_, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
826 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
827 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
828 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
829 check_added_monitors!(nodes[2], 1);
831 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
832 assert!(updates.update_add_htlcs.is_empty());
833 assert!(updates.update_fulfill_htlcs.is_empty());
834 assert_eq!(updates.update_fail_htlcs.len(), 1);
835 assert!(updates.update_fail_malformed_htlcs.is_empty());
836 assert!(updates.update_fee.is_none());
837 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
839 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
840 check_added_monitors!(nodes[0], 0);
842 // While the second channel is AwaitingRAA, forward a second payment to get it into the
844 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
846 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
847 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
848 check_added_monitors!(nodes[0], 1);
851 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
852 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
853 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
855 expect_pending_htlcs_forwardable!(nodes[1]);
856 check_added_monitors!(nodes[1], 0);
857 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
859 // Now fail monitor updating.
860 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
861 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
862 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
863 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
864 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
865 check_added_monitors!(nodes[1], 1);
867 // Forward a third payment which will also be added to the holding cell, despite the channel
868 // being paused waiting a monitor update.
869 let (route, payment_hash_3, _, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
871 nodes[0].node.send_payment_with_route(&route, payment_hash_3,
872 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
873 check_added_monitors!(nodes[0], 1);
876 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed); // We succeed in updating the monitor for the first channel
877 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
878 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
879 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
880 check_added_monitors!(nodes[1], 0);
882 // Call forward_pending_htlcs and check that the new HTLC was simply added to the holding cell
883 // and not forwarded.
884 expect_pending_htlcs_forwardable!(nodes[1]);
885 check_added_monitors!(nodes[1], 0);
886 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
888 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
889 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
890 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
891 nodes[2].node.send_payment_with_route(&route, payment_hash_4,
892 RecipientOnionFields::secret_only(payment_secret_4), PaymentId(payment_hash_4.0)).unwrap();
893 check_added_monitors!(nodes[2], 1);
895 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
896 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
897 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
898 check_added_monitors!(nodes[1], 1);
899 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
900 (Some(payment_preimage_4), Some(payment_hash_4))
901 } else { (None, None) };
903 // Restore monitor updating, ensuring we immediately get a fail-back update and a
904 // update_add update.
905 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
906 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
907 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
908 check_added_monitors!(nodes[1], 0);
909 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 }]);
910 check_added_monitors!(nodes[1], 1);
912 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
913 if test_ignore_second_cs {
914 assert_eq!(events_3.len(), 3);
916 assert_eq!(events_3.len(), 2);
919 // Note that the ordering of the events for different nodes is non-prescriptive, though the
920 // ordering of the two events that both go to nodes[2] have to stay in the same order.
921 let nodes_0_event = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &mut events_3);
922 let messages_a = match nodes_0_event {
923 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
924 assert_eq!(node_id, nodes[0].node.get_our_node_id());
925 assert!(updates.update_fulfill_htlcs.is_empty());
926 assert_eq!(updates.update_fail_htlcs.len(), 1);
927 assert!(updates.update_fail_malformed_htlcs.is_empty());
928 assert!(updates.update_add_htlcs.is_empty());
929 assert!(updates.update_fee.is_none());
930 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
932 _ => panic!("Unexpected event type!"),
935 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events_3);
936 let send_event_b = SendEvent::from_event(nodes_2_event);
937 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
939 let raa = if test_ignore_second_cs {
940 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events_3);
941 match nodes_2_event {
942 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
943 assert_eq!(node_id, nodes[2].node.get_our_node_id());
946 _ => panic!("Unexpected event"),
950 // Now deliver the new messages...
952 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
953 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
954 expect_payment_failed!(nodes[0], payment_hash_1, true);
956 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
958 if test_ignore_second_cs {
959 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
960 check_added_monitors!(nodes[2], 1);
961 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
962 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
963 check_added_monitors!(nodes[2], 1);
964 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
965 assert!(bs_cs.update_add_htlcs.is_empty());
966 assert!(bs_cs.update_fail_htlcs.is_empty());
967 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
968 assert!(bs_cs.update_fulfill_htlcs.is_empty());
969 assert!(bs_cs.update_fee.is_none());
971 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
972 check_added_monitors!(nodes[1], 1);
973 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
975 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
976 check_added_monitors!(nodes[1], 1);
978 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
979 check_added_monitors!(nodes[2], 1);
981 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
982 // As both messages are for nodes[1], they're in order.
983 assert_eq!(bs_revoke_and_commit.len(), 2);
984 match bs_revoke_and_commit[0] {
985 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
986 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
987 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
988 check_added_monitors!(nodes[1], 1);
990 _ => panic!("Unexpected event"),
993 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
995 match bs_revoke_and_commit[1] {
996 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
997 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
998 assert!(updates.update_add_htlcs.is_empty());
999 assert!(updates.update_fail_htlcs.is_empty());
1000 assert!(updates.update_fail_malformed_htlcs.is_empty());
1001 assert!(updates.update_fulfill_htlcs.is_empty());
1002 assert!(updates.update_fee.is_none());
1003 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1004 check_added_monitors!(nodes[1], 1);
1006 _ => panic!("Unexpected event"),
1010 assert_eq!(as_cs.update_add_htlcs.len(), 1);
1011 assert!(as_cs.update_fail_htlcs.is_empty());
1012 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1013 assert!(as_cs.update_fulfill_htlcs.is_empty());
1014 assert!(as_cs.update_fee.is_none());
1015 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1018 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1019 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1020 check_added_monitors!(nodes[2], 1);
1021 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1023 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1024 check_added_monitors!(nodes[2], 1);
1025 let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1027 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1028 check_added_monitors!(nodes[1], 1);
1029 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1031 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1032 check_added_monitors!(nodes[1], 1);
1033 let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1035 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1036 check_added_monitors!(nodes[2], 1);
1037 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1039 expect_pending_htlcs_forwardable!(nodes[2]);
1041 let events_6 = nodes[2].node.get_and_clear_pending_events();
1042 assert_eq!(events_6.len(), 2);
1044 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1045 _ => panic!("Unexpected event"),
1048 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1049 _ => panic!("Unexpected event"),
1052 if test_ignore_second_cs {
1053 expect_pending_htlcs_forwardable!(nodes[1]);
1054 check_added_monitors!(nodes[1], 1);
1056 send_event = SendEvent::from_node(&nodes[1]);
1057 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1058 assert_eq!(send_event.msgs.len(), 1);
1059 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1060 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1062 expect_pending_htlcs_forwardable!(nodes[0]);
1064 let events_9 = nodes[0].node.get_and_clear_pending_events();
1065 assert_eq!(events_9.len(), 1);
1067 Event::PaymentClaimable { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1068 _ => panic!("Unexpected event"),
1070 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1073 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1077 fn test_monitor_update_fail_raa() {
1078 do_test_monitor_update_fail_raa(false);
1079 do_test_monitor_update_fail_raa(true);
1083 fn test_monitor_update_fail_reestablish() {
1084 // Simple test for message retransmission after monitor update failure on
1085 // channel_reestablish generating a monitor update (which comes from freeing holding cell
1087 let chanmon_cfgs = create_chanmon_cfgs(3);
1088 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1089 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1090 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1091 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1092 create_announced_chan_between_nodes(&nodes, 1, 2);
1094 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
1096 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1097 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1099 nodes[2].node.claim_funds(payment_preimage);
1100 check_added_monitors!(nodes[2], 1);
1101 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
1103 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1104 assert!(updates.update_add_htlcs.is_empty());
1105 assert!(updates.update_fail_htlcs.is_empty());
1106 assert!(updates.update_fail_malformed_htlcs.is_empty());
1107 assert!(updates.update_fee.is_none());
1108 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1109 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1110 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
1111 check_added_monitors!(nodes[1], 1);
1112 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1113 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1115 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1116 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1117 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1119 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1120 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1123 let as_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1124 let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1126 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1128 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1130 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1131 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1133 nodes[1].node.get_and_clear_pending_msg_events(); // Free the holding cell
1134 check_added_monitors!(nodes[1], 1);
1136 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1137 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1139 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1140 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1142 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1143 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1146 assert_eq!(get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap(), as_reestablish);
1147 assert_eq!(get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap(), bs_reestablish);
1149 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1151 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1152 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1154 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1155 check_added_monitors!(nodes[1], 0);
1157 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1158 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1160 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1161 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1162 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1163 check_added_monitors!(nodes[1], 0);
1165 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1166 assert!(updates.update_add_htlcs.is_empty());
1167 assert!(updates.update_fail_htlcs.is_empty());
1168 assert!(updates.update_fail_malformed_htlcs.is_empty());
1169 assert!(updates.update_fee.is_none());
1170 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1171 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1172 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1173 expect_payment_sent!(nodes[0], payment_preimage);
1177 fn raa_no_response_awaiting_raa_state() {
1178 // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1179 // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1180 // in question (assuming it intends to respond with a CS after monitor updating is restored).
1181 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1182 let chanmon_cfgs = create_chanmon_cfgs(2);
1183 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1184 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1185 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1186 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1188 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1189 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1190 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1192 // Queue up two payments - one will be delivered right away, one immediately goes into the
1193 // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1194 // immediately after a CS. By setting failing the monitor update failure from the CS (which
1195 // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1196 // generation during RAA while in monitor-update-failed state.
1198 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1199 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1200 check_added_monitors!(nodes[0], 1);
1201 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1202 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1203 check_added_monitors!(nodes[0], 0);
1206 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1207 assert_eq!(events.len(), 1);
1208 let payment_event = SendEvent::from_event(events.pop().unwrap());
1209 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1210 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1211 check_added_monitors!(nodes[1], 1);
1213 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1214 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1215 check_added_monitors!(nodes[0], 1);
1216 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1217 assert_eq!(events.len(), 1);
1218 let payment_event = SendEvent::from_event(events.pop().unwrap());
1220 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1221 check_added_monitors!(nodes[0], 1);
1222 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1224 // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1225 // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1226 // then restore channel monitor updates.
1227 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1228 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1229 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1230 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1231 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1232 check_added_monitors!(nodes[1], 1);
1233 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1235 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1236 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1237 check_added_monitors!(nodes[1], 1);
1239 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1240 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1241 // nodes[1] should be AwaitingRAA here!
1242 check_added_monitors!(nodes[1], 0);
1243 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1244 expect_pending_htlcs_forwardable!(nodes[1]);
1245 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1247 // We send a third payment here, which is somewhat of a redundant test, but the
1248 // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1249 // commitment transaction states) whereas here we can explicitly check for it.
1251 nodes[0].node.send_payment_with_route(&route, payment_hash_3,
1252 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1253 check_added_monitors!(nodes[0], 0);
1254 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1256 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1257 check_added_monitors!(nodes[0], 1);
1258 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1259 assert_eq!(events.len(), 1);
1260 let payment_event = SendEvent::from_event(events.pop().unwrap());
1262 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1263 check_added_monitors!(nodes[0], 1);
1264 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1266 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1267 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1268 check_added_monitors!(nodes[1], 1);
1269 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1271 // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1272 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1273 check_added_monitors!(nodes[1], 1);
1274 expect_pending_htlcs_forwardable!(nodes[1]);
1275 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1276 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1278 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1279 check_added_monitors!(nodes[0], 1);
1281 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1282 check_added_monitors!(nodes[0], 1);
1283 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1285 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1286 check_added_monitors!(nodes[1], 1);
1287 expect_pending_htlcs_forwardable!(nodes[1]);
1288 expect_payment_claimable!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1290 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1291 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1292 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1296 fn claim_while_disconnected_monitor_update_fail() {
1297 // Test for claiming a payment while disconnected and then having the resulting
1298 // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1299 // contrived case for nodes with network instability.
1300 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1301 // code introduced a regression in this test (specifically, this caught a removal of the
1302 // channel_reestablish handling ensuring the order was sensical given the messages used).
1303 let chanmon_cfgs = create_chanmon_cfgs(2);
1304 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1305 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1306 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1307 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1309 // Forward a payment for B to claim
1310 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1312 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1313 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1315 nodes[1].node.claim_funds(payment_preimage_1);
1316 check_added_monitors!(nodes[1], 1);
1317 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1319 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1320 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1322 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1323 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1326 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1327 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1329 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1330 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1332 // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1334 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1336 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1337 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1338 check_added_monitors!(nodes[1], 1);
1339 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1341 // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1342 // the monitor still failed
1343 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1345 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1346 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1347 check_added_monitors!(nodes[0], 1);
1350 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1351 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1352 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1353 check_added_monitors!(nodes[1], 1);
1354 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1355 // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1356 // until we've channel_monitor_update'd and updated for the new commitment transaction.
1358 // Now un-fail the monitor, which will result in B sending its original commitment update,
1359 // receiving the commitment update from A, and the resulting commitment dances.
1360 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1361 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1362 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1363 check_added_monitors!(nodes[1], 0);
1365 let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1366 assert_eq!(bs_msgs.len(), 2);
1369 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1370 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1371 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1372 expect_payment_sent(&nodes[0], payment_preimage_1, None, false, false);
1373 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1374 check_added_monitors!(nodes[0], 1);
1376 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1377 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1378 check_added_monitors!(nodes[1], 1);
1380 _ => panic!("Unexpected event"),
1384 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1385 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1386 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1387 check_added_monitors!(nodes[0], 1);
1389 _ => panic!("Unexpected event"),
1392 let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1394 let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1395 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1396 check_added_monitors!(nodes[0], 1);
1397 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1399 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1400 check_added_monitors!(nodes[1], 1);
1401 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1402 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1403 check_added_monitors!(nodes[1], 1);
1405 expect_pending_htlcs_forwardable!(nodes[1]);
1406 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1408 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1409 check_added_monitors!(nodes[0], 1);
1410 expect_payment_path_successful!(nodes[0]);
1412 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1416 fn monitor_failed_no_reestablish_response() {
1417 // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1418 // response to a commitment_signed.
1419 // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1420 // debug_assert!() failure in channel_reestablish handling.
1421 let chanmon_cfgs = create_chanmon_cfgs(2);
1422 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1423 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1424 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1425 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1427 let mut node_0_per_peer_lock;
1428 let mut node_0_peer_state_lock;
1429 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;
1432 let mut node_1_per_peer_lock;
1433 let mut node_1_peer_state_lock;
1434 get_channel_ref!(nodes[1], nodes[0], node_1_per_peer_lock, node_1_peer_state_lock, channel_id).context_mut().announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1437 // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1439 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1441 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1442 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1443 check_added_monitors!(nodes[0], 1);
1446 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1447 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1448 assert_eq!(events.len(), 1);
1449 let payment_event = SendEvent::from_event(events.pop().unwrap());
1450 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1451 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1452 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1453 check_added_monitors!(nodes[1], 1);
1455 // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1456 // is still failing to update monitors.
1457 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1458 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1460 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1461 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1463 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1464 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1467 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1468 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1470 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1471 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1472 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1473 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1475 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1476 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1477 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1478 check_added_monitors!(nodes[1], 0);
1479 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1481 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1482 check_added_monitors!(nodes[0], 1);
1483 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1484 check_added_monitors!(nodes[0], 1);
1486 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1487 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1488 check_added_monitors!(nodes[1], 1);
1490 expect_pending_htlcs_forwardable!(nodes[1]);
1491 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1493 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1497 fn first_message_on_recv_ordering() {
1498 // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1499 // messages, we're willing to flip the order of response messages if neccessary in resposne to
1500 // a commitment_signed which needs to send an RAA first.
1501 // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1502 // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1503 // response. To do this, we start routing two payments, with the final RAA for the first being
1504 // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1505 // have no pending response but will want to send a RAA/CS (with the updates for the second
1506 // payment applied).
1507 // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1508 let chanmon_cfgs = create_chanmon_cfgs(2);
1509 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1510 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1511 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1512 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1514 // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1515 // can deliver it and fail the monitor update.
1516 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1518 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1519 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1520 check_added_monitors!(nodes[0], 1);
1523 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1524 assert_eq!(events.len(), 1);
1525 let payment_event = SendEvent::from_event(events.pop().unwrap());
1526 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1527 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1528 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1529 check_added_monitors!(nodes[1], 1);
1530 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1532 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1533 check_added_monitors!(nodes[0], 1);
1534 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1535 check_added_monitors!(nodes[0], 1);
1537 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1539 // Route the second payment, generating an update_add_htlc/commitment_signed
1540 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1542 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1543 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1544 check_added_monitors!(nodes[0], 1);
1546 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1547 assert_eq!(events.len(), 1);
1548 let payment_event = SendEvent::from_event(events.pop().unwrap());
1549 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1551 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1553 // Deliver the final RAA for the first payment, which does not require a response. RAAs
1554 // generally require a commitment_signed, so the fact that we're expecting an opposite response
1555 // to the next message also tests resetting the delivery order.
1556 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1557 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1558 check_added_monitors!(nodes[1], 1);
1560 // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1561 // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1562 // appropriate HTLC acceptance).
1563 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1564 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1565 check_added_monitors!(nodes[1], 1);
1566 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1568 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1569 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1570 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1571 check_added_monitors!(nodes[1], 0);
1573 expect_pending_htlcs_forwardable!(nodes[1]);
1574 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1576 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1577 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1578 check_added_monitors!(nodes[0], 1);
1579 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1580 check_added_monitors!(nodes[0], 1);
1582 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1583 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1584 check_added_monitors!(nodes[1], 1);
1586 expect_pending_htlcs_forwardable!(nodes[1]);
1587 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1589 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1590 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1594 fn test_monitor_update_fail_claim() {
1595 // Basic test for monitor update failures when processing claim_funds calls.
1596 // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1597 // update to claim the payment. We then send two payments C->B->A, which are held at B.
1598 // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1599 // the payments from C onwards to A.
1600 let chanmon_cfgs = create_chanmon_cfgs(3);
1601 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1602 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1603 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1604 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1605 create_announced_chan_between_nodes(&nodes, 1, 2);
1607 // Rebalance a bit so that we can send backwards from 3 to 2.
1608 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1610 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1612 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1613 nodes[1].node.claim_funds(payment_preimage_1);
1614 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1615 check_added_monitors!(nodes[1], 1);
1617 // Note that at this point there is a pending commitment transaction update for A being held by
1618 // B. Even when we go to send the payment from C through B to A, B will not update this
1619 // already-signed commitment transaction and will instead wait for it to resolve before
1620 // forwarding the payment onwards.
1622 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1_000_000);
1624 nodes[2].node.send_payment_with_route(&route, payment_hash_2,
1625 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1626 check_added_monitors!(nodes[2], 1);
1629 // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1630 // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1631 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1633 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1634 assert_eq!(events.len(), 1);
1635 let payment_event = SendEvent::from_event(events.pop().unwrap());
1636 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1637 let events = nodes[1].node.get_and_clear_pending_msg_events();
1638 assert_eq!(events.len(), 0);
1639 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1640 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1642 let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1643 nodes[2].node.send_payment_with_route(&route, payment_hash_3,
1644 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1645 check_added_monitors!(nodes[2], 1);
1647 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1648 assert_eq!(events.len(), 1);
1649 let payment_event = SendEvent::from_event(events.pop().unwrap());
1650 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1651 let events = nodes[1].node.get_and_clear_pending_msg_events();
1652 assert_eq!(events.len(), 0);
1653 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1655 // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1656 let channel_id = chan_1.2;
1657 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1658 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1659 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1660 check_added_monitors!(nodes[1], 0);
1662 let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1663 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1664 commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1665 expect_payment_sent!(nodes[0], payment_preimage_1);
1667 // Get the payment forwards, note that they were batched into one commitment update.
1668 nodes[1].node.process_pending_htlc_forwards();
1669 check_added_monitors!(nodes[1], 1);
1670 let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1671 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1672 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1673 commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1674 expect_pending_htlcs_forwardable!(nodes[0]);
1676 let events = nodes[0].node.get_and_clear_pending_events();
1677 assert_eq!(events.len(), 2);
1679 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id, .. } => {
1680 assert_eq!(payment_hash_2, *payment_hash);
1681 assert_eq!(1_000_000, amount_msat);
1682 assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1683 assert_eq!(via_channel_id, Some(channel_id));
1684 assert_eq!(via_user_channel_id, Some(42));
1686 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1687 assert!(payment_preimage.is_none());
1688 assert_eq!(payment_secret_2, *payment_secret);
1690 _ => panic!("expected PaymentPurpose::InvoicePayment")
1693 _ => panic!("Unexpected event"),
1696 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
1697 assert_eq!(payment_hash_3, *payment_hash);
1698 assert_eq!(1_000_000, amount_msat);
1699 assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1700 assert_eq!(via_channel_id, Some(channel_id));
1702 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1703 assert!(payment_preimage.is_none());
1704 assert_eq!(payment_secret_3, *payment_secret);
1706 _ => panic!("expected PaymentPurpose::InvoicePayment")
1709 _ => panic!("Unexpected event"),
1714 fn test_monitor_update_on_pending_forwards() {
1715 // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1716 // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1717 // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1718 // from C to A will be pending a forward to A.
1719 let chanmon_cfgs = create_chanmon_cfgs(3);
1720 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1721 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1722 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1723 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1724 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1726 // Rebalance a bit so that we can send backwards from 3 to 1.
1727 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1729 let (_, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1730 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
1731 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
1732 check_added_monitors!(nodes[2], 1);
1734 let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1735 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1736 commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1737 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1739 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
1741 nodes[2].node.send_payment_with_route(&route, payment_hash_2,
1742 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1743 check_added_monitors!(nodes[2], 1);
1746 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1747 assert_eq!(events.len(), 1);
1748 let payment_event = SendEvent::from_event(events.pop().unwrap());
1749 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1750 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1752 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1753 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 }]);
1754 check_added_monitors!(nodes[1], 1);
1756 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1757 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1758 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1759 check_added_monitors!(nodes[1], 0);
1761 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1762 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1763 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1764 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1766 let events = nodes[0].node.get_and_clear_pending_events();
1767 assert_eq!(events.len(), 3);
1768 if let Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } = events[1] {
1769 assert_eq!(payment_hash, payment_hash_1);
1770 assert!(payment_failed_permanently);
1771 } else { panic!("Unexpected event!"); }
1773 Event::PaymentFailed { payment_hash, .. } => {
1774 assert_eq!(payment_hash, payment_hash_1);
1776 _ => panic!("Unexpected event"),
1779 Event::PendingHTLCsForwardable { .. } => { },
1780 _ => panic!("Unexpected event"),
1782 nodes[0].node.process_pending_htlc_forwards();
1783 expect_payment_claimable!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1785 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1789 fn monitor_update_claim_fail_no_response() {
1790 // Test for claim_funds resulting in both a monitor update failure and no message response (due
1791 // to channel being AwaitingRAA).
1792 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1794 let chanmon_cfgs = create_chanmon_cfgs(2);
1795 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1796 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1797 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1798 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1800 // Forward a payment for B to claim
1801 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1803 // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1804 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1806 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1807 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1808 check_added_monitors!(nodes[0], 1);
1811 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1812 assert_eq!(events.len(), 1);
1813 let payment_event = SendEvent::from_event(events.pop().unwrap());
1814 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1815 let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1817 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1818 nodes[1].node.claim_funds(payment_preimage_1);
1819 check_added_monitors!(nodes[1], 1);
1821 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1823 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1824 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1825 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1826 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1827 check_added_monitors!(nodes[1], 0);
1828 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1830 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1831 check_added_monitors!(nodes[1], 1);
1832 expect_pending_htlcs_forwardable!(nodes[1]);
1833 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1835 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1836 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1837 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1838 expect_payment_sent!(nodes[0], payment_preimage_1);
1840 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1843 // restore_b_before_conf has no meaning if !confirm_a_first
1844 // restore_b_before_lock has no meaning if confirm_a_first
1845 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool, restore_b_before_lock: bool) {
1846 // Test that if the monitor update generated by funding_transaction_generated fails we continue
1847 // the channel setup happily after the update is restored.
1848 let chanmon_cfgs = create_chanmon_cfgs(2);
1849 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1850 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1851 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1853 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1854 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()));
1855 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()));
1857 let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
1859 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
1860 check_added_monitors!(nodes[0], 0);
1862 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1863 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1864 let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1865 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1866 check_added_monitors!(nodes[1], 1);
1868 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1869 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()));
1870 check_added_monitors!(nodes[0], 1);
1871 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1872 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1873 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1874 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1875 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1876 check_added_monitors!(nodes[0], 0);
1877 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
1879 let events = nodes[0].node.get_and_clear_pending_events();
1880 assert_eq!(events.len(), 0);
1881 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1882 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1884 if confirm_a_first {
1885 confirm_transaction(&nodes[0], &funding_tx);
1886 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()));
1887 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1888 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1890 assert!(!restore_b_before_conf);
1891 confirm_transaction(&nodes[1], &funding_tx);
1892 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1895 // Make sure nodes[1] isn't stupid enough to re-send the ChannelReady on reconnect
1896 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1897 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1898 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
1899 reconnect_args.send_channel_ready.1 = confirm_a_first;
1900 reconnect_nodes(reconnect_args);
1902 // But we want to re-emit ChannelPending
1903 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
1904 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1905 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1907 if !restore_b_before_conf {
1908 confirm_transaction(&nodes[1], &funding_tx);
1909 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1910 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1912 if !confirm_a_first && !restore_b_before_lock {
1913 confirm_transaction(&nodes[0], &funding_tx);
1914 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()));
1915 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1916 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1919 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1920 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1921 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1922 check_added_monitors!(nodes[1], 0);
1924 let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1925 if !restore_b_before_lock {
1926 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1927 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1929 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()));
1930 confirm_transaction(&nodes[0], &funding_tx);
1931 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1932 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready))
1935 if restore_b_before_conf {
1936 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1937 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1938 confirm_transaction(&nodes[1], &funding_tx);
1940 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1941 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1943 for node in nodes.iter() {
1944 assert!(node.gossip_sync.handle_channel_announcement(&announcement).unwrap());
1945 node.gossip_sync.handle_channel_update(&as_update).unwrap();
1946 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
1949 if !restore_b_before_lock {
1950 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
1952 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
1956 send_payment(&nodes[0], &[&nodes[1]], 8000000);
1957 close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1958 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1959 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1963 fn during_funding_monitor_fail() {
1964 do_during_funding_monitor_fail(true, true, false);
1965 do_during_funding_monitor_fail(true, false, false);
1966 do_during_funding_monitor_fail(false, false, false);
1967 do_during_funding_monitor_fail(false, false, true);
1971 fn test_path_paused_mpp() {
1972 // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1974 let chanmon_cfgs = create_chanmon_cfgs(4);
1975 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1976 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1977 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1979 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
1980 let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2);
1981 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
1982 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
1984 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
1986 // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1987 let path = route.paths[0].clone();
1988 route.paths.push(path);
1989 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
1990 route.paths[0].hops[0].short_channel_id = chan_1_id;
1991 route.paths[0].hops[1].short_channel_id = chan_3_id;
1992 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
1993 route.paths[1].hops[0].short_channel_id = chan_2_ann.contents.short_channel_id;
1994 route.paths[1].hops[1].short_channel_id = chan_4_id;
1996 // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
1997 // (for the path 0 -> 2 -> 3) fails.
1998 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1999 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2001 // Now check that we get the right return value, indicating that the first path succeeded but
2002 // the second got a MonitorUpdateInProgress err. This implies
2003 // PaymentSendFailure::PartialFailure as some paths succeeded, preventing retry.
2004 if let Err(PaymentSendFailure::PartialFailure { results, ..}) = nodes[0].node.send_payment_with_route(
2005 &route, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
2007 assert_eq!(results.len(), 2);
2008 if let Ok(()) = results[0] {} else { panic!(); }
2009 if let Err(APIError::MonitorUpdateInProgress) = results[1] {} else { panic!(); }
2010 } else { panic!(); }
2011 check_added_monitors!(nodes[0], 2);
2012 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2014 // Pass the first HTLC of the payment along to nodes[3].
2015 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2016 assert_eq!(events.len(), 1);
2017 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false, None);
2019 // And check that, after we successfully update the monitor for chan_2 we can pass the second
2020 // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
2021 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
2022 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2023 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2024 assert_eq!(events.len(), 1);
2025 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true, None);
2027 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
2031 fn test_pending_update_fee_ack_on_reconnect() {
2032 // In early versions of our automated fee update patch, nodes did not correctly use the
2033 // previous channel feerate after sending an undelivered revoke_and_ack when re-sending an
2034 // undelivered commitment_signed.
2036 // B sends A new HTLC + CS, not delivered
2037 // A sends B update_fee + CS
2038 // B receives the CS and sends RAA, previously causing B to lock in the new feerate
2040 // B resends initial CS, using the original fee
2042 let chanmon_cfgs = create_chanmon_cfgs(2);
2043 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2044 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2045 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2047 create_announced_chan_between_nodes(&nodes, 0, 1);
2048 send_payment(&nodes[0], &[&nodes[1]], 100_000_00);
2050 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[1], nodes[0], 1_000_000);
2051 nodes[1].node.send_payment_with_route(&route, payment_hash,
2052 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
2053 check_added_monitors!(nodes[1], 1);
2054 let bs_initial_send_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2055 // bs_initial_send_msgs are not delivered until they are re-generated after reconnect
2058 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2061 nodes[0].node.timer_tick_occurred();
2062 check_added_monitors!(nodes[0], 1);
2063 let as_update_fee_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2064 assert!(as_update_fee_msgs.update_fee.is_some());
2066 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_update_fee_msgs.update_fee.as_ref().unwrap());
2067 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_fee_msgs.commitment_signed);
2068 check_added_monitors!(nodes[1], 1);
2069 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2070 // bs_first_raa is not delivered until it is re-generated after reconnect
2072 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2073 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2075 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
2076 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
2078 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2079 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
2080 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
2082 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2084 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2085 let bs_resend_msgs = nodes[1].node.get_and_clear_pending_msg_events();
2086 assert_eq!(bs_resend_msgs.len(), 3);
2087 if let MessageSendEvent::UpdateHTLCs { ref updates, .. } = bs_resend_msgs[0] {
2088 assert_eq!(*updates, bs_initial_send_msgs);
2089 } else { panic!(); }
2090 if let MessageSendEvent::SendRevokeAndACK { ref msg, .. } = bs_resend_msgs[1] {
2091 assert_eq!(*msg, bs_first_raa);
2092 } else { panic!(); }
2093 if let MessageSendEvent::SendChannelUpdate { .. } = bs_resend_msgs[2] { } else { panic!(); }
2095 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2096 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
2098 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.update_add_htlcs[0]);
2099 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.commitment_signed);
2100 check_added_monitors!(nodes[0], 1);
2101 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()));
2102 check_added_monitors!(nodes[1], 1);
2103 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()).commitment_signed;
2105 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2106 check_added_monitors!(nodes[0], 1);
2107 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);
2108 check_added_monitors!(nodes[1], 1);
2109 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2111 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2112 check_added_monitors!(nodes[0], 1);
2113 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2114 check_added_monitors!(nodes[0], 1);
2116 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()));
2117 check_added_monitors!(nodes[1], 1);
2119 expect_pending_htlcs_forwardable!(nodes[0]);
2120 expect_payment_claimable!(nodes[0], payment_hash, payment_secret, 1_000_000);
2122 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
2126 fn test_fail_htlc_on_broadcast_after_claim() {
2127 // In an earlier version of 7e78fa660cec8a73286c94c1073ee588140e7a01 we'd also fail the inbound
2128 // channel backwards if we received an HTLC failure after a HTLC fulfillment. Here we test a
2129 // specific case of that by having the HTLC failure come from the ChannelMonitor after a dust
2130 // HTLC was not included in a confirmed commitment transaction.
2132 // We first forward a payment, then claim it with an update_fulfill_htlc message, closing the
2133 // channel immediately before commitment occurs. After the commitment transaction reaches
2134 // ANTI_REORG_DELAY confirmations, will will try to fail the HTLC which was already fulfilled.
2135 let chanmon_cfgs = create_chanmon_cfgs(3);
2136 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2137 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2138 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2140 create_announced_chan_between_nodes(&nodes, 0, 1);
2141 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2143 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 2000);
2145 let bs_txn = get_local_commitment_txn!(nodes[2], chan_id_2);
2146 assert_eq!(bs_txn.len(), 1);
2148 nodes[2].node.claim_funds(payment_preimage);
2149 check_added_monitors!(nodes[2], 1);
2150 expect_payment_claimed!(nodes[2], payment_hash, 2000);
2152 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2153 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
2154 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2155 check_added_monitors!(nodes[1], 1);
2156 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2158 mine_transaction(&nodes[1], &bs_txn[0]);
2159 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[2].node.get_our_node_id()], 100000);
2160 check_closed_broadcast!(nodes[1], true);
2161 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2162 check_added_monitors!(nodes[1], 1);
2163 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 }]);
2165 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
2166 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2167 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, true, true);
2168 expect_payment_path_successful!(nodes[0]);
2171 fn do_update_fee_resend_test(deliver_update: bool, parallel_updates: bool) {
2172 // In early versions we did not handle resending of update_fee on reconnect correctly. The
2173 // chanmon_consistency fuzz target, of course, immediately found it, but we test a few cases
2175 let chanmon_cfgs = create_chanmon_cfgs(2);
2176 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2177 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2178 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2180 create_announced_chan_between_nodes(&nodes, 0, 1);
2181 send_payment(&nodes[0], &[&nodes[1]], 1000);
2184 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2185 *feerate_lock += 20;
2187 nodes[0].node.timer_tick_occurred();
2188 check_added_monitors!(nodes[0], 1);
2189 let update_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2190 assert!(update_msgs.update_fee.is_some());
2192 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2195 if parallel_updates {
2197 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2198 *feerate_lock += 20;
2200 nodes[0].node.timer_tick_occurred();
2201 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2204 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2205 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2207 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
2208 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
2210 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2211 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
2212 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
2214 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2216 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2217 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
2218 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2220 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2221 let mut as_reconnect_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2222 assert_eq!(as_reconnect_msgs.len(), 2);
2223 if let MessageSendEvent::SendChannelUpdate { .. } = as_reconnect_msgs.pop().unwrap() {} else { panic!(); }
2224 let update_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = as_reconnect_msgs.pop().unwrap()
2225 { updates } else { panic!(); };
2226 assert!(update_msgs.update_fee.is_some());
2227 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2228 if parallel_updates {
2229 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update_msgs.commitment_signed);
2230 check_added_monitors!(nodes[1], 1);
2231 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2232 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2233 check_added_monitors!(nodes[0], 1);
2234 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2236 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2237 check_added_monitors!(nodes[0], 1);
2238 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2240 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_second_update.update_fee.as_ref().unwrap());
2241 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
2242 check_added_monitors!(nodes[1], 1);
2243 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2245 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2246 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2247 check_added_monitors!(nodes[1], 1);
2249 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2250 check_added_monitors!(nodes[0], 1);
2252 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs.commitment_signed);
2253 check_added_monitors!(nodes[0], 1);
2254 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2256 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2257 check_added_monitors!(nodes[1], 1);
2259 commitment_signed_dance!(nodes[1], nodes[0], update_msgs.commitment_signed, false);
2262 send_payment(&nodes[0], &[&nodes[1]], 1000);
2265 fn update_fee_resend_test() {
2266 do_update_fee_resend_test(false, false);
2267 do_update_fee_resend_test(true, false);
2268 do_update_fee_resend_test(false, true);
2269 do_update_fee_resend_test(true, true);
2272 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2273 // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2274 // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2275 // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2276 // which failed in such a case).
2277 let chanmon_cfgs = create_chanmon_cfgs(2);
2278 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2280 let new_chain_monitor;
2281 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2282 let nodes_0_deserialized;
2283 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2285 let chan_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 15_000_000, 7_000_000_000).2;
2286 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
2287 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2289 // Do a really complicated dance to get an HTLC into the holding cell, with
2290 // MonitorUpdateInProgress set but AwaitingRemoteRevoke unset. When this test was written, any
2291 // attempts to send an HTLC while MonitorUpdateInProgress is set are immediately
2292 // failed-backwards. Thus, the only way to get an AddHTLC into the holding cell is to add it
2293 // while AwaitingRemoteRevoke is set but MonitorUpdateInProgress is unset, and then swap the
2297 // a) routing a payment from node B to node A,
2298 // b) sending a payment from node A to node B without delivering any of the generated messages,
2299 // putting node A in AwaitingRemoteRevoke,
2300 // c) sending a second payment from node A to node B, which is immediately placed in the
2302 // d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2303 // when we try to persist the payment preimage,
2304 // e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2305 // clearing AwaitingRemoteRevoke on node A.
2307 // Note that because, at the end, MonitorUpdateInProgress is still set, the HTLC generated in
2308 // (c) will not be freed from the holding cell.
2309 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[1], &[&nodes[0]], 100_000);
2311 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
2312 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
2313 check_added_monitors!(nodes[0], 1);
2314 let send = SendEvent::from_node(&nodes[0]);
2315 assert_eq!(send.msgs.len(), 1);
2317 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
2318 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
2319 check_added_monitors!(nodes[0], 0);
2321 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
2322 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2323 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2324 nodes[0].node.claim_funds(payment_preimage_0);
2325 check_added_monitors!(nodes[0], 1);
2327 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2328 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2329 check_added_monitors!(nodes[1], 1);
2331 let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2333 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2334 check_added_monitors!(nodes[0], 1);
2337 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2338 // disconnect the peers. Note that the fuzzer originally found this issue because
2339 // deserializing a ChannelManager in this state causes an assertion failure.
2341 reload_node!(nodes[0], &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
2342 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2343 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2345 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2347 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2349 // Now reconnect the two
2350 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
2351 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
2353 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2354 assert_eq!(reestablish_1.len(), 1);
2355 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
2356 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
2358 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2359 assert_eq!(reestablish_2.len(), 1);
2361 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2362 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2363 check_added_monitors!(nodes[1], 0);
2365 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2366 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2368 assert!(resp_0.0.is_none());
2369 assert!(resp_0.1.is_none());
2370 assert!(resp_0.2.is_none());
2371 assert!(resp_1.0.is_none());
2372 assert!(resp_1.1.is_none());
2374 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2376 if let Some(pending_cs) = resp_1.2 {
2377 assert!(pending_cs.update_add_htlcs.is_empty());
2378 assert!(pending_cs.update_fail_htlcs.is_empty());
2379 assert!(pending_cs.update_fulfill_htlcs.is_empty());
2380 assert_eq!(pending_cs.commitment_signed, cs);
2381 } else { panic!(); }
2384 // The two pending monitor updates were replayed (but are still pending).
2385 check_added_monitors(&nodes[0], 2);
2387 // There should be no monitor updates as we are still pending awaiting a failed one.
2388 check_added_monitors(&nodes[0], 0);
2390 check_added_monitors(&nodes[1], 0);
2393 // If we finish updating the monitor, we should free the holding cell right away (this did
2394 // not occur prior to #756).
2395 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2396 let (funding_txo, mon_id, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2397 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_txo, mon_id);
2398 expect_payment_claimed!(nodes[0], payment_hash_0, 100_000);
2400 // New outbound messages should be generated immediately upon a call to
2401 // get_and_clear_pending_msg_events (but not before).
2402 check_added_monitors!(nodes[0], 0);
2403 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2404 check_added_monitors!(nodes[0], 1);
2405 assert_eq!(events.len(), 1);
2407 // Deliver the pending in-flight CS
2408 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2409 check_added_monitors!(nodes[0], 1);
2411 let commitment_msg = match events.pop().unwrap() {
2412 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2413 assert_eq!(node_id, nodes[1].node.get_our_node_id());
2414 assert!(updates.update_fail_htlcs.is_empty());
2415 assert!(updates.update_fail_malformed_htlcs.is_empty());
2416 assert!(updates.update_fee.is_none());
2417 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2418 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2419 expect_payment_sent(&nodes[1], payment_preimage_0, None, false, false);
2420 assert_eq!(updates.update_add_htlcs.len(), 1);
2421 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2422 updates.commitment_signed
2424 _ => panic!("Unexpected event type!"),
2427 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2428 check_added_monitors!(nodes[1], 1);
2430 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2431 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2432 expect_pending_htlcs_forwardable!(nodes[1]);
2433 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2434 check_added_monitors!(nodes[1], 1);
2436 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false, false);
2438 let events = nodes[1].node.get_and_clear_pending_events();
2439 assert_eq!(events.len(), 2);
2441 Event::PendingHTLCsForwardable { .. } => { },
2442 _ => panic!("Unexpected event"),
2445 Event::PaymentPathSuccessful { .. } => { },
2446 _ => panic!("Unexpected event"),
2449 nodes[1].node.process_pending_htlc_forwards();
2450 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2452 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2453 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2456 fn channel_holding_cell_serialize() {
2457 do_channel_holding_cell_serialize(true, true);
2458 do_channel_holding_cell_serialize(true, false);
2459 do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2462 #[derive(PartialEq)]
2463 enum HTLCStatusAtDupClaim {
2468 fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_fails: bool) {
2469 // When receiving an update_fulfill_htlc message, we immediately forward the claim backwards
2470 // along the payment path before waiting for a full commitment_signed dance. This is great, but
2471 // can cause duplicative claims if a node sends an update_fulfill_htlc message, disconnects,
2472 // reconnects, and then has to re-send its update_fulfill_htlc message again.
2473 // In previous code, we didn't handle the double-claim correctly, spuriously closing the
2474 // channel on which the inbound HTLC was received.
2475 let chanmon_cfgs = create_chanmon_cfgs(3);
2476 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2477 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2478 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2480 create_announced_chan_between_nodes(&nodes, 0, 1);
2481 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2483 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
2485 let mut as_raa = None;
2486 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2487 // In order to get the HTLC claim into the holding cell at nodes[1], we need nodes[1] to be
2488 // awaiting a remote revoke_and_ack from nodes[0].
2489 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
2490 nodes[0].node.send_payment_with_route(&route, second_payment_hash,
2491 RecipientOnionFields::secret_only(second_payment_secret), PaymentId(second_payment_hash.0)).unwrap();
2492 check_added_monitors!(nodes[0], 1);
2494 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
2495 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
2496 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
2497 check_added_monitors!(nodes[1], 1);
2499 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2500 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2501 check_added_monitors!(nodes[0], 1);
2502 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
2503 check_added_monitors!(nodes[0], 1);
2505 as_raa = Some(get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2508 let fulfill_msg = msgs::UpdateFulfillHTLC {
2509 channel_id: chan_id_2,
2514 nodes[2].node.fail_htlc_backwards(&payment_hash);
2515 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash }]);
2516 check_added_monitors!(nodes[2], 1);
2517 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2519 nodes[2].node.claim_funds(payment_preimage);
2520 check_added_monitors!(nodes[2], 1);
2521 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
2523 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2524 assert_eq!(cs_updates.update_fulfill_htlcs.len(), 1);
2525 // Check that the message we're about to deliver matches the one generated:
2526 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
2528 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
2529 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2530 check_added_monitors!(nodes[1], 1);
2532 let mut bs_updates = None;
2533 if htlc_status != HTLCStatusAtDupClaim::HoldingCell {
2534 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2535 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2536 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2537 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2538 if htlc_status == HTLCStatusAtDupClaim::Cleared {
2539 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2540 expect_payment_path_successful!(nodes[0]);
2543 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2546 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
2547 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2550 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
2551 reconnect_args.pending_htlc_fails.0 = 1;
2552 reconnect_nodes(reconnect_args);
2553 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 }]);
2555 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
2556 reconnect_args.pending_htlc_claims.0 = 1;
2557 reconnect_nodes(reconnect_args);
2560 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2561 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa.unwrap());
2562 check_added_monitors!(nodes[1], 1);
2563 expect_pending_htlcs_forwardable_ignore!(nodes[1]); // We finally receive the second payment, but don't claim it
2565 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2566 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2567 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2568 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2570 if htlc_status != HTLCStatusAtDupClaim::Cleared {
2571 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2572 expect_payment_path_successful!(nodes[0]);
2577 fn test_reconnect_dup_htlc_claims() {
2578 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, false);
2579 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, false);
2580 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, false);
2581 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, true);
2582 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, true);
2583 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, true);
2587 fn test_temporary_error_during_shutdown() {
2588 // Test that temporary failures when updating the monitor's shutdown script delay cooperative
2590 let mut config = test_default_channel_config();
2591 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2593 let chanmon_cfgs = create_chanmon_cfgs(2);
2594 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2595 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
2596 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2598 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
2600 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2601 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2603 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
2604 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()));
2605 check_added_monitors!(nodes[1], 1);
2607 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()));
2608 check_added_monitors!(nodes[0], 1);
2610 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2612 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2613 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2615 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2616 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2617 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()));
2619 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2621 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2622 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2623 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2625 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()));
2626 let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
2627 let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2629 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_a.unwrap());
2630 let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
2631 assert!(none_b.is_none());
2632 let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2634 assert_eq!(txn_a, txn_b);
2635 assert_eq!(txn_a.len(), 1);
2636 check_spends!(txn_a[0], funding_tx);
2637 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
2638 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
2642 fn double_temp_error() {
2643 // Test that it's OK to have multiple `ChainMonitor::update_channel` calls fail in a row.
2644 let chanmon_cfgs = create_chanmon_cfgs(2);
2645 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2646 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2647 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2649 let (_, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1);
2651 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2652 let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2654 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2655 // `claim_funds` results in a ChannelMonitorUpdate.
2656 nodes[1].node.claim_funds(payment_preimage_1);
2657 check_added_monitors!(nodes[1], 1);
2658 let (funding_tx, latest_update_1, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2660 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2661 // Previously, this would've panicked due to a double-call to `Channel::monitor_update_failed`,
2662 // which had some asserts that prevented it from being called twice.
2663 nodes[1].node.claim_funds(payment_preimage_2);
2664 check_added_monitors!(nodes[1], 1);
2665 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2667 let (_, latest_update_2, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2668 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_1);
2669 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2670 check_added_monitors!(nodes[1], 0);
2671 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_2);
2673 // Complete the first HTLC. Note that as a side-effect we handle the monitor update completions
2674 // and get both PaymentClaimed events at once.
2675 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
2677 let events = nodes[1].node.get_and_clear_pending_events();
2678 assert_eq!(events.len(), 2);
2680 Event::PaymentClaimed { amount_msat: 1_000_000, payment_hash, .. } => assert_eq!(payment_hash, payment_hash_1),
2681 _ => panic!("Unexpected Event: {:?}", events[0]),
2684 Event::PaymentClaimed { amount_msat: 1_000_000, payment_hash, .. } => assert_eq!(payment_hash, payment_hash_2),
2685 _ => panic!("Unexpected Event: {:?}", events[1]),
2688 assert_eq!(msg_events.len(), 1);
2689 let (update_fulfill_1, commitment_signed_b1, node_id) = {
2690 match &msg_events[0] {
2691 &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 } } => {
2692 assert!(update_add_htlcs.is_empty());
2693 assert_eq!(update_fulfill_htlcs.len(), 1);
2694 assert!(update_fail_htlcs.is_empty());
2695 assert!(update_fail_malformed_htlcs.is_empty());
2696 assert!(update_fee.is_none());
2697 (update_fulfill_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2699 _ => panic!("Unexpected event"),
2702 assert_eq!(node_id, nodes[0].node.get_our_node_id());
2703 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_1);
2704 check_added_monitors!(nodes[0], 0);
2705 expect_payment_sent(&nodes[0], payment_preimage_1, None, false, false);
2706 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_b1);
2707 check_added_monitors!(nodes[0], 1);
2708 nodes[0].node.process_pending_htlc_forwards();
2709 let (raa_a1, commitment_signed_a1) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2710 check_added_monitors!(nodes[1], 0);
2711 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2712 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_a1);
2713 check_added_monitors!(nodes[1], 1);
2714 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed_a1);
2715 check_added_monitors!(nodes[1], 1);
2717 // Complete the second HTLC.
2718 let ((update_fulfill_2, commitment_signed_b2), raa_b2) = {
2719 let events = nodes[1].node.get_and_clear_pending_msg_events();
2720 assert_eq!(events.len(), 2);
2722 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2723 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2724 assert!(updates.update_add_htlcs.is_empty());
2725 assert!(updates.update_fail_htlcs.is_empty());
2726 assert!(updates.update_fail_malformed_htlcs.is_empty());
2727 assert!(updates.update_fee.is_none());
2728 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2729 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2731 _ => panic!("Unexpected event"),
2734 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2735 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2738 _ => panic!("Unexpected event"),
2741 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_b2);
2742 check_added_monitors!(nodes[0], 1);
2743 expect_payment_path_successful!(nodes[0]);
2745 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_2);
2746 check_added_monitors!(nodes[0], 0);
2747 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2748 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed_b2, false);
2749 expect_payment_sent!(nodes[0], payment_preimage_2);
2752 fn do_test_outbound_reload_without_init_mon(use_0conf: bool) {
2753 // Test that if the monitor update generated in funding_signed is stored async and we restart
2754 // with the latest ChannelManager but the ChannelMonitor persistence never completed we happily
2755 // drop the channel and move on.
2756 let chanmon_cfgs = create_chanmon_cfgs(2);
2757 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2760 let new_chain_monitor;
2762 let mut chan_config = test_default_channel_config();
2763 chan_config.manually_accept_inbound_channels = true;
2764 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2766 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2767 let nodes_0_deserialized;
2769 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2771 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2772 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()));
2774 let events = nodes[1].node.get_and_clear_pending_events();
2775 assert_eq!(events.len(), 1);
2777 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2779 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2781 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2784 _ => panic!("Unexpected event"),
2787 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()));
2789 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2791 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2792 check_added_monitors!(nodes[0], 0);
2794 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2795 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2796 check_added_monitors!(nodes[1], 1);
2797 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
2799 let bs_signed_locked = nodes[1].node.get_and_clear_pending_msg_events();
2800 assert_eq!(bs_signed_locked.len(), if use_0conf { 2 } else { 1 });
2801 match &bs_signed_locked[0] {
2802 MessageSendEvent::SendFundingSigned { msg, .. } => {
2803 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2805 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &msg);
2806 check_added_monitors!(nodes[0], 1);
2808 _ => panic!("Unexpected event"),
2811 match &bs_signed_locked[1] {
2812 MessageSendEvent::SendChannelReady { msg, .. } => {
2813 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &msg);
2815 _ => panic!("Unexpected event"),
2819 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
2820 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2821 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2823 // nodes[0] is now waiting on the first ChannelMonitor persistence to complete in order to
2824 // broadcast the funding transaction. If nodes[0] restarts at this point with the
2825 // ChannelMonitor lost, we should simply discard the channel.
2827 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2828 // not, so we have to clear them here.
2829 nodes[0].chain_source.watched_txn.lock().unwrap().clear();
2830 nodes[0].chain_source.watched_outputs.lock().unwrap().clear();
2832 reload_node!(nodes[0], &nodes[0].node.encode(), &[], persister, new_chain_monitor, nodes_0_deserialized);
2833 check_closed_event!(nodes[0], 1, ClosureReason::DisconnectedPeer, [nodes[1].node.get_our_node_id()], 100000);
2834 assert!(nodes[0].node.list_channels().is_empty());
2838 fn test_outbound_reload_without_init_mon() {
2839 do_test_outbound_reload_without_init_mon(true);
2840 do_test_outbound_reload_without_init_mon(false);
2843 fn do_test_inbound_reload_without_init_mon(use_0conf: bool, lock_commitment: bool) {
2844 // Test that if the monitor update generated by funding_transaction_generated is stored async
2845 // and we restart with the latest ChannelManager but the ChannelMonitor persistence never
2846 // completed we happily drop the channel and move on.
2847 let chanmon_cfgs = create_chanmon_cfgs(2);
2848 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2851 let new_chain_monitor;
2853 let mut chan_config = test_default_channel_config();
2854 chan_config.manually_accept_inbound_channels = true;
2855 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2857 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2858 let nodes_1_deserialized;
2860 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2862 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2863 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()));
2865 let events = nodes[1].node.get_and_clear_pending_events();
2866 assert_eq!(events.len(), 1);
2868 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2870 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2872 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2875 _ => panic!("Unexpected event"),
2878 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()));
2880 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2882 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2883 check_added_monitors!(nodes[0], 0);
2885 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2886 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2887 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2888 check_added_monitors!(nodes[1], 1);
2890 // nodes[1] happily sends its funding_signed even though its awaiting the persistence of the
2891 // initial ChannelMonitor, but it will decline to send its channel_ready even if the funding
2892 // transaction is confirmed.
2893 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
2895 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
2896 check_added_monitors!(nodes[0], 1);
2897 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
2899 let as_funding_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2900 if lock_commitment {
2901 confirm_transaction(&nodes[0], &as_funding_tx[0]);
2902 confirm_transaction(&nodes[1], &as_funding_tx[0]);
2904 if use_0conf || lock_commitment {
2905 let as_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
2906 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_ready);
2908 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2910 // nodes[1] is now waiting on the first ChannelMonitor persistence to complete in order to
2911 // move the channel to ready (or is waiting on the funding transaction to confirm). If nodes[1]
2912 // restarts at this point with the ChannelMonitor lost, we should simply discard the channel.
2914 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2915 // not, so we have to clear them here.
2916 nodes[1].chain_source.watched_txn.lock().unwrap().clear();
2917 nodes[1].chain_source.watched_outputs.lock().unwrap().clear();
2919 reload_node!(nodes[1], &nodes[1].node.encode(), &[], persister, new_chain_monitor, nodes_1_deserialized);
2921 check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer, [nodes[0].node.get_our_node_id()], 100000);
2922 assert!(nodes[1].node.list_channels().is_empty());
2926 fn test_inbound_reload_without_init_mon() {
2927 do_test_inbound_reload_without_init_mon(true, true);
2928 do_test_inbound_reload_without_init_mon(true, false);
2929 do_test_inbound_reload_without_init_mon(false, true);
2930 do_test_inbound_reload_without_init_mon(false, false);
2934 fn test_blocked_chan_preimage_release() {
2935 // Test that even if a channel's `ChannelMonitorUpdate` flow is blocked waiting on an event to
2936 // be handled HTLC preimage `ChannelMonitorUpdate`s will still go out.
2937 let chanmon_cfgs = create_chanmon_cfgs(3);
2938 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2939 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2940 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2942 create_announced_chan_between_nodes(&nodes, 0, 1);
2943 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2945 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5_000_000);
2947 // Tee up two payments in opposite directions across nodes[1], one it sent to generate a
2948 // PaymentSent event and one it forwards.
2949 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[1], &[&nodes[2]], 1_000_000);
2950 let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[2], &[&nodes[1], &nodes[0]], 1_000_000);
2952 // Claim the first payment to get a `PaymentSent` event (but don't handle it yet).
2953 nodes[2].node.claim_funds(payment_preimage_1);
2954 check_added_monitors(&nodes[2], 1);
2955 expect_payment_claimed!(nodes[2], payment_hash_1, 1_000_000);
2957 let cs_htlc_fulfill_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2958 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_htlc_fulfill_updates.update_fulfill_htlcs[0]);
2959 do_commitment_signed_dance(&nodes[1], &nodes[2], &cs_htlc_fulfill_updates.commitment_signed, false, false);
2960 check_added_monitors(&nodes[1], 0);
2962 // Now claim the second payment on nodes[0], which will ultimately result in nodes[1] trying to
2963 // claim an HTLC on its channel with nodes[2], but that channel is blocked on the above
2964 // `PaymentSent` event.
2965 nodes[0].node.claim_funds(payment_preimage_2);
2966 check_added_monitors(&nodes[0], 1);
2967 expect_payment_claimed!(nodes[0], payment_hash_2, 1_000_000);
2969 let as_htlc_fulfill_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2970 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &as_htlc_fulfill_updates.update_fulfill_htlcs[0]);
2971 check_added_monitors(&nodes[1], 1); // We generate only a preimage monitor update
2972 assert!(get_monitor!(nodes[1], chan_id_2).get_stored_preimages().contains_key(&payment_hash_2));
2973 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2975 // Finish the CS dance between nodes[0] and nodes[1]. Note that until the event handling, the
2976 // update_fulfill_htlc + CS is held, even though the preimage is already on disk for the
2978 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_htlc_fulfill_updates.commitment_signed);
2979 check_added_monitors(&nodes[1], 1);
2980 let (a, raa) = do_main_commitment_signed_dance(&nodes[1], &nodes[0], false);
2981 assert!(a.is_none());
2983 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
2984 check_added_monitors(&nodes[1], 0);
2985 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2987 let events = nodes[1].node.get_and_clear_pending_events();
2988 assert_eq!(events.len(), 3);
2989 if let Event::PaymentSent { .. } = events[0] {} else { panic!(); }
2990 if let Event::PaymentPathSuccessful { .. } = events[2] {} else { panic!(); }
2991 if let Event::PaymentForwarded { .. } = events[1] {} else { panic!(); }
2993 // The event processing should release the last RAA updates on both channels.
2994 check_added_monitors(&nodes[1], 2);
2996 // When we fetch the next update the message getter will generate the next update for nodes[2],
2997 // generating a further monitor update.
2998 let bs_htlc_fulfill_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
2999 check_added_monitors(&nodes[1], 1);
3001 nodes[2].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_htlc_fulfill_updates.update_fulfill_htlcs[0]);
3002 do_commitment_signed_dance(&nodes[2], &nodes[1], &bs_htlc_fulfill_updates.commitment_signed, false, false);
3003 expect_payment_sent(&nodes[2], payment_preimage_2, None, true, true);
3006 fn do_test_inverted_mon_completion_order(with_latest_manager: bool, complete_bc_commitment_dance: bool) {
3007 // When we forward a payment and receive `update_fulfill_htlc`+`commitment_signed` messages
3008 // from the downstream channel, we immediately claim the HTLC on the upstream channel, before
3009 // even doing a `commitment_signed` dance on the downstream channel. This implies that our
3010 // `ChannelMonitorUpdate`s are generated in the right order - first we ensure we'll get our
3011 // money, then we write the update that resolves the downstream node claiming their money. This
3012 // is safe as long as `ChannelMonitorUpdate`s complete in the order in which they are
3013 // generated, but of course this may not be the case. For asynchronous update writes, we have
3014 // to ensure monitor updates can block each other, preventing the inversion all together.
3015 let chanmon_cfgs = create_chanmon_cfgs(3);
3016 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3019 let new_chain_monitor;
3020 let nodes_1_deserialized;
3022 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3023 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3025 let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
3026 let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;
3028 // Route a payment from A, through B, to C, then claim it on C. Once we pass B the
3029 // `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
3030 // on the B<->C channel but leave the A<->B monitor update pending, then reload B.
3031 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
3033 let mon_ab = get_monitor!(nodes[1], chan_id_ab).encode();
3034 let mut manager_b = Vec::new();
3035 if !with_latest_manager {
3036 manager_b = nodes[1].node.encode();
3039 nodes[2].node.claim_funds(payment_preimage);
3040 check_added_monitors(&nodes[2], 1);
3041 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
3043 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3044 let cs_updates = get_htlc_update_msgs(&nodes[2], &nodes[1].node.get_our_node_id());
3045 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
3047 // B generates a new monitor update for the A <-> B channel, but doesn't send the new messages
3048 // for it since the monitor update is marked in-progress.
3049 check_added_monitors(&nodes[1], 1);
3050 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3052 // Now step the Commitment Signed Dance between B and C forward a bit (or fully), ensuring we
3053 // won't get the preimage when the nodes reconnect and we have to get it from the
3055 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &cs_updates.commitment_signed);
3056 check_added_monitors(&nodes[1], 1);
3057 if complete_bc_commitment_dance {
3058 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3059 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3060 check_added_monitors(&nodes[2], 1);
3061 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3062 check_added_monitors(&nodes[2], 1);
3063 let cs_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3065 // At this point node B still hasn't persisted the `ChannelMonitorUpdate` with the
3066 // preimage in the A <-> B channel, which will prevent it from persisting the
3067 // `ChannelMonitorUpdate` for the B<->C channel here to avoid "losing" the preimage.
3068 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &cs_raa);
3069 check_added_monitors(&nodes[1], 0);
3070 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3073 // Now reload node B
3074 if with_latest_manager {
3075 manager_b = nodes[1].node.encode();
3078 let mon_bc = get_monitor!(nodes[1], chan_id_bc).encode();
3079 reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, new_chain_monitor, nodes_1_deserialized);
3081 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3082 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3084 if with_latest_manager {
3085 // If we used the latest ChannelManager to reload from, we should have both channels still
3086 // live. The B <-> C channel's final RAA ChannelMonitorUpdate must still be blocked as
3087 // before - the ChannelMonitorUpdate for the A <-> B channel hasn't completed.
3088 // When we call `timer_tick_occurred` we will get that monitor update back, which we'll
3089 // complete after reconnecting to our peers.
3090 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3091 nodes[1].node.timer_tick_occurred();
3092 check_added_monitors(&nodes[1], 1);
3093 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3095 // Now reconnect B to both A and C. If the B <-> C commitment signed dance wasn't run to
3096 // the end go ahead and do that, though the
3097 // `pending_responding_commitment_signed_dup_monitor` in `reconnect_args` indicates that we
3098 // expect to *not* receive the final RAA ChannelMonitorUpdate.
3099 if complete_bc_commitment_dance {
3100 reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[2]));
3102 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
3103 reconnect_args.pending_responding_commitment_signed.1 = true;
3104 reconnect_args.pending_responding_commitment_signed_dup_monitor.1 = true;
3105 reconnect_args.pending_raa = (false, true);
3106 reconnect_nodes(reconnect_args);
3109 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
3111 // (Finally) complete the A <-> B ChannelMonitorUpdate, ensuring the preimage is durably on
3112 // disk in the proper ChannelMonitor, unblocking the B <-> C ChannelMonitor updating
3114 let (outpoint, _, ab_update_id) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_ab).unwrap().clone();
3115 nodes[1].chain_monitor.chain_monitor.channel_monitor_updated(outpoint, ab_update_id).unwrap();
3117 // When we fetch B's HTLC update messages next (now that the ChannelMonitorUpdate has
3118 // completed), it will also release the final RAA ChannelMonitorUpdate on the B <-> C
3121 // If the ChannelManager used in the reload was stale, check that the B <-> C channel was
3124 // Note that this will also process the ChannelMonitorUpdates which were queued up when we
3125 // reloaded the ChannelManager. This will re-emit the A<->B preimage as well as the B<->C
3126 // force-closure ChannelMonitorUpdate. Once the A<->B preimage update completes, the claim
3127 // commitment update will be allowed to go out.
3128 check_added_monitors(&nodes[1], 0);
3129 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3130 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3131 check_closed_event(&nodes[1], 1, ClosureReason::OutdatedChannelManager, false, &[nodes[2].node.get_our_node_id()], 100_000);
3132 check_added_monitors(&nodes[1], 2);
3134 nodes[1].node.timer_tick_occurred();
3135 check_added_monitors(&nodes[1], 0);
3137 // Don't bother to reconnect B to C - that channel has been closed. We don't need to
3138 // exchange any messages here even though there's a pending commitment update because the
3139 // ChannelMonitorUpdate hasn't yet completed.
3140 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
3142 let (outpoint, _, ab_update_id) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_ab).unwrap().clone();
3143 nodes[1].chain_monitor.chain_monitor.channel_monitor_updated(outpoint, ab_update_id).unwrap();
3145 // The ChannelMonitorUpdate which was completed prior to the reconnect only contained the
3146 // preimage (as it was a replay of the original ChannelMonitorUpdate from before we
3147 // restarted). When we go to fetch the commitment transaction updates we'll poll the
3148 // ChannelMonitorUpdate completion, then generate (and complete) a new ChannelMonitorUpdate
3149 // with the actual commitment transaction, which will allow us to fulfill the HTLC with
3153 let bs_updates = get_htlc_update_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
3154 check_added_monitors(&nodes[1], 1);
3156 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
3157 do_commitment_signed_dance(&nodes[0], &nodes[1], &bs_updates.commitment_signed, false, false);
3159 expect_payment_forwarded!(nodes[1], &nodes[0], &nodes[2], Some(1_000), false, !with_latest_manager);
3161 // Finally, check that the payment was, ultimately, seen as sent by node A.
3162 expect_payment_sent(&nodes[0], payment_preimage, None, true, true);
3166 fn test_inverted_mon_completion_order() {
3167 do_test_inverted_mon_completion_order(true, true);
3168 do_test_inverted_mon_completion_order(true, false);
3169 do_test_inverted_mon_completion_order(false, true);
3170 do_test_inverted_mon_completion_order(false, false);
3173 fn do_test_durable_preimages_on_closed_channel(close_chans_before_reload: bool, close_only_a: bool, hold_post_reload_mon_update: bool) {
3174 // Test that we can apply a `ChannelMonitorUpdate` with a payment preimage even if the channel
3175 // is force-closed between when we generate the update on reload and when we go to handle the
3176 // update or prior to generating the update at all.
3178 if !close_chans_before_reload && close_only_a {
3179 // If we're not closing, it makes no sense to "only close A"
3183 let chanmon_cfgs = create_chanmon_cfgs(3);
3184 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3187 let new_chain_monitor;
3188 let nodes_1_deserialized;
3190 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3191 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3193 let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
3194 let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;
3196 // Route a payment from A, through B, to C, then claim it on C. Once we pass B the
3197 // `update_fulfill_htlc` we have a monitor update for both of B's channels. We complete the one
3198 // on the B<->C channel but leave the A<->B monitor update pending, then reload B.
3199 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
3201 let mon_ab = get_monitor!(nodes[1], chan_id_ab).encode();
3203 nodes[2].node.claim_funds(payment_preimage);
3204 check_added_monitors(&nodes[2], 1);
3205 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
3207 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3208 let cs_updates = get_htlc_update_msgs(&nodes[2], &nodes[1].node.get_our_node_id());
3209 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
3211 // B generates a new monitor update for the A <-> B channel, but doesn't send the new messages
3212 // for it since the monitor update is marked in-progress.
3213 check_added_monitors(&nodes[1], 1);
3214 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3216 // Now step the Commitment Signed Dance between B and C forward a bit, ensuring we won't get
3217 // the preimage when the nodes reconnect, at which point we have to ensure we get it from the
3219 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &cs_updates.commitment_signed);
3220 check_added_monitors(&nodes[1], 1);
3221 let _ = get_revoke_commit_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3223 let mon_bc = get_monitor!(nodes[1], chan_id_bc).encode();
3225 if close_chans_before_reload {
3227 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3228 nodes[1].node.force_close_broadcasting_latest_txn(&chan_id_bc, &nodes[2].node.get_our_node_id()).unwrap();
3229 check_closed_broadcast(&nodes[1], 1, true);
3230 check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed, false, &[nodes[2].node.get_our_node_id()], 100000);
3233 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3234 nodes[1].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[0].node.get_our_node_id()).unwrap();
3235 check_closed_broadcast(&nodes[1], 1, true);
3236 check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed, false, &[nodes[0].node.get_our_node_id()], 100000);
3239 // Now reload node B
3240 let manager_b = nodes[1].node.encode();
3241 reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, new_chain_monitor, nodes_1_deserialized);
3243 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3244 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3246 if close_chans_before_reload {
3247 // If the channels were already closed, B will rebroadcast its closing transactions here.
3248 let bs_close_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3250 assert_eq!(bs_close_txn.len(), 2);
3252 assert_eq!(bs_close_txn.len(), 3);
3256 nodes[0].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[1].node.get_our_node_id()).unwrap();
3257 check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed, false, &[nodes[1].node.get_our_node_id()], 100000);
3258 let as_closing_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3259 assert_eq!(as_closing_tx.len(), 1);
3261 // In order to give A's closing transaction to B without processing background events first,
3262 // use the _without_consistency_checks utility method. This is similar to connecting blocks
3263 // during startup prior to the node being full initialized.
3264 mine_transaction_without_consistency_checks(&nodes[1], &as_closing_tx[0]);
3266 // After a timer tick a payment preimage ChannelMonitorUpdate is applied to the A<->B
3267 // ChannelMonitor (possible twice), even though the channel has since been closed.
3268 check_added_monitors(&nodes[1], 0);
3269 let mons_added = if close_chans_before_reload { if !close_only_a { 4 } else { 3 } } else { 2 };
3270 if hold_post_reload_mon_update {
3271 for _ in 0..mons_added {
3272 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3275 nodes[1].node.timer_tick_occurred();
3276 check_added_monitors(&nodes[1], mons_added);
3278 // Finally, check that B created a payment preimage transaction and close out the payment.
3279 let bs_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3280 assert_eq!(bs_txn.len(), if close_chans_before_reload && !close_only_a { 2 } else { 1 });
3281 let bs_preimage_tx = &bs_txn[0];
3282 check_spends!(bs_preimage_tx, as_closing_tx[0]);
3284 if !close_chans_before_reload {
3285 check_closed_broadcast(&nodes[1], 1, true);
3286 check_closed_event(&nodes[1], 1, ClosureReason::CommitmentTxConfirmed, false, &[nodes[0].node.get_our_node_id()], 100000);
3288 // While we forwarded the payment a while ago, we don't want to process events too early or
3289 // we'll run background tasks we wanted to test individually.
3290 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], None, true, !close_only_a);
3293 mine_transactions(&nodes[0], &[&as_closing_tx[0], bs_preimage_tx]);
3294 check_closed_broadcast(&nodes[0], 1, true);
3295 expect_payment_sent(&nodes[0], payment_preimage, None, true, true);
3297 if !close_chans_before_reload || close_only_a {
3298 // Make sure the B<->C channel is still alive and well by sending a payment over it.
3299 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
3300 reconnect_args.pending_responding_commitment_signed.1 = true;
3301 if !close_chans_before_reload {
3302 // TODO: If the A<->B channel was closed before we reloaded, the `ChannelManager`
3303 // will consider the forwarded payment complete and allow the B<->C
3304 // `ChannelMonitorUpdate` to complete, wiping the payment preimage. This should not
3305 // be allowed, and needs fixing.
3306 reconnect_args.pending_responding_commitment_signed_dup_monitor.1 = true;
3308 reconnect_args.pending_raa.1 = true;
3310 reconnect_nodes(reconnect_args);
3311 let (outpoint, ab_update_id, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_ab).unwrap().clone();
3312 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, ab_update_id);
3313 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), true, false);
3314 if !close_chans_before_reload {
3315 // Once we call `process_pending_events` the final `ChannelMonitor` for the B<->C
3316 // channel will fly, removing the payment preimage from it.
3317 check_added_monitors(&nodes[1], 1);
3319 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3320 send_payment(&nodes[1], &[&nodes[2]], 100_000);
3325 fn test_durable_preimages_on_closed_channel() {
3326 do_test_durable_preimages_on_closed_channel(true, true, true);
3327 do_test_durable_preimages_on_closed_channel(true, true, false);
3328 do_test_durable_preimages_on_closed_channel(true, false, true);
3329 do_test_durable_preimages_on_closed_channel(true, false, false);
3330 do_test_durable_preimages_on_closed_channel(false, false, true);
3331 do_test_durable_preimages_on_closed_channel(false, false, false);
3334 fn do_test_reload_mon_update_completion_actions(close_during_reload: bool) {
3335 // Test that if a `ChannelMonitorUpdate` completes but a `ChannelManager` isn't serialized
3336 // before restart we run the monitor update completion action on startup.
3337 let chanmon_cfgs = create_chanmon_cfgs(3);
3338 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3341 let new_chain_monitor;
3342 let nodes_1_deserialized;
3344 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3345 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3347 let chan_id_ab = create_announced_chan_between_nodes(&nodes, 0, 1).2;
3348 let chan_id_bc = create_announced_chan_between_nodes(&nodes, 1, 2).2;
3350 // Route a payment from A, through B, to C, then claim it on C. Once we pass B the
3351 // `update_fulfill_htlc`+`commitment_signed` we have a monitor update for both of B's channels.
3352 // We complete the commitment signed dance on the B<->C channel but leave the A<->B monitor
3353 // update pending, then reload B. At that point, the final monitor update on the B<->C channel
3354 // is still pending because it can't fly until the preimage is persisted on the A<->B monitor.
3355 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
3357 nodes[2].node.claim_funds(payment_preimage);
3358 check_added_monitors(&nodes[2], 1);
3359 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
3361 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3362 let cs_updates = get_htlc_update_msgs(&nodes[2], &nodes[1].node.get_our_node_id());
3363 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
3365 // B generates a new monitor update for the A <-> B channel, but doesn't send the new messages
3366 // for it since the monitor update is marked in-progress.
3367 check_added_monitors(&nodes[1], 1);
3368 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3370 // Now step the Commitment Signed Dance between B and C and check that after the final RAA B
3371 // doesn't let the preimage-removing monitor update fly.
3372 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &cs_updates.commitment_signed);
3373 check_added_monitors(&nodes[1], 1);
3374 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3376 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
3377 check_added_monitors(&nodes[2], 1);
3378 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
3379 check_added_monitors(&nodes[2], 1);
3381 let cs_final_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3382 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &cs_final_raa);
3383 check_added_monitors(&nodes[1], 0);
3385 // Finally, reload node B and check that after we call `process_pending_events` once we realize
3386 // we've completed the A<->B preimage-including monitor update and so can release the B<->C
3387 // preimage-removing monitor update.
3388 let mon_ab = get_monitor!(nodes[1], chan_id_ab).encode();
3389 let mon_bc = get_monitor!(nodes[1], chan_id_bc).encode();
3390 let manager_b = nodes[1].node.encode();
3391 reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, new_chain_monitor, nodes_1_deserialized);
3393 if close_during_reload {
3394 // Test that we still free the B<->C channel if the A<->B channel closed while we reloaded
3395 // (as learned about during the on-reload block connection).
3396 nodes[0].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[1].node.get_our_node_id()).unwrap();
3397 check_added_monitors!(nodes[0], 1);
3398 check_closed_broadcast!(nodes[0], true);
3399 check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed, false, &[nodes[1].node.get_our_node_id()], 100_000);
3400 let as_closing_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3401 mine_transaction_without_consistency_checks(&nodes[1], &as_closing_tx[0]);
3404 let bc_update_id = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_bc).unwrap().2;
3405 let mut events = nodes[1].node.get_and_clear_pending_events();
3406 assert_eq!(events.len(), if close_during_reload { 2 } else { 1 });
3407 expect_payment_forwarded(events.pop().unwrap(), &nodes[1], &nodes[0], &nodes[2], Some(1000), close_during_reload, false);
3408 if close_during_reload {
3410 Event::ChannelClosed { .. } => {},
3413 check_closed_broadcast!(nodes[1], true);
3416 // Once we run event processing the monitor should free, check that it was indeed the B<->C
3417 // channel which was updated.
3418 check_added_monitors(&nodes[1], if close_during_reload { 2 } else { 1 });
3419 let post_ev_bc_update_id = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id_bc).unwrap().2;
3420 assert!(bc_update_id != post_ev_bc_update_id);
3422 // Finally, check that there's nothing left to do on B<->C reconnect and the channel operates
3424 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3425 reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[2]));
3426 send_payment(&nodes[1], &[&nodes[2]], 100_000);
3430 fn test_reload_mon_update_completion_actions() {
3431 do_test_reload_mon_update_completion_actions(true);
3432 do_test_reload_mon_update_completion_actions(false);