1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Functional tests which test the correct handling of ChannelMonitorUpdateStatus returns from
12 //! There are a bunch of these as their handling is relatively error-prone so they are split out
13 //! here. See also the chanmon_fail_consistency fuzz test.
15 use bitcoin::blockdata::block::{Block, BlockHeader};
16 use bitcoin::blockdata::constants::genesis_block;
17 use bitcoin::hash_types::BlockHash;
18 use bitcoin::network::constants::Network;
19 use crate::chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor};
20 use crate::chain::transaction::OutPoint;
21 use crate::chain::{ChannelMonitorUpdateStatus, Listen, Watch};
22 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason, HTLCDestination};
23 use crate::ln::channelmanager::{ChannelManager, RAACommitmentOrder, PaymentSendFailure, PaymentId, RecipientOnionFields};
24 use crate::ln::channel::AnnouncementSigsState;
26 use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
27 use crate::util::enforcing_trait_impls::EnforcingSigner;
28 use crate::util::errors::APIError;
29 use crate::util::ser::{ReadableArgs, Writeable};
30 use crate::util::test_utils::TestBroadcaster;
32 use crate::ln::functional_test_utils::*;
34 use crate::util::test_utils;
37 use bitcoin::hashes::Hash;
38 use bitcoin::TxMerkleNode;
39 use crate::prelude::*;
40 use crate::sync::{Arc, Mutex};
43 fn test_simple_monitor_permanent_update_fail() {
44 // Test that we handle a simple permanent monitor update failure
45 let chanmon_cfgs = create_chanmon_cfgs(2);
46 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
47 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
48 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
49 create_announced_chan_between_nodes(&nodes, 0, 1);
51 let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
52 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
53 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_1,
54 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)
55 ), true, APIError::ChannelUnavailable {..}, {});
56 check_added_monitors!(nodes[0], 2);
58 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
59 assert_eq!(events_1.len(), 2);
61 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
62 _ => panic!("Unexpected event"),
65 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
66 _ => panic!("Unexpected event"),
69 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
71 // TODO: Once we hit the chain with the failure transaction we should check that we get a
72 // PaymentPathFailed event
74 assert_eq!(nodes[0].node.list_channels().len(), 0);
75 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
79 fn test_monitor_and_persister_update_fail() {
80 // Test that if both updating the `ChannelMonitor` and persisting the updated
81 // `ChannelMonitor` fail, then the failure from updating the `ChannelMonitor`
82 // one that gets returned.
83 let chanmon_cfgs = create_chanmon_cfgs(2);
84 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
85 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
86 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
88 // Create some initial channel
89 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
90 let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
92 // Rebalance the network to generate htlc in the two directions
93 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
95 // Route an HTLC from node 0 to node 1 (but don't settle)
96 let (preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
98 // Make a copy of the ChainMonitor so we can capture the error it returns on a
99 // bogus update. Note that if instead we updated the nodes[0]'s ChainMonitor
100 // directly, the node would fail to be `Drop`'d at the end because its
101 // ChannelManager and ChainMonitor would be out of sync.
102 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
103 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
104 let persister = test_utils::TestPersister::new();
105 let tx_broadcaster = TestBroadcaster {
106 txn_broadcasted: Mutex::new(Vec::new()),
107 // Because we will connect a block at height 200 below, we need the TestBroadcaster to know
108 // that we are at height 200 so that it doesn't think we're violating the time lock
109 // requirements of transactions broadcasted at that point.
110 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 200); 200])),
114 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
115 let new_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
116 &mut io::Cursor::new(&monitor.encode()), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
117 assert!(new_monitor == *monitor);
120 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
121 assert_eq!(chain_mon.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
124 let header = BlockHeader {
126 prev_blockhash: BlockHash::all_zeros(),
127 merkle_root: TxMerkleNode::all_zeros(),
132 chain_mon.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
134 // Set the persister's return value to be a InProgress.
135 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
137 // Try to update ChannelMonitor
138 nodes[1].node.claim_funds(preimage);
139 expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
140 check_added_monitors!(nodes[1], 1);
142 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
143 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
144 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
146 let mut node_0_per_peer_lock;
147 let mut node_0_peer_state_lock;
148 let mut channel = get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan.2);
149 if let Ok(update) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
150 // Check that even though the persister is returning a InProgress,
151 // because the update is bogus, ultimately the error that's returned
152 // should be a PermanentFailure.
153 if let ChannelMonitorUpdateStatus::PermanentFailure = chain_mon.chain_monitor.update_channel(outpoint, &update) {} else { panic!("Expected monitor error to be permanent"); }
154 logger.assert_log_regex("lightning::chain::chainmonitor", regex::Regex::new("Persistence of ChannelMonitorUpdate for channel [0-9a-f]* in progress").unwrap(), 1);
155 assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::Completed);
156 } else { assert!(false); }
159 check_added_monitors!(nodes[0], 1);
160 let events = nodes[0].node.get_and_clear_pending_events();
161 assert_eq!(events.len(), 1);
164 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
165 // Test that we can recover from a simple temporary monitor update failure optionally with
166 // a disconnect in between
167 let chanmon_cfgs = create_chanmon_cfgs(2);
168 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
169 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
170 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
171 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
173 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
175 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
178 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_1,
179 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)
180 ), false, APIError::MonitorUpdateInProgress, {});
181 check_added_monitors!(nodes[0], 1);
184 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
185 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
186 assert_eq!(nodes[0].node.list_channels().len(), 1);
189 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
190 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
191 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
194 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
195 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
196 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
197 check_added_monitors!(nodes[0], 0);
199 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
200 assert_eq!(events_2.len(), 1);
201 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
202 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
203 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
204 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
206 expect_pending_htlcs_forwardable!(nodes[1]);
208 let events_3 = nodes[1].node.get_and_clear_pending_events();
209 assert_eq!(events_3.len(), 1);
211 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
212 assert_eq!(payment_hash_1, *payment_hash);
213 assert_eq!(amount_msat, 1_000_000);
214 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
215 assert_eq!(via_channel_id, Some(channel_id));
217 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
218 assert!(payment_preimage.is_none());
219 assert_eq!(payment_secret_1, *payment_secret);
221 _ => panic!("expected PaymentPurpose::InvoicePayment")
224 _ => panic!("Unexpected event"),
227 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
229 // Now set it to failed again...
230 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
232 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
233 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_2,
234 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)
235 ), false, APIError::MonitorUpdateInProgress, {});
236 check_added_monitors!(nodes[0], 1);
239 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
240 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
241 assert_eq!(nodes[0].node.list_channels().len(), 1);
244 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
245 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
246 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
249 // ...and make sure we can force-close a frozen channel
250 nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
251 check_added_monitors!(nodes[0], 1);
252 check_closed_broadcast!(nodes[0], true);
254 // TODO: Once we hit the chain with the failure transaction we should check that we get a
255 // PaymentPathFailed event
257 assert_eq!(nodes[0].node.list_channels().len(), 0);
258 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
262 fn test_simple_monitor_temporary_update_fail() {
263 do_test_simple_monitor_temporary_update_fail(false);
264 do_test_simple_monitor_temporary_update_fail(true);
267 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
268 let disconnect_flags = 8 | 16;
270 // Test that we can recover from a temporary monitor update failure with some in-flight
271 // HTLCs going on at the same time potentially with some disconnection thrown in.
272 // * First we route a payment, then get a temporary monitor update failure when trying to
273 // route a second payment. We then claim the first payment.
274 // * If disconnect_count is set, we will disconnect at this point (which is likely as
275 // InProgress likely indicates net disconnect which resulted in failing to update the
276 // ChannelMonitor on a watchtower).
277 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
278 // immediately, otherwise we wait disconnect and deliver them via the reconnect
279 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
280 // disconnect_count & !disconnect_flags is 0).
281 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
282 // through message sending, potentially disconnect/reconnecting multiple times based on
283 // disconnect_count, to get the update_fulfill_htlc through.
284 // * We then walk through more message exchanges to get the original update_add_htlc
285 // through, swapping message ordering based on disconnect_count & 8 and optionally
286 // disconnect/reconnecting based on disconnect_count.
287 let chanmon_cfgs = create_chanmon_cfgs(2);
288 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
289 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
290 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
291 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
293 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
295 // Now try to send a second payment which will fail to send
296 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
298 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
299 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash_2,
300 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)
301 ), false, APIError::MonitorUpdateInProgress, {});
302 check_added_monitors!(nodes[0], 1);
305 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
306 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
307 assert_eq!(nodes[0].node.list_channels().len(), 1);
309 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
310 // but nodes[0] won't respond since it is frozen.
311 nodes[1].node.claim_funds(payment_preimage_1);
312 check_added_monitors!(nodes[1], 1);
313 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
315 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
316 assert_eq!(events_2.len(), 1);
317 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
318 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 } } => {
319 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
320 assert!(update_add_htlcs.is_empty());
321 assert_eq!(update_fulfill_htlcs.len(), 1);
322 assert!(update_fail_htlcs.is_empty());
323 assert!(update_fail_malformed_htlcs.is_empty());
324 assert!(update_fee.is_none());
326 if (disconnect_count & 16) == 0 {
327 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
328 let events_3 = nodes[0].node.get_and_clear_pending_events();
329 assert_eq!(events_3.len(), 1);
331 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
332 assert_eq!(*payment_preimage, payment_preimage_1);
333 assert_eq!(*payment_hash, payment_hash_1);
335 _ => panic!("Unexpected event"),
338 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
339 check_added_monitors!(nodes[0], 1);
340 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
343 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
345 _ => panic!("Unexpected event"),
348 if disconnect_count & !disconnect_flags > 0 {
349 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
350 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
353 // Now fix monitor updating...
354 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
355 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
356 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
357 check_added_monitors!(nodes[0], 0);
359 macro_rules! disconnect_reconnect_peers { () => { {
360 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
361 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
363 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
364 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
365 assert_eq!(reestablish_1.len(), 1);
366 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
367 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
368 assert_eq!(reestablish_2.len(), 1);
370 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
371 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
372 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
373 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
375 assert!(as_resp.0.is_none());
376 assert!(bs_resp.0.is_none());
378 (reestablish_1, reestablish_2, as_resp, bs_resp)
381 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
382 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
383 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
385 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
386 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
387 assert_eq!(reestablish_1.len(), 1);
388 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
389 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
390 assert_eq!(reestablish_2.len(), 1);
392 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
393 check_added_monitors!(nodes[0], 0);
394 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
395 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
396 check_added_monitors!(nodes[1], 0);
397 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
399 assert!(as_resp.0.is_none());
400 assert!(bs_resp.0.is_none());
402 assert!(bs_resp.1.is_none());
403 if (disconnect_count & 16) == 0 {
404 assert!(bs_resp.2.is_none());
406 assert!(as_resp.1.is_some());
407 assert!(as_resp.2.is_some());
408 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
410 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
411 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
412 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
413 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
414 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
415 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
417 assert!(as_resp.1.is_none());
419 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
420 let events_3 = nodes[0].node.get_and_clear_pending_events();
421 assert_eq!(events_3.len(), 1);
423 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
424 assert_eq!(*payment_preimage, payment_preimage_1);
425 assert_eq!(*payment_hash, payment_hash_1);
427 _ => panic!("Unexpected event"),
430 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
431 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
432 // No commitment_signed so get_event_msg's assert(len == 1) passes
433 check_added_monitors!(nodes[0], 1);
435 as_resp.1 = Some(as_resp_raa);
439 if disconnect_count & !disconnect_flags > 1 {
440 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
442 if (disconnect_count & 16) == 0 {
443 assert!(reestablish_1 == second_reestablish_1);
444 assert!(reestablish_2 == second_reestablish_2);
446 assert!(as_resp == second_as_resp);
447 assert!(bs_resp == second_bs_resp);
450 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
452 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
453 assert_eq!(events_4.len(), 2);
454 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
455 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
456 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
459 _ => panic!("Unexpected event"),
463 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
465 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
466 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
467 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
468 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
469 check_added_monitors!(nodes[1], 1);
471 if disconnect_count & !disconnect_flags > 2 {
472 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
474 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
475 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
477 assert!(as_resp.2.is_none());
478 assert!(bs_resp.2.is_none());
481 let as_commitment_update;
482 let bs_second_commitment_update;
484 macro_rules! handle_bs_raa { () => {
485 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
486 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
487 assert!(as_commitment_update.update_add_htlcs.is_empty());
488 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
489 assert!(as_commitment_update.update_fail_htlcs.is_empty());
490 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
491 assert!(as_commitment_update.update_fee.is_none());
492 check_added_monitors!(nodes[0], 1);
495 macro_rules! handle_initial_raa { () => {
496 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
497 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
498 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
499 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
500 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
501 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
502 assert!(bs_second_commitment_update.update_fee.is_none());
503 check_added_monitors!(nodes[1], 1);
506 if (disconnect_count & 8) == 0 {
509 if disconnect_count & !disconnect_flags > 3 {
510 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
512 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
513 assert!(bs_resp.1.is_none());
515 assert!(as_resp.2.unwrap() == as_commitment_update);
516 assert!(bs_resp.2.is_none());
518 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
521 handle_initial_raa!();
523 if disconnect_count & !disconnect_flags > 4 {
524 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
526 assert!(as_resp.1.is_none());
527 assert!(bs_resp.1.is_none());
529 assert!(as_resp.2.unwrap() == as_commitment_update);
530 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
533 handle_initial_raa!();
535 if disconnect_count & !disconnect_flags > 3 {
536 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
538 assert!(as_resp.1.is_none());
539 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
541 assert!(as_resp.2.is_none());
542 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
544 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
549 if disconnect_count & !disconnect_flags > 4 {
550 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
552 assert!(as_resp.1.is_none());
553 assert!(bs_resp.1.is_none());
555 assert!(as_resp.2.unwrap() == as_commitment_update);
556 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
560 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
561 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
562 // No commitment_signed so get_event_msg's assert(len == 1) passes
563 check_added_monitors!(nodes[0], 1);
565 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
566 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
567 // No commitment_signed so get_event_msg's assert(len == 1) passes
568 check_added_monitors!(nodes[1], 1);
570 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
571 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
572 check_added_monitors!(nodes[1], 1);
574 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
575 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
576 check_added_monitors!(nodes[0], 1);
577 expect_payment_path_successful!(nodes[0]);
579 expect_pending_htlcs_forwardable!(nodes[1]);
581 let events_5 = nodes[1].node.get_and_clear_pending_events();
582 assert_eq!(events_5.len(), 1);
584 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
585 assert_eq!(payment_hash_2, *payment_hash);
586 assert_eq!(amount_msat, 1_000_000);
587 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
588 assert_eq!(via_channel_id, Some(channel_id));
590 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
591 assert!(payment_preimage.is_none());
592 assert_eq!(payment_secret_2, *payment_secret);
594 _ => panic!("expected PaymentPurpose::InvoicePayment")
597 _ => panic!("Unexpected event"),
600 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
604 fn test_monitor_temporary_update_fail_a() {
605 do_test_monitor_temporary_update_fail(0);
606 do_test_monitor_temporary_update_fail(1);
607 do_test_monitor_temporary_update_fail(2);
608 do_test_monitor_temporary_update_fail(3);
609 do_test_monitor_temporary_update_fail(4);
610 do_test_monitor_temporary_update_fail(5);
614 fn test_monitor_temporary_update_fail_b() {
615 do_test_monitor_temporary_update_fail(2 | 8);
616 do_test_monitor_temporary_update_fail(3 | 8);
617 do_test_monitor_temporary_update_fail(4 | 8);
618 do_test_monitor_temporary_update_fail(5 | 8);
622 fn test_monitor_temporary_update_fail_c() {
623 do_test_monitor_temporary_update_fail(1 | 16);
624 do_test_monitor_temporary_update_fail(2 | 16);
625 do_test_monitor_temporary_update_fail(3 | 16);
626 do_test_monitor_temporary_update_fail(2 | 8 | 16);
627 do_test_monitor_temporary_update_fail(3 | 8 | 16);
631 fn test_monitor_update_fail_cs() {
632 // Tests handling of a monitor update failure when processing an incoming commitment_signed
633 let chanmon_cfgs = create_chanmon_cfgs(2);
634 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
635 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
636 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
637 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
639 let (route, our_payment_hash, payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
641 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
642 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
643 check_added_monitors!(nodes[0], 1);
646 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
647 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
649 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
650 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
651 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
652 check_added_monitors!(nodes[1], 1);
653 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
655 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
656 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
657 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
658 check_added_monitors!(nodes[1], 0);
659 let responses = nodes[1].node.get_and_clear_pending_msg_events();
660 assert_eq!(responses.len(), 2);
663 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
664 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
665 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
666 check_added_monitors!(nodes[0], 1);
668 _ => panic!("Unexpected event"),
671 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
672 assert!(updates.update_add_htlcs.is_empty());
673 assert!(updates.update_fulfill_htlcs.is_empty());
674 assert!(updates.update_fail_htlcs.is_empty());
675 assert!(updates.update_fail_malformed_htlcs.is_empty());
676 assert!(updates.update_fee.is_none());
677 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
679 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
680 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
681 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
682 check_added_monitors!(nodes[0], 1);
683 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
685 _ => panic!("Unexpected event"),
688 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
689 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
690 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
691 check_added_monitors!(nodes[0], 0);
693 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
694 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
695 check_added_monitors!(nodes[1], 1);
697 expect_pending_htlcs_forwardable!(nodes[1]);
699 let events = nodes[1].node.get_and_clear_pending_events();
700 assert_eq!(events.len(), 1);
702 Event::PaymentClaimable { payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
703 assert_eq!(payment_hash, our_payment_hash);
704 assert_eq!(amount_msat, 1_000_000);
705 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
706 assert_eq!(via_channel_id, Some(channel_id));
708 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
709 assert!(payment_preimage.is_none());
710 assert_eq!(our_payment_secret, *payment_secret);
712 _ => panic!("expected PaymentPurpose::InvoicePayment")
715 _ => panic!("Unexpected event"),
718 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
722 fn test_monitor_update_fail_no_rebroadcast() {
723 // Tests handling of a monitor update failure when no message rebroadcasting on
724 // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
726 let chanmon_cfgs = create_chanmon_cfgs(2);
727 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
728 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
729 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
730 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
732 let (route, our_payment_hash, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
734 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
735 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(our_payment_hash.0)).unwrap();
736 check_added_monitors!(nodes[0], 1);
739 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
740 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
741 let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
743 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
744 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
745 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
746 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
747 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
748 check_added_monitors!(nodes[1], 1);
750 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
751 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
752 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
753 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
754 check_added_monitors!(nodes[1], 0);
755 expect_pending_htlcs_forwardable!(nodes[1]);
757 let events = nodes[1].node.get_and_clear_pending_events();
758 assert_eq!(events.len(), 1);
760 Event::PaymentClaimable { payment_hash, .. } => {
761 assert_eq!(payment_hash, our_payment_hash);
763 _ => panic!("Unexpected event"),
766 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
770 fn test_monitor_update_raa_while_paused() {
771 // Tests handling of an RAA while monitor updating has already been marked failed.
772 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
773 let chanmon_cfgs = create_chanmon_cfgs(2);
774 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
775 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
776 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
777 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
779 send_payment(&nodes[0], &[&nodes[1]], 5000000);
780 let (route, our_payment_hash_1, payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
782 nodes[0].node.send_payment_with_route(&route, our_payment_hash_1,
783 RecipientOnionFields::secret_only(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
784 check_added_monitors!(nodes[0], 1);
786 let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
788 let (route, our_payment_hash_2, payment_preimage_2, our_payment_secret_2) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000000);
790 nodes[1].node.send_payment_with_route(&route, our_payment_hash_2,
791 RecipientOnionFields::secret_only(our_payment_secret_2), PaymentId(our_payment_hash_2.0)).unwrap();
792 check_added_monitors!(nodes[1], 1);
794 let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
796 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
797 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
798 check_added_monitors!(nodes[1], 1);
799 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
801 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
802 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
803 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
804 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
805 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
806 check_added_monitors!(nodes[0], 1);
807 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
809 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
810 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
811 check_added_monitors!(nodes[0], 1);
813 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
814 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
815 check_added_monitors!(nodes[0], 0);
817 let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
818 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
819 check_added_monitors!(nodes[1], 1);
820 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
822 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
823 check_added_monitors!(nodes[1], 1);
824 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
826 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
827 check_added_monitors!(nodes[0], 1);
828 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
830 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
831 check_added_monitors!(nodes[0], 1);
832 expect_pending_htlcs_forwardable!(nodes[0]);
833 expect_payment_claimable!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
835 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
836 check_added_monitors!(nodes[1], 1);
837 expect_pending_htlcs_forwardable!(nodes[1]);
838 expect_payment_claimable!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
840 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
841 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
844 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
845 // Tests handling of a monitor update failure when processing an incoming RAA
846 let chanmon_cfgs = create_chanmon_cfgs(3);
847 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
848 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
849 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
850 create_announced_chan_between_nodes(&nodes, 0, 1);
851 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
853 // Rebalance a bit so that we can send backwards from 2 to 1.
854 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
856 // Route a first payment that we'll fail backwards
857 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
859 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
860 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
861 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
862 check_added_monitors!(nodes[2], 1);
864 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
865 assert!(updates.update_add_htlcs.is_empty());
866 assert!(updates.update_fulfill_htlcs.is_empty());
867 assert_eq!(updates.update_fail_htlcs.len(), 1);
868 assert!(updates.update_fail_malformed_htlcs.is_empty());
869 assert!(updates.update_fee.is_none());
870 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
872 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
873 check_added_monitors!(nodes[0], 0);
875 // While the second channel is AwaitingRAA, forward a second payment to get it into the
877 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
879 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
880 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
881 check_added_monitors!(nodes[0], 1);
884 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
885 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
886 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
888 expect_pending_htlcs_forwardable!(nodes[1]);
889 check_added_monitors!(nodes[1], 0);
890 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
892 // Now fail monitor updating.
893 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
894 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
895 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
896 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
897 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
898 check_added_monitors!(nodes[1], 1);
900 // Forward a third payment which will also be added to the holding cell, despite the channel
901 // being paused waiting a monitor update.
902 let (route, payment_hash_3, _, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
904 nodes[0].node.send_payment_with_route(&route, payment_hash_3,
905 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
906 check_added_monitors!(nodes[0], 1);
909 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed); // We succeed in updating the monitor for the first channel
910 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
911 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
912 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
913 check_added_monitors!(nodes[1], 0);
915 // Call forward_pending_htlcs and check that the new HTLC was simply added to the holding cell
916 // and not forwarded.
917 expect_pending_htlcs_forwardable!(nodes[1]);
918 check_added_monitors!(nodes[1], 0);
919 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
921 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
922 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
923 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
924 nodes[2].node.send_payment_with_route(&route, payment_hash_4,
925 RecipientOnionFields::secret_only(payment_secret_4), PaymentId(payment_hash_4.0)).unwrap();
926 check_added_monitors!(nodes[2], 1);
928 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
929 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
930 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
931 check_added_monitors!(nodes[1], 1);
932 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
933 (Some(payment_preimage_4), Some(payment_hash_4))
934 } else { (None, None) };
936 // Restore monitor updating, ensuring we immediately get a fail-back update and a
937 // update_add update.
938 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
939 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
940 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
941 check_added_monitors!(nodes[1], 0);
942 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 }]);
943 check_added_monitors!(nodes[1], 1);
945 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
946 if test_ignore_second_cs {
947 assert_eq!(events_3.len(), 3);
949 assert_eq!(events_3.len(), 2);
952 // Note that the ordering of the events for different nodes is non-prescriptive, though the
953 // ordering of the two events that both go to nodes[2] have to stay in the same order.
954 let nodes_0_event = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &mut events_3);
955 let messages_a = match nodes_0_event {
956 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
957 assert_eq!(node_id, nodes[0].node.get_our_node_id());
958 assert!(updates.update_fulfill_htlcs.is_empty());
959 assert_eq!(updates.update_fail_htlcs.len(), 1);
960 assert!(updates.update_fail_malformed_htlcs.is_empty());
961 assert!(updates.update_add_htlcs.is_empty());
962 assert!(updates.update_fee.is_none());
963 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
965 _ => panic!("Unexpected event type!"),
968 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events_3);
969 let send_event_b = SendEvent::from_event(nodes_2_event);
970 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
972 let raa = if test_ignore_second_cs {
973 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events_3);
974 match nodes_2_event {
975 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
976 assert_eq!(node_id, nodes[2].node.get_our_node_id());
979 _ => panic!("Unexpected event"),
983 // Now deliver the new messages...
985 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
986 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
987 expect_payment_failed!(nodes[0], payment_hash_1, true);
989 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
991 if test_ignore_second_cs {
992 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
993 check_added_monitors!(nodes[2], 1);
994 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
995 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
996 check_added_monitors!(nodes[2], 1);
997 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
998 assert!(bs_cs.update_add_htlcs.is_empty());
999 assert!(bs_cs.update_fail_htlcs.is_empty());
1000 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
1001 assert!(bs_cs.update_fulfill_htlcs.is_empty());
1002 assert!(bs_cs.update_fee.is_none());
1004 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1005 check_added_monitors!(nodes[1], 1);
1006 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1008 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
1009 check_added_monitors!(nodes[1], 1);
1011 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
1012 check_added_monitors!(nodes[2], 1);
1014 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
1015 // As both messages are for nodes[1], they're in order.
1016 assert_eq!(bs_revoke_and_commit.len(), 2);
1017 match bs_revoke_and_commit[0] {
1018 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1019 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1020 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
1021 check_added_monitors!(nodes[1], 1);
1023 _ => panic!("Unexpected event"),
1026 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1028 match bs_revoke_and_commit[1] {
1029 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1030 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1031 assert!(updates.update_add_htlcs.is_empty());
1032 assert!(updates.update_fail_htlcs.is_empty());
1033 assert!(updates.update_fail_malformed_htlcs.is_empty());
1034 assert!(updates.update_fulfill_htlcs.is_empty());
1035 assert!(updates.update_fee.is_none());
1036 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1037 check_added_monitors!(nodes[1], 1);
1039 _ => panic!("Unexpected event"),
1043 assert_eq!(as_cs.update_add_htlcs.len(), 1);
1044 assert!(as_cs.update_fail_htlcs.is_empty());
1045 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1046 assert!(as_cs.update_fulfill_htlcs.is_empty());
1047 assert!(as_cs.update_fee.is_none());
1048 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1051 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1052 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1053 check_added_monitors!(nodes[2], 1);
1054 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1056 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1057 check_added_monitors!(nodes[2], 1);
1058 let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1060 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1061 check_added_monitors!(nodes[1], 1);
1062 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1064 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1065 check_added_monitors!(nodes[1], 1);
1066 let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1068 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1069 check_added_monitors!(nodes[2], 1);
1070 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1072 expect_pending_htlcs_forwardable!(nodes[2]);
1074 let events_6 = nodes[2].node.get_and_clear_pending_events();
1075 assert_eq!(events_6.len(), 2);
1077 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1078 _ => panic!("Unexpected event"),
1081 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1082 _ => panic!("Unexpected event"),
1085 if test_ignore_second_cs {
1086 expect_pending_htlcs_forwardable!(nodes[1]);
1087 check_added_monitors!(nodes[1], 1);
1089 send_event = SendEvent::from_node(&nodes[1]);
1090 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1091 assert_eq!(send_event.msgs.len(), 1);
1092 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1093 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1095 expect_pending_htlcs_forwardable!(nodes[0]);
1097 let events_9 = nodes[0].node.get_and_clear_pending_events();
1098 assert_eq!(events_9.len(), 1);
1100 Event::PaymentClaimable { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1101 _ => panic!("Unexpected event"),
1103 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1106 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1110 fn test_monitor_update_fail_raa() {
1111 do_test_monitor_update_fail_raa(false);
1112 do_test_monitor_update_fail_raa(true);
1116 fn test_monitor_update_fail_reestablish() {
1117 // Simple test for message retransmission after monitor update failure on
1118 // channel_reestablish generating a monitor update (which comes from freeing holding cell
1120 let chanmon_cfgs = create_chanmon_cfgs(3);
1121 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1122 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1123 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1124 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1125 create_announced_chan_between_nodes(&nodes, 1, 2);
1127 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
1129 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1130 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1132 nodes[2].node.claim_funds(payment_preimage);
1133 check_added_monitors!(nodes[2], 1);
1134 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
1136 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1137 assert!(updates.update_add_htlcs.is_empty());
1138 assert!(updates.update_fail_htlcs.is_empty());
1139 assert!(updates.update_fail_malformed_htlcs.is_empty());
1140 assert!(updates.update_fee.is_none());
1141 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1142 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1143 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
1144 check_added_monitors!(nodes[1], 1);
1145 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1146 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1148 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1149 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
1150 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
1152 let as_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1153 let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1155 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1157 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1159 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1160 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1162 nodes[1].node.get_and_clear_pending_msg_events(); // Free the holding cell
1163 check_added_monitors!(nodes[1], 1);
1165 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1166 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1168 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
1169 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
1171 assert_eq!(get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap(), as_reestablish);
1172 assert_eq!(get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap(), bs_reestablish);
1174 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1176 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1177 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1179 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1180 check_added_monitors!(nodes[1], 0);
1182 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1183 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1185 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1186 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1187 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1188 check_added_monitors!(nodes[1], 0);
1190 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1191 assert!(updates.update_add_htlcs.is_empty());
1192 assert!(updates.update_fail_htlcs.is_empty());
1193 assert!(updates.update_fail_malformed_htlcs.is_empty());
1194 assert!(updates.update_fee.is_none());
1195 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1196 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1197 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1198 expect_payment_sent!(nodes[0], payment_preimage);
1202 fn raa_no_response_awaiting_raa_state() {
1203 // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1204 // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1205 // in question (assuming it intends to respond with a CS after monitor updating is restored).
1206 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1207 let chanmon_cfgs = create_chanmon_cfgs(2);
1208 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1209 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1210 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1211 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1213 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1214 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1215 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1217 // Queue up two payments - one will be delivered right away, one immediately goes into the
1218 // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1219 // immediately after a CS. By setting failing the monitor update failure from the CS (which
1220 // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1221 // generation during RAA while in monitor-update-failed state.
1223 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1224 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1225 check_added_monitors!(nodes[0], 1);
1226 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1227 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1228 check_added_monitors!(nodes[0], 0);
1231 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1232 assert_eq!(events.len(), 1);
1233 let payment_event = SendEvent::from_event(events.pop().unwrap());
1234 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1235 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1236 check_added_monitors!(nodes[1], 1);
1238 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1239 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1240 check_added_monitors!(nodes[0], 1);
1241 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1242 assert_eq!(events.len(), 1);
1243 let payment_event = SendEvent::from_event(events.pop().unwrap());
1245 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1246 check_added_monitors!(nodes[0], 1);
1247 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1249 // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1250 // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1251 // then restore channel monitor updates.
1252 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1253 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1254 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1255 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1256 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1257 check_added_monitors!(nodes[1], 1);
1258 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1260 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1261 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1262 check_added_monitors!(nodes[1], 1);
1264 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1265 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1266 // nodes[1] should be AwaitingRAA here!
1267 check_added_monitors!(nodes[1], 0);
1268 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1269 expect_pending_htlcs_forwardable!(nodes[1]);
1270 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1272 // We send a third payment here, which is somewhat of a redundant test, but the
1273 // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1274 // commitment transaction states) whereas here we can explicitly check for it.
1276 nodes[0].node.send_payment_with_route(&route, payment_hash_3,
1277 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1278 check_added_monitors!(nodes[0], 0);
1279 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1281 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1282 check_added_monitors!(nodes[0], 1);
1283 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1284 assert_eq!(events.len(), 1);
1285 let payment_event = SendEvent::from_event(events.pop().unwrap());
1287 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1288 check_added_monitors!(nodes[0], 1);
1289 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1291 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1292 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1293 check_added_monitors!(nodes[1], 1);
1294 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1296 // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1297 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1298 check_added_monitors!(nodes[1], 1);
1299 expect_pending_htlcs_forwardable!(nodes[1]);
1300 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1301 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1303 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1304 check_added_monitors!(nodes[0], 1);
1306 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1307 check_added_monitors!(nodes[0], 1);
1308 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1310 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1311 check_added_monitors!(nodes[1], 1);
1312 expect_pending_htlcs_forwardable!(nodes[1]);
1313 expect_payment_claimable!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1315 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1316 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1317 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1321 fn claim_while_disconnected_monitor_update_fail() {
1322 // Test for claiming a payment while disconnected and then having the resulting
1323 // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1324 // contrived case for nodes with network instability.
1325 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1326 // code introduced a regression in this test (specifically, this caught a removal of the
1327 // channel_reestablish handling ensuring the order was sensical given the messages used).
1328 let chanmon_cfgs = create_chanmon_cfgs(2);
1329 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1330 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1331 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1332 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1334 // Forward a payment for B to claim
1335 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1337 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1338 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1340 nodes[1].node.claim_funds(payment_preimage_1);
1341 check_added_monitors!(nodes[1], 1);
1342 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1344 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
1345 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
1347 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1348 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1350 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1351 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1353 // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1355 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1357 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1358 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1359 check_added_monitors!(nodes[1], 1);
1360 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1362 // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1363 // the monitor still failed
1364 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1366 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1367 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1368 check_added_monitors!(nodes[0], 1);
1371 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1372 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1373 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1374 check_added_monitors!(nodes[1], 1);
1375 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1376 // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1377 // until we've channel_monitor_update'd and updated for the new commitment transaction.
1379 // Now un-fail the monitor, which will result in B sending its original commitment update,
1380 // receiving the commitment update from A, and the resulting commitment dances.
1381 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1382 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1383 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1384 check_added_monitors!(nodes[1], 0);
1386 let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1387 assert_eq!(bs_msgs.len(), 2);
1390 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1391 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1392 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1393 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1394 check_added_monitors!(nodes[0], 1);
1396 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1397 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1398 check_added_monitors!(nodes[1], 1);
1400 _ => panic!("Unexpected event"),
1404 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1405 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1406 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1407 check_added_monitors!(nodes[0], 1);
1409 _ => panic!("Unexpected event"),
1412 let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1414 let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1415 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1416 check_added_monitors!(nodes[0], 1);
1417 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1419 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1420 check_added_monitors!(nodes[1], 1);
1421 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1422 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1423 check_added_monitors!(nodes[1], 1);
1425 expect_pending_htlcs_forwardable!(nodes[1]);
1426 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1428 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1429 check_added_monitors!(nodes[0], 1);
1430 expect_payment_sent!(nodes[0], payment_preimage_1);
1432 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1436 fn monitor_failed_no_reestablish_response() {
1437 // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1438 // response to a commitment_signed.
1439 // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1440 // debug_assert!() failure in channel_reestablish handling.
1441 let chanmon_cfgs = create_chanmon_cfgs(2);
1442 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1443 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1444 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1445 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1447 let mut node_0_per_peer_lock;
1448 let mut node_0_peer_state_lock;
1449 get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, channel_id).announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1452 let mut node_1_per_peer_lock;
1453 let mut node_1_peer_state_lock;
1454 get_channel_ref!(nodes[1], nodes[0], node_1_per_peer_lock, node_1_peer_state_lock, channel_id).announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1457 // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1459 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1461 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1462 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1463 check_added_monitors!(nodes[0], 1);
1466 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1467 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1468 assert_eq!(events.len(), 1);
1469 let payment_event = SendEvent::from_event(events.pop().unwrap());
1470 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1471 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1472 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1473 check_added_monitors!(nodes[1], 1);
1475 // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1476 // is still failing to update monitors.
1477 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1478 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1480 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
1481 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
1483 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1484 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1486 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1487 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1488 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1489 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1491 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1492 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1493 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1494 check_added_monitors!(nodes[1], 0);
1495 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1497 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1498 check_added_monitors!(nodes[0], 1);
1499 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1500 check_added_monitors!(nodes[0], 1);
1502 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1503 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1504 check_added_monitors!(nodes[1], 1);
1506 expect_pending_htlcs_forwardable!(nodes[1]);
1507 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1509 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1513 fn first_message_on_recv_ordering() {
1514 // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1515 // messages, we're willing to flip the order of response messages if neccessary in resposne to
1516 // a commitment_signed which needs to send an RAA first.
1517 // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1518 // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1519 // response. To do this, we start routing two payments, with the final RAA for the first being
1520 // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1521 // have no pending response but will want to send a RAA/CS (with the updates for the second
1522 // payment applied).
1523 // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1524 let chanmon_cfgs = create_chanmon_cfgs(2);
1525 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1526 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1527 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1528 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1530 // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1531 // can deliver it and fail the monitor update.
1532 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1534 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1535 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1536 check_added_monitors!(nodes[0], 1);
1539 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1540 assert_eq!(events.len(), 1);
1541 let payment_event = SendEvent::from_event(events.pop().unwrap());
1542 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1543 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1544 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1545 check_added_monitors!(nodes[1], 1);
1546 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1548 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1549 check_added_monitors!(nodes[0], 1);
1550 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1551 check_added_monitors!(nodes[0], 1);
1553 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1555 // Route the second payment, generating an update_add_htlc/commitment_signed
1556 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1558 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1559 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1560 check_added_monitors!(nodes[0], 1);
1562 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1563 assert_eq!(events.len(), 1);
1564 let payment_event = SendEvent::from_event(events.pop().unwrap());
1565 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1567 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1569 // Deliver the final RAA for the first payment, which does not require a response. RAAs
1570 // generally require a commitment_signed, so the fact that we're expecting an opposite response
1571 // to the next message also tests resetting the delivery order.
1572 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1573 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1574 check_added_monitors!(nodes[1], 1);
1576 // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1577 // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1578 // appropriate HTLC acceptance).
1579 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1580 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1581 check_added_monitors!(nodes[1], 1);
1582 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1584 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1585 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1586 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1587 check_added_monitors!(nodes[1], 0);
1589 expect_pending_htlcs_forwardable!(nodes[1]);
1590 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1592 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1593 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1594 check_added_monitors!(nodes[0], 1);
1595 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1596 check_added_monitors!(nodes[0], 1);
1598 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1599 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1600 check_added_monitors!(nodes[1], 1);
1602 expect_pending_htlcs_forwardable!(nodes[1]);
1603 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1605 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1606 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1610 fn test_monitor_update_fail_claim() {
1611 // Basic test for monitor update failures when processing claim_funds calls.
1612 // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1613 // update to claim the payment. We then send two payments C->B->A, which are held at B.
1614 // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1615 // the payments from C onwards to A.
1616 let chanmon_cfgs = create_chanmon_cfgs(3);
1617 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1618 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1619 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1620 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1621 create_announced_chan_between_nodes(&nodes, 1, 2);
1623 // Rebalance a bit so that we can send backwards from 3 to 2.
1624 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1626 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1628 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1629 nodes[1].node.claim_funds(payment_preimage_1);
1630 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1631 check_added_monitors!(nodes[1], 1);
1633 // Note that at this point there is a pending commitment transaction update for A being held by
1634 // B. Even when we go to send the payment from C through B to A, B will not update this
1635 // already-signed commitment transaction and will instead wait for it to resolve before
1636 // forwarding the payment onwards.
1638 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1_000_000);
1640 nodes[2].node.send_payment_with_route(&route, payment_hash_2,
1641 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1642 check_added_monitors!(nodes[2], 1);
1645 // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1646 // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1647 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1649 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1650 assert_eq!(events.len(), 1);
1651 let payment_event = SendEvent::from_event(events.pop().unwrap());
1652 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1653 let events = nodes[1].node.get_and_clear_pending_msg_events();
1654 assert_eq!(events.len(), 0);
1655 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1656 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1658 let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1659 nodes[2].node.send_payment_with_route(&route, payment_hash_3,
1660 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1661 check_added_monitors!(nodes[2], 1);
1663 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1664 assert_eq!(events.len(), 1);
1665 let payment_event = SendEvent::from_event(events.pop().unwrap());
1666 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1667 let events = nodes[1].node.get_and_clear_pending_msg_events();
1668 assert_eq!(events.len(), 0);
1669 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1671 // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1672 let channel_id = chan_1.2;
1673 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1674 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1675 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1676 check_added_monitors!(nodes[1], 0);
1678 let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1679 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1680 commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1681 expect_payment_sent!(nodes[0], payment_preimage_1);
1683 // Get the payment forwards, note that they were batched into one commitment update.
1684 nodes[1].node.process_pending_htlc_forwards();
1685 check_added_monitors!(nodes[1], 1);
1686 let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1687 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1688 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1689 commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1690 expect_pending_htlcs_forwardable!(nodes[0]);
1692 let events = nodes[0].node.get_and_clear_pending_events();
1693 assert_eq!(events.len(), 2);
1695 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id, .. } => {
1696 assert_eq!(payment_hash_2, *payment_hash);
1697 assert_eq!(1_000_000, amount_msat);
1698 assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1699 assert_eq!(via_channel_id, Some(channel_id));
1700 assert_eq!(via_user_channel_id, Some(42));
1702 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1703 assert!(payment_preimage.is_none());
1704 assert_eq!(payment_secret_2, *payment_secret);
1706 _ => panic!("expected PaymentPurpose::InvoicePayment")
1709 _ => panic!("Unexpected event"),
1712 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
1713 assert_eq!(payment_hash_3, *payment_hash);
1714 assert_eq!(1_000_000, amount_msat);
1715 assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1716 assert_eq!(via_channel_id, Some(channel_id));
1718 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1719 assert!(payment_preimage.is_none());
1720 assert_eq!(payment_secret_3, *payment_secret);
1722 _ => panic!("expected PaymentPurpose::InvoicePayment")
1725 _ => panic!("Unexpected event"),
1730 fn test_monitor_update_on_pending_forwards() {
1731 // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1732 // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1733 // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1734 // from C to A will be pending a forward to A.
1735 let chanmon_cfgs = create_chanmon_cfgs(3);
1736 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1737 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1738 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1739 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1740 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1742 // Rebalance a bit so that we can send backwards from 3 to 1.
1743 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1745 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1746 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
1747 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
1748 check_added_monitors!(nodes[2], 1);
1750 let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1751 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1752 commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1753 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1755 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
1757 nodes[2].node.send_payment_with_route(&route, payment_hash_2,
1758 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1759 check_added_monitors!(nodes[2], 1);
1762 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1763 assert_eq!(events.len(), 1);
1764 let payment_event = SendEvent::from_event(events.pop().unwrap());
1765 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1766 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1768 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1769 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 }]);
1770 check_added_monitors!(nodes[1], 1);
1772 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1773 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1774 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1775 check_added_monitors!(nodes[1], 0);
1777 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1778 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1779 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1780 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1782 let events = nodes[0].node.get_and_clear_pending_events();
1783 assert_eq!(events.len(), 3);
1784 if let Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } = events[1] {
1785 assert_eq!(payment_hash, payment_hash_1);
1786 assert!(payment_failed_permanently);
1787 } else { panic!("Unexpected event!"); }
1789 Event::PaymentFailed { payment_hash, .. } => {
1790 assert_eq!(payment_hash, payment_hash_1);
1792 _ => panic!("Unexpected event"),
1795 Event::PendingHTLCsForwardable { .. } => { },
1796 _ => panic!("Unexpected event"),
1798 nodes[0].node.process_pending_htlc_forwards();
1799 expect_payment_claimable!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1801 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1805 fn monitor_update_claim_fail_no_response() {
1806 // Test for claim_funds resulting in both a monitor update failure and no message response (due
1807 // to channel being AwaitingRAA).
1808 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1810 let chanmon_cfgs = create_chanmon_cfgs(2);
1811 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1812 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1813 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1814 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1816 // Forward a payment for B to claim
1817 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1819 // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1820 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1822 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1823 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1824 check_added_monitors!(nodes[0], 1);
1827 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1828 assert_eq!(events.len(), 1);
1829 let payment_event = SendEvent::from_event(events.pop().unwrap());
1830 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1831 let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1833 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1834 nodes[1].node.claim_funds(payment_preimage_1);
1835 check_added_monitors!(nodes[1], 1);
1837 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1839 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1840 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1841 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1842 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1843 check_added_monitors!(nodes[1], 0);
1844 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1846 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1847 check_added_monitors!(nodes[1], 1);
1848 expect_pending_htlcs_forwardable!(nodes[1]);
1849 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1851 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1852 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1853 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1854 expect_payment_sent!(nodes[0], payment_preimage_1);
1856 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1859 // restore_b_before_conf has no meaning if !confirm_a_first
1860 // restore_b_before_lock has no meaning if confirm_a_first
1861 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool, restore_b_before_lock: bool) {
1862 // Test that if the monitor update generated by funding_transaction_generated fails we continue
1863 // the channel setup happily after the update is restored.
1864 let chanmon_cfgs = create_chanmon_cfgs(2);
1865 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1866 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1867 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1869 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1870 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()));
1871 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()));
1873 let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
1875 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
1876 check_added_monitors!(nodes[0], 0);
1878 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1879 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1880 let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1881 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1882 check_added_monitors!(nodes[1], 1);
1884 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1885 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()));
1886 check_added_monitors!(nodes[0], 1);
1887 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1888 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1889 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1890 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1891 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1892 check_added_monitors!(nodes[0], 0);
1893 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
1895 let events = nodes[0].node.get_and_clear_pending_events();
1896 assert_eq!(events.len(), 0);
1897 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1898 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1900 if confirm_a_first {
1901 confirm_transaction(&nodes[0], &funding_tx);
1902 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()));
1903 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1904 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1906 assert!(!restore_b_before_conf);
1907 confirm_transaction(&nodes[1], &funding_tx);
1908 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1911 // Make sure nodes[1] isn't stupid enough to re-send the ChannelReady on reconnect
1912 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1913 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1914 reconnect_nodes(&nodes[0], &nodes[1], (false, confirm_a_first), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1916 // But we want to re-emit ChannelPending
1917 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
1918 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1919 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1921 if !restore_b_before_conf {
1922 confirm_transaction(&nodes[1], &funding_tx);
1923 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1924 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1926 if !confirm_a_first && !restore_b_before_lock {
1927 confirm_transaction(&nodes[0], &funding_tx);
1928 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()));
1929 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1930 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1933 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1934 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1935 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1936 check_added_monitors!(nodes[1], 0);
1938 let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1939 if !restore_b_before_lock {
1940 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1941 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1943 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()));
1944 confirm_transaction(&nodes[0], &funding_tx);
1945 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1946 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready))
1949 if restore_b_before_conf {
1950 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1951 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1952 confirm_transaction(&nodes[1], &funding_tx);
1954 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1955 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1957 for node in nodes.iter() {
1958 assert!(node.gossip_sync.handle_channel_announcement(&announcement).unwrap());
1959 node.gossip_sync.handle_channel_update(&as_update).unwrap();
1960 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
1963 if !restore_b_before_lock {
1964 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
1966 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
1970 send_payment(&nodes[0], &[&nodes[1]], 8000000);
1971 close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1972 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
1973 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1977 fn during_funding_monitor_fail() {
1978 do_during_funding_monitor_fail(true, true, false);
1979 do_during_funding_monitor_fail(true, false, false);
1980 do_during_funding_monitor_fail(false, false, false);
1981 do_during_funding_monitor_fail(false, false, true);
1985 fn test_path_paused_mpp() {
1986 // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1988 let chanmon_cfgs = create_chanmon_cfgs(4);
1989 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1990 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1991 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1993 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
1994 let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2);
1995 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
1996 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
1998 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
2000 // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
2001 let path = route.paths[0].clone();
2002 route.paths.push(path);
2003 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
2004 route.paths[0][0].short_channel_id = chan_1_id;
2005 route.paths[0][1].short_channel_id = chan_3_id;
2006 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
2007 route.paths[1][0].short_channel_id = chan_2_ann.contents.short_channel_id;
2008 route.paths[1][1].short_channel_id = chan_4_id;
2010 // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
2011 // (for the path 0 -> 2 -> 3) fails.
2012 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2013 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2015 // Now check that we get the right return value, indicating that the first path succeeded but
2016 // the second got a MonitorUpdateInProgress err. This implies
2017 // PaymentSendFailure::PartialFailure as some paths succeeded, preventing retry.
2018 if let Err(PaymentSendFailure::PartialFailure { results, ..}) = nodes[0].node.send_payment_with_route(
2019 &route, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
2021 assert_eq!(results.len(), 2);
2022 if let Ok(()) = results[0] {} else { panic!(); }
2023 if let Err(APIError::MonitorUpdateInProgress) = results[1] {} else { panic!(); }
2024 } else { panic!(); }
2025 check_added_monitors!(nodes[0], 2);
2026 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2028 // Pass the first HTLC of the payment along to nodes[3].
2029 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2030 assert_eq!(events.len(), 1);
2031 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false, None);
2033 // And check that, after we successfully update the monitor for chan_2 we can pass the second
2034 // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
2035 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
2036 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2037 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2038 assert_eq!(events.len(), 1);
2039 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true, None);
2041 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
2045 fn test_pending_update_fee_ack_on_reconnect() {
2046 // In early versions of our automated fee update patch, nodes did not correctly use the
2047 // previous channel feerate after sending an undelivered revoke_and_ack when re-sending an
2048 // undelivered commitment_signed.
2050 // B sends A new HTLC + CS, not delivered
2051 // A sends B update_fee + CS
2052 // B receives the CS and sends RAA, previously causing B to lock in the new feerate
2054 // B resends initial CS, using the original fee
2056 let chanmon_cfgs = create_chanmon_cfgs(2);
2057 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2058 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2059 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2061 create_announced_chan_between_nodes(&nodes, 0, 1);
2062 send_payment(&nodes[0], &[&nodes[1]], 100_000_00);
2064 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[1], nodes[0], 1_000_000);
2065 nodes[1].node.send_payment_with_route(&route, payment_hash,
2066 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
2067 check_added_monitors!(nodes[1], 1);
2068 let bs_initial_send_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2069 // bs_initial_send_msgs are not delivered until they are re-generated after reconnect
2072 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2075 nodes[0].node.timer_tick_occurred();
2076 check_added_monitors!(nodes[0], 1);
2077 let as_update_fee_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2078 assert!(as_update_fee_msgs.update_fee.is_some());
2080 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_update_fee_msgs.update_fee.as_ref().unwrap());
2081 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_fee_msgs.commitment_signed);
2082 check_added_monitors!(nodes[1], 1);
2083 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2084 // bs_first_raa is not delivered until it is re-generated after reconnect
2086 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2087 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2089 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
2090 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2091 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
2092 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2094 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2095 let bs_resend_msgs = nodes[1].node.get_and_clear_pending_msg_events();
2096 assert_eq!(bs_resend_msgs.len(), 3);
2097 if let MessageSendEvent::UpdateHTLCs { ref updates, .. } = bs_resend_msgs[0] {
2098 assert_eq!(*updates, bs_initial_send_msgs);
2099 } else { panic!(); }
2100 if let MessageSendEvent::SendRevokeAndACK { ref msg, .. } = bs_resend_msgs[1] {
2101 assert_eq!(*msg, bs_first_raa);
2102 } else { panic!(); }
2103 if let MessageSendEvent::SendChannelUpdate { .. } = bs_resend_msgs[2] { } else { panic!(); }
2105 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2106 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
2108 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.update_add_htlcs[0]);
2109 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.commitment_signed);
2110 check_added_monitors!(nodes[0], 1);
2111 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()));
2112 check_added_monitors!(nodes[1], 1);
2113 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()).commitment_signed;
2115 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2116 check_added_monitors!(nodes[0], 1);
2117 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);
2118 check_added_monitors!(nodes[1], 1);
2119 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2121 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2122 check_added_monitors!(nodes[0], 1);
2123 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2124 check_added_monitors!(nodes[0], 1);
2126 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()));
2127 check_added_monitors!(nodes[1], 1);
2129 expect_pending_htlcs_forwardable!(nodes[0]);
2130 expect_payment_claimable!(nodes[0], payment_hash, payment_secret, 1_000_000);
2132 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
2136 fn test_fail_htlc_on_broadcast_after_claim() {
2137 // In an earlier version of 7e78fa660cec8a73286c94c1073ee588140e7a01 we'd also fail the inbound
2138 // channel backwards if we received an HTLC failure after a HTLC fulfillment. Here we test a
2139 // specific case of that by having the HTLC failure come from the ChannelMonitor after a dust
2140 // HTLC was not included in a confirmed commitment transaction.
2142 // We first forward a payment, then claim it with an update_fulfill_htlc message, closing the
2143 // channel immediately before commitment occurs. After the commitment transaction reaches
2144 // ANTI_REORG_DELAY confirmations, will will try to fail the HTLC which was already fulfilled.
2145 let chanmon_cfgs = create_chanmon_cfgs(3);
2146 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2147 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2148 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2150 create_announced_chan_between_nodes(&nodes, 0, 1);
2151 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2153 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 2000);
2155 let bs_txn = get_local_commitment_txn!(nodes[2], chan_id_2);
2156 assert_eq!(bs_txn.len(), 1);
2158 nodes[2].node.claim_funds(payment_preimage);
2159 check_added_monitors!(nodes[2], 1);
2160 expect_payment_claimed!(nodes[2], payment_hash, 2000);
2162 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2163 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
2164 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2165 check_added_monitors!(nodes[1], 1);
2166 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2168 mine_transaction(&nodes[1], &bs_txn[0]);
2169 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2170 check_closed_broadcast!(nodes[1], true);
2171 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2172 check_added_monitors!(nodes[1], 1);
2173 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 }]);
2175 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
2176 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2177 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, true, true);
2178 expect_payment_path_successful!(nodes[0]);
2181 fn do_update_fee_resend_test(deliver_update: bool, parallel_updates: bool) {
2182 // In early versions we did not handle resending of update_fee on reconnect correctly. The
2183 // chanmon_consistency fuzz target, of course, immediately found it, but we test a few cases
2185 let chanmon_cfgs = create_chanmon_cfgs(2);
2186 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2187 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2188 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2190 create_announced_chan_between_nodes(&nodes, 0, 1);
2191 send_payment(&nodes[0], &[&nodes[1]], 1000);
2194 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2195 *feerate_lock += 20;
2197 nodes[0].node.timer_tick_occurred();
2198 check_added_monitors!(nodes[0], 1);
2199 let update_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2200 assert!(update_msgs.update_fee.is_some());
2202 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2205 if parallel_updates {
2207 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2208 *feerate_lock += 20;
2210 nodes[0].node.timer_tick_occurred();
2211 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2214 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2215 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2217 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
2218 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2219 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
2220 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2222 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2223 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
2224 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2226 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2227 let mut as_reconnect_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2228 assert_eq!(as_reconnect_msgs.len(), 2);
2229 if let MessageSendEvent::SendChannelUpdate { .. } = as_reconnect_msgs.pop().unwrap() {} else { panic!(); }
2230 let update_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = as_reconnect_msgs.pop().unwrap()
2231 { updates } else { panic!(); };
2232 assert!(update_msgs.update_fee.is_some());
2233 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2234 if parallel_updates {
2235 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update_msgs.commitment_signed);
2236 check_added_monitors!(nodes[1], 1);
2237 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2238 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2239 check_added_monitors!(nodes[0], 1);
2240 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2242 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2243 check_added_monitors!(nodes[0], 1);
2244 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2246 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_second_update.update_fee.as_ref().unwrap());
2247 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
2248 check_added_monitors!(nodes[1], 1);
2249 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2251 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2252 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2253 check_added_monitors!(nodes[1], 1);
2255 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2256 check_added_monitors!(nodes[0], 1);
2258 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs.commitment_signed);
2259 check_added_monitors!(nodes[0], 1);
2260 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2262 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2263 check_added_monitors!(nodes[1], 1);
2265 commitment_signed_dance!(nodes[1], nodes[0], update_msgs.commitment_signed, false);
2268 send_payment(&nodes[0], &[&nodes[1]], 1000);
2271 fn update_fee_resend_test() {
2272 do_update_fee_resend_test(false, false);
2273 do_update_fee_resend_test(true, false);
2274 do_update_fee_resend_test(false, true);
2275 do_update_fee_resend_test(true, true);
2278 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2279 // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2280 // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2281 // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2282 // which failed in such a case).
2283 let chanmon_cfgs = create_chanmon_cfgs(2);
2284 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2285 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2286 let persister: test_utils::TestPersister;
2287 let new_chain_monitor: test_utils::TestChainMonitor;
2288 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
2289 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2291 let chan_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 15_000_000, 7_000_000_000).2;
2292 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
2293 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2295 // Do a really complicated dance to get an HTLC into the holding cell, with
2296 // MonitorUpdateInProgress set but AwaitingRemoteRevoke unset. When this test was written, any
2297 // attempts to send an HTLC while MonitorUpdateInProgress is set are immediately
2298 // failed-backwards. Thus, the only way to get an AddHTLC into the holding cell is to add it
2299 // while AwaitingRemoteRevoke is set but MonitorUpdateInProgress is unset, and then swap the
2303 // a) routing a payment from node B to node A,
2304 // b) sending a payment from node A to node B without delivering any of the generated messages,
2305 // putting node A in AwaitingRemoteRevoke,
2306 // c) sending a second payment from node A to node B, which is immediately placed in the
2308 // d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2309 // when we try to persist the payment preimage,
2310 // e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2311 // clearing AwaitingRemoteRevoke on node A.
2313 // Note that because, at the end, MonitorUpdateInProgress is still set, the HTLC generated in
2314 // (c) will not be freed from the holding cell.
2315 let (payment_preimage_0, payment_hash_0, _) = route_payment(&nodes[1], &[&nodes[0]], 100_000);
2317 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
2318 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
2319 check_added_monitors!(nodes[0], 1);
2320 let send = SendEvent::from_node(&nodes[0]);
2321 assert_eq!(send.msgs.len(), 1);
2323 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
2324 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
2325 check_added_monitors!(nodes[0], 0);
2327 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2328 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2329 nodes[0].node.claim_funds(payment_preimage_0);
2330 check_added_monitors!(nodes[0], 1);
2332 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2333 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2334 check_added_monitors!(nodes[1], 1);
2336 let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2338 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2339 check_added_monitors!(nodes[0], 1);
2342 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2343 // disconnect the peers. Note that the fuzzer originally found this issue because
2344 // deserializing a ChannelManager in this state causes an assertion failure.
2346 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
2347 reload_node!(nodes[0], &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
2349 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2351 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
2353 // Now reconnect the two
2354 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
2355 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2356 assert_eq!(reestablish_1.len(), 1);
2357 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
2358 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2359 assert_eq!(reestablish_2.len(), 1);
2361 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2362 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2363 check_added_monitors!(nodes[1], 0);
2365 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2366 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2368 assert!(resp_0.0.is_none());
2369 assert!(resp_0.1.is_none());
2370 assert!(resp_0.2.is_none());
2371 assert!(resp_1.0.is_none());
2372 assert!(resp_1.1.is_none());
2374 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2376 if let Some(pending_cs) = resp_1.2 {
2377 assert!(pending_cs.update_add_htlcs.is_empty());
2378 assert!(pending_cs.update_fail_htlcs.is_empty());
2379 assert!(pending_cs.update_fulfill_htlcs.is_empty());
2380 assert_eq!(pending_cs.commitment_signed, cs);
2381 } else { panic!(); }
2383 // There should be no monitor updates as we are still pending awaiting a failed one.
2384 check_added_monitors!(nodes[0], 0);
2385 check_added_monitors!(nodes[1], 0);
2388 // If we finish updating the monitor, we should free the holding cell right away (this did
2389 // not occur prior to #756).
2390 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2391 let (funding_txo, mon_id, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2392 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_txo, mon_id);
2393 expect_payment_claimed!(nodes[0], payment_hash_0, 100_000);
2395 // New outbound messages should be generated immediately upon a call to
2396 // get_and_clear_pending_msg_events (but not before).
2397 check_added_monitors!(nodes[0], 0);
2398 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2399 check_added_monitors!(nodes[0], 1);
2400 assert_eq!(events.len(), 1);
2402 // Deliver the pending in-flight CS
2403 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2404 check_added_monitors!(nodes[0], 1);
2406 let commitment_msg = match events.pop().unwrap() {
2407 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2408 assert_eq!(node_id, nodes[1].node.get_our_node_id());
2409 assert!(updates.update_fail_htlcs.is_empty());
2410 assert!(updates.update_fail_malformed_htlcs.is_empty());
2411 assert!(updates.update_fee.is_none());
2412 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2413 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2414 expect_payment_sent_without_paths!(nodes[1], payment_preimage_0);
2415 assert_eq!(updates.update_add_htlcs.len(), 1);
2416 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2417 updates.commitment_signed
2419 _ => panic!("Unexpected event type!"),
2422 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2423 check_added_monitors!(nodes[1], 1);
2425 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2426 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2427 expect_pending_htlcs_forwardable!(nodes[1]);
2428 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2429 check_added_monitors!(nodes[1], 1);
2431 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
2433 let events = nodes[1].node.get_and_clear_pending_events();
2434 assert_eq!(events.len(), 2);
2436 Event::PendingHTLCsForwardable { .. } => { },
2437 _ => panic!("Unexpected event"),
2440 Event::PaymentPathSuccessful { .. } => { },
2441 _ => panic!("Unexpected event"),
2444 nodes[1].node.process_pending_htlc_forwards();
2445 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2447 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2448 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2451 fn channel_holding_cell_serialize() {
2452 do_channel_holding_cell_serialize(true, true);
2453 do_channel_holding_cell_serialize(true, false);
2454 do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2457 #[derive(PartialEq)]
2458 enum HTLCStatusAtDupClaim {
2463 fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_fails: bool) {
2464 // When receiving an update_fulfill_htlc message, we immediately forward the claim backwards
2465 // along the payment path before waiting for a full commitment_signed dance. This is great, but
2466 // can cause duplicative claims if a node sends an update_fulfill_htlc message, disconnects,
2467 // reconnects, and then has to re-send its update_fulfill_htlc message again.
2468 // In previous code, we didn't handle the double-claim correctly, spuriously closing the
2469 // channel on which the inbound HTLC was received.
2470 let chanmon_cfgs = create_chanmon_cfgs(3);
2471 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2472 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2473 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2475 create_announced_chan_between_nodes(&nodes, 0, 1);
2476 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
2478 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
2480 let mut as_raa = None;
2481 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2482 // In order to get the HTLC claim into the holding cell at nodes[1], we need nodes[1] to be
2483 // awaiting a remote revoke_and_ack from nodes[0].
2484 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
2485 nodes[0].node.send_payment_with_route(&route, second_payment_hash,
2486 RecipientOnionFields::secret_only(second_payment_secret), PaymentId(second_payment_hash.0)).unwrap();
2487 check_added_monitors!(nodes[0], 1);
2489 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
2490 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
2491 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
2492 check_added_monitors!(nodes[1], 1);
2494 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2495 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2496 check_added_monitors!(nodes[0], 1);
2497 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
2498 check_added_monitors!(nodes[0], 1);
2500 as_raa = Some(get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2503 let fulfill_msg = msgs::UpdateFulfillHTLC {
2504 channel_id: chan_id_2,
2509 nodes[2].node.fail_htlc_backwards(&payment_hash);
2510 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash }]);
2511 check_added_monitors!(nodes[2], 1);
2512 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2514 nodes[2].node.claim_funds(payment_preimage);
2515 check_added_monitors!(nodes[2], 1);
2516 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
2518 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2519 assert_eq!(cs_updates.update_fulfill_htlcs.len(), 1);
2520 // Check that the message we're about to deliver matches the one generated:
2521 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
2523 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
2524 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2525 check_added_monitors!(nodes[1], 1);
2527 let mut bs_updates = None;
2528 if htlc_status != HTLCStatusAtDupClaim::HoldingCell {
2529 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2530 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2531 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2532 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2533 if htlc_status == HTLCStatusAtDupClaim::Cleared {
2534 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2535 expect_payment_path_successful!(nodes[0]);
2538 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2541 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
2542 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
2545 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
2546 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 }]);
2548 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2551 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2552 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa.unwrap());
2553 check_added_monitors!(nodes[1], 1);
2554 expect_pending_htlcs_forwardable_ignore!(nodes[1]); // We finally receive the second payment, but don't claim it
2556 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2557 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2558 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2559 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2561 if htlc_status != HTLCStatusAtDupClaim::Cleared {
2562 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2563 expect_payment_path_successful!(nodes[0]);
2568 fn test_reconnect_dup_htlc_claims() {
2569 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, false);
2570 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, false);
2571 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, false);
2572 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, true);
2573 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, true);
2574 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, true);
2578 fn test_temporary_error_during_shutdown() {
2579 // Test that temporary failures when updating the monitor's shutdown script delay cooperative
2581 let mut config = test_default_channel_config();
2582 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2584 let chanmon_cfgs = create_chanmon_cfgs(2);
2585 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2586 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
2587 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2589 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
2591 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2592 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2594 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
2595 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()));
2596 check_added_monitors!(nodes[1], 1);
2598 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()));
2599 check_added_monitors!(nodes[0], 1);
2601 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2603 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2604 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2606 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2607 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2608 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()));
2610 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2612 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2613 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2614 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2616 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()));
2617 let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
2618 let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2620 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_a.unwrap());
2621 let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
2622 assert!(none_b.is_none());
2623 let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2625 assert_eq!(txn_a, txn_b);
2626 assert_eq!(txn_a.len(), 1);
2627 check_spends!(txn_a[0], funding_tx);
2628 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
2629 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
2633 fn test_permanent_error_during_sending_shutdown() {
2634 // Test that permanent failures when updating the monitor's shutdown script result in a force
2635 // close when initiating a cooperative close.
2636 let mut config = test_default_channel_config();
2637 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2639 let chanmon_cfgs = create_chanmon_cfgs(2);
2640 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2641 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
2642 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2644 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
2645 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2647 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2649 // We always send the `shutdown` response when initiating a shutdown, even if we immediately
2650 // close the channel thereafter.
2651 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2652 assert_eq!(msg_events.len(), 3);
2653 if let MessageSendEvent::SendShutdown { .. } = msg_events[0] {} else { panic!(); }
2654 if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg_events[1] {} else { panic!(); }
2655 if let MessageSendEvent::HandleError { .. } = msg_events[2] {} else { panic!(); }
2657 check_added_monitors!(nodes[0], 2);
2658 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2662 fn test_permanent_error_during_handling_shutdown() {
2663 // Test that permanent failures when updating the monitor's shutdown script result in a force
2664 // close when handling a cooperative close.
2665 let mut config = test_default_channel_config();
2666 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2668 let chanmon_cfgs = create_chanmon_cfgs(2);
2669 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2670 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
2671 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2673 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
2674 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2676 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2677 let shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
2678 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &shutdown);
2680 // We always send the `shutdown` response when receiving a shutdown, even if we immediately
2681 // close the channel thereafter.
2682 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
2683 assert_eq!(msg_events.len(), 3);
2684 if let MessageSendEvent::SendShutdown { .. } = msg_events[0] {} else { panic!(); }
2685 if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg_events[1] {} else { panic!(); }
2686 if let MessageSendEvent::HandleError { .. } = msg_events[2] {} else { panic!(); }
2688 check_added_monitors!(nodes[1], 2);
2689 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2693 fn double_temp_error() {
2694 // Test that it's OK to have multiple `ChainMonitor::update_channel` calls fail in a row.
2695 let chanmon_cfgs = create_chanmon_cfgs(2);
2696 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2697 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2698 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2700 let (_, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1);
2702 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2703 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2705 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2706 // `claim_funds` results in a ChannelMonitorUpdate.
2707 nodes[1].node.claim_funds(payment_preimage_1);
2708 check_added_monitors!(nodes[1], 1);
2709 let (funding_tx, latest_update_1, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2711 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2712 // Previously, this would've panicked due to a double-call to `Channel::monitor_update_failed`,
2713 // which had some asserts that prevented it from being called twice.
2714 nodes[1].node.claim_funds(payment_preimage_2);
2715 check_added_monitors!(nodes[1], 1);
2716 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2718 let (_, latest_update_2, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2719 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_1);
2720 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2721 check_added_monitors!(nodes[1], 0);
2722 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_2);
2724 // Complete the first HTLC. Note that as a side-effect we handle the monitor update completions
2725 // and get both PaymentClaimed events at once.
2726 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
2728 let events = nodes[1].node.get_and_clear_pending_events();
2729 assert_eq!(events.len(), 2);
2731 Event::PaymentClaimed { amount_msat: 1_000_000, payment_hash, .. } => assert_eq!(payment_hash, payment_hash_1),
2732 _ => panic!("Unexpected Event: {:?}", events[0]),
2735 Event::PaymentClaimed { amount_msat: 1_000_000, payment_hash, .. } => assert_eq!(payment_hash, payment_hash_2),
2736 _ => panic!("Unexpected Event: {:?}", events[1]),
2739 assert_eq!(msg_events.len(), 1);
2740 let (update_fulfill_1, commitment_signed_b1, node_id) = {
2741 match &msg_events[0] {
2742 &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 } } => {
2743 assert!(update_add_htlcs.is_empty());
2744 assert_eq!(update_fulfill_htlcs.len(), 1);
2745 assert!(update_fail_htlcs.is_empty());
2746 assert!(update_fail_malformed_htlcs.is_empty());
2747 assert!(update_fee.is_none());
2748 (update_fulfill_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2750 _ => panic!("Unexpected event"),
2753 assert_eq!(node_id, nodes[0].node.get_our_node_id());
2754 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_1);
2755 check_added_monitors!(nodes[0], 0);
2756 expect_payment_sent_without_paths!(nodes[0], payment_preimage_1);
2757 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_b1);
2758 check_added_monitors!(nodes[0], 1);
2759 nodes[0].node.process_pending_htlc_forwards();
2760 let (raa_a1, commitment_signed_a1) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2761 check_added_monitors!(nodes[1], 0);
2762 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2763 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_a1);
2764 check_added_monitors!(nodes[1], 1);
2765 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed_a1);
2766 check_added_monitors!(nodes[1], 1);
2768 // Complete the second HTLC.
2769 let ((update_fulfill_2, commitment_signed_b2), raa_b2) = {
2770 let events = nodes[1].node.get_and_clear_pending_msg_events();
2771 assert_eq!(events.len(), 2);
2773 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2774 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2775 assert!(updates.update_add_htlcs.is_empty());
2776 assert!(updates.update_fail_htlcs.is_empty());
2777 assert!(updates.update_fail_malformed_htlcs.is_empty());
2778 assert!(updates.update_fee.is_none());
2779 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2780 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2782 _ => panic!("Unexpected event"),
2785 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2786 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2789 _ => panic!("Unexpected event"),
2792 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_b2);
2793 check_added_monitors!(nodes[0], 1);
2794 expect_payment_path_successful!(nodes[0]);
2796 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_2);
2797 check_added_monitors!(nodes[0], 0);
2798 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2799 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed_b2, false);
2800 expect_payment_sent!(nodes[0], payment_preimage_2);
2803 fn do_test_outbound_reload_without_init_mon(use_0conf: bool) {
2804 // Test that if the monitor update generated in funding_signed is stored async and we restart
2805 // with the latest ChannelManager but the ChannelMonitor persistence never completed we happily
2806 // drop the channel and move on.
2807 let chanmon_cfgs = create_chanmon_cfgs(2);
2808 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2810 let persister: test_utils::TestPersister;
2811 let new_chain_monitor: test_utils::TestChainMonitor;
2812 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
2814 let mut chan_config = test_default_channel_config();
2815 chan_config.manually_accept_inbound_channels = true;
2816 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2818 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2819 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2821 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2822 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()));
2824 let events = nodes[1].node.get_and_clear_pending_events();
2825 assert_eq!(events.len(), 1);
2827 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2829 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2831 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2834 _ => panic!("Unexpected event"),
2837 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()));
2839 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2841 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2842 check_added_monitors!(nodes[0], 0);
2844 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2845 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2846 check_added_monitors!(nodes[1], 1);
2847 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
2849 let bs_signed_locked = nodes[1].node.get_and_clear_pending_msg_events();
2850 assert_eq!(bs_signed_locked.len(), if use_0conf { 2 } else { 1 });
2851 match &bs_signed_locked[0] {
2852 MessageSendEvent::SendFundingSigned { msg, .. } => {
2853 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2855 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &msg);
2856 check_added_monitors!(nodes[0], 1);
2858 _ => panic!("Unexpected event"),
2861 match &bs_signed_locked[1] {
2862 MessageSendEvent::SendChannelReady { msg, .. } => {
2863 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &msg);
2865 _ => panic!("Unexpected event"),
2869 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
2870 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2871 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2873 // nodes[0] is now waiting on the first ChannelMonitor persistence to complete in order to
2874 // broadcast the funding transaction. If nodes[0] restarts at this point with the
2875 // ChannelMonitor lost, we should simply discard the channel.
2877 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2878 // not, so we have to clear them here.
2879 nodes[0].chain_source.watched_txn.lock().unwrap().clear();
2880 nodes[0].chain_source.watched_outputs.lock().unwrap().clear();
2882 reload_node!(nodes[0], &nodes[0].node.encode(), &[], persister, new_chain_monitor, nodes_0_deserialized);
2883 check_closed_event!(nodes[0], 1, ClosureReason::DisconnectedPeer);
2884 assert!(nodes[0].node.list_channels().is_empty());
2888 fn test_outbound_reload_without_init_mon() {
2889 do_test_outbound_reload_without_init_mon(true);
2890 do_test_outbound_reload_without_init_mon(false);
2893 fn do_test_inbound_reload_without_init_mon(use_0conf: bool, lock_commitment: bool) {
2894 // Test that if the monitor update generated by funding_transaction_generated is stored async
2895 // and we restart with the latest ChannelManager but the ChannelMonitor persistence never
2896 // completed we happily drop the channel and move on.
2897 let chanmon_cfgs = create_chanmon_cfgs(2);
2898 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2900 let persister: test_utils::TestPersister;
2901 let new_chain_monitor: test_utils::TestChainMonitor;
2902 let nodes_1_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
2904 let mut chan_config = test_default_channel_config();
2905 chan_config.manually_accept_inbound_channels = true;
2906 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2908 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2909 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2911 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2912 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()));
2914 let events = nodes[1].node.get_and_clear_pending_events();
2915 assert_eq!(events.len(), 1);
2917 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2919 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2921 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2924 _ => panic!("Unexpected event"),
2927 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()));
2929 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2931 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2932 check_added_monitors!(nodes[0], 0);
2934 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2935 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2936 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2937 check_added_monitors!(nodes[1], 1);
2939 // nodes[1] happily sends its funding_signed even though its awaiting the persistence of the
2940 // initial ChannelMonitor, but it will decline to send its channel_ready even if the funding
2941 // transaction is confirmed.
2942 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
2944 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
2945 check_added_monitors!(nodes[0], 1);
2946 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
2948 let as_funding_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2949 if lock_commitment {
2950 confirm_transaction(&nodes[0], &as_funding_tx[0]);
2951 confirm_transaction(&nodes[1], &as_funding_tx[0]);
2953 if use_0conf || lock_commitment {
2954 let as_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
2955 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_ready);
2957 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2959 // nodes[1] is now waiting on the first ChannelMonitor persistence to complete in order to
2960 // move the channel to ready (or is waiting on the funding transaction to confirm). If nodes[1]
2961 // restarts at this point with the ChannelMonitor lost, we should simply discard the channel.
2963 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2964 // not, so we have to clear them here.
2965 nodes[1].chain_source.watched_txn.lock().unwrap().clear();
2966 nodes[1].chain_source.watched_outputs.lock().unwrap().clear();
2968 reload_node!(nodes[1], &nodes[1].node.encode(), &[], persister, new_chain_monitor, nodes_1_deserialized);
2970 check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
2971 assert!(nodes[1].node.list_channels().is_empty());
2975 fn test_inbound_reload_without_init_mon() {
2976 do_test_inbound_reload_without_init_mon(true, true);
2977 do_test_inbound_reload_without_init_mon(true, false);
2978 do_test_inbound_reload_without_init_mon(false, true);
2979 do_test_inbound_reload_without_init_mon(false, false);