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 chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor};
20 use chain::transaction::OutPoint;
21 use chain::{ChannelMonitorUpdateStatus, Listen, Watch};
22 use ln::channelmanager::{self, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
23 use ln::channel::AnnouncementSigsState;
25 use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
26 use util::config::UserConfig;
27 use util::enforcing_trait_impls::EnforcingSigner;
28 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason, HTLCDestination};
29 use util::errors::APIError;
30 use util::ser::{ReadableArgs, Writeable};
31 use util::test_utils::TestBroadcaster;
33 use ln::functional_test_utils::*;
38 use bitcoin::hashes::Hash;
39 use bitcoin::TxMerkleNode;
41 use sync::{Arc, Mutex};
44 fn test_simple_monitor_permanent_update_fail() {
45 // Test that we handle a simple permanent monitor update failure
46 let chanmon_cfgs = create_chanmon_cfgs(2);
47 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
48 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
49 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
50 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
52 let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
53 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
54 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable {..}, {});
55 check_added_monitors!(nodes[0], 2);
57 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
58 assert_eq!(events_1.len(), 2);
60 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
61 _ => panic!("Unexpected event"),
64 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
65 _ => panic!("Unexpected event"),
68 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
70 // TODO: Once we hit the chain with the failure transaction we should check that we get a
71 // PaymentPathFailed event
73 assert_eq!(nodes[0].node.list_channels().len(), 0);
74 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
78 fn test_monitor_and_persister_update_fail() {
79 // Test that if both updating the `ChannelMonitor` and persisting the updated
80 // `ChannelMonitor` fail, then the failure from updating the `ChannelMonitor`
81 // one that gets returned.
82 let chanmon_cfgs = create_chanmon_cfgs(2);
83 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
84 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
85 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
87 // Create some initial channel
88 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
89 let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
91 // Rebalance the network to generate htlc in the two directions
92 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
94 // Route an HTLC from node 0 to node 1 (but don't settle)
95 let (preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
97 // Make a copy of the ChainMonitor so we can capture the error it returns on a
98 // bogus update. Note that if instead we updated the nodes[0]'s ChainMonitor
99 // directly, the node would fail to be `Drop`'d at the end because its
100 // ChannelManager and ChainMonitor would be out of sync.
101 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
102 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
103 let persister = test_utils::TestPersister::new();
104 let tx_broadcaster = TestBroadcaster {
105 txn_broadcasted: Mutex::new(Vec::new()),
106 // Because we will connect a block at height 200 below, we need the TestBroadcaster to know
107 // that we are at height 200 so that it doesn't think we're violating the time lock
108 // requirements of transactions broadcasted at that point.
109 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 200); 200])),
112 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
113 let mut w = test_utils::TestVecWriter(Vec::new());
114 monitor.write(&mut w).unwrap();
115 let new_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
116 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
117 assert!(new_monitor == *monitor);
118 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
119 assert_eq!(chain_mon.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
122 let header = BlockHeader {
124 prev_blockhash: BlockHash::all_zeros(),
125 merkle_root: TxMerkleNode::all_zeros(),
130 chain_mon.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
132 // Set the persister's return value to be a InProgress.
133 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
135 // Try to update ChannelMonitor
136 nodes[1].node.claim_funds(preimage);
137 expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
138 check_added_monitors!(nodes[1], 1);
140 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
141 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
142 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
143 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2) {
144 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
145 // Check that even though the persister is returning a InProgress,
146 // because the update is bogus, ultimately the error that's returned
147 // should be a PermanentFailure.
148 if let ChannelMonitorUpdateStatus::PermanentFailure = chain_mon.chain_monitor.update_channel(outpoint, update.clone()) {} else { panic!("Expected monitor error to be permanent"); }
149 logger.assert_log_regex("lightning::chain::chainmonitor".to_string(), regex::Regex::new("Persistence of ChannelMonitorUpdate for channel [0-9a-f]* in progress").unwrap(), 1);
150 assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, update), ChannelMonitorUpdateStatus::Completed);
151 } else { assert!(false); }
152 } else { assert!(false); };
154 check_added_monitors!(nodes[0], 1);
155 let events = nodes[0].node.get_and_clear_pending_events();
156 assert_eq!(events.len(), 1);
159 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
160 // Test that we can recover from a simple temporary monitor update failure optionally with
161 // a disconnect in between
162 let chanmon_cfgs = create_chanmon_cfgs(2);
163 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
164 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
165 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
166 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
168 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
170 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
173 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), false, APIError::MonitorUpdateInProgress, {});
174 check_added_monitors!(nodes[0], 1);
177 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
178 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
179 assert_eq!(nodes[0].node.list_channels().len(), 1);
182 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
183 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
184 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
187 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
188 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
189 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
190 check_added_monitors!(nodes[0], 0);
192 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
193 assert_eq!(events_2.len(), 1);
194 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
195 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
196 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
197 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
199 expect_pending_htlcs_forwardable!(nodes[1]);
201 let events_3 = nodes[1].node.get_and_clear_pending_events();
202 assert_eq!(events_3.len(), 1);
204 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
205 assert_eq!(payment_hash_1, *payment_hash);
206 assert_eq!(amount_msat, 1_000_000);
208 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
209 assert!(payment_preimage.is_none());
210 assert_eq!(payment_secret_1, *payment_secret);
212 _ => panic!("expected PaymentPurpose::InvoicePayment")
215 _ => panic!("Unexpected event"),
218 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
220 // Now set it to failed again...
221 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
223 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
224 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)), false, APIError::MonitorUpdateInProgress, {});
225 check_added_monitors!(nodes[0], 1);
228 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
229 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
230 assert_eq!(nodes[0].node.list_channels().len(), 1);
233 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
234 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
235 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
238 // ...and make sure we can force-close a frozen channel
239 nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
240 check_added_monitors!(nodes[0], 1);
241 check_closed_broadcast!(nodes[0], true);
243 // TODO: Once we hit the chain with the failure transaction we should check that we get a
244 // PaymentPathFailed event
246 assert_eq!(nodes[0].node.list_channels().len(), 0);
247 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
251 fn test_simple_monitor_temporary_update_fail() {
252 do_test_simple_monitor_temporary_update_fail(false);
253 do_test_simple_monitor_temporary_update_fail(true);
256 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
257 let disconnect_flags = 8 | 16;
259 // Test that we can recover from a temporary monitor update failure with some in-flight
260 // HTLCs going on at the same time potentially with some disconnection thrown in.
261 // * First we route a payment, then get a temporary monitor update failure when trying to
262 // route a second payment. We then claim the first payment.
263 // * If disconnect_count is set, we will disconnect at this point (which is likely as
264 // InProgress likely indicates net disconnect which resulted in failing to update the
265 // ChannelMonitor on a watchtower).
266 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
267 // immediately, otherwise we wait disconnect and deliver them via the reconnect
268 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
269 // disconnect_count & !disconnect_flags is 0).
270 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
271 // through message sending, potentially disconnect/reconnecting multiple times based on
272 // disconnect_count, to get the update_fulfill_htlc through.
273 // * We then walk through more message exchanges to get the original update_add_htlc
274 // through, swapping message ordering based on disconnect_count & 8 and optionally
275 // disconnect/reconnecting based on disconnect_count.
276 let chanmon_cfgs = create_chanmon_cfgs(2);
277 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
278 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
279 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
280 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
282 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
284 // Now try to send a second payment which will fail to send
285 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
287 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
288 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)), false, APIError::MonitorUpdateInProgress, {});
289 check_added_monitors!(nodes[0], 1);
292 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
293 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
294 assert_eq!(nodes[0].node.list_channels().len(), 1);
296 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
297 // but nodes[0] won't respond since it is frozen.
298 nodes[1].node.claim_funds(payment_preimage_1);
299 check_added_monitors!(nodes[1], 1);
300 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
302 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
303 assert_eq!(events_2.len(), 1);
304 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
305 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 } } => {
306 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
307 assert!(update_add_htlcs.is_empty());
308 assert_eq!(update_fulfill_htlcs.len(), 1);
309 assert!(update_fail_htlcs.is_empty());
310 assert!(update_fail_malformed_htlcs.is_empty());
311 assert!(update_fee.is_none());
313 if (disconnect_count & 16) == 0 {
314 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
315 let events_3 = nodes[0].node.get_and_clear_pending_events();
316 assert_eq!(events_3.len(), 1);
318 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
319 assert_eq!(*payment_preimage, payment_preimage_1);
320 assert_eq!(*payment_hash, payment_hash_1);
322 _ => panic!("Unexpected event"),
325 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
326 check_added_monitors!(nodes[0], 1);
327 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
328 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
331 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
333 _ => panic!("Unexpected event"),
336 if disconnect_count & !disconnect_flags > 0 {
337 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
338 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
341 // Now fix monitor updating...
342 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
343 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
344 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
345 check_added_monitors!(nodes[0], 0);
347 macro_rules! disconnect_reconnect_peers { () => { {
348 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
349 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
351 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
352 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
353 assert_eq!(reestablish_1.len(), 1);
354 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
355 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
356 assert_eq!(reestablish_2.len(), 1);
358 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
359 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
360 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
361 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
363 assert!(as_resp.0.is_none());
364 assert!(bs_resp.0.is_none());
366 (reestablish_1, reestablish_2, as_resp, bs_resp)
369 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
370 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
371 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
373 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
374 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
375 assert_eq!(reestablish_1.len(), 1);
376 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
377 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
378 assert_eq!(reestablish_2.len(), 1);
380 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
381 check_added_monitors!(nodes[0], 0);
382 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
383 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
384 check_added_monitors!(nodes[1], 0);
385 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
387 assert!(as_resp.0.is_none());
388 assert!(bs_resp.0.is_none());
390 assert!(bs_resp.1.is_none());
391 if (disconnect_count & 16) == 0 {
392 assert!(bs_resp.2.is_none());
394 assert!(as_resp.1.is_some());
395 assert!(as_resp.2.is_some());
396 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
398 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
399 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
400 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
401 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
402 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
403 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
405 assert!(as_resp.1.is_none());
407 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
408 let events_3 = nodes[0].node.get_and_clear_pending_events();
409 assert_eq!(events_3.len(), 1);
411 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
412 assert_eq!(*payment_preimage, payment_preimage_1);
413 assert_eq!(*payment_hash, payment_hash_1);
415 _ => panic!("Unexpected event"),
418 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
419 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
420 // No commitment_signed so get_event_msg's assert(len == 1) passes
421 check_added_monitors!(nodes[0], 1);
423 as_resp.1 = Some(as_resp_raa);
427 if disconnect_count & !disconnect_flags > 1 {
428 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
430 if (disconnect_count & 16) == 0 {
431 assert!(reestablish_1 == second_reestablish_1);
432 assert!(reestablish_2 == second_reestablish_2);
434 assert!(as_resp == second_as_resp);
435 assert!(bs_resp == second_bs_resp);
438 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
440 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
441 assert_eq!(events_4.len(), 2);
442 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
443 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
444 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
447 _ => panic!("Unexpected event"),
451 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
453 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
454 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
455 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
456 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
457 check_added_monitors!(nodes[1], 1);
459 if disconnect_count & !disconnect_flags > 2 {
460 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
462 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
463 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
465 assert!(as_resp.2.is_none());
466 assert!(bs_resp.2.is_none());
469 let as_commitment_update;
470 let bs_second_commitment_update;
472 macro_rules! handle_bs_raa { () => {
473 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
474 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
475 assert!(as_commitment_update.update_add_htlcs.is_empty());
476 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
477 assert!(as_commitment_update.update_fail_htlcs.is_empty());
478 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
479 assert!(as_commitment_update.update_fee.is_none());
480 check_added_monitors!(nodes[0], 1);
483 macro_rules! handle_initial_raa { () => {
484 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
485 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
486 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
487 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
488 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
489 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
490 assert!(bs_second_commitment_update.update_fee.is_none());
491 check_added_monitors!(nodes[1], 1);
494 if (disconnect_count & 8) == 0 {
497 if disconnect_count & !disconnect_flags > 3 {
498 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
500 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
501 assert!(bs_resp.1.is_none());
503 assert!(as_resp.2.unwrap() == as_commitment_update);
504 assert!(bs_resp.2.is_none());
506 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
509 handle_initial_raa!();
511 if disconnect_count & !disconnect_flags > 4 {
512 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
514 assert!(as_resp.1.is_none());
515 assert!(bs_resp.1.is_none());
517 assert!(as_resp.2.unwrap() == as_commitment_update);
518 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
521 handle_initial_raa!();
523 if disconnect_count & !disconnect_flags > 3 {
524 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
526 assert!(as_resp.1.is_none());
527 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
529 assert!(as_resp.2.is_none());
530 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
532 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
537 if disconnect_count & !disconnect_flags > 4 {
538 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
540 assert!(as_resp.1.is_none());
541 assert!(bs_resp.1.is_none());
543 assert!(as_resp.2.unwrap() == as_commitment_update);
544 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
548 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
549 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
550 // No commitment_signed so get_event_msg's assert(len == 1) passes
551 check_added_monitors!(nodes[0], 1);
553 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
554 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
555 // No commitment_signed so get_event_msg's assert(len == 1) passes
556 check_added_monitors!(nodes[1], 1);
558 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
559 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
560 check_added_monitors!(nodes[1], 1);
562 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
563 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
564 check_added_monitors!(nodes[0], 1);
565 expect_payment_path_successful!(nodes[0]);
567 expect_pending_htlcs_forwardable!(nodes[1]);
569 let events_5 = nodes[1].node.get_and_clear_pending_events();
570 assert_eq!(events_5.len(), 1);
572 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
573 assert_eq!(payment_hash_2, *payment_hash);
574 assert_eq!(amount_msat, 1_000_000);
576 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
577 assert!(payment_preimage.is_none());
578 assert_eq!(payment_secret_2, *payment_secret);
580 _ => panic!("expected PaymentPurpose::InvoicePayment")
583 _ => panic!("Unexpected event"),
586 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
590 fn test_monitor_temporary_update_fail_a() {
591 do_test_monitor_temporary_update_fail(0);
592 do_test_monitor_temporary_update_fail(1);
593 do_test_monitor_temporary_update_fail(2);
594 do_test_monitor_temporary_update_fail(3);
595 do_test_monitor_temporary_update_fail(4);
596 do_test_monitor_temporary_update_fail(5);
600 fn test_monitor_temporary_update_fail_b() {
601 do_test_monitor_temporary_update_fail(2 | 8);
602 do_test_monitor_temporary_update_fail(3 | 8);
603 do_test_monitor_temporary_update_fail(4 | 8);
604 do_test_monitor_temporary_update_fail(5 | 8);
608 fn test_monitor_temporary_update_fail_c() {
609 do_test_monitor_temporary_update_fail(1 | 16);
610 do_test_monitor_temporary_update_fail(2 | 16);
611 do_test_monitor_temporary_update_fail(3 | 16);
612 do_test_monitor_temporary_update_fail(2 | 8 | 16);
613 do_test_monitor_temporary_update_fail(3 | 8 | 16);
617 fn test_monitor_update_fail_cs() {
618 // Tests handling of a monitor update failure when processing an incoming commitment_signed
619 let chanmon_cfgs = create_chanmon_cfgs(2);
620 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
621 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
622 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
623 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
625 let (route, our_payment_hash, payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
627 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
628 check_added_monitors!(nodes[0], 1);
631 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
632 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
634 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
635 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
636 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
637 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
638 check_added_monitors!(nodes[1], 1);
639 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
641 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
642 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
643 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
644 check_added_monitors!(nodes[1], 0);
645 let responses = nodes[1].node.get_and_clear_pending_msg_events();
646 assert_eq!(responses.len(), 2);
649 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
650 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
651 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
652 check_added_monitors!(nodes[0], 1);
654 _ => panic!("Unexpected event"),
657 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
658 assert!(updates.update_add_htlcs.is_empty());
659 assert!(updates.update_fulfill_htlcs.is_empty());
660 assert!(updates.update_fail_htlcs.is_empty());
661 assert!(updates.update_fail_malformed_htlcs.is_empty());
662 assert!(updates.update_fee.is_none());
663 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
665 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
666 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
667 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
668 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
669 check_added_monitors!(nodes[0], 1);
670 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
672 _ => panic!("Unexpected event"),
675 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
676 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
677 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
678 check_added_monitors!(nodes[0], 0);
680 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
681 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
682 check_added_monitors!(nodes[1], 1);
684 expect_pending_htlcs_forwardable!(nodes[1]);
686 let events = nodes[1].node.get_and_clear_pending_events();
687 assert_eq!(events.len(), 1);
689 Event::PaymentReceived { payment_hash, ref purpose, amount_msat } => {
690 assert_eq!(payment_hash, our_payment_hash);
691 assert_eq!(amount_msat, 1_000_000);
693 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
694 assert!(payment_preimage.is_none());
695 assert_eq!(our_payment_secret, *payment_secret);
697 _ => panic!("expected PaymentPurpose::InvoicePayment")
700 _ => panic!("Unexpected event"),
703 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
707 fn test_monitor_update_fail_no_rebroadcast() {
708 // Tests handling of a monitor update failure when no message rebroadcasting on
709 // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
711 let chanmon_cfgs = create_chanmon_cfgs(2);
712 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
713 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
714 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
715 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
717 let (route, our_payment_hash, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
719 nodes[0].node.send_payment(&route, our_payment_hash, &Some(payment_secret_1)).unwrap();
720 check_added_monitors!(nodes[0], 1);
723 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
724 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
725 let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
727 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
728 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
729 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
730 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
731 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
732 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
733 check_added_monitors!(nodes[1], 1);
735 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
736 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
737 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
738 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
739 check_added_monitors!(nodes[1], 0);
740 expect_pending_htlcs_forwardable!(nodes[1]);
742 let events = nodes[1].node.get_and_clear_pending_events();
743 assert_eq!(events.len(), 1);
745 Event::PaymentReceived { payment_hash, .. } => {
746 assert_eq!(payment_hash, our_payment_hash);
748 _ => panic!("Unexpected event"),
751 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
755 fn test_monitor_update_raa_while_paused() {
756 // Tests handling of an RAA while monitor updating has already been marked failed.
757 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
758 let chanmon_cfgs = create_chanmon_cfgs(2);
759 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
760 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
761 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
762 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
764 send_payment(&nodes[0], &[&nodes[1]], 5000000);
765 let (route, our_payment_hash_1, payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
767 nodes[0].node.send_payment(&route, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
768 check_added_monitors!(nodes[0], 1);
770 let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
772 let (route, our_payment_hash_2, payment_preimage_2, our_payment_secret_2) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000000);
774 nodes[1].node.send_payment(&route, our_payment_hash_2, &Some(our_payment_secret_2)).unwrap();
775 check_added_monitors!(nodes[1], 1);
777 let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
779 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
780 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
781 check_added_monitors!(nodes[1], 1);
782 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
784 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
785 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
786 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
787 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
788 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
789 check_added_monitors!(nodes[0], 1);
791 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
792 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
793 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Existing pending monitor update prevented responses to RAA".to_string(), 1);
794 check_added_monitors!(nodes[0], 1);
796 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
797 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
798 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
799 check_added_monitors!(nodes[0], 0);
801 let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
802 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
803 check_added_monitors!(nodes[1], 1);
804 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
806 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
807 check_added_monitors!(nodes[1], 1);
808 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
810 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
811 check_added_monitors!(nodes[0], 1);
812 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
814 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
815 check_added_monitors!(nodes[0], 1);
816 expect_pending_htlcs_forwardable!(nodes[0]);
817 expect_payment_received!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
819 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
820 check_added_monitors!(nodes[1], 1);
821 expect_pending_htlcs_forwardable!(nodes[1]);
822 expect_payment_received!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
824 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
825 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
828 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
829 // Tests handling of a monitor update failure when processing an incoming RAA
830 let chanmon_cfgs = create_chanmon_cfgs(3);
831 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
832 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
833 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
834 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
835 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
837 // Rebalance a bit so that we can send backwards from 2 to 1.
838 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
840 // Route a first payment that we'll fail backwards
841 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
843 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
844 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
845 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
846 check_added_monitors!(nodes[2], 1);
848 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
849 assert!(updates.update_add_htlcs.is_empty());
850 assert!(updates.update_fulfill_htlcs.is_empty());
851 assert_eq!(updates.update_fail_htlcs.len(), 1);
852 assert!(updates.update_fail_malformed_htlcs.is_empty());
853 assert!(updates.update_fee.is_none());
854 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
856 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
857 check_added_monitors!(nodes[0], 0);
859 // While the second channel is AwaitingRAA, forward a second payment to get it into the
861 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
863 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
864 check_added_monitors!(nodes[0], 1);
867 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
868 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
869 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
871 expect_pending_htlcs_forwardable!(nodes[1]);
872 check_added_monitors!(nodes[1], 0);
873 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
875 // Now fail monitor updating.
876 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
877 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
878 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
879 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
880 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
881 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
882 check_added_monitors!(nodes[1], 1);
884 // Forward a third payment which will also be added to the holding cell, despite the channel
885 // being paused waiting a monitor update.
886 let (route, payment_hash_3, _, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
888 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
889 check_added_monitors!(nodes[0], 1);
892 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed); // We succeed in updating the monitor for the first channel
893 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
894 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
895 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
896 check_added_monitors!(nodes[1], 0);
898 // Call forward_pending_htlcs and check that the new HTLC was simply added to the holding cell
899 // and not forwarded.
900 expect_pending_htlcs_forwardable!(nodes[1]);
901 check_added_monitors!(nodes[1], 0);
902 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
904 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
905 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
906 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
907 nodes[2].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
908 check_added_monitors!(nodes[2], 1);
910 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
911 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
912 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
913 check_added_monitors!(nodes[1], 1);
914 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
915 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
916 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
917 (Some(payment_preimage_4), Some(payment_hash_4))
918 } else { (None, None) };
920 // Restore monitor updating, ensuring we immediately get a fail-back update and a
921 // update_add update.
922 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
923 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
924 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
925 check_added_monitors!(nodes[1], 0);
926 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
927 check_added_monitors!(nodes[1], 1);
929 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
930 if test_ignore_second_cs {
931 assert_eq!(events_3.len(), 3);
933 assert_eq!(events_3.len(), 2);
936 // Note that the ordering of the events for different nodes is non-prescriptive, though the
937 // ordering of the two events that both go to nodes[2] have to stay in the same order.
938 let messages_a = match events_3.pop().unwrap() {
939 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
940 assert_eq!(node_id, nodes[0].node.get_our_node_id());
941 assert!(updates.update_fulfill_htlcs.is_empty());
942 assert_eq!(updates.update_fail_htlcs.len(), 1);
943 assert!(updates.update_fail_malformed_htlcs.is_empty());
944 assert!(updates.update_add_htlcs.is_empty());
945 assert!(updates.update_fee.is_none());
946 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
948 _ => panic!("Unexpected event type!"),
950 let raa = if test_ignore_second_cs {
951 match events_3.remove(1) {
952 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
953 assert_eq!(node_id, nodes[2].node.get_our_node_id());
956 _ => panic!("Unexpected event"),
959 let send_event_b = SendEvent::from_event(events_3.remove(0));
960 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
962 // Now deliver the new messages...
964 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
965 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
966 expect_payment_failed!(nodes[0], payment_hash_1, true);
968 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
970 if test_ignore_second_cs {
971 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
972 check_added_monitors!(nodes[2], 1);
973 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
974 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
975 check_added_monitors!(nodes[2], 1);
976 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
977 assert!(bs_cs.update_add_htlcs.is_empty());
978 assert!(bs_cs.update_fail_htlcs.is_empty());
979 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
980 assert!(bs_cs.update_fulfill_htlcs.is_empty());
981 assert!(bs_cs.update_fee.is_none());
983 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
984 check_added_monitors!(nodes[1], 1);
985 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
987 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
988 check_added_monitors!(nodes[1], 1);
990 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
991 check_added_monitors!(nodes[2], 1);
993 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
994 assert_eq!(bs_revoke_and_commit.len(), 2);
995 match bs_revoke_and_commit[0] {
996 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
997 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
998 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
999 check_added_monitors!(nodes[1], 1);
1001 _ => panic!("Unexpected event"),
1004 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1006 match bs_revoke_and_commit[1] {
1007 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1008 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1009 assert!(updates.update_add_htlcs.is_empty());
1010 assert!(updates.update_fail_htlcs.is_empty());
1011 assert!(updates.update_fail_malformed_htlcs.is_empty());
1012 assert!(updates.update_fulfill_htlcs.is_empty());
1013 assert!(updates.update_fee.is_none());
1014 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1015 check_added_monitors!(nodes[1], 1);
1017 _ => panic!("Unexpected event"),
1021 assert_eq!(as_cs.update_add_htlcs.len(), 1);
1022 assert!(as_cs.update_fail_htlcs.is_empty());
1023 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1024 assert!(as_cs.update_fulfill_htlcs.is_empty());
1025 assert!(as_cs.update_fee.is_none());
1026 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1029 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1030 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1031 check_added_monitors!(nodes[2], 1);
1032 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1034 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1035 check_added_monitors!(nodes[2], 1);
1036 let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1038 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1039 check_added_monitors!(nodes[1], 1);
1040 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1042 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1043 check_added_monitors!(nodes[1], 1);
1044 let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1046 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1047 check_added_monitors!(nodes[2], 1);
1048 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1050 expect_pending_htlcs_forwardable!(nodes[2]);
1052 let events_6 = nodes[2].node.get_and_clear_pending_events();
1053 assert_eq!(events_6.len(), 2);
1055 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1056 _ => panic!("Unexpected event"),
1059 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1060 _ => panic!("Unexpected event"),
1063 if test_ignore_second_cs {
1064 expect_pending_htlcs_forwardable!(nodes[1]);
1065 check_added_monitors!(nodes[1], 1);
1067 send_event = SendEvent::from_node(&nodes[1]);
1068 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1069 assert_eq!(send_event.msgs.len(), 1);
1070 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1071 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1073 expect_pending_htlcs_forwardable!(nodes[0]);
1075 let events_9 = nodes[0].node.get_and_clear_pending_events();
1076 assert_eq!(events_9.len(), 1);
1078 Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1079 _ => panic!("Unexpected event"),
1081 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1084 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1088 fn test_monitor_update_fail_raa() {
1089 do_test_monitor_update_fail_raa(false);
1090 do_test_monitor_update_fail_raa(true);
1094 fn test_monitor_update_fail_reestablish() {
1095 // Simple test for message retransmission after monitor update failure on
1096 // channel_reestablish generating a monitor update (which comes from freeing holding cell
1098 let chanmon_cfgs = create_chanmon_cfgs(3);
1099 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1100 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1101 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1102 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1103 create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1105 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
1107 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1108 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1110 nodes[2].node.claim_funds(payment_preimage);
1111 check_added_monitors!(nodes[2], 1);
1112 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
1114 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1115 assert!(updates.update_add_htlcs.is_empty());
1116 assert!(updates.update_fail_htlcs.is_empty());
1117 assert!(updates.update_fail_malformed_htlcs.is_empty());
1118 assert!(updates.update_fee.is_none());
1119 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1120 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1121 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
1122 check_added_monitors!(nodes[1], 1);
1123 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1124 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1126 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1127 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1128 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1130 let as_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1131 let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1133 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1135 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1137 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1138 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1140 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1141 check_added_monitors!(nodes[1], 1);
1143 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1144 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1146 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1147 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1149 assert_eq!(get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap(), as_reestablish);
1150 assert_eq!(get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap(), bs_reestablish);
1152 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1154 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1155 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1157 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1158 check_added_monitors!(nodes[1], 0);
1160 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1161 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1163 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1164 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1165 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1166 check_added_monitors!(nodes[1], 0);
1168 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1169 assert!(updates.update_add_htlcs.is_empty());
1170 assert!(updates.update_fail_htlcs.is_empty());
1171 assert!(updates.update_fail_malformed_htlcs.is_empty());
1172 assert!(updates.update_fee.is_none());
1173 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1174 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1175 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1176 expect_payment_sent!(nodes[0], payment_preimage);
1180 fn raa_no_response_awaiting_raa_state() {
1181 // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1182 // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1183 // in question (assuming it intends to respond with a CS after monitor updating is restored).
1184 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1185 let chanmon_cfgs = create_chanmon_cfgs(2);
1186 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1187 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1188 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1189 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1191 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1192 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1193 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1195 // Queue up two payments - one will be delivered right away, one immediately goes into the
1196 // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1197 // immediately after a CS. By setting failing the monitor update failure from the CS (which
1198 // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1199 // generation during RAA while in monitor-update-failed state.
1201 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1202 check_added_monitors!(nodes[0], 1);
1203 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1204 check_added_monitors!(nodes[0], 0);
1207 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1208 assert_eq!(events.len(), 1);
1209 let payment_event = SendEvent::from_event(events.pop().unwrap());
1210 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1211 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1212 check_added_monitors!(nodes[1], 1);
1214 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1215 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1216 check_added_monitors!(nodes[0], 1);
1217 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1218 assert_eq!(events.len(), 1);
1219 let payment_event = SendEvent::from_event(events.pop().unwrap());
1221 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1222 check_added_monitors!(nodes[0], 1);
1223 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1225 // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1226 // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1227 // then restore channel monitor updates.
1228 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1229 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1230 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1231 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1232 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1233 check_added_monitors!(nodes[1], 1);
1235 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1236 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1237 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Existing pending monitor update prevented responses to RAA".to_string(), 1);
1238 check_added_monitors!(nodes[1], 1);
1240 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1241 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1242 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1243 // nodes[1] should be AwaitingRAA here!
1244 check_added_monitors!(nodes[1], 0);
1245 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1246 expect_pending_htlcs_forwardable!(nodes[1]);
1247 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1249 // We send a third payment here, which is somewhat of a redundant test, but the
1250 // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1251 // commitment transaction states) whereas here we can explicitly check for it.
1253 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1254 check_added_monitors!(nodes[0], 0);
1255 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1257 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1258 check_added_monitors!(nodes[0], 1);
1259 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1260 assert_eq!(events.len(), 1);
1261 let payment_event = SendEvent::from_event(events.pop().unwrap());
1263 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1264 check_added_monitors!(nodes[0], 1);
1265 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1267 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1268 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1269 check_added_monitors!(nodes[1], 1);
1270 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1272 // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1273 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1274 check_added_monitors!(nodes[1], 1);
1275 expect_pending_htlcs_forwardable!(nodes[1]);
1276 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1277 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1279 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1280 check_added_monitors!(nodes[0], 1);
1282 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1283 check_added_monitors!(nodes[0], 1);
1284 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1286 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1287 check_added_monitors!(nodes[1], 1);
1288 expect_pending_htlcs_forwardable!(nodes[1]);
1289 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1291 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1292 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1293 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1297 fn claim_while_disconnected_monitor_update_fail() {
1298 // Test for claiming a payment while disconnected and then having the resulting
1299 // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1300 // contrived case for nodes with network instability.
1301 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1302 // code introduced a regression in this test (specifically, this caught a removal of the
1303 // channel_reestablish handling ensuring the order was sensical given the messages used).
1304 let chanmon_cfgs = create_chanmon_cfgs(2);
1305 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1306 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1307 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1308 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1310 // Forward a payment for B to claim
1311 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1313 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1314 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1316 nodes[1].node.claim_funds(payment_preimage_1);
1317 check_added_monitors!(nodes[1], 1);
1318 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1320 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1321 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1323 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1324 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1326 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1327 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1329 // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1331 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1333 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1334 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1335 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1336 check_added_monitors!(nodes[1], 1);
1337 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1339 // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1340 // the monitor still failed
1341 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1343 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1344 check_added_monitors!(nodes[0], 1);
1347 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1348 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1349 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1350 check_added_monitors!(nodes[1], 1);
1351 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1352 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1353 // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1354 // until we've channel_monitor_update'd and updated for the new commitment transaction.
1356 // Now un-fail the monitor, which will result in B sending its original commitment update,
1357 // receiving the commitment update from A, and the resulting commitment dances.
1358 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1359 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1360 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1361 check_added_monitors!(nodes[1], 0);
1363 let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1364 assert_eq!(bs_msgs.len(), 2);
1367 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1368 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1369 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1370 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1371 check_added_monitors!(nodes[0], 1);
1373 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1374 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1375 check_added_monitors!(nodes[1], 1);
1377 _ => panic!("Unexpected event"),
1381 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1382 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1383 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1384 check_added_monitors!(nodes[0], 1);
1386 _ => panic!("Unexpected event"),
1389 let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1391 let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1392 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1393 check_added_monitors!(nodes[0], 1);
1394 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1396 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1397 check_added_monitors!(nodes[1], 1);
1398 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1399 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1400 check_added_monitors!(nodes[1], 1);
1402 expect_pending_htlcs_forwardable!(nodes[1]);
1403 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1405 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1406 check_added_monitors!(nodes[0], 1);
1407 expect_payment_sent!(nodes[0], payment_preimage_1);
1409 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1413 fn monitor_failed_no_reestablish_response() {
1414 // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1415 // response to a commitment_signed.
1416 // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1417 // debug_assert!() failure in channel_reestablish handling.
1418 let chanmon_cfgs = create_chanmon_cfgs(2);
1419 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1420 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1421 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1422 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1425 get_channel_ref!(nodes[0], lock, channel_id).announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1426 get_channel_ref!(nodes[1], lock, channel_id).announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1429 // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1431 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1433 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1434 check_added_monitors!(nodes[0], 1);
1437 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1438 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1439 assert_eq!(events.len(), 1);
1440 let payment_event = SendEvent::from_event(events.pop().unwrap());
1441 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1442 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1443 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1444 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1445 check_added_monitors!(nodes[1], 1);
1447 // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1448 // is still failing to update monitors.
1449 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1450 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1452 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1453 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1455 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1456 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1458 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1459 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1460 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1461 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1463 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1464 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1465 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1466 check_added_monitors!(nodes[1], 0);
1467 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1469 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1470 check_added_monitors!(nodes[0], 1);
1471 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1472 check_added_monitors!(nodes[0], 1);
1474 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1475 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1476 check_added_monitors!(nodes[1], 1);
1478 expect_pending_htlcs_forwardable!(nodes[1]);
1479 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1481 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1485 fn first_message_on_recv_ordering() {
1486 // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1487 // messages, we're willing to flip the order of response messages if neccessary in resposne to
1488 // a commitment_signed which needs to send an RAA first.
1489 // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1490 // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1491 // response. To do this, we start routing two payments, with the final RAA for the first being
1492 // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1493 // have no pending response but will want to send a RAA/CS (with the updates for the second
1494 // payment applied).
1495 // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1496 let chanmon_cfgs = create_chanmon_cfgs(2);
1497 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1498 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1499 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1500 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1502 // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1503 // can deliver it and fail the monitor update.
1504 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1506 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1507 check_added_monitors!(nodes[0], 1);
1510 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1511 assert_eq!(events.len(), 1);
1512 let payment_event = SendEvent::from_event(events.pop().unwrap());
1513 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1514 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1515 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1516 check_added_monitors!(nodes[1], 1);
1517 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1519 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1520 check_added_monitors!(nodes[0], 1);
1521 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1522 check_added_monitors!(nodes[0], 1);
1524 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1526 // Route the second payment, generating an update_add_htlc/commitment_signed
1527 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1529 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1530 check_added_monitors!(nodes[0], 1);
1532 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1533 assert_eq!(events.len(), 1);
1534 let payment_event = SendEvent::from_event(events.pop().unwrap());
1535 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1537 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1539 // Deliver the final RAA for the first payment, which does not require a response. RAAs
1540 // generally require a commitment_signed, so the fact that we're expecting an opposite response
1541 // to the next message also tests resetting the delivery order.
1542 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1543 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1544 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1545 check_added_monitors!(nodes[1], 1);
1547 // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1548 // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1549 // appropriate HTLC acceptance).
1550 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1551 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1552 check_added_monitors!(nodes[1], 1);
1553 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1554 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1556 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1557 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1558 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1559 check_added_monitors!(nodes[1], 0);
1561 expect_pending_htlcs_forwardable!(nodes[1]);
1562 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1564 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1565 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1566 check_added_monitors!(nodes[0], 1);
1567 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1568 check_added_monitors!(nodes[0], 1);
1570 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1571 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1572 check_added_monitors!(nodes[1], 1);
1574 expect_pending_htlcs_forwardable!(nodes[1]);
1575 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1577 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1578 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1582 fn test_monitor_update_fail_claim() {
1583 // Basic test for monitor update failures when processing claim_funds calls.
1584 // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1585 // update to claim the payment. We then send two payments C->B->A, which are held at B.
1586 // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1587 // the payments from C onwards to A.
1588 let chanmon_cfgs = create_chanmon_cfgs(3);
1589 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1590 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1591 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1592 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1593 create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1595 // Rebalance a bit so that we can send backwards from 3 to 2.
1596 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1598 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1600 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1601 nodes[1].node.claim_funds(payment_preimage_1);
1602 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1603 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1604 check_added_monitors!(nodes[1], 1);
1606 // Note that at this point there is a pending commitment transaction update for A being held by
1607 // B. Even when we go to send the payment from C through B to A, B will not update this
1608 // already-signed commitment transaction and will instead wait for it to resolve before
1609 // forwarding the payment onwards.
1611 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1_000_000);
1613 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1614 check_added_monitors!(nodes[2], 1);
1617 // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1618 // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1619 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1621 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1622 assert_eq!(events.len(), 1);
1623 let payment_event = SendEvent::from_event(events.pop().unwrap());
1624 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1625 let events = nodes[1].node.get_and_clear_pending_msg_events();
1626 assert_eq!(events.len(), 0);
1627 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1629 let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1630 nodes[2].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1631 check_added_monitors!(nodes[2], 1);
1633 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1634 assert_eq!(events.len(), 1);
1635 let payment_event = SendEvent::from_event(events.pop().unwrap());
1636 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1637 let events = nodes[1].node.get_and_clear_pending_msg_events();
1638 assert_eq!(events.len(), 0);
1639 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1641 // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1642 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1643 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1644 check_added_monitors!(nodes[1], 0);
1646 let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1647 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1648 commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1649 expect_payment_sent!(nodes[0], payment_preimage_1);
1651 // Get the payment forwards, note that they were batched into one commitment update.
1652 expect_pending_htlcs_forwardable!(nodes[1]);
1653 check_added_monitors!(nodes[1], 1);
1654 let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1655 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1656 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1657 commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1658 expect_pending_htlcs_forwardable!(nodes[0]);
1660 let events = nodes[0].node.get_and_clear_pending_events();
1661 assert_eq!(events.len(), 2);
1663 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1664 assert_eq!(payment_hash_2, *payment_hash);
1665 assert_eq!(1_000_000, amount_msat);
1667 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1668 assert!(payment_preimage.is_none());
1669 assert_eq!(payment_secret_2, *payment_secret);
1671 _ => panic!("expected PaymentPurpose::InvoicePayment")
1674 _ => panic!("Unexpected event"),
1677 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1678 assert_eq!(payment_hash_3, *payment_hash);
1679 assert_eq!(1_000_000, amount_msat);
1681 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1682 assert!(payment_preimage.is_none());
1683 assert_eq!(payment_secret_3, *payment_secret);
1685 _ => panic!("expected PaymentPurpose::InvoicePayment")
1688 _ => panic!("Unexpected event"),
1693 fn test_monitor_update_on_pending_forwards() {
1694 // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1695 // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1696 // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1697 // from C to A will be pending a forward to A.
1698 let chanmon_cfgs = create_chanmon_cfgs(3);
1699 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1700 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1701 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1702 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1703 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1705 // Rebalance a bit so that we can send backwards from 3 to 1.
1706 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1708 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1709 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
1710 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
1711 check_added_monitors!(nodes[2], 1);
1713 let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1714 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1715 commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1716 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1718 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
1720 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1721 check_added_monitors!(nodes[2], 1);
1724 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1725 assert_eq!(events.len(), 1);
1726 let payment_event = SendEvent::from_event(events.pop().unwrap());
1727 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1728 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1730 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1731 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 }]);
1732 check_added_monitors!(nodes[1], 1);
1733 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1734 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1736 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1737 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1738 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1739 check_added_monitors!(nodes[1], 0);
1741 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1742 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1743 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1744 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1746 let events = nodes[0].node.get_and_clear_pending_events();
1747 assert_eq!(events.len(), 2);
1748 if let Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } = events[0] {
1749 assert_eq!(payment_hash, payment_hash_1);
1750 assert!(payment_failed_permanently);
1751 } else { panic!("Unexpected event!"); }
1753 Event::PendingHTLCsForwardable { .. } => { },
1754 _ => panic!("Unexpected event"),
1756 nodes[0].node.process_pending_htlc_forwards();
1757 expect_payment_received!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1759 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1763 fn monitor_update_claim_fail_no_response() {
1764 // Test for claim_funds resulting in both a monitor update failure and no message response (due
1765 // to channel being AwaitingRAA).
1766 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1768 let chanmon_cfgs = create_chanmon_cfgs(2);
1769 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1770 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1771 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1772 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1774 // Forward a payment for B to claim
1775 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1777 // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1778 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1780 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1781 check_added_monitors!(nodes[0], 1);
1784 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1785 assert_eq!(events.len(), 1);
1786 let payment_event = SendEvent::from_event(events.pop().unwrap());
1787 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1788 let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1790 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1791 nodes[1].node.claim_funds(payment_preimage_1);
1792 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1793 check_added_monitors!(nodes[1], 1);
1795 let events = nodes[1].node.get_and_clear_pending_msg_events();
1796 assert_eq!(events.len(), 0);
1797 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1799 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1800 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1801 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1802 check_added_monitors!(nodes[1], 0);
1803 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1805 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1806 check_added_monitors!(nodes[1], 1);
1807 expect_pending_htlcs_forwardable!(nodes[1]);
1808 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1810 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1811 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1812 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1813 expect_payment_sent!(nodes[0], payment_preimage_1);
1815 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1818 // restore_b_before_conf has no meaning if !confirm_a_first
1819 // restore_b_before_lock has no meaning if confirm_a_first
1820 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool, restore_b_before_lock: bool) {
1821 // Test that if the monitor update generated by funding_transaction_generated fails we continue
1822 // the channel setup happily after the update is restored.
1823 let chanmon_cfgs = create_chanmon_cfgs(2);
1824 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1825 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1826 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1828 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1829 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
1830 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
1832 let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
1834 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
1835 check_added_monitors!(nodes[0], 0);
1837 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1838 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1839 let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1840 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1841 check_added_monitors!(nodes[1], 1);
1843 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1844 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()));
1845 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1846 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1847 check_added_monitors!(nodes[0], 1);
1848 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1849 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1850 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1851 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1852 check_added_monitors!(nodes[0], 0);
1854 let events = nodes[0].node.get_and_clear_pending_events();
1855 assert_eq!(events.len(), 0);
1856 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1857 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1859 if confirm_a_first {
1860 confirm_transaction(&nodes[0], &funding_tx);
1861 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()));
1862 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1863 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1865 assert!(!restore_b_before_conf);
1866 confirm_transaction(&nodes[1], &funding_tx);
1867 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1870 // Make sure nodes[1] isn't stupid enough to re-send the ChannelReady on reconnect
1871 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1872 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1873 reconnect_nodes(&nodes[0], &nodes[1], (false, confirm_a_first), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1874 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1875 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1877 if !restore_b_before_conf {
1878 confirm_transaction(&nodes[1], &funding_tx);
1879 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1880 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1882 if !confirm_a_first && !restore_b_before_lock {
1883 confirm_transaction(&nodes[0], &funding_tx);
1884 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()));
1885 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1886 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1889 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1890 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1891 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1892 check_added_monitors!(nodes[1], 0);
1894 let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1895 if !restore_b_before_lock {
1896 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1897 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1899 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()));
1900 confirm_transaction(&nodes[0], &funding_tx);
1901 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1902 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready))
1905 if restore_b_before_conf {
1906 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1907 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1908 confirm_transaction(&nodes[1], &funding_tx);
1910 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1911 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1913 for node in nodes.iter() {
1914 assert!(node.gossip_sync.handle_channel_announcement(&announcement).unwrap());
1915 node.gossip_sync.handle_channel_update(&as_update).unwrap();
1916 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
1919 send_payment(&nodes[0], &[&nodes[1]], 8000000);
1920 close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1921 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
1922 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1926 fn during_funding_monitor_fail() {
1927 do_during_funding_monitor_fail(true, true, false);
1928 do_during_funding_monitor_fail(true, false, false);
1929 do_during_funding_monitor_fail(false, false, false);
1930 do_during_funding_monitor_fail(false, false, true);
1934 fn test_path_paused_mpp() {
1935 // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1937 let chanmon_cfgs = create_chanmon_cfgs(4);
1938 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1939 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1940 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1942 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
1943 let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1944 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
1945 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
1947 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
1949 // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1950 let path = route.paths[0].clone();
1951 route.paths.push(path);
1952 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
1953 route.paths[0][0].short_channel_id = chan_1_id;
1954 route.paths[0][1].short_channel_id = chan_3_id;
1955 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
1956 route.paths[1][0].short_channel_id = chan_2_ann.contents.short_channel_id;
1957 route.paths[1][1].short_channel_id = chan_4_id;
1959 // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
1960 // (for the path 0 -> 2 -> 3) fails.
1961 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1962 chanmon_cfgs[0].persister.set_next_update_ret(Some(ChannelMonitorUpdateStatus::InProgress));
1964 // Now check that we get the right return value, indicating that the first path succeeded but
1965 // the second got a MonitorUpdateInProgress err. This implies
1966 // PaymentSendFailure::PartialFailure as some paths succeeded, preventing retry.
1967 if let Err(PaymentSendFailure::PartialFailure { results, ..}) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)) {
1968 assert_eq!(results.len(), 2);
1969 if let Ok(()) = results[0] {} else { panic!(); }
1970 if let Err(APIError::MonitorUpdateInProgress) = results[1] {} else { panic!(); }
1971 } else { panic!(); }
1972 check_added_monitors!(nodes[0], 2);
1973 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1975 // Pass the first HTLC of the payment along to nodes[3].
1976 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1977 assert_eq!(events.len(), 1);
1978 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false, None);
1980 // And check that, after we successfully update the monitor for chan_2 we can pass the second
1981 // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
1982 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
1983 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1984 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1985 assert_eq!(events.len(), 1);
1986 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true, None);
1988 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
1992 fn test_pending_update_fee_ack_on_reconnect() {
1993 // In early versions of our automated fee update patch, nodes did not correctly use the
1994 // previous channel feerate after sending an undelivered revoke_and_ack when re-sending an
1995 // undelivered commitment_signed.
1997 // B sends A new HTLC + CS, not delivered
1998 // A sends B update_fee + CS
1999 // B receives the CS and sends RAA, previously causing B to lock in the new feerate
2001 // B resends initial CS, using the original fee
2003 let chanmon_cfgs = create_chanmon_cfgs(2);
2004 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2005 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2006 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2008 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2009 send_payment(&nodes[0], &[&nodes[1]], 100_000_00);
2011 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[1], nodes[0], 1_000_000);
2012 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
2013 check_added_monitors!(nodes[1], 1);
2014 let bs_initial_send_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2015 // bs_initial_send_msgs are not delivered until they are re-generated after reconnect
2018 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2021 nodes[0].node.timer_tick_occurred();
2022 check_added_monitors!(nodes[0], 1);
2023 let as_update_fee_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2024 assert!(as_update_fee_msgs.update_fee.is_some());
2026 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_update_fee_msgs.update_fee.as_ref().unwrap());
2027 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_fee_msgs.commitment_signed);
2028 check_added_monitors!(nodes[1], 1);
2029 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2030 // bs_first_raa is not delivered until it is re-generated after reconnect
2032 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2033 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2035 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2036 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2037 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2038 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2040 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2041 let bs_resend_msgs = nodes[1].node.get_and_clear_pending_msg_events();
2042 assert_eq!(bs_resend_msgs.len(), 3);
2043 if let MessageSendEvent::UpdateHTLCs { ref updates, .. } = bs_resend_msgs[0] {
2044 assert_eq!(*updates, bs_initial_send_msgs);
2045 } else { panic!(); }
2046 if let MessageSendEvent::SendRevokeAndACK { ref msg, .. } = bs_resend_msgs[1] {
2047 assert_eq!(*msg, bs_first_raa);
2048 } else { panic!(); }
2049 if let MessageSendEvent::SendChannelUpdate { .. } = bs_resend_msgs[2] { } else { panic!(); }
2051 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2052 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
2054 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.update_add_htlcs[0]);
2055 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.commitment_signed);
2056 check_added_monitors!(nodes[0], 1);
2057 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()));
2058 check_added_monitors!(nodes[1], 1);
2059 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()).commitment_signed;
2061 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2062 check_added_monitors!(nodes[0], 1);
2063 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);
2064 check_added_monitors!(nodes[1], 1);
2065 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2067 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2068 check_added_monitors!(nodes[0], 1);
2069 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2070 check_added_monitors!(nodes[0], 1);
2072 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()));
2073 check_added_monitors!(nodes[1], 1);
2075 expect_pending_htlcs_forwardable!(nodes[0]);
2076 expect_payment_received!(nodes[0], payment_hash, payment_secret, 1_000_000);
2078 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
2082 fn test_fail_htlc_on_broadcast_after_claim() {
2083 // In an earlier version of 7e78fa660cec8a73286c94c1073ee588140e7a01 we'd also fail the inbound
2084 // channel backwards if we received an HTLC failure after a HTLC fulfillment. Here we test a
2085 // specific case of that by having the HTLC failure come from the ChannelMonitor after a dust
2086 // HTLC was not included in a confirmed commitment transaction.
2088 // We first forward a payment, then claim it with an update_fulfill_htlc message, closing the
2089 // channel immediately before commitment occurs. After the commitment transaction reaches
2090 // ANTI_REORG_DELAY confirmations, will will try to fail the HTLC which was already fulfilled.
2091 let chanmon_cfgs = create_chanmon_cfgs(3);
2092 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2093 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2094 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2096 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2097 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2099 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 2000);
2101 let bs_txn = get_local_commitment_txn!(nodes[2], chan_id_2);
2102 assert_eq!(bs_txn.len(), 1);
2104 nodes[2].node.claim_funds(payment_preimage);
2105 check_added_monitors!(nodes[2], 1);
2106 expect_payment_claimed!(nodes[2], payment_hash, 2000);
2108 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2109 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
2110 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2111 check_added_monitors!(nodes[1], 1);
2112 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2114 mine_transaction(&nodes[1], &bs_txn[0]);
2115 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2116 check_closed_broadcast!(nodes[1], true);
2117 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2118 check_added_monitors!(nodes[1], 1);
2119 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 }]);
2121 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
2122 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2123 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, true, true);
2124 expect_payment_path_successful!(nodes[0]);
2127 fn do_update_fee_resend_test(deliver_update: bool, parallel_updates: bool) {
2128 // In early versions we did not handle resending of update_fee on reconnect correctly. The
2129 // chanmon_consistency fuzz target, of course, immediately found it, but we test a few cases
2131 let chanmon_cfgs = create_chanmon_cfgs(2);
2132 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2133 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2134 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2136 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2137 send_payment(&nodes[0], &[&nodes[1]], 1000);
2140 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2141 *feerate_lock += 20;
2143 nodes[0].node.timer_tick_occurred();
2144 check_added_monitors!(nodes[0], 1);
2145 let update_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2146 assert!(update_msgs.update_fee.is_some());
2148 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2151 if parallel_updates {
2153 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2154 *feerate_lock += 20;
2156 nodes[0].node.timer_tick_occurred();
2157 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2160 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2161 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2163 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2164 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2165 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2166 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2168 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2169 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
2170 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2172 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2173 let mut as_reconnect_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2174 assert_eq!(as_reconnect_msgs.len(), 2);
2175 if let MessageSendEvent::SendChannelUpdate { .. } = as_reconnect_msgs.pop().unwrap() {} else { panic!(); }
2176 let update_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = as_reconnect_msgs.pop().unwrap()
2177 { updates } else { panic!(); };
2178 assert!(update_msgs.update_fee.is_some());
2179 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2180 if parallel_updates {
2181 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update_msgs.commitment_signed);
2182 check_added_monitors!(nodes[1], 1);
2183 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2184 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2185 check_added_monitors!(nodes[0], 1);
2186 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2188 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2189 check_added_monitors!(nodes[0], 1);
2190 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2192 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_second_update.update_fee.as_ref().unwrap());
2193 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
2194 check_added_monitors!(nodes[1], 1);
2195 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2197 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2198 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2199 check_added_monitors!(nodes[1], 1);
2201 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2202 check_added_monitors!(nodes[0], 1);
2204 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs.commitment_signed);
2205 check_added_monitors!(nodes[0], 1);
2206 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2208 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2209 check_added_monitors!(nodes[1], 1);
2211 commitment_signed_dance!(nodes[1], nodes[0], update_msgs.commitment_signed, false);
2214 send_payment(&nodes[0], &[&nodes[1]], 1000);
2217 fn update_fee_resend_test() {
2218 do_update_fee_resend_test(false, false);
2219 do_update_fee_resend_test(true, false);
2220 do_update_fee_resend_test(false, true);
2221 do_update_fee_resend_test(true, true);
2224 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2225 // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2226 // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2227 // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2228 // which failed in such a case).
2229 let chanmon_cfgs = create_chanmon_cfgs(2);
2230 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2231 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2232 let persister: test_utils::TestPersister;
2233 let new_chain_monitor: test_utils::TestChainMonitor;
2234 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2235 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2237 let chan_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 15_000_000, 7_000_000_000, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2238 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
2239 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2241 // Do a really complicated dance to get an HTLC into the holding cell, with
2242 // MonitorUpdateInProgress set but AwaitingRemoteRevoke unset. When this test was written, any
2243 // attempts to send an HTLC while MonitorUpdateInProgress is set are immediately
2244 // failed-backwards. Thus, the only way to get an AddHTLC into the holding cell is to add it
2245 // while AwaitingRemoteRevoke is set but MonitorUpdateInProgress is unset, and then swap the
2249 // a) routing a payment from node B to node A,
2250 // b) sending a payment from node A to node B without delivering any of the generated messages,
2251 // putting node A in AwaitingRemoteRevoke,
2252 // c) sending a second payment from node A to node B, which is immediately placed in the
2254 // d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2255 // when we try to persist the payment preimage,
2256 // e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2257 // clearing AwaitingRemoteRevoke on node A.
2259 // Note that because, at the end, MonitorUpdateInProgress is still set, the HTLC generated in
2260 // (c) will not be freed from the holding cell.
2261 let (payment_preimage_0, payment_hash_0, _) = route_payment(&nodes[1], &[&nodes[0]], 100_000);
2263 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
2264 check_added_monitors!(nodes[0], 1);
2265 let send = SendEvent::from_node(&nodes[0]);
2266 assert_eq!(send.msgs.len(), 1);
2268 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
2269 check_added_monitors!(nodes[0], 0);
2271 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2272 nodes[0].node.claim_funds(payment_preimage_0);
2273 check_added_monitors!(nodes[0], 1);
2274 expect_payment_claimed!(nodes[0], payment_hash_0, 100_000);
2276 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2277 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2278 check_added_monitors!(nodes[1], 1);
2280 let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2282 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2283 check_added_monitors!(nodes[0], 1);
2286 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2287 // disconnect the peers. Note that the fuzzer originally found this issue because
2288 // deserializing a ChannelManager in this state causes an assertion failure.
2290 let nodes_0_serialized = nodes[0].node.encode();
2291 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
2292 get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
2294 persister = test_utils::TestPersister::new();
2295 let keys_manager = &chanmon_cfgs[0].keys_manager;
2296 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
2297 nodes[0].chain_monitor = &new_chain_monitor;
2298 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
2299 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
2300 &mut chan_0_monitor_read, keys_manager).unwrap();
2301 assert!(chan_0_monitor_read.is_empty());
2303 let mut nodes_0_read = &nodes_0_serialized[..];
2304 let config = UserConfig::default();
2305 nodes_0_deserialized = {
2306 let mut channel_monitors = HashMap::new();
2307 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
2308 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
2309 default_config: config,
2311 fee_estimator: node_cfgs[0].fee_estimator,
2312 chain_monitor: nodes[0].chain_monitor,
2313 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
2314 logger: nodes[0].logger,
2318 nodes[0].node = &nodes_0_deserialized;
2319 assert!(nodes_0_read.is_empty());
2321 assert_eq!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0.clone(), chan_0_monitor),
2322 ChannelMonitorUpdateStatus::Completed);
2323 check_added_monitors!(nodes[0], 1);
2325 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2327 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2329 // Now reconnect the two
2330 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2331 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2332 assert_eq!(reestablish_1.len(), 1);
2333 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2334 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2335 assert_eq!(reestablish_2.len(), 1);
2337 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2338 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2339 check_added_monitors!(nodes[1], 0);
2341 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2342 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2344 assert!(resp_0.0.is_none());
2345 assert!(resp_0.1.is_none());
2346 assert!(resp_0.2.is_none());
2347 assert!(resp_1.0.is_none());
2348 assert!(resp_1.1.is_none());
2350 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2352 if let Some(pending_cs) = resp_1.2 {
2353 assert!(pending_cs.update_add_htlcs.is_empty());
2354 assert!(pending_cs.update_fail_htlcs.is_empty());
2355 assert!(pending_cs.update_fulfill_htlcs.is_empty());
2356 assert_eq!(pending_cs.commitment_signed, cs);
2357 } else { panic!(); }
2359 // There should be no monitor updates as we are still pending awaiting a failed one.
2360 check_added_monitors!(nodes[0], 0);
2361 check_added_monitors!(nodes[1], 0);
2364 // If we finish updating the monitor, we should free the holding cell right away (this did
2365 // not occur prior to #756).
2366 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2367 let (funding_txo, mon_id, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2368 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_txo, mon_id);
2370 // New outbound messages should be generated immediately upon a call to
2371 // get_and_clear_pending_msg_events (but not before).
2372 check_added_monitors!(nodes[0], 0);
2373 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2374 check_added_monitors!(nodes[0], 1);
2375 assert_eq!(events.len(), 1);
2377 // Deliver the pending in-flight CS
2378 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2379 check_added_monitors!(nodes[0], 1);
2381 let commitment_msg = match events.pop().unwrap() {
2382 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2383 assert_eq!(node_id, nodes[1].node.get_our_node_id());
2384 assert!(updates.update_fail_htlcs.is_empty());
2385 assert!(updates.update_fail_malformed_htlcs.is_empty());
2386 assert!(updates.update_fee.is_none());
2387 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2388 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2389 expect_payment_sent_without_paths!(nodes[1], payment_preimage_0);
2390 assert_eq!(updates.update_add_htlcs.len(), 1);
2391 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2392 updates.commitment_signed
2394 _ => panic!("Unexpected event type!"),
2397 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2398 check_added_monitors!(nodes[1], 1);
2400 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2401 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2402 expect_pending_htlcs_forwardable!(nodes[1]);
2403 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2404 check_added_monitors!(nodes[1], 1);
2406 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
2408 let events = nodes[1].node.get_and_clear_pending_events();
2409 assert_eq!(events.len(), 2);
2411 Event::PendingHTLCsForwardable { .. } => { },
2412 _ => panic!("Unexpected event"),
2415 Event::PaymentPathSuccessful { .. } => { },
2416 _ => panic!("Unexpected event"),
2419 nodes[1].node.process_pending_htlc_forwards();
2420 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2422 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2423 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2426 fn channel_holding_cell_serialize() {
2427 do_channel_holding_cell_serialize(true, true);
2428 do_channel_holding_cell_serialize(true, false);
2429 do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2432 #[derive(PartialEq)]
2433 enum HTLCStatusAtDupClaim {
2438 fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_fails: bool) {
2439 // When receiving an update_fulfill_htlc message, we immediately forward the claim backwards
2440 // along the payment path before waiting for a full commitment_signed dance. This is great, but
2441 // can cause duplicative claims if a node sends an update_fulfill_htlc message, disconnects,
2442 // reconnects, and then has to re-send its update_fulfill_htlc message again.
2443 // In previous code, we didn't handle the double-claim correctly, spuriously closing the
2444 // channel on which the inbound HTLC was received.
2445 let chanmon_cfgs = create_chanmon_cfgs(3);
2446 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2447 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2448 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2450 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2451 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2453 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
2455 let mut as_raa = None;
2456 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2457 // In order to get the HTLC claim into the holding cell at nodes[1], we need nodes[1] to be
2458 // awaiting a remote revoke_and_ack from nodes[0].
2459 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
2460 nodes[0].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
2461 check_added_monitors!(nodes[0], 1);
2463 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
2464 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
2465 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
2466 check_added_monitors!(nodes[1], 1);
2468 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2469 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2470 check_added_monitors!(nodes[0], 1);
2471 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
2472 check_added_monitors!(nodes[0], 1);
2474 as_raa = Some(get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2477 let fulfill_msg = msgs::UpdateFulfillHTLC {
2478 channel_id: chan_id_2,
2483 nodes[2].node.fail_htlc_backwards(&payment_hash);
2484 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash }]);
2485 check_added_monitors!(nodes[2], 1);
2486 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2488 nodes[2].node.claim_funds(payment_preimage);
2489 check_added_monitors!(nodes[2], 1);
2490 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
2492 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2493 assert_eq!(cs_updates.update_fulfill_htlcs.len(), 1);
2494 // Check that the message we're about to deliver matches the one generated:
2495 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
2497 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
2498 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2499 check_added_monitors!(nodes[1], 1);
2501 let mut bs_updates = None;
2502 if htlc_status != HTLCStatusAtDupClaim::HoldingCell {
2503 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2504 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2505 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2506 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2507 if htlc_status == HTLCStatusAtDupClaim::Cleared {
2508 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2509 expect_payment_path_successful!(nodes[0]);
2512 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2515 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
2516 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2519 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
2520 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 }]);
2522 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2525 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2526 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa.unwrap());
2527 check_added_monitors!(nodes[1], 1);
2528 expect_pending_htlcs_forwardable_ignore!(nodes[1]); // We finally receive the second payment, but don't claim it
2530 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2531 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2532 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2533 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2535 if htlc_status != HTLCStatusAtDupClaim::Cleared {
2536 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2537 expect_payment_path_successful!(nodes[0]);
2542 fn test_reconnect_dup_htlc_claims() {
2543 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, false);
2544 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, false);
2545 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, false);
2546 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, true);
2547 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, true);
2548 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, true);
2552 fn test_temporary_error_during_shutdown() {
2553 // Test that temporary failures when updating the monitor's shutdown script delay cooperative
2555 let mut config = test_default_channel_config();
2556 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2558 let chanmon_cfgs = create_chanmon_cfgs(2);
2559 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2560 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
2561 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2563 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2565 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2566 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2568 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
2569 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
2570 check_added_monitors!(nodes[1], 1);
2572 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id()));
2573 check_added_monitors!(nodes[0], 1);
2575 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2577 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2578 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2580 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2581 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2582 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()));
2584 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2586 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2587 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2588 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2590 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()));
2591 let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
2592 let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2594 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_a.unwrap());
2595 let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
2596 assert!(none_b.is_none());
2597 let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2599 assert_eq!(txn_a, txn_b);
2600 assert_eq!(txn_a.len(), 1);
2601 check_spends!(txn_a[0], funding_tx);
2602 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
2603 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
2607 fn test_permanent_error_during_sending_shutdown() {
2608 // Test that permanent failures when updating the monitor's shutdown script result in a force
2609 // close when initiating a cooperative close.
2610 let mut config = test_default_channel_config();
2611 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2613 let chanmon_cfgs = create_chanmon_cfgs(2);
2614 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2615 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
2616 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2618 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2619 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2621 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2622 check_closed_broadcast!(nodes[0], true);
2623 check_added_monitors!(nodes[0], 2);
2624 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2628 fn test_permanent_error_during_handling_shutdown() {
2629 // Test that permanent failures when updating the monitor's shutdown script result in a force
2630 // close when handling a cooperative close.
2631 let mut config = test_default_channel_config();
2632 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2634 let chanmon_cfgs = create_chanmon_cfgs(2);
2635 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2636 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
2637 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2639 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2640 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2642 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2643 let shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
2644 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &shutdown);
2645 check_closed_broadcast!(nodes[1], true);
2646 check_added_monitors!(nodes[1], 2);
2647 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2651 fn double_temp_error() {
2652 // Test that it's OK to have multiple `ChainMonitor::update_channel` calls fail in a row.
2653 let chanmon_cfgs = create_chanmon_cfgs(2);
2654 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2655 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2656 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2658 let (_, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2660 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2661 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2663 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2664 // `claim_funds` results in a ChannelMonitorUpdate.
2665 nodes[1].node.claim_funds(payment_preimage_1);
2666 check_added_monitors!(nodes[1], 1);
2667 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
2668 let (funding_tx, latest_update_1, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2670 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2671 // Previously, this would've panicked due to a double-call to `Channel::monitor_update_failed`,
2672 // which had some asserts that prevented it from being called twice.
2673 nodes[1].node.claim_funds(payment_preimage_2);
2674 check_added_monitors!(nodes[1], 1);
2675 expect_payment_claimed!(nodes[1], payment_hash_2, 1_000_000);
2676 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2678 let (_, latest_update_2, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2679 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_1);
2680 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2681 check_added_monitors!(nodes[1], 0);
2682 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_2);
2684 // Complete the first HTLC.
2685 let events = nodes[1].node.get_and_clear_pending_msg_events();
2686 assert_eq!(events.len(), 1);
2687 let (update_fulfill_1, commitment_signed_b1, node_id) = {
2689 &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 } } => {
2690 assert!(update_add_htlcs.is_empty());
2691 assert_eq!(update_fulfill_htlcs.len(), 1);
2692 assert!(update_fail_htlcs.is_empty());
2693 assert!(update_fail_malformed_htlcs.is_empty());
2694 assert!(update_fee.is_none());
2695 (update_fulfill_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2697 _ => panic!("Unexpected event"),
2700 assert_eq!(node_id, nodes[0].node.get_our_node_id());
2701 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_1);
2702 check_added_monitors!(nodes[0], 0);
2703 expect_payment_sent_without_paths!(nodes[0], payment_preimage_1);
2704 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_b1);
2705 check_added_monitors!(nodes[0], 1);
2706 nodes[0].node.process_pending_htlc_forwards();
2707 let (raa_a1, commitment_signed_a1) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2708 check_added_monitors!(nodes[1], 0);
2709 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2710 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_a1);
2711 check_added_monitors!(nodes[1], 1);
2712 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed_a1);
2713 check_added_monitors!(nodes[1], 1);
2715 // Complete the second HTLC.
2716 let ((update_fulfill_2, commitment_signed_b2), raa_b2) = {
2717 let events = nodes[1].node.get_and_clear_pending_msg_events();
2718 assert_eq!(events.len(), 2);
2720 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2721 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2722 assert!(updates.update_add_htlcs.is_empty());
2723 assert!(updates.update_fail_htlcs.is_empty());
2724 assert!(updates.update_fail_malformed_htlcs.is_empty());
2725 assert!(updates.update_fee.is_none());
2726 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2727 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2729 _ => panic!("Unexpected event"),
2732 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2733 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2736 _ => panic!("Unexpected event"),
2739 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_b2);
2740 check_added_monitors!(nodes[0], 1);
2741 expect_payment_path_successful!(nodes[0]);
2743 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_2);
2744 check_added_monitors!(nodes[0], 0);
2745 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2746 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed_b2, false);
2747 expect_payment_sent!(nodes[0], payment_preimage_2);
2750 fn do_test_outbound_reload_without_init_mon(use_0conf: bool) {
2751 // Test that if the monitor update generated in funding_signed is stored async and we restart
2752 // with the latest ChannelManager but the ChannelMonitor persistence never completed we happily
2753 // drop the channel and move on.
2754 let chanmon_cfgs = create_chanmon_cfgs(2);
2755 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2757 let persister: test_utils::TestPersister;
2758 let new_chain_monitor: test_utils::TestChainMonitor;
2759 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2761 let mut chan_config = test_default_channel_config();
2762 chan_config.manually_accept_inbound_channels = true;
2763 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2765 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2766 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2768 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2769 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
2771 let events = nodes[1].node.get_and_clear_pending_events();
2772 assert_eq!(events.len(), 1);
2774 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2776 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2778 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2781 _ => panic!("Unexpected event"),
2784 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
2786 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2788 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2789 check_added_monitors!(nodes[0], 0);
2791 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2792 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2793 check_added_monitors!(nodes[1], 1);
2795 let bs_signed_locked = nodes[1].node.get_and_clear_pending_msg_events();
2796 assert_eq!(bs_signed_locked.len(), if use_0conf { 2 } else { 1 });
2797 match &bs_signed_locked[0] {
2798 MessageSendEvent::SendFundingSigned { msg, .. } => {
2799 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2801 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &msg);
2802 check_added_monitors!(nodes[0], 1);
2804 _ => panic!("Unexpected event"),
2807 match &bs_signed_locked[1] {
2808 MessageSendEvent::SendChannelReady { msg, .. } => {
2809 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &msg);
2811 _ => panic!("Unexpected event"),
2815 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
2816 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2817 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2819 // nodes[0] is now waiting on the first ChannelMonitor persistence to complete in order to
2820 // broadcast the funding transaction. If nodes[0] restarts at this point with the
2821 // ChannelMonitor lost, we should simply discard the channel.
2823 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2824 // not, so we have to clear them here.
2825 nodes[0].chain_source.watched_txn.lock().unwrap().clear();
2826 nodes[0].chain_source.watched_outputs.lock().unwrap().clear();
2828 let nodes_0_serialized = nodes[0].node.encode();
2829 persister = test_utils::TestPersister::new();
2830 let keys_manager = &chanmon_cfgs[0].keys_manager;
2831 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
2832 nodes[0].chain_monitor = &new_chain_monitor;
2834 let mut nodes_0_read = &nodes_0_serialized[..];
2835 let config = UserConfig::default();
2836 nodes_0_deserialized = {
2837 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
2838 default_config: config,
2840 fee_estimator: node_cfgs[0].fee_estimator,
2841 chain_monitor: nodes[0].chain_monitor,
2842 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
2843 logger: nodes[0].logger,
2844 channel_monitors: HashMap::new(),
2847 nodes[0].node = &nodes_0_deserialized;
2848 assert!(nodes_0_read.is_empty());
2850 check_closed_event!(nodes[0], 1, ClosureReason::DisconnectedPeer);
2851 assert!(nodes[0].node.list_channels().is_empty());
2855 fn test_outbound_reload_without_init_mon() {
2856 do_test_outbound_reload_without_init_mon(true);
2857 do_test_outbound_reload_without_init_mon(false);
2860 fn do_test_inbound_reload_without_init_mon(use_0conf: bool, lock_commitment: bool) {
2861 // Test that if the monitor update generated by funding_transaction_generated is stored async
2862 // and we restart with the latest ChannelManager but the ChannelMonitor persistence never
2863 // completed we happily drop the channel and move on.
2864 let chanmon_cfgs = create_chanmon_cfgs(2);
2865 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2867 let persister: test_utils::TestPersister;
2868 let new_chain_monitor: test_utils::TestChainMonitor;
2869 let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2871 let mut chan_config = test_default_channel_config();
2872 chan_config.manually_accept_inbound_channels = true;
2873 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2875 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2876 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2878 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2879 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
2881 let events = nodes[1].node.get_and_clear_pending_events();
2882 assert_eq!(events.len(), 1);
2884 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2886 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2888 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2891 _ => panic!("Unexpected event"),
2894 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
2896 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2898 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2899 check_added_monitors!(nodes[0], 0);
2901 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2902 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2903 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2904 check_added_monitors!(nodes[1], 1);
2906 // nodes[1] happily sends its funding_signed even though its awaiting the persistence of the
2907 // initial ChannelMonitor, but it will decline to send its channel_ready even if the funding
2908 // transaction is confirmed.
2909 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
2911 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
2912 check_added_monitors!(nodes[0], 1);
2914 let as_funding_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2915 if lock_commitment {
2916 confirm_transaction(&nodes[0], &as_funding_tx[0]);
2917 confirm_transaction(&nodes[1], &as_funding_tx[0]);
2919 if use_0conf || lock_commitment {
2920 let as_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
2921 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_ready);
2923 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2925 // nodes[1] is now waiting on the first ChannelMonitor persistence to complete in order to
2926 // move the channel to ready (or is waiting on the funding transaction to confirm). If nodes[1]
2927 // restarts at this point with the ChannelMonitor lost, we should simply discard the channel.
2929 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2930 // not, so we have to clear them here.
2931 nodes[1].chain_source.watched_txn.lock().unwrap().clear();
2932 nodes[1].chain_source.watched_outputs.lock().unwrap().clear();
2934 let nodes_1_serialized = nodes[1].node.encode();
2935 persister = test_utils::TestPersister::new();
2936 let keys_manager = &chanmon_cfgs[1].keys_manager;
2937 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger, node_cfgs[1].fee_estimator, &persister, keys_manager);
2938 nodes[1].chain_monitor = &new_chain_monitor;
2940 let mut nodes_1_read = &nodes_1_serialized[..];
2941 let config = UserConfig::default();
2942 nodes_1_deserialized = {
2943 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
2944 default_config: config,
2946 fee_estimator: node_cfgs[1].fee_estimator,
2947 chain_monitor: nodes[1].chain_monitor,
2948 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
2949 logger: nodes[1].logger,
2950 channel_monitors: HashMap::new(),
2953 nodes[1].node = &nodes_1_deserialized;
2954 assert!(nodes_1_read.is_empty());
2956 check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
2957 assert!(nodes[1].node.list_channels().is_empty());
2961 fn test_inbound_reload_without_init_mon() {
2962 do_test_inbound_reload_without_init_mon(true, true);
2963 do_test_inbound_reload_without_init_mon(true, false);
2964 do_test_inbound_reload_without_init_mon(false, true);
2965 do_test_inbound_reload_without_init_mon(false, false);