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::{ChannelManager, RAACommitmentOrder, PaymentSendFailure, PaymentId, RecipientOnionFields};
23 use crate::ln::channel::AnnouncementSigsState;
25 use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
26 use crate::util::enforcing_trait_impls::EnforcingSigner;
27 use crate::util::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_simple_monitor_permanent_update_fail() {
42 // Test that we handle a simple permanent monitor update failure
43 let chanmon_cfgs = create_chanmon_cfgs(2);
44 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
45 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
46 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
47 create_announced_chan_between_nodes(&nodes, 0, 1);
49 let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
50 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
51 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_1,
52 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)
53 ), true, APIError::ChannelUnavailable {..}, {});
54 check_added_monitors!(nodes[0], 2);
56 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
57 assert_eq!(events_1.len(), 2);
59 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
60 _ => panic!("Unexpected event"),
63 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
64 _ => panic!("Unexpected event"),
67 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
69 // TODO: Once we hit the chain with the failure transaction we should check that we get a
70 // PaymentPathFailed event
72 assert_eq!(nodes[0].node.list_channels().len(), 0);
73 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() },
74 [nodes[1].node.get_our_node_id()], 100000);
78 fn test_monitor_and_persister_update_fail() {
79 // Test that if both updating the `ChannelMonitor` and persisting the updated
80 // `ChannelMonitor` fail, then the failure from updating the `ChannelMonitor`
81 // one that gets returned.
82 let chanmon_cfgs = create_chanmon_cfgs(2);
83 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
84 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
85 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
87 // Create some initial channel
88 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
89 let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
91 // Rebalance the network to generate htlc in the two directions
92 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
94 // Route an HTLC from node 0 to node 1 (but don't settle)
95 let (preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
97 // Make a copy of the ChainMonitor so we can capture the error it returns on a
98 // bogus update. Note that if instead we updated the nodes[0]'s ChainMonitor
99 // directly, the node would fail to be `Drop`'d at the end because its
100 // ChannelManager and ChainMonitor would be out of sync.
101 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
102 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
103 let persister = test_utils::TestPersister::new();
104 let tx_broadcaster = TestBroadcaster {
105 txn_broadcasted: Mutex::new(Vec::new()),
106 // Because we will connect a block at height 200 below, we need the TestBroadcaster to know
107 // that we are at height 200 so that it doesn't think we're violating the time lock
108 // requirements of transactions broadcasted at that point.
109 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 200); 200])),
113 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
114 let new_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
115 &mut io::Cursor::new(&monitor.encode()), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
116 assert!(new_monitor == *monitor);
119 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
120 assert_eq!(chain_mon.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
123 chain_mon.chain_monitor.block_connected(&create_dummy_block(BlockHash::all_zeros(), 42, Vec::new()), 200);
125 // Set the persister's return value to be a InProgress.
126 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
128 // Try to update ChannelMonitor
129 nodes[1].node.claim_funds(preimage);
130 expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
131 check_added_monitors!(nodes[1], 1);
133 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
134 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
135 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
137 let mut node_0_per_peer_lock;
138 let mut node_0_peer_state_lock;
139 let mut channel = get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan.2);
140 if let Ok(Some(update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
141 // Check that even though the persister is returning a InProgress,
142 // because the update is bogus, ultimately the error that's returned
143 // should be a PermanentFailure.
144 if let ChannelMonitorUpdateStatus::PermanentFailure = chain_mon.chain_monitor.update_channel(outpoint, &update) {} else { panic!("Expected monitor error to be permanent"); }
145 logger.assert_log_regex("lightning::chain::chainmonitor", regex::Regex::new("Persistence of ChannelMonitorUpdate for channel [0-9a-f]* in progress").unwrap(), 1);
146 assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::Completed);
147 } else { assert!(false); }
150 check_added_monitors!(nodes[0], 1);
151 let events = nodes[0].node.get_and_clear_pending_events();
152 assert_eq!(events.len(), 1);
155 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
156 // Test that we can recover from a simple temporary monitor update failure optionally with
157 // a disconnect in between
158 let chanmon_cfgs = create_chanmon_cfgs(2);
159 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
160 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
161 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
162 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
164 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
166 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
169 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_1,
170 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)
171 ), false, APIError::MonitorUpdateInProgress, {});
172 check_added_monitors!(nodes[0], 1);
175 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
176 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
177 assert_eq!(nodes[0].node.list_channels().len(), 1);
180 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
181 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
182 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
183 reconnect_args.send_channel_ready = (true, true);
184 reconnect_nodes(reconnect_args);
187 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
188 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
189 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
190 check_added_monitors!(nodes[0], 0);
192 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
193 assert_eq!(events_2.len(), 1);
194 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
195 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
196 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
197 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
199 expect_pending_htlcs_forwardable!(nodes[1]);
201 let events_3 = nodes[1].node.get_and_clear_pending_events();
202 assert_eq!(events_3.len(), 1);
204 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
205 assert_eq!(payment_hash_1, *payment_hash);
206 assert_eq!(amount_msat, 1_000_000);
207 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
208 assert_eq!(via_channel_id, Some(channel_id));
210 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
211 assert!(payment_preimage.is_none());
212 assert_eq!(payment_secret_1, *payment_secret);
214 _ => panic!("expected PaymentPurpose::InvoicePayment")
217 _ => panic!("Unexpected event"),
220 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
222 // Now set it to failed again...
223 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
225 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
226 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_2,
227 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)
228 ), false, APIError::MonitorUpdateInProgress, {});
229 check_added_monitors!(nodes[0], 1);
232 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
233 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
234 assert_eq!(nodes[0].node.list_channels().len(), 1);
237 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
238 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
239 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
242 // ...and make sure we can force-close a frozen channel
243 nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
244 check_added_monitors!(nodes[0], 1);
245 check_closed_broadcast!(nodes[0], true);
247 // TODO: Once we hit the chain with the failure transaction we should check that we get a
248 // PaymentPathFailed event
250 assert_eq!(nodes[0].node.list_channels().len(), 0);
251 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
255 fn test_simple_monitor_temporary_update_fail() {
256 do_test_simple_monitor_temporary_update_fail(false);
257 do_test_simple_monitor_temporary_update_fail(true);
260 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
261 let disconnect_flags = 8 | 16;
263 // Test that we can recover from a temporary monitor update failure with some in-flight
264 // HTLCs going on at the same time potentially with some disconnection thrown in.
265 // * First we route a payment, then get a temporary monitor update failure when trying to
266 // route a second payment. We then claim the first payment.
267 // * If disconnect_count is set, we will disconnect at this point (which is likely as
268 // InProgress likely indicates net disconnect which resulted in failing to update the
269 // ChannelMonitor on a watchtower).
270 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
271 // immediately, otherwise we wait disconnect and deliver them via the reconnect
272 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
273 // disconnect_count & !disconnect_flags is 0).
274 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
275 // through message sending, potentially disconnect/reconnecting multiple times based on
276 // disconnect_count, to get the update_fulfill_htlc through.
277 // * We then walk through more message exchanges to get the original update_add_htlc
278 // through, swapping message ordering based on disconnect_count & 8 and optionally
279 // disconnect/reconnecting based on disconnect_count.
280 let chanmon_cfgs = create_chanmon_cfgs(2);
281 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
282 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
283 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
284 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
286 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
288 // Now try to send a second payment which will fail to send
289 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
291 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
292 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_2,
293 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)
294 ), false, APIError::MonitorUpdateInProgress, {});
295 check_added_monitors!(nodes[0], 1);
298 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
299 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
300 assert_eq!(nodes[0].node.list_channels().len(), 1);
302 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
303 // but nodes[0] won't respond since it is frozen.
304 nodes[1].node.claim_funds(payment_preimage_1);
305 check_added_monitors!(nodes[1], 1);
306 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
308 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
309 assert_eq!(events_2.len(), 1);
310 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
311 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 } } => {
312 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
313 assert!(update_add_htlcs.is_empty());
314 assert_eq!(update_fulfill_htlcs.len(), 1);
315 assert!(update_fail_htlcs.is_empty());
316 assert!(update_fail_malformed_htlcs.is_empty());
317 assert!(update_fee.is_none());
319 if (disconnect_count & 16) == 0 {
320 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
321 let events_3 = nodes[0].node.get_and_clear_pending_events();
322 assert_eq!(events_3.len(), 1);
324 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
325 assert_eq!(*payment_preimage, payment_preimage_1);
326 assert_eq!(*payment_hash, payment_hash_1);
328 _ => panic!("Unexpected event"),
331 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
332 check_added_monitors!(nodes[0], 1);
333 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
336 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
338 _ => panic!("Unexpected event"),
341 if disconnect_count & !disconnect_flags > 0 {
342 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
343 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
346 // Now fix monitor updating...
347 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
348 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
349 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
350 check_added_monitors!(nodes[0], 0);
352 macro_rules! disconnect_reconnect_peers { () => { {
353 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
354 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
356 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
357 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
359 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
360 assert_eq!(reestablish_1.len(), 1);
361 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
362 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
364 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
365 assert_eq!(reestablish_2.len(), 1);
367 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
368 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
369 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
370 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
372 assert!(as_resp.0.is_none());
373 assert!(bs_resp.0.is_none());
375 (reestablish_1, reestablish_2, as_resp, bs_resp)
378 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
379 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
380 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
382 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
383 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
385 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
386 assert_eq!(reestablish_1.len(), 1);
387 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
388 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
390 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
391 assert_eq!(reestablish_2.len(), 1);
393 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
394 check_added_monitors!(nodes[0], 0);
395 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
396 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
397 check_added_monitors!(nodes[1], 0);
398 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
400 assert!(as_resp.0.is_none());
401 assert!(bs_resp.0.is_none());
403 assert!(bs_resp.1.is_none());
404 if (disconnect_count & 16) == 0 {
405 assert!(bs_resp.2.is_none());
407 assert!(as_resp.1.is_some());
408 assert!(as_resp.2.is_some());
409 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
411 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
412 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
413 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
414 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
415 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
416 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
418 assert!(as_resp.1.is_none());
420 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
421 let events_3 = nodes[0].node.get_and_clear_pending_events();
422 assert_eq!(events_3.len(), 1);
424 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
425 assert_eq!(*payment_preimage, payment_preimage_1);
426 assert_eq!(*payment_hash, payment_hash_1);
428 _ => panic!("Unexpected event"),
431 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
432 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
433 // No commitment_signed so get_event_msg's assert(len == 1) passes
434 check_added_monitors!(nodes[0], 1);
436 as_resp.1 = Some(as_resp_raa);
440 if disconnect_count & !disconnect_flags > 1 {
441 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
443 if (disconnect_count & 16) == 0 {
444 assert!(reestablish_1 == second_reestablish_1);
445 assert!(reestablish_2 == second_reestablish_2);
447 assert!(as_resp == second_as_resp);
448 assert!(bs_resp == second_bs_resp);
451 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
453 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
454 assert_eq!(events_4.len(), 2);
455 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
456 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
457 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
460 _ => panic!("Unexpected event"),
464 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
466 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
467 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
468 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
469 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
470 check_added_monitors!(nodes[1], 1);
472 if disconnect_count & !disconnect_flags > 2 {
473 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
475 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
476 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
478 assert!(as_resp.2.is_none());
479 assert!(bs_resp.2.is_none());
482 let as_commitment_update;
483 let bs_second_commitment_update;
485 macro_rules! handle_bs_raa { () => {
486 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
487 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
488 assert!(as_commitment_update.update_add_htlcs.is_empty());
489 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
490 assert!(as_commitment_update.update_fail_htlcs.is_empty());
491 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
492 assert!(as_commitment_update.update_fee.is_none());
493 check_added_monitors!(nodes[0], 1);
496 macro_rules! handle_initial_raa { () => {
497 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
498 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
499 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
500 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
501 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
502 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
503 assert!(bs_second_commitment_update.update_fee.is_none());
504 check_added_monitors!(nodes[1], 1);
507 if (disconnect_count & 8) == 0 {
510 if disconnect_count & !disconnect_flags > 3 {
511 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
513 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
514 assert!(bs_resp.1.is_none());
516 assert!(as_resp.2.unwrap() == as_commitment_update);
517 assert!(bs_resp.2.is_none());
519 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
522 handle_initial_raa!();
524 if disconnect_count & !disconnect_flags > 4 {
525 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
527 assert!(as_resp.1.is_none());
528 assert!(bs_resp.1.is_none());
530 assert!(as_resp.2.unwrap() == as_commitment_update);
531 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
534 handle_initial_raa!();
536 if disconnect_count & !disconnect_flags > 3 {
537 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
539 assert!(as_resp.1.is_none());
540 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
542 assert!(as_resp.2.is_none());
543 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
545 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
550 if disconnect_count & !disconnect_flags > 4 {
551 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
553 assert!(as_resp.1.is_none());
554 assert!(bs_resp.1.is_none());
556 assert!(as_resp.2.unwrap() == as_commitment_update);
557 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
561 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
562 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
563 // No commitment_signed so get_event_msg's assert(len == 1) passes
564 check_added_monitors!(nodes[0], 1);
566 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
567 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
568 // No commitment_signed so get_event_msg's assert(len == 1) passes
569 check_added_monitors!(nodes[1], 1);
571 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
572 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
573 check_added_monitors!(nodes[1], 1);
575 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
576 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
577 check_added_monitors!(nodes[0], 1);
578 expect_payment_path_successful!(nodes[0]);
580 expect_pending_htlcs_forwardable!(nodes[1]);
582 let events_5 = nodes[1].node.get_and_clear_pending_events();
583 assert_eq!(events_5.len(), 1);
585 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
586 assert_eq!(payment_hash_2, *payment_hash);
587 assert_eq!(amount_msat, 1_000_000);
588 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
589 assert_eq!(via_channel_id, Some(channel_id));
591 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
592 assert!(payment_preimage.is_none());
593 assert_eq!(payment_secret_2, *payment_secret);
595 _ => panic!("expected PaymentPurpose::InvoicePayment")
598 _ => panic!("Unexpected event"),
601 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
605 fn test_monitor_temporary_update_fail_a() {
606 do_test_monitor_temporary_update_fail(0);
607 do_test_monitor_temporary_update_fail(1);
608 do_test_monitor_temporary_update_fail(2);
609 do_test_monitor_temporary_update_fail(3);
610 do_test_monitor_temporary_update_fail(4);
611 do_test_monitor_temporary_update_fail(5);
615 fn test_monitor_temporary_update_fail_b() {
616 do_test_monitor_temporary_update_fail(2 | 8);
617 do_test_monitor_temporary_update_fail(3 | 8);
618 do_test_monitor_temporary_update_fail(4 | 8);
619 do_test_monitor_temporary_update_fail(5 | 8);
623 fn test_monitor_temporary_update_fail_c() {
624 do_test_monitor_temporary_update_fail(1 | 16);
625 do_test_monitor_temporary_update_fail(2 | 16);
626 do_test_monitor_temporary_update_fail(3 | 16);
627 do_test_monitor_temporary_update_fail(2 | 8 | 16);
628 do_test_monitor_temporary_update_fail(3 | 8 | 16);
632 fn test_monitor_update_fail_cs() {
633 // Tests handling of a monitor update failure when processing an incoming commitment_signed
634 let chanmon_cfgs = create_chanmon_cfgs(2);
635 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
636 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
637 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
638 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
640 let (route, our_payment_hash, payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
642 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
643 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
644 check_added_monitors!(nodes[0], 1);
647 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
648 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
650 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
651 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
652 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
653 check_added_monitors!(nodes[1], 1);
654 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
656 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
657 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
658 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
659 check_added_monitors!(nodes[1], 0);
660 let responses = nodes[1].node.get_and_clear_pending_msg_events();
661 assert_eq!(responses.len(), 2);
664 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
665 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
666 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
667 check_added_monitors!(nodes[0], 1);
669 _ => panic!("Unexpected event"),
672 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
673 assert!(updates.update_add_htlcs.is_empty());
674 assert!(updates.update_fulfill_htlcs.is_empty());
675 assert!(updates.update_fail_htlcs.is_empty());
676 assert!(updates.update_fail_malformed_htlcs.is_empty());
677 assert!(updates.update_fee.is_none());
678 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
680 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
681 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
682 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
683 check_added_monitors!(nodes[0], 1);
684 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
686 _ => panic!("Unexpected event"),
689 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
690 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
691 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
692 check_added_monitors!(nodes[0], 0);
694 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
695 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
696 check_added_monitors!(nodes[1], 1);
698 expect_pending_htlcs_forwardable!(nodes[1]);
700 let events = nodes[1].node.get_and_clear_pending_events();
701 assert_eq!(events.len(), 1);
703 Event::PaymentClaimable { payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
704 assert_eq!(payment_hash, our_payment_hash);
705 assert_eq!(amount_msat, 1_000_000);
706 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
707 assert_eq!(via_channel_id, Some(channel_id));
709 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
710 assert!(payment_preimage.is_none());
711 assert_eq!(our_payment_secret, *payment_secret);
713 _ => panic!("expected PaymentPurpose::InvoicePayment")
716 _ => panic!("Unexpected event"),
719 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
723 fn test_monitor_update_fail_no_rebroadcast() {
724 // Tests handling of a monitor update failure when no message rebroadcasting on
725 // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
727 let chanmon_cfgs = create_chanmon_cfgs(2);
728 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
729 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
730 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
731 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
733 let (route, our_payment_hash, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
735 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
736 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(our_payment_hash.0)).unwrap();
737 check_added_monitors!(nodes[0], 1);
740 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
741 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
742 let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
744 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
745 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
746 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
747 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
748 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
749 check_added_monitors!(nodes[1], 1);
751 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
752 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
753 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
754 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
755 check_added_monitors!(nodes[1], 0);
756 expect_pending_htlcs_forwardable!(nodes[1]);
758 let events = nodes[1].node.get_and_clear_pending_events();
759 assert_eq!(events.len(), 1);
761 Event::PaymentClaimable { payment_hash, .. } => {
762 assert_eq!(payment_hash, our_payment_hash);
764 _ => panic!("Unexpected event"),
767 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
771 fn test_monitor_update_raa_while_paused() {
772 // Tests handling of an RAA while monitor updating has already been marked failed.
773 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
774 let chanmon_cfgs = create_chanmon_cfgs(2);
775 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
776 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
777 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
778 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
780 send_payment(&nodes[0], &[&nodes[1]], 5000000);
781 let (route, our_payment_hash_1, payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
783 nodes[0].node.send_payment_with_route(&route, our_payment_hash_1,
784 RecipientOnionFields::secret_only(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
785 check_added_monitors!(nodes[0], 1);
787 let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
789 let (route, our_payment_hash_2, payment_preimage_2, our_payment_secret_2) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000000);
791 nodes[1].node.send_payment_with_route(&route, our_payment_hash_2,
792 RecipientOnionFields::secret_only(our_payment_secret_2), PaymentId(our_payment_hash_2.0)).unwrap();
793 check_added_monitors!(nodes[1], 1);
795 let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
797 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
798 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
799 check_added_monitors!(nodes[1], 1);
800 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
802 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
803 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
804 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
805 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
806 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
807 check_added_monitors!(nodes[0], 1);
808 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
810 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
811 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
812 check_added_monitors!(nodes[0], 1);
814 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
815 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
816 check_added_monitors!(nodes[0], 0);
818 let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
819 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
820 check_added_monitors!(nodes[1], 1);
821 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
823 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
824 check_added_monitors!(nodes[1], 1);
825 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
827 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
828 check_added_monitors!(nodes[0], 1);
829 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
831 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
832 check_added_monitors!(nodes[0], 1);
833 expect_pending_htlcs_forwardable!(nodes[0]);
834 expect_payment_claimable!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
836 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
837 check_added_monitors!(nodes[1], 1);
838 expect_pending_htlcs_forwardable!(nodes[1]);
839 expect_payment_claimable!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
841 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
842 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
845 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
846 // Tests handling of a monitor update failure when processing an incoming RAA
847 let chanmon_cfgs = create_chanmon_cfgs(3);
848 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
849 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
850 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
851 create_announced_chan_between_nodes(&nodes, 0, 1);
852 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
854 // Rebalance a bit so that we can send backwards from 2 to 1.
855 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
857 // Route a first payment that we'll fail backwards
858 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
860 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
861 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
862 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
863 check_added_monitors!(nodes[2], 1);
865 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
866 assert!(updates.update_add_htlcs.is_empty());
867 assert!(updates.update_fulfill_htlcs.is_empty());
868 assert_eq!(updates.update_fail_htlcs.len(), 1);
869 assert!(updates.update_fail_malformed_htlcs.is_empty());
870 assert!(updates.update_fee.is_none());
871 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
873 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
874 check_added_monitors!(nodes[0], 0);
876 // While the second channel is AwaitingRAA, forward a second payment to get it into the
878 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
880 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
881 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
882 check_added_monitors!(nodes[0], 1);
885 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
886 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
887 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
889 expect_pending_htlcs_forwardable!(nodes[1]);
890 check_added_monitors!(nodes[1], 0);
891 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
893 // Now fail monitor updating.
894 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
895 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
896 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
897 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
898 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
899 check_added_monitors!(nodes[1], 1);
901 // Forward a third payment which will also be added to the holding cell, despite the channel
902 // being paused waiting a monitor update.
903 let (route, payment_hash_3, _, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
905 nodes[0].node.send_payment_with_route(&route, payment_hash_3,
906 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
907 check_added_monitors!(nodes[0], 1);
910 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed); // We succeed in updating the monitor for the first channel
911 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
912 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
913 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
914 check_added_monitors!(nodes[1], 0);
916 // Call forward_pending_htlcs and check that the new HTLC was simply added to the holding cell
917 // and not forwarded.
918 expect_pending_htlcs_forwardable!(nodes[1]);
919 check_added_monitors!(nodes[1], 0);
920 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
922 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
923 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
924 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
925 nodes[2].node.send_payment_with_route(&route, payment_hash_4,
926 RecipientOnionFields::secret_only(payment_secret_4), PaymentId(payment_hash_4.0)).unwrap();
927 check_added_monitors!(nodes[2], 1);
929 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
930 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
931 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
932 check_added_monitors!(nodes[1], 1);
933 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
934 (Some(payment_preimage_4), Some(payment_hash_4))
935 } else { (None, None) };
937 // Restore monitor updating, ensuring we immediately get a fail-back update and a
938 // update_add update.
939 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
940 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
941 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
942 check_added_monitors!(nodes[1], 0);
943 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 }]);
944 check_added_monitors!(nodes[1], 1);
946 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
947 if test_ignore_second_cs {
948 assert_eq!(events_3.len(), 3);
950 assert_eq!(events_3.len(), 2);
953 // Note that the ordering of the events for different nodes is non-prescriptive, though the
954 // ordering of the two events that both go to nodes[2] have to stay in the same order.
955 let nodes_0_event = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &mut events_3);
956 let messages_a = match nodes_0_event {
957 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
958 assert_eq!(node_id, nodes[0].node.get_our_node_id());
959 assert!(updates.update_fulfill_htlcs.is_empty());
960 assert_eq!(updates.update_fail_htlcs.len(), 1);
961 assert!(updates.update_fail_malformed_htlcs.is_empty());
962 assert!(updates.update_add_htlcs.is_empty());
963 assert!(updates.update_fee.is_none());
964 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
966 _ => panic!("Unexpected event type!"),
969 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events_3);
970 let send_event_b = SendEvent::from_event(nodes_2_event);
971 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
973 let raa = if test_ignore_second_cs {
974 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events_3);
975 match nodes_2_event {
976 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
977 assert_eq!(node_id, nodes[2].node.get_our_node_id());
980 _ => panic!("Unexpected event"),
984 // Now deliver the new messages...
986 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
987 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
988 expect_payment_failed!(nodes[0], payment_hash_1, true);
990 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
992 if test_ignore_second_cs {
993 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
994 check_added_monitors!(nodes[2], 1);
995 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
996 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
997 check_added_monitors!(nodes[2], 1);
998 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
999 assert!(bs_cs.update_add_htlcs.is_empty());
1000 assert!(bs_cs.update_fail_htlcs.is_empty());
1001 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
1002 assert!(bs_cs.update_fulfill_htlcs.is_empty());
1003 assert!(bs_cs.update_fee.is_none());
1005 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1006 check_added_monitors!(nodes[1], 1);
1007 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1009 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
1010 check_added_monitors!(nodes[1], 1);
1012 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
1013 check_added_monitors!(nodes[2], 1);
1015 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
1016 // As both messages are for nodes[1], they're in order.
1017 assert_eq!(bs_revoke_and_commit.len(), 2);
1018 match bs_revoke_and_commit[0] {
1019 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1020 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1021 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
1022 check_added_monitors!(nodes[1], 1);
1024 _ => panic!("Unexpected event"),
1027 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1029 match bs_revoke_and_commit[1] {
1030 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1031 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1032 assert!(updates.update_add_htlcs.is_empty());
1033 assert!(updates.update_fail_htlcs.is_empty());
1034 assert!(updates.update_fail_malformed_htlcs.is_empty());
1035 assert!(updates.update_fulfill_htlcs.is_empty());
1036 assert!(updates.update_fee.is_none());
1037 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1038 check_added_monitors!(nodes[1], 1);
1040 _ => panic!("Unexpected event"),
1044 assert_eq!(as_cs.update_add_htlcs.len(), 1);
1045 assert!(as_cs.update_fail_htlcs.is_empty());
1046 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1047 assert!(as_cs.update_fulfill_htlcs.is_empty());
1048 assert!(as_cs.update_fee.is_none());
1049 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1052 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1053 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1054 check_added_monitors!(nodes[2], 1);
1055 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1057 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1058 check_added_monitors!(nodes[2], 1);
1059 let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1061 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1062 check_added_monitors!(nodes[1], 1);
1063 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1065 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1066 check_added_monitors!(nodes[1], 1);
1067 let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1069 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1070 check_added_monitors!(nodes[2], 1);
1071 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1073 expect_pending_htlcs_forwardable!(nodes[2]);
1075 let events_6 = nodes[2].node.get_and_clear_pending_events();
1076 assert_eq!(events_6.len(), 2);
1078 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1079 _ => panic!("Unexpected event"),
1082 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1083 _ => panic!("Unexpected event"),
1086 if test_ignore_second_cs {
1087 expect_pending_htlcs_forwardable!(nodes[1]);
1088 check_added_monitors!(nodes[1], 1);
1090 send_event = SendEvent::from_node(&nodes[1]);
1091 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1092 assert_eq!(send_event.msgs.len(), 1);
1093 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1094 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1096 expect_pending_htlcs_forwardable!(nodes[0]);
1098 let events_9 = nodes[0].node.get_and_clear_pending_events();
1099 assert_eq!(events_9.len(), 1);
1101 Event::PaymentClaimable { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1102 _ => panic!("Unexpected event"),
1104 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1107 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1111 fn test_monitor_update_fail_raa() {
1112 do_test_monitor_update_fail_raa(false);
1113 do_test_monitor_update_fail_raa(true);
1117 fn test_monitor_update_fail_reestablish() {
1118 // Simple test for message retransmission after monitor update failure on
1119 // channel_reestablish generating a monitor update (which comes from freeing holding cell
1121 let chanmon_cfgs = create_chanmon_cfgs(3);
1122 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1123 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1124 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1125 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1126 create_announced_chan_between_nodes(&nodes, 1, 2);
1128 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
1130 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1131 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1133 nodes[2].node.claim_funds(payment_preimage);
1134 check_added_monitors!(nodes[2], 1);
1135 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
1137 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1138 assert!(updates.update_add_htlcs.is_empty());
1139 assert!(updates.update_fail_htlcs.is_empty());
1140 assert!(updates.update_fail_malformed_htlcs.is_empty());
1141 assert!(updates.update_fee.is_none());
1142 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1143 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1144 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
1145 check_added_monitors!(nodes[1], 1);
1146 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1147 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1149 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1150 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1151 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1153 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1154 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1157 let as_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1158 let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1160 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1162 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1164 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1165 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1167 nodes[1].node.get_and_clear_pending_msg_events(); // Free the holding cell
1168 check_added_monitors!(nodes[1], 1);
1170 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1171 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1173 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1174 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1176 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1177 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1180 assert_eq!(get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap(), as_reestablish);
1181 assert_eq!(get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap(), bs_reestablish);
1183 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1185 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1186 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1188 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1189 check_added_monitors!(nodes[1], 0);
1191 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1192 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1194 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1195 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1196 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1197 check_added_monitors!(nodes[1], 0);
1199 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1200 assert!(updates.update_add_htlcs.is_empty());
1201 assert!(updates.update_fail_htlcs.is_empty());
1202 assert!(updates.update_fail_malformed_htlcs.is_empty());
1203 assert!(updates.update_fee.is_none());
1204 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1205 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1206 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1207 expect_payment_sent!(nodes[0], payment_preimage);
1211 fn raa_no_response_awaiting_raa_state() {
1212 // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1213 // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1214 // in question (assuming it intends to respond with a CS after monitor updating is restored).
1215 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1216 let chanmon_cfgs = create_chanmon_cfgs(2);
1217 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1218 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1219 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1220 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1222 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1223 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1224 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1226 // Queue up two payments - one will be delivered right away, one immediately goes into the
1227 // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1228 // immediately after a CS. By setting failing the monitor update failure from the CS (which
1229 // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1230 // generation during RAA while in monitor-update-failed state.
1232 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1233 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1234 check_added_monitors!(nodes[0], 1);
1235 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1236 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1237 check_added_monitors!(nodes[0], 0);
1240 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1241 assert_eq!(events.len(), 1);
1242 let payment_event = SendEvent::from_event(events.pop().unwrap());
1243 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1244 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1245 check_added_monitors!(nodes[1], 1);
1247 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1248 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1249 check_added_monitors!(nodes[0], 1);
1250 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1251 assert_eq!(events.len(), 1);
1252 let payment_event = SendEvent::from_event(events.pop().unwrap());
1254 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1255 check_added_monitors!(nodes[0], 1);
1256 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1258 // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1259 // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1260 // then restore channel monitor updates.
1261 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1262 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1263 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1264 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1265 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1266 check_added_monitors!(nodes[1], 1);
1267 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1269 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1270 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1271 check_added_monitors!(nodes[1], 1);
1273 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1274 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1275 // nodes[1] should be AwaitingRAA here!
1276 check_added_monitors!(nodes[1], 0);
1277 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1278 expect_pending_htlcs_forwardable!(nodes[1]);
1279 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1281 // We send a third payment here, which is somewhat of a redundant test, but the
1282 // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1283 // commitment transaction states) whereas here we can explicitly check for it.
1285 nodes[0].node.send_payment_with_route(&route, payment_hash_3,
1286 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1287 check_added_monitors!(nodes[0], 0);
1288 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1290 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1291 check_added_monitors!(nodes[0], 1);
1292 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1293 assert_eq!(events.len(), 1);
1294 let payment_event = SendEvent::from_event(events.pop().unwrap());
1296 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1297 check_added_monitors!(nodes[0], 1);
1298 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1300 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1301 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1302 check_added_monitors!(nodes[1], 1);
1303 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1305 // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1306 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1307 check_added_monitors!(nodes[1], 1);
1308 expect_pending_htlcs_forwardable!(nodes[1]);
1309 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1310 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1312 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1313 check_added_monitors!(nodes[0], 1);
1315 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1316 check_added_monitors!(nodes[0], 1);
1317 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1319 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1320 check_added_monitors!(nodes[1], 1);
1321 expect_pending_htlcs_forwardable!(nodes[1]);
1322 expect_payment_claimable!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1324 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1325 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1326 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1330 fn claim_while_disconnected_monitor_update_fail() {
1331 // Test for claiming a payment while disconnected and then having the resulting
1332 // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1333 // contrived case for nodes with network instability.
1334 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1335 // code introduced a regression in this test (specifically, this caught a removal of the
1336 // channel_reestablish handling ensuring the order was sensical given the messages used).
1337 let chanmon_cfgs = create_chanmon_cfgs(2);
1338 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1339 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1340 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1341 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1343 // Forward a payment for B to claim
1344 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1346 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1347 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1349 nodes[1].node.claim_funds(payment_preimage_1);
1350 check_added_monitors!(nodes[1], 1);
1351 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1353 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1354 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1356 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1357 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1360 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1361 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1363 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1364 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1366 // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1368 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1370 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1371 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1372 check_added_monitors!(nodes[1], 1);
1373 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1375 // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1376 // the monitor still failed
1377 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1379 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1380 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1381 check_added_monitors!(nodes[0], 1);
1384 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1385 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1386 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1387 check_added_monitors!(nodes[1], 1);
1388 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1389 // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1390 // until we've channel_monitor_update'd and updated for the new commitment transaction.
1392 // Now un-fail the monitor, which will result in B sending its original commitment update,
1393 // receiving the commitment update from A, and the resulting commitment dances.
1394 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1395 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1396 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1397 check_added_monitors!(nodes[1], 0);
1399 let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1400 assert_eq!(bs_msgs.len(), 2);
1403 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1404 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1405 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1406 expect_payment_sent(&nodes[0], payment_preimage_1, None, false, false);
1407 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1408 check_added_monitors!(nodes[0], 1);
1410 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1411 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1412 check_added_monitors!(nodes[1], 1);
1414 _ => panic!("Unexpected event"),
1418 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1419 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1420 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1421 check_added_monitors!(nodes[0], 1);
1423 _ => panic!("Unexpected event"),
1426 let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1428 let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1429 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1430 check_added_monitors!(nodes[0], 1);
1431 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1433 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1434 check_added_monitors!(nodes[1], 1);
1435 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1436 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1437 check_added_monitors!(nodes[1], 1);
1439 expect_pending_htlcs_forwardable!(nodes[1]);
1440 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1442 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1443 check_added_monitors!(nodes[0], 1);
1444 expect_payment_path_successful!(nodes[0]);
1446 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1450 fn monitor_failed_no_reestablish_response() {
1451 // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1452 // response to a commitment_signed.
1453 // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1454 // debug_assert!() failure in channel_reestablish handling.
1455 let chanmon_cfgs = create_chanmon_cfgs(2);
1456 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1457 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1458 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1459 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1461 let mut node_0_per_peer_lock;
1462 let mut node_0_peer_state_lock;
1463 get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, channel_id).context.announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1466 let mut node_1_per_peer_lock;
1467 let mut node_1_peer_state_lock;
1468 get_channel_ref!(nodes[1], nodes[0], node_1_per_peer_lock, node_1_peer_state_lock, channel_id).context.announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1471 // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1473 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1475 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1476 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1477 check_added_monitors!(nodes[0], 1);
1480 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1481 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1482 assert_eq!(events.len(), 1);
1483 let payment_event = SendEvent::from_event(events.pop().unwrap());
1484 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1485 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1486 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1487 check_added_monitors!(nodes[1], 1);
1489 // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1490 // is still failing to update monitors.
1491 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1492 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1494 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
1495 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
1497 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
1498 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
1501 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1502 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1504 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1505 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1506 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1507 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1509 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1510 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1511 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1512 check_added_monitors!(nodes[1], 0);
1513 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1515 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1516 check_added_monitors!(nodes[0], 1);
1517 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1518 check_added_monitors!(nodes[0], 1);
1520 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1521 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1522 check_added_monitors!(nodes[1], 1);
1524 expect_pending_htlcs_forwardable!(nodes[1]);
1525 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1527 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1531 fn first_message_on_recv_ordering() {
1532 // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1533 // messages, we're willing to flip the order of response messages if neccessary in resposne to
1534 // a commitment_signed which needs to send an RAA first.
1535 // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1536 // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1537 // response. To do this, we start routing two payments, with the final RAA for the first being
1538 // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1539 // have no pending response but will want to send a RAA/CS (with the updates for the second
1540 // payment applied).
1541 // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1542 let chanmon_cfgs = create_chanmon_cfgs(2);
1543 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1544 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1545 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1546 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1548 // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1549 // can deliver it and fail the monitor update.
1550 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1552 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1553 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1554 check_added_monitors!(nodes[0], 1);
1557 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1558 assert_eq!(events.len(), 1);
1559 let payment_event = SendEvent::from_event(events.pop().unwrap());
1560 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1561 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1562 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1563 check_added_monitors!(nodes[1], 1);
1564 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1566 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1567 check_added_monitors!(nodes[0], 1);
1568 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1569 check_added_monitors!(nodes[0], 1);
1571 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1573 // Route the second payment, generating an update_add_htlc/commitment_signed
1574 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1576 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1577 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1578 check_added_monitors!(nodes[0], 1);
1580 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1581 assert_eq!(events.len(), 1);
1582 let payment_event = SendEvent::from_event(events.pop().unwrap());
1583 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1585 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1587 // Deliver the final RAA for the first payment, which does not require a response. RAAs
1588 // generally require a commitment_signed, so the fact that we're expecting an opposite response
1589 // to the next message also tests resetting the delivery order.
1590 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1591 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1592 check_added_monitors!(nodes[1], 1);
1594 // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1595 // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1596 // appropriate HTLC acceptance).
1597 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1598 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1599 check_added_monitors!(nodes[1], 1);
1600 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1602 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1603 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1604 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1605 check_added_monitors!(nodes[1], 0);
1607 expect_pending_htlcs_forwardable!(nodes[1]);
1608 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1610 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1611 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1612 check_added_monitors!(nodes[0], 1);
1613 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1614 check_added_monitors!(nodes[0], 1);
1616 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1617 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1618 check_added_monitors!(nodes[1], 1);
1620 expect_pending_htlcs_forwardable!(nodes[1]);
1621 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1623 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1624 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1628 fn test_monitor_update_fail_claim() {
1629 // Basic test for monitor update failures when processing claim_funds calls.
1630 // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1631 // update to claim the payment. We then send two payments C->B->A, which are held at B.
1632 // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1633 // the payments from C onwards to A.
1634 let chanmon_cfgs = create_chanmon_cfgs(3);
1635 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1636 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1637 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1638 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1639 create_announced_chan_between_nodes(&nodes, 1, 2);
1641 // Rebalance a bit so that we can send backwards from 3 to 2.
1642 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1644 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1646 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1647 nodes[1].node.claim_funds(payment_preimage_1);
1648 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1649 check_added_monitors!(nodes[1], 1);
1651 // Note that at this point there is a pending commitment transaction update for A being held by
1652 // B. Even when we go to send the payment from C through B to A, B will not update this
1653 // already-signed commitment transaction and will instead wait for it to resolve before
1654 // forwarding the payment onwards.
1656 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1_000_000);
1658 nodes[2].node.send_payment_with_route(&route, payment_hash_2,
1659 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1660 check_added_monitors!(nodes[2], 1);
1663 // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1664 // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1665 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1667 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1668 assert_eq!(events.len(), 1);
1669 let payment_event = SendEvent::from_event(events.pop().unwrap());
1670 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1671 let events = nodes[1].node.get_and_clear_pending_msg_events();
1672 assert_eq!(events.len(), 0);
1673 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1674 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1676 let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1677 nodes[2].node.send_payment_with_route(&route, payment_hash_3,
1678 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1679 check_added_monitors!(nodes[2], 1);
1681 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1682 assert_eq!(events.len(), 1);
1683 let payment_event = SendEvent::from_event(events.pop().unwrap());
1684 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1685 let events = nodes[1].node.get_and_clear_pending_msg_events();
1686 assert_eq!(events.len(), 0);
1687 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1689 // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1690 let channel_id = chan_1.2;
1691 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1692 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1693 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1694 check_added_monitors!(nodes[1], 0);
1696 let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1697 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1698 commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1699 expect_payment_sent!(nodes[0], payment_preimage_1);
1701 // Get the payment forwards, note that they were batched into one commitment update.
1702 nodes[1].node.process_pending_htlc_forwards();
1703 check_added_monitors!(nodes[1], 1);
1704 let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1705 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1706 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1707 commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1708 expect_pending_htlcs_forwardable!(nodes[0]);
1710 let events = nodes[0].node.get_and_clear_pending_events();
1711 assert_eq!(events.len(), 2);
1713 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id, .. } => {
1714 assert_eq!(payment_hash_2, *payment_hash);
1715 assert_eq!(1_000_000, amount_msat);
1716 assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1717 assert_eq!(via_channel_id, Some(channel_id));
1718 assert_eq!(via_user_channel_id, Some(42));
1720 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1721 assert!(payment_preimage.is_none());
1722 assert_eq!(payment_secret_2, *payment_secret);
1724 _ => panic!("expected PaymentPurpose::InvoicePayment")
1727 _ => panic!("Unexpected event"),
1730 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
1731 assert_eq!(payment_hash_3, *payment_hash);
1732 assert_eq!(1_000_000, amount_msat);
1733 assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1734 assert_eq!(via_channel_id, Some(channel_id));
1736 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1737 assert!(payment_preimage.is_none());
1738 assert_eq!(payment_secret_3, *payment_secret);
1740 _ => panic!("expected PaymentPurpose::InvoicePayment")
1743 _ => panic!("Unexpected event"),
1748 fn test_monitor_update_on_pending_forwards() {
1749 // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1750 // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1751 // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1752 // from C to A will be pending a forward to A.
1753 let chanmon_cfgs = create_chanmon_cfgs(3);
1754 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1755 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1756 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1757 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1758 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1760 // Rebalance a bit so that we can send backwards from 3 to 1.
1761 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1763 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1764 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
1765 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
1766 check_added_monitors!(nodes[2], 1);
1768 let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1769 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1770 commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1771 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1773 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
1775 nodes[2].node.send_payment_with_route(&route, payment_hash_2,
1776 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1777 check_added_monitors!(nodes[2], 1);
1780 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1781 assert_eq!(events.len(), 1);
1782 let payment_event = SendEvent::from_event(events.pop().unwrap());
1783 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1784 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1786 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1787 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 }]);
1788 check_added_monitors!(nodes[1], 1);
1790 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1791 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1792 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1793 check_added_monitors!(nodes[1], 0);
1795 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1796 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1797 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1798 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1800 let events = nodes[0].node.get_and_clear_pending_events();
1801 assert_eq!(events.len(), 3);
1802 if let Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } = events[1] {
1803 assert_eq!(payment_hash, payment_hash_1);
1804 assert!(payment_failed_permanently);
1805 } else { panic!("Unexpected event!"); }
1807 Event::PaymentFailed { payment_hash, .. } => {
1808 assert_eq!(payment_hash, payment_hash_1);
1810 _ => panic!("Unexpected event"),
1813 Event::PendingHTLCsForwardable { .. } => { },
1814 _ => panic!("Unexpected event"),
1816 nodes[0].node.process_pending_htlc_forwards();
1817 expect_payment_claimable!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1819 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1823 fn monitor_update_claim_fail_no_response() {
1824 // Test for claim_funds resulting in both a monitor update failure and no message response (due
1825 // to channel being AwaitingRAA).
1826 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1828 let chanmon_cfgs = create_chanmon_cfgs(2);
1829 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1830 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1831 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1832 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1834 // Forward a payment for B to claim
1835 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1837 // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1838 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1840 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1841 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1842 check_added_monitors!(nodes[0], 1);
1845 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1846 assert_eq!(events.len(), 1);
1847 let payment_event = SendEvent::from_event(events.pop().unwrap());
1848 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1849 let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1851 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1852 nodes[1].node.claim_funds(payment_preimage_1);
1853 check_added_monitors!(nodes[1], 1);
1855 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1857 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1858 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1859 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1860 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1861 check_added_monitors!(nodes[1], 0);
1862 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1864 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1865 check_added_monitors!(nodes[1], 1);
1866 expect_pending_htlcs_forwardable!(nodes[1]);
1867 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1869 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1870 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1871 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1872 expect_payment_sent!(nodes[0], payment_preimage_1);
1874 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1877 // restore_b_before_conf has no meaning if !confirm_a_first
1878 // restore_b_before_lock has no meaning if confirm_a_first
1879 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool, restore_b_before_lock: bool) {
1880 // Test that if the monitor update generated by funding_transaction_generated fails we continue
1881 // the channel setup happily after the update is restored.
1882 let chanmon_cfgs = create_chanmon_cfgs(2);
1883 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1884 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1885 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1887 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1888 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()));
1889 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()));
1891 let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
1893 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
1894 check_added_monitors!(nodes[0], 0);
1896 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1897 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1898 let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1899 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1900 check_added_monitors!(nodes[1], 1);
1902 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1903 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()));
1904 check_added_monitors!(nodes[0], 1);
1905 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1906 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1907 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1908 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1909 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1910 check_added_monitors!(nodes[0], 0);
1911 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
1913 let events = nodes[0].node.get_and_clear_pending_events();
1914 assert_eq!(events.len(), 0);
1915 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1916 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1918 if confirm_a_first {
1919 confirm_transaction(&nodes[0], &funding_tx);
1920 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()));
1921 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1922 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1924 assert!(!restore_b_before_conf);
1925 confirm_transaction(&nodes[1], &funding_tx);
1926 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1929 // Make sure nodes[1] isn't stupid enough to re-send the ChannelReady on reconnect
1930 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1931 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1932 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
1933 reconnect_args.send_channel_ready.1 = confirm_a_first;
1934 reconnect_nodes(reconnect_args);
1936 // But we want to re-emit ChannelPending
1937 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
1938 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1939 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1941 if !restore_b_before_conf {
1942 confirm_transaction(&nodes[1], &funding_tx);
1943 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1944 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1946 if !confirm_a_first && !restore_b_before_lock {
1947 confirm_transaction(&nodes[0], &funding_tx);
1948 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()));
1949 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1950 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1953 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1954 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1955 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1956 check_added_monitors!(nodes[1], 0);
1958 let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1959 if !restore_b_before_lock {
1960 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1961 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1963 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()));
1964 confirm_transaction(&nodes[0], &funding_tx);
1965 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1966 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready))
1969 if restore_b_before_conf {
1970 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1971 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1972 confirm_transaction(&nodes[1], &funding_tx);
1974 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1975 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1977 for node in nodes.iter() {
1978 assert!(node.gossip_sync.handle_channel_announcement(&announcement).unwrap());
1979 node.gossip_sync.handle_channel_update(&as_update).unwrap();
1980 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
1983 if !restore_b_before_lock {
1984 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
1986 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
1990 send_payment(&nodes[0], &[&nodes[1]], 8000000);
1991 close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1992 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1993 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1997 fn during_funding_monitor_fail() {
1998 do_during_funding_monitor_fail(true, true, false);
1999 do_during_funding_monitor_fail(true, false, false);
2000 do_during_funding_monitor_fail(false, false, false);
2001 do_during_funding_monitor_fail(false, false, true);
2005 fn test_path_paused_mpp() {
2006 // Simple test of sending a multi-part payment where one path is currently blocked awaiting
2008 let chanmon_cfgs = create_chanmon_cfgs(4);
2009 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
2010 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
2011 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
2013 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
2014 let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2);
2015 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
2016 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
2018 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
2020 // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
2021 let path = route.paths[0].clone();
2022 route.paths.push(path);
2023 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
2024 route.paths[0].hops[0].short_channel_id = chan_1_id;
2025 route.paths[0].hops[1].short_channel_id = chan_3_id;
2026 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
2027 route.paths[1].hops[0].short_channel_id = chan_2_ann.contents.short_channel_id;
2028 route.paths[1].hops[1].short_channel_id = chan_4_id;
2030 // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
2031 // (for the path 0 -> 2 -> 3) fails.
2032 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2033 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2035 // Now check that we get the right return value, indicating that the first path succeeded but
2036 // the second got a MonitorUpdateInProgress err. This implies
2037 // PaymentSendFailure::PartialFailure as some paths succeeded, preventing retry.
2038 if let Err(PaymentSendFailure::PartialFailure { results, ..}) = nodes[0].node.send_payment_with_route(
2039 &route, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
2041 assert_eq!(results.len(), 2);
2042 if let Ok(()) = results[0] {} else { panic!(); }
2043 if let Err(APIError::MonitorUpdateInProgress) = results[1] {} else { panic!(); }
2044 } else { panic!(); }
2045 check_added_monitors!(nodes[0], 2);
2046 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2048 // Pass the first HTLC of the payment along to nodes[3].
2049 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2050 assert_eq!(events.len(), 1);
2051 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false, None);
2053 // And check that, after we successfully update the monitor for chan_2 we can pass the second
2054 // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
2055 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
2056 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2057 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2058 assert_eq!(events.len(), 1);
2059 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true, None);
2061 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
2065 fn test_pending_update_fee_ack_on_reconnect() {
2066 // In early versions of our automated fee update patch, nodes did not correctly use the
2067 // previous channel feerate after sending an undelivered revoke_and_ack when re-sending an
2068 // undelivered commitment_signed.
2070 // B sends A new HTLC + CS, not delivered
2071 // A sends B update_fee + CS
2072 // B receives the CS and sends RAA, previously causing B to lock in the new feerate
2074 // B resends initial CS, using the original fee
2076 let chanmon_cfgs = create_chanmon_cfgs(2);
2077 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2078 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2079 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2081 create_announced_chan_between_nodes(&nodes, 0, 1);
2082 send_payment(&nodes[0], &[&nodes[1]], 100_000_00);
2084 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[1], nodes[0], 1_000_000);
2085 nodes[1].node.send_payment_with_route(&route, payment_hash,
2086 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
2087 check_added_monitors!(nodes[1], 1);
2088 let bs_initial_send_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2089 // bs_initial_send_msgs are not delivered until they are re-generated after reconnect
2092 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2095 nodes[0].node.timer_tick_occurred();
2096 check_added_monitors!(nodes[0], 1);
2097 let as_update_fee_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2098 assert!(as_update_fee_msgs.update_fee.is_some());
2100 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_update_fee_msgs.update_fee.as_ref().unwrap());
2101 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_fee_msgs.commitment_signed);
2102 check_added_monitors!(nodes[1], 1);
2103 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2104 // bs_first_raa is not delivered until it is re-generated after reconnect
2106 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2107 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2109 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
2110 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
2112 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2113 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
2114 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
2116 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2118 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2119 let bs_resend_msgs = nodes[1].node.get_and_clear_pending_msg_events();
2120 assert_eq!(bs_resend_msgs.len(), 3);
2121 if let MessageSendEvent::UpdateHTLCs { ref updates, .. } = bs_resend_msgs[0] {
2122 assert_eq!(*updates, bs_initial_send_msgs);
2123 } else { panic!(); }
2124 if let MessageSendEvent::SendRevokeAndACK { ref msg, .. } = bs_resend_msgs[1] {
2125 assert_eq!(*msg, bs_first_raa);
2126 } else { panic!(); }
2127 if let MessageSendEvent::SendChannelUpdate { .. } = bs_resend_msgs[2] { } else { panic!(); }
2129 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2130 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
2132 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.update_add_htlcs[0]);
2133 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.commitment_signed);
2134 check_added_monitors!(nodes[0], 1);
2135 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()));
2136 check_added_monitors!(nodes[1], 1);
2137 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()).commitment_signed;
2139 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2140 check_added_monitors!(nodes[0], 1);
2141 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);
2142 check_added_monitors!(nodes[1], 1);
2143 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2145 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2146 check_added_monitors!(nodes[0], 1);
2147 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2148 check_added_monitors!(nodes[0], 1);
2150 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()));
2151 check_added_monitors!(nodes[1], 1);
2153 expect_pending_htlcs_forwardable!(nodes[0]);
2154 expect_payment_claimable!(nodes[0], payment_hash, payment_secret, 1_000_000);
2156 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
2160 fn test_fail_htlc_on_broadcast_after_claim() {
2161 // In an earlier version of 7e78fa660cec8a73286c94c1073ee588140e7a01 we'd also fail the inbound
2162 // channel backwards if we received an HTLC failure after a HTLC fulfillment. Here we test a
2163 // specific case of that by having the HTLC failure come from the ChannelMonitor after a dust
2164 // HTLC was not included in a confirmed commitment transaction.
2166 // We first forward a payment, then claim it with an update_fulfill_htlc message, closing the
2167 // channel immediately before commitment occurs. After the commitment transaction reaches
2168 // ANTI_REORG_DELAY confirmations, will will try to fail the HTLC which was already fulfilled.
2169 let chanmon_cfgs = create_chanmon_cfgs(3);
2170 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2171 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2172 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2174 create_announced_chan_between_nodes(&nodes, 0, 1);
2175 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2177 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 2000);
2179 let bs_txn = get_local_commitment_txn!(nodes[2], chan_id_2);
2180 assert_eq!(bs_txn.len(), 1);
2182 nodes[2].node.claim_funds(payment_preimage);
2183 check_added_monitors!(nodes[2], 1);
2184 expect_payment_claimed!(nodes[2], payment_hash, 2000);
2186 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2187 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
2188 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2189 check_added_monitors!(nodes[1], 1);
2190 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2192 mine_transaction(&nodes[1], &bs_txn[0]);
2193 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[2].node.get_our_node_id()], 100000);
2194 check_closed_broadcast!(nodes[1], true);
2195 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2196 check_added_monitors!(nodes[1], 1);
2197 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 }]);
2199 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
2200 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2201 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, true, true);
2202 expect_payment_path_successful!(nodes[0]);
2205 fn do_update_fee_resend_test(deliver_update: bool, parallel_updates: bool) {
2206 // In early versions we did not handle resending of update_fee on reconnect correctly. The
2207 // chanmon_consistency fuzz target, of course, immediately found it, but we test a few cases
2209 let chanmon_cfgs = create_chanmon_cfgs(2);
2210 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2211 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2212 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2214 create_announced_chan_between_nodes(&nodes, 0, 1);
2215 send_payment(&nodes[0], &[&nodes[1]], 1000);
2218 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2219 *feerate_lock += 20;
2221 nodes[0].node.timer_tick_occurred();
2222 check_added_monitors!(nodes[0], 1);
2223 let update_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2224 assert!(update_msgs.update_fee.is_some());
2226 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2229 if parallel_updates {
2231 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2232 *feerate_lock += 20;
2234 nodes[0].node.timer_tick_occurred();
2235 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2238 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2239 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2241 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
2242 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
2244 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2245 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
2246 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
2248 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2250 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2251 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
2252 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2254 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2255 let mut as_reconnect_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2256 assert_eq!(as_reconnect_msgs.len(), 2);
2257 if let MessageSendEvent::SendChannelUpdate { .. } = as_reconnect_msgs.pop().unwrap() {} else { panic!(); }
2258 let update_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = as_reconnect_msgs.pop().unwrap()
2259 { updates } else { panic!(); };
2260 assert!(update_msgs.update_fee.is_some());
2261 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2262 if parallel_updates {
2263 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update_msgs.commitment_signed);
2264 check_added_monitors!(nodes[1], 1);
2265 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2266 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2267 check_added_monitors!(nodes[0], 1);
2268 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2270 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2271 check_added_monitors!(nodes[0], 1);
2272 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2274 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_second_update.update_fee.as_ref().unwrap());
2275 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
2276 check_added_monitors!(nodes[1], 1);
2277 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2279 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2280 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2281 check_added_monitors!(nodes[1], 1);
2283 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2284 check_added_monitors!(nodes[0], 1);
2286 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs.commitment_signed);
2287 check_added_monitors!(nodes[0], 1);
2288 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2290 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2291 check_added_monitors!(nodes[1], 1);
2293 commitment_signed_dance!(nodes[1], nodes[0], update_msgs.commitment_signed, false);
2296 send_payment(&nodes[0], &[&nodes[1]], 1000);
2299 fn update_fee_resend_test() {
2300 do_update_fee_resend_test(false, false);
2301 do_update_fee_resend_test(true, false);
2302 do_update_fee_resend_test(false, true);
2303 do_update_fee_resend_test(true, true);
2306 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2307 // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2308 // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2309 // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2310 // which failed in such a case).
2311 let chanmon_cfgs = create_chanmon_cfgs(2);
2312 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2314 let new_chain_monitor;
2315 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2316 let nodes_0_deserialized;
2317 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2319 let chan_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 15_000_000, 7_000_000_000).2;
2320 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
2321 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2323 // Do a really complicated dance to get an HTLC into the holding cell, with
2324 // MonitorUpdateInProgress set but AwaitingRemoteRevoke unset. When this test was written, any
2325 // attempts to send an HTLC while MonitorUpdateInProgress is set are immediately
2326 // failed-backwards. Thus, the only way to get an AddHTLC into the holding cell is to add it
2327 // while AwaitingRemoteRevoke is set but MonitorUpdateInProgress is unset, and then swap the
2331 // a) routing a payment from node B to node A,
2332 // b) sending a payment from node A to node B without delivering any of the generated messages,
2333 // putting node A in AwaitingRemoteRevoke,
2334 // c) sending a second payment from node A to node B, which is immediately placed in the
2336 // d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2337 // when we try to persist the payment preimage,
2338 // e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2339 // clearing AwaitingRemoteRevoke on node A.
2341 // Note that because, at the end, MonitorUpdateInProgress is still set, the HTLC generated in
2342 // (c) will not be freed from the holding cell.
2343 let (payment_preimage_0, payment_hash_0, _) = route_payment(&nodes[1], &[&nodes[0]], 100_000);
2345 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
2346 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
2347 check_added_monitors!(nodes[0], 1);
2348 let send = SendEvent::from_node(&nodes[0]);
2349 assert_eq!(send.msgs.len(), 1);
2351 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
2352 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
2353 check_added_monitors!(nodes[0], 0);
2355 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
2356 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2357 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2358 nodes[0].node.claim_funds(payment_preimage_0);
2359 check_added_monitors!(nodes[0], 1);
2361 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2362 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2363 check_added_monitors!(nodes[1], 1);
2365 let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2367 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2368 check_added_monitors!(nodes[0], 1);
2371 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2372 // disconnect the peers. Note that the fuzzer originally found this issue because
2373 // deserializing a ChannelManager in this state causes an assertion failure.
2375 reload_node!(nodes[0], &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
2376 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2377 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2379 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2381 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2383 // Now reconnect the two
2384 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
2385 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
2387 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2388 assert_eq!(reestablish_1.len(), 1);
2389 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
2390 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
2392 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2393 assert_eq!(reestablish_2.len(), 1);
2395 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2396 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2397 check_added_monitors!(nodes[1], 0);
2399 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2400 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2402 assert!(resp_0.0.is_none());
2403 assert!(resp_0.1.is_none());
2404 assert!(resp_0.2.is_none());
2405 assert!(resp_1.0.is_none());
2406 assert!(resp_1.1.is_none());
2408 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2410 if let Some(pending_cs) = resp_1.2 {
2411 assert!(pending_cs.update_add_htlcs.is_empty());
2412 assert!(pending_cs.update_fail_htlcs.is_empty());
2413 assert!(pending_cs.update_fulfill_htlcs.is_empty());
2414 assert_eq!(pending_cs.commitment_signed, cs);
2415 } else { panic!(); }
2418 // The two pending monitor updates were replayed (but are still pending).
2419 check_added_monitors(&nodes[0], 2);
2421 // There should be no monitor updates as we are still pending awaiting a failed one.
2422 check_added_monitors(&nodes[0], 0);
2424 check_added_monitors(&nodes[1], 0);
2427 // If we finish updating the monitor, we should free the holding cell right away (this did
2428 // not occur prior to #756).
2429 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2430 let (funding_txo, mon_id, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2431 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_txo, mon_id);
2432 expect_payment_claimed!(nodes[0], payment_hash_0, 100_000);
2434 // New outbound messages should be generated immediately upon a call to
2435 // get_and_clear_pending_msg_events (but not before).
2436 check_added_monitors!(nodes[0], 0);
2437 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2438 check_added_monitors!(nodes[0], 1);
2439 assert_eq!(events.len(), 1);
2441 // Deliver the pending in-flight CS
2442 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2443 check_added_monitors!(nodes[0], 1);
2445 let commitment_msg = match events.pop().unwrap() {
2446 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2447 assert_eq!(node_id, nodes[1].node.get_our_node_id());
2448 assert!(updates.update_fail_htlcs.is_empty());
2449 assert!(updates.update_fail_malformed_htlcs.is_empty());
2450 assert!(updates.update_fee.is_none());
2451 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2452 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2453 expect_payment_sent(&nodes[1], payment_preimage_0, None, false, false);
2454 assert_eq!(updates.update_add_htlcs.len(), 1);
2455 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2456 updates.commitment_signed
2458 _ => panic!("Unexpected event type!"),
2461 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2462 check_added_monitors!(nodes[1], 1);
2464 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2465 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2466 expect_pending_htlcs_forwardable!(nodes[1]);
2467 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2468 check_added_monitors!(nodes[1], 1);
2470 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false, false);
2472 let events = nodes[1].node.get_and_clear_pending_events();
2473 assert_eq!(events.len(), 2);
2475 Event::PendingHTLCsForwardable { .. } => { },
2476 _ => panic!("Unexpected event"),
2479 Event::PaymentPathSuccessful { .. } => { },
2480 _ => panic!("Unexpected event"),
2483 nodes[1].node.process_pending_htlc_forwards();
2484 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2486 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2487 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2490 fn channel_holding_cell_serialize() {
2491 do_channel_holding_cell_serialize(true, true);
2492 do_channel_holding_cell_serialize(true, false);
2493 do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2496 #[derive(PartialEq)]
2497 enum HTLCStatusAtDupClaim {
2502 fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_fails: bool) {
2503 // When receiving an update_fulfill_htlc message, we immediately forward the claim backwards
2504 // along the payment path before waiting for a full commitment_signed dance. This is great, but
2505 // can cause duplicative claims if a node sends an update_fulfill_htlc message, disconnects,
2506 // reconnects, and then has to re-send its update_fulfill_htlc message again.
2507 // In previous code, we didn't handle the double-claim correctly, spuriously closing the
2508 // channel on which the inbound HTLC was received.
2509 let chanmon_cfgs = create_chanmon_cfgs(3);
2510 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2511 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2512 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2514 create_announced_chan_between_nodes(&nodes, 0, 1);
2515 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2517 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
2519 let mut as_raa = None;
2520 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2521 // In order to get the HTLC claim into the holding cell at nodes[1], we need nodes[1] to be
2522 // awaiting a remote revoke_and_ack from nodes[0].
2523 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
2524 nodes[0].node.send_payment_with_route(&route, second_payment_hash,
2525 RecipientOnionFields::secret_only(second_payment_secret), PaymentId(second_payment_hash.0)).unwrap();
2526 check_added_monitors!(nodes[0], 1);
2528 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
2529 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
2530 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
2531 check_added_monitors!(nodes[1], 1);
2533 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2534 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2535 check_added_monitors!(nodes[0], 1);
2536 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
2537 check_added_monitors!(nodes[0], 1);
2539 as_raa = Some(get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2542 let fulfill_msg = msgs::UpdateFulfillHTLC {
2543 channel_id: chan_id_2,
2548 nodes[2].node.fail_htlc_backwards(&payment_hash);
2549 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash }]);
2550 check_added_monitors!(nodes[2], 1);
2551 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2553 nodes[2].node.claim_funds(payment_preimage);
2554 check_added_monitors!(nodes[2], 1);
2555 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
2557 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2558 assert_eq!(cs_updates.update_fulfill_htlcs.len(), 1);
2559 // Check that the message we're about to deliver matches the one generated:
2560 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
2562 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
2563 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2564 check_added_monitors!(nodes[1], 1);
2566 let mut bs_updates = None;
2567 if htlc_status != HTLCStatusAtDupClaim::HoldingCell {
2568 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2569 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2570 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2571 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2572 if htlc_status == HTLCStatusAtDupClaim::Cleared {
2573 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2574 expect_payment_path_successful!(nodes[0]);
2577 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2580 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
2581 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2584 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
2585 reconnect_args.pending_htlc_fails.0 = 1;
2586 reconnect_nodes(reconnect_args);
2587 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 }]);
2589 let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
2590 reconnect_args.pending_htlc_claims.0 = 1;
2591 reconnect_nodes(reconnect_args);
2594 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2595 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa.unwrap());
2596 check_added_monitors!(nodes[1], 1);
2597 expect_pending_htlcs_forwardable_ignore!(nodes[1]); // We finally receive the second payment, but don't claim it
2599 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2600 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2601 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2602 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2604 if htlc_status != HTLCStatusAtDupClaim::Cleared {
2605 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2606 expect_payment_path_successful!(nodes[0]);
2611 fn test_reconnect_dup_htlc_claims() {
2612 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, false);
2613 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, false);
2614 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, false);
2615 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, true);
2616 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, true);
2617 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, true);
2621 fn test_temporary_error_during_shutdown() {
2622 // Test that temporary failures when updating the monitor's shutdown script delay cooperative
2624 let mut config = test_default_channel_config();
2625 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2627 let chanmon_cfgs = create_chanmon_cfgs(2);
2628 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2629 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
2630 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2632 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
2634 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2635 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2637 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
2638 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()));
2639 check_added_monitors!(nodes[1], 1);
2641 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()));
2642 check_added_monitors!(nodes[0], 1);
2644 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2646 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2647 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2649 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2650 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2651 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()));
2653 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2655 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2656 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2657 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2659 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()));
2660 let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
2661 let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2663 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_a.unwrap());
2664 let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
2665 assert!(none_b.is_none());
2666 let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2668 assert_eq!(txn_a, txn_b);
2669 assert_eq!(txn_a.len(), 1);
2670 check_spends!(txn_a[0], funding_tx);
2671 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
2672 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
2676 fn test_permanent_error_during_sending_shutdown() {
2677 // Test that permanent failures when updating the monitor's shutdown script result in a force
2678 // close when initiating a cooperative close.
2679 let mut config = test_default_channel_config();
2680 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2682 let chanmon_cfgs = create_chanmon_cfgs(2);
2683 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2684 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
2685 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2687 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
2688 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2690 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2692 // We always send the `shutdown` response when initiating a shutdown, even if we immediately
2693 // close the channel thereafter.
2694 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2695 assert_eq!(msg_events.len(), 3);
2696 if let MessageSendEvent::SendShutdown { .. } = msg_events[0] {} else { panic!(); }
2697 if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg_events[1] {} else { panic!(); }
2698 if let MessageSendEvent::HandleError { .. } = msg_events[2] {} else { panic!(); }
2700 check_added_monitors!(nodes[0], 2);
2701 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() },
2702 [nodes[1].node.get_our_node_id()], 100000);
2706 fn test_permanent_error_during_handling_shutdown() {
2707 // Test that permanent failures when updating the monitor's shutdown script result in a force
2708 // close when handling a cooperative close.
2709 let mut config = test_default_channel_config();
2710 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2712 let chanmon_cfgs = create_chanmon_cfgs(2);
2713 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2714 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
2715 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2717 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
2718 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2720 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2721 let shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
2722 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &shutdown);
2724 // We always send the `shutdown` response when receiving a shutdown, even if we immediately
2725 // close the channel thereafter.
2726 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
2727 assert_eq!(msg_events.len(), 3);
2728 if let MessageSendEvent::SendShutdown { .. } = msg_events[0] {} else { panic!(); }
2729 if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg_events[1] {} else { panic!(); }
2730 if let MessageSendEvent::HandleError { .. } = msg_events[2] {} else { panic!(); }
2732 check_added_monitors!(nodes[1], 2);
2733 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() },
2734 [nodes[0].node.get_our_node_id()], 100000);
2738 fn double_temp_error() {
2739 // Test that it's OK to have multiple `ChainMonitor::update_channel` calls fail in a row.
2740 let chanmon_cfgs = create_chanmon_cfgs(2);
2741 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2742 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2743 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2745 let (_, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1);
2747 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2748 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2750 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2751 // `claim_funds` results in a ChannelMonitorUpdate.
2752 nodes[1].node.claim_funds(payment_preimage_1);
2753 check_added_monitors!(nodes[1], 1);
2754 let (funding_tx, latest_update_1, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2756 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2757 // Previously, this would've panicked due to a double-call to `Channel::monitor_update_failed`,
2758 // which had some asserts that prevented it from being called twice.
2759 nodes[1].node.claim_funds(payment_preimage_2);
2760 check_added_monitors!(nodes[1], 1);
2761 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2763 let (_, latest_update_2, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2764 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_1);
2765 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2766 check_added_monitors!(nodes[1], 0);
2767 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_2);
2769 // Complete the first HTLC. Note that as a side-effect we handle the monitor update completions
2770 // and get both PaymentClaimed events at once.
2771 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
2773 let events = nodes[1].node.get_and_clear_pending_events();
2774 assert_eq!(events.len(), 2);
2776 Event::PaymentClaimed { amount_msat: 1_000_000, payment_hash, .. } => assert_eq!(payment_hash, payment_hash_1),
2777 _ => panic!("Unexpected Event: {:?}", events[0]),
2780 Event::PaymentClaimed { amount_msat: 1_000_000, payment_hash, .. } => assert_eq!(payment_hash, payment_hash_2),
2781 _ => panic!("Unexpected Event: {:?}", events[1]),
2784 assert_eq!(msg_events.len(), 1);
2785 let (update_fulfill_1, commitment_signed_b1, node_id) = {
2786 match &msg_events[0] {
2787 &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 } } => {
2788 assert!(update_add_htlcs.is_empty());
2789 assert_eq!(update_fulfill_htlcs.len(), 1);
2790 assert!(update_fail_htlcs.is_empty());
2791 assert!(update_fail_malformed_htlcs.is_empty());
2792 assert!(update_fee.is_none());
2793 (update_fulfill_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2795 _ => panic!("Unexpected event"),
2798 assert_eq!(node_id, nodes[0].node.get_our_node_id());
2799 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_1);
2800 check_added_monitors!(nodes[0], 0);
2801 expect_payment_sent(&nodes[0], payment_preimage_1, None, false, false);
2802 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_b1);
2803 check_added_monitors!(nodes[0], 1);
2804 nodes[0].node.process_pending_htlc_forwards();
2805 let (raa_a1, commitment_signed_a1) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2806 check_added_monitors!(nodes[1], 0);
2807 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2808 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_a1);
2809 check_added_monitors!(nodes[1], 1);
2810 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed_a1);
2811 check_added_monitors!(nodes[1], 1);
2813 // Complete the second HTLC.
2814 let ((update_fulfill_2, commitment_signed_b2), raa_b2) = {
2815 let events = nodes[1].node.get_and_clear_pending_msg_events();
2816 assert_eq!(events.len(), 2);
2818 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2819 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2820 assert!(updates.update_add_htlcs.is_empty());
2821 assert!(updates.update_fail_htlcs.is_empty());
2822 assert!(updates.update_fail_malformed_htlcs.is_empty());
2823 assert!(updates.update_fee.is_none());
2824 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2825 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2827 _ => panic!("Unexpected event"),
2830 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2831 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2834 _ => panic!("Unexpected event"),
2837 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_b2);
2838 check_added_monitors!(nodes[0], 1);
2839 expect_payment_path_successful!(nodes[0]);
2841 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_2);
2842 check_added_monitors!(nodes[0], 0);
2843 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2844 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed_b2, false);
2845 expect_payment_sent!(nodes[0], payment_preimage_2);
2848 fn do_test_outbound_reload_without_init_mon(use_0conf: bool) {
2849 // Test that if the monitor update generated in funding_signed is stored async and we restart
2850 // with the latest ChannelManager but the ChannelMonitor persistence never completed we happily
2851 // drop the channel and move on.
2852 let chanmon_cfgs = create_chanmon_cfgs(2);
2853 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2856 let new_chain_monitor;
2858 let mut chan_config = test_default_channel_config();
2859 chan_config.manually_accept_inbound_channels = true;
2860 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2862 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2863 let nodes_0_deserialized;
2865 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2867 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2868 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()));
2870 let events = nodes[1].node.get_and_clear_pending_events();
2871 assert_eq!(events.len(), 1);
2873 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2875 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2877 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2880 _ => panic!("Unexpected event"),
2883 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()));
2885 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2887 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2888 check_added_monitors!(nodes[0], 0);
2890 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2891 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2892 check_added_monitors!(nodes[1], 1);
2893 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
2895 let bs_signed_locked = nodes[1].node.get_and_clear_pending_msg_events();
2896 assert_eq!(bs_signed_locked.len(), if use_0conf { 2 } else { 1 });
2897 match &bs_signed_locked[0] {
2898 MessageSendEvent::SendFundingSigned { msg, .. } => {
2899 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2901 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &msg);
2902 check_added_monitors!(nodes[0], 1);
2904 _ => panic!("Unexpected event"),
2907 match &bs_signed_locked[1] {
2908 MessageSendEvent::SendChannelReady { msg, .. } => {
2909 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &msg);
2911 _ => panic!("Unexpected event"),
2915 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
2916 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2917 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2919 // nodes[0] is now waiting on the first ChannelMonitor persistence to complete in order to
2920 // broadcast the funding transaction. If nodes[0] restarts at this point with the
2921 // ChannelMonitor lost, we should simply discard the channel.
2923 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2924 // not, so we have to clear them here.
2925 nodes[0].chain_source.watched_txn.lock().unwrap().clear();
2926 nodes[0].chain_source.watched_outputs.lock().unwrap().clear();
2928 reload_node!(nodes[0], &nodes[0].node.encode(), &[], persister, new_chain_monitor, nodes_0_deserialized);
2929 check_closed_event!(nodes[0], 1, ClosureReason::DisconnectedPeer, [nodes[1].node.get_our_node_id()], 100000);
2930 assert!(nodes[0].node.list_channels().is_empty());
2934 fn test_outbound_reload_without_init_mon() {
2935 do_test_outbound_reload_without_init_mon(true);
2936 do_test_outbound_reload_without_init_mon(false);
2939 fn do_test_inbound_reload_without_init_mon(use_0conf: bool, lock_commitment: bool) {
2940 // Test that if the monitor update generated by funding_transaction_generated is stored async
2941 // and we restart with the latest ChannelManager but the ChannelMonitor persistence never
2942 // completed we happily drop the channel and move on.
2943 let chanmon_cfgs = create_chanmon_cfgs(2);
2944 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2947 let new_chain_monitor;
2949 let mut chan_config = test_default_channel_config();
2950 chan_config.manually_accept_inbound_channels = true;
2951 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2953 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2954 let nodes_1_deserialized;
2956 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2958 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2959 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()));
2961 let events = nodes[1].node.get_and_clear_pending_events();
2962 assert_eq!(events.len(), 1);
2964 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2966 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2968 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2971 _ => panic!("Unexpected event"),
2974 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()));
2976 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2978 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2979 check_added_monitors!(nodes[0], 0);
2981 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2982 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2983 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2984 check_added_monitors!(nodes[1], 1);
2986 // nodes[1] happily sends its funding_signed even though its awaiting the persistence of the
2987 // initial ChannelMonitor, but it will decline to send its channel_ready even if the funding
2988 // transaction is confirmed.
2989 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
2991 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
2992 check_added_monitors!(nodes[0], 1);
2993 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
2995 let as_funding_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2996 if lock_commitment {
2997 confirm_transaction(&nodes[0], &as_funding_tx[0]);
2998 confirm_transaction(&nodes[1], &as_funding_tx[0]);
3000 if use_0conf || lock_commitment {
3001 let as_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
3002 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_ready);
3004 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3006 // nodes[1] is now waiting on the first ChannelMonitor persistence to complete in order to
3007 // move the channel to ready (or is waiting on the funding transaction to confirm). If nodes[1]
3008 // restarts at this point with the ChannelMonitor lost, we should simply discard the channel.
3010 // The test framework checks that watched_txn/outputs match the monitor set, which they will
3011 // not, so we have to clear them here.
3012 nodes[1].chain_source.watched_txn.lock().unwrap().clear();
3013 nodes[1].chain_source.watched_outputs.lock().unwrap().clear();
3015 reload_node!(nodes[1], &nodes[1].node.encode(), &[], persister, new_chain_monitor, nodes_1_deserialized);
3017 check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer, [nodes[0].node.get_our_node_id()], 100000);
3018 assert!(nodes[1].node.list_channels().is_empty());
3022 fn test_inbound_reload_without_init_mon() {
3023 do_test_inbound_reload_without_init_mon(true, true);
3024 do_test_inbound_reload_without_init_mon(true, false);
3025 do_test_inbound_reload_without_init_mon(false, true);
3026 do_test_inbound_reload_without_init_mon(false, false);
3030 fn test_blocked_chan_preimage_release() {
3031 // Test that even if a channel's `ChannelMonitorUpdate` flow is blocked waiting on an event to
3032 // be handled HTLC preimage `ChannelMonitorUpdate`s will still go out.
3033 let chanmon_cfgs = create_chanmon_cfgs(3);
3034 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3035 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3036 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3038 create_announced_chan_between_nodes(&nodes, 0, 1).2;
3039 create_announced_chan_between_nodes(&nodes, 1, 2).2;
3041 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5_000_000);
3043 // Tee up two payments in opposite directions across nodes[1], one it sent to generate a
3044 // PaymentSent event and one it forwards.
3045 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[1], &[&nodes[2]], 1_000_000);
3046 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[2], &[&nodes[1], &nodes[0]], 1_000_000);
3048 // Claim the first payment to get a `PaymentSent` event (but don't handle it yet).
3049 nodes[2].node.claim_funds(payment_preimage_1);
3050 check_added_monitors(&nodes[2], 1);
3051 expect_payment_claimed!(nodes[2], payment_hash_1, 1_000_000);
3053 let cs_htlc_fulfill_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3054 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_htlc_fulfill_updates.update_fulfill_htlcs[0]);
3055 do_commitment_signed_dance(&nodes[1], &nodes[2], &cs_htlc_fulfill_updates.commitment_signed, false, false);
3056 check_added_monitors(&nodes[1], 0);
3058 // Now claim the second payment on nodes[0], which will ultimately result in nodes[1] trying to
3059 // claim an HTLC on its channel with nodes[2], but that channel is blocked on the above
3060 // `PaymentSent` event.
3061 nodes[0].node.claim_funds(payment_preimage_2);
3062 check_added_monitors(&nodes[0], 1);
3063 expect_payment_claimed!(nodes[0], payment_hash_2, 1_000_000);
3065 let as_htlc_fulfill_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3066 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &as_htlc_fulfill_updates.update_fulfill_htlcs[0]);
3067 check_added_monitors(&nodes[1], 1); // We generate only a preimage monitor update
3068 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3070 // Finish the CS dance between nodes[0] and nodes[1].
3071 do_commitment_signed_dance(&nodes[1], &nodes[0], &as_htlc_fulfill_updates.commitment_signed, false, false);
3072 check_added_monitors(&nodes[1], 0);
3074 let events = nodes[1].node.get_and_clear_pending_events();
3075 assert_eq!(events.len(), 3);
3076 if let Event::PaymentSent { .. } = events[0] {} else { panic!(); }
3077 if let Event::PaymentPathSuccessful { .. } = events[2] {} else { panic!(); }
3078 if let Event::PaymentForwarded { .. } = events[1] {} else { panic!(); }
3080 // The event processing should release the last RAA update.
3081 check_added_monitors(&nodes[1], 1);
3083 // When we fetch the next update the message getter will generate the next update for nodes[2],
3084 // generating a further monitor update.
3085 let bs_htlc_fulfill_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3086 check_added_monitors(&nodes[1], 1);
3088 nodes[2].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_htlc_fulfill_updates.update_fulfill_htlcs[0]);
3089 do_commitment_signed_dance(&nodes[2], &nodes[1], &bs_htlc_fulfill_updates.commitment_signed, false, false);
3090 expect_payment_sent(&nodes[2], payment_preimage_2, None, true, true);