1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Functional tests which test the correct handling of ChannelMonitorUpdateStatus returns from
12 //! There are a bunch of these as their handling is relatively error-prone so they are split out
13 //! here. See also the chanmon_fail_consistency fuzz test.
15 use bitcoin::blockdata::block::{Block, BlockHeader};
16 use bitcoin::blockdata::constants::genesis_block;
17 use bitcoin::hash_types::BlockHash;
18 use bitcoin::network::constants::Network;
19 use crate::chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor};
20 use crate::chain::transaction::OutPoint;
21 use crate::chain::{ChannelMonitorUpdateStatus, Listen, Watch};
22 use crate::ln::channelmanager::{self, ChannelManager, RAACommitmentOrder, PaymentSendFailure, PaymentId};
23 use crate::ln::channel::AnnouncementSigsState;
25 use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
26 use crate::util::enforcing_trait_impls::EnforcingSigner;
27 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason, HTLCDestination};
28 use crate::util::errors::APIError;
29 use crate::util::ser::{ReadableArgs, Writeable};
30 use crate::util::test_utils::TestBroadcaster;
32 use crate::ln::functional_test_utils::*;
34 use crate::util::test_utils;
37 use bitcoin::hashes::Hash;
38 use bitcoin::TxMerkleNode;
39 use crate::prelude::*;
40 use crate::sync::{Arc, Mutex};
43 fn test_simple_monitor_permanent_update_fail() {
44 // Test that we handle a simple permanent monitor update failure
45 let chanmon_cfgs = create_chanmon_cfgs(2);
46 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
47 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
48 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
49 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
51 let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
52 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
53 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)), true, APIError::ChannelUnavailable {..}, {});
54 check_added_monitors!(nodes[0], 2);
56 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
57 assert_eq!(events_1.len(), 2);
59 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
60 _ => panic!("Unexpected event"),
63 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
64 _ => panic!("Unexpected event"),
67 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
69 // TODO: Once we hit the chain with the failure transaction we should check that we get a
70 // PaymentPathFailed event
72 assert_eq!(nodes[0].node.list_channels().len(), 0);
73 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
77 fn test_monitor_and_persister_update_fail() {
78 // Test that if both updating the `ChannelMonitor` and persisting the updated
79 // `ChannelMonitor` fail, then the failure from updating the `ChannelMonitor`
80 // one that gets returned.
81 let chanmon_cfgs = create_chanmon_cfgs(2);
82 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
83 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
84 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
86 // Create some initial channel
87 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
88 let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
90 // Rebalance the network to generate htlc in the two directions
91 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
93 // Route an HTLC from node 0 to node 1 (but don't settle)
94 let (preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
96 // Make a copy of the ChainMonitor so we can capture the error it returns on a
97 // bogus update. Note that if instead we updated the nodes[0]'s ChainMonitor
98 // directly, the node would fail to be `Drop`'d at the end because its
99 // ChannelManager and ChainMonitor would be out of sync.
100 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
101 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
102 let persister = test_utils::TestPersister::new();
103 let tx_broadcaster = TestBroadcaster {
104 txn_broadcasted: Mutex::new(Vec::new()),
105 // Because we will connect a block at height 200 below, we need the TestBroadcaster to know
106 // that we are at height 200 so that it doesn't think we're violating the time lock
107 // requirements of transactions broadcasted at that point.
108 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 200); 200])),
111 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
112 let mut w = test_utils::TestVecWriter(Vec::new());
113 monitor.write(&mut w).unwrap();
114 let new_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
115 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
116 assert!(new_monitor == *monitor);
117 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
118 assert_eq!(chain_mon.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
121 let header = BlockHeader {
123 prev_blockhash: BlockHash::all_zeros(),
124 merkle_root: TxMerkleNode::all_zeros(),
129 chain_mon.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
131 // Set the persister's return value to be a InProgress.
132 persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
134 // Try to update ChannelMonitor
135 nodes[1].node.claim_funds(preimage);
136 expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
137 check_added_monitors!(nodes[1], 1);
139 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
140 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
141 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
142 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2) {
143 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
144 // Check that even though the persister is returning a InProgress,
145 // because the update is bogus, ultimately the error that's returned
146 // should be a PermanentFailure.
147 if let ChannelMonitorUpdateStatus::PermanentFailure = chain_mon.chain_monitor.update_channel(outpoint, update.clone()) {} else { panic!("Expected monitor error to be permanent"); }
148 logger.assert_log_regex("lightning::chain::chainmonitor".to_string(), regex::Regex::new("Persistence of ChannelMonitorUpdate for channel [0-9a-f]* in progress").unwrap(), 1);
149 assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, update), ChannelMonitorUpdateStatus::Completed);
150 } else { assert!(false); }
151 } else { assert!(false); };
153 check_added_monitors!(nodes[0], 1);
154 let events = nodes[0].node.get_and_clear_pending_events();
155 assert_eq!(events.len(), 1);
158 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
159 // Test that we can recover from a simple temporary monitor update failure optionally with
160 // a disconnect in between
161 let chanmon_cfgs = create_chanmon_cfgs(2);
162 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
163 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
164 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
165 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
167 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
169 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
172 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)), false, APIError::MonitorUpdateInProgress, {});
173 check_added_monitors!(nodes[0], 1);
176 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
177 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
178 assert_eq!(nodes[0].node.list_channels().len(), 1);
181 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
182 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
183 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
186 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
187 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
188 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
189 check_added_monitors!(nodes[0], 0);
191 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
192 assert_eq!(events_2.len(), 1);
193 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
194 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
195 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
196 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
198 expect_pending_htlcs_forwardable!(nodes[1]);
200 let events_3 = nodes[1].node.get_and_clear_pending_events();
201 assert_eq!(events_3.len(), 1);
203 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
204 assert_eq!(payment_hash_1, *payment_hash);
205 assert_eq!(amount_msat, 1_000_000);
207 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
208 assert!(payment_preimage.is_none());
209 assert_eq!(payment_secret_1, *payment_secret);
211 _ => panic!("expected PaymentPurpose::InvoicePayment")
214 _ => panic!("Unexpected event"),
217 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
219 // Now set it to failed again...
220 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
222 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
223 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)), false, APIError::MonitorUpdateInProgress, {});
224 check_added_monitors!(nodes[0], 1);
227 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
228 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
229 assert_eq!(nodes[0].node.list_channels().len(), 1);
232 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
233 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
234 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
237 // ...and make sure we can force-close a frozen channel
238 nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
239 check_added_monitors!(nodes[0], 1);
240 check_closed_broadcast!(nodes[0], true);
242 // TODO: Once we hit the chain with the failure transaction we should check that we get a
243 // PaymentPathFailed event
245 assert_eq!(nodes[0].node.list_channels().len(), 0);
246 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
250 fn test_simple_monitor_temporary_update_fail() {
251 do_test_simple_monitor_temporary_update_fail(false);
252 do_test_simple_monitor_temporary_update_fail(true);
255 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
256 let disconnect_flags = 8 | 16;
258 // Test that we can recover from a temporary monitor update failure with some in-flight
259 // HTLCs going on at the same time potentially with some disconnection thrown in.
260 // * First we route a payment, then get a temporary monitor update failure when trying to
261 // route a second payment. We then claim the first payment.
262 // * If disconnect_count is set, we will disconnect at this point (which is likely as
263 // InProgress likely indicates net disconnect which resulted in failing to update the
264 // ChannelMonitor on a watchtower).
265 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
266 // immediately, otherwise we wait disconnect and deliver them via the reconnect
267 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
268 // disconnect_count & !disconnect_flags is 0).
269 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
270 // through message sending, potentially disconnect/reconnecting multiple times based on
271 // disconnect_count, to get the update_fulfill_htlc through.
272 // * We then walk through more message exchanges to get the original update_add_htlc
273 // through, swapping message ordering based on disconnect_count & 8 and optionally
274 // disconnect/reconnecting based on disconnect_count.
275 let chanmon_cfgs = create_chanmon_cfgs(2);
276 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
277 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
278 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
279 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
281 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
283 // Now try to send a second payment which will fail to send
284 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
286 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
287 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)), false, APIError::MonitorUpdateInProgress, {});
288 check_added_monitors!(nodes[0], 1);
291 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
292 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
293 assert_eq!(nodes[0].node.list_channels().len(), 1);
295 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
296 // but nodes[0] won't respond since it is frozen.
297 nodes[1].node.claim_funds(payment_preimage_1);
298 check_added_monitors!(nodes[1], 1);
299 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
301 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
302 assert_eq!(events_2.len(), 1);
303 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
304 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 } } => {
305 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
306 assert!(update_add_htlcs.is_empty());
307 assert_eq!(update_fulfill_htlcs.len(), 1);
308 assert!(update_fail_htlcs.is_empty());
309 assert!(update_fail_malformed_htlcs.is_empty());
310 assert!(update_fee.is_none());
312 if (disconnect_count & 16) == 0 {
313 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
314 let events_3 = nodes[0].node.get_and_clear_pending_events();
315 assert_eq!(events_3.len(), 1);
317 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
318 assert_eq!(*payment_preimage, payment_preimage_1);
319 assert_eq!(*payment_hash, payment_hash_1);
321 _ => panic!("Unexpected event"),
324 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
325 check_added_monitors!(nodes[0], 1);
326 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
327 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
330 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
332 _ => panic!("Unexpected event"),
335 if disconnect_count & !disconnect_flags > 0 {
336 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
337 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
340 // Now fix monitor updating...
341 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
342 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
343 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
344 check_added_monitors!(nodes[0], 0);
346 macro_rules! disconnect_reconnect_peers { () => { {
347 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
348 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
350 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
351 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
352 assert_eq!(reestablish_1.len(), 1);
353 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
354 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
355 assert_eq!(reestablish_2.len(), 1);
357 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
358 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
359 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
360 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
362 assert!(as_resp.0.is_none());
363 assert!(bs_resp.0.is_none());
365 (reestablish_1, reestablish_2, as_resp, bs_resp)
368 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
369 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
370 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
372 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
373 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
374 assert_eq!(reestablish_1.len(), 1);
375 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
376 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
377 assert_eq!(reestablish_2.len(), 1);
379 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
380 check_added_monitors!(nodes[0], 0);
381 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
382 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
383 check_added_monitors!(nodes[1], 0);
384 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
386 assert!(as_resp.0.is_none());
387 assert!(bs_resp.0.is_none());
389 assert!(bs_resp.1.is_none());
390 if (disconnect_count & 16) == 0 {
391 assert!(bs_resp.2.is_none());
393 assert!(as_resp.1.is_some());
394 assert!(as_resp.2.is_some());
395 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
397 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
398 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
399 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
400 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
401 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
402 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
404 assert!(as_resp.1.is_none());
406 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
407 let events_3 = nodes[0].node.get_and_clear_pending_events();
408 assert_eq!(events_3.len(), 1);
410 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
411 assert_eq!(*payment_preimage, payment_preimage_1);
412 assert_eq!(*payment_hash, payment_hash_1);
414 _ => panic!("Unexpected event"),
417 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
418 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
419 // No commitment_signed so get_event_msg's assert(len == 1) passes
420 check_added_monitors!(nodes[0], 1);
422 as_resp.1 = Some(as_resp_raa);
426 if disconnect_count & !disconnect_flags > 1 {
427 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
429 if (disconnect_count & 16) == 0 {
430 assert!(reestablish_1 == second_reestablish_1);
431 assert!(reestablish_2 == second_reestablish_2);
433 assert!(as_resp == second_as_resp);
434 assert!(bs_resp == second_bs_resp);
437 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
439 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
440 assert_eq!(events_4.len(), 2);
441 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
442 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
443 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
446 _ => panic!("Unexpected event"),
450 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
452 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
453 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
454 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
455 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
456 check_added_monitors!(nodes[1], 1);
458 if disconnect_count & !disconnect_flags > 2 {
459 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
461 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
462 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
464 assert!(as_resp.2.is_none());
465 assert!(bs_resp.2.is_none());
468 let as_commitment_update;
469 let bs_second_commitment_update;
471 macro_rules! handle_bs_raa { () => {
472 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
473 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
474 assert!(as_commitment_update.update_add_htlcs.is_empty());
475 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
476 assert!(as_commitment_update.update_fail_htlcs.is_empty());
477 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
478 assert!(as_commitment_update.update_fee.is_none());
479 check_added_monitors!(nodes[0], 1);
482 macro_rules! handle_initial_raa { () => {
483 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
484 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
485 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
486 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
487 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
488 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
489 assert!(bs_second_commitment_update.update_fee.is_none());
490 check_added_monitors!(nodes[1], 1);
493 if (disconnect_count & 8) == 0 {
496 if disconnect_count & !disconnect_flags > 3 {
497 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
499 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
500 assert!(bs_resp.1.is_none());
502 assert!(as_resp.2.unwrap() == as_commitment_update);
503 assert!(bs_resp.2.is_none());
505 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
508 handle_initial_raa!();
510 if disconnect_count & !disconnect_flags > 4 {
511 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
513 assert!(as_resp.1.is_none());
514 assert!(bs_resp.1.is_none());
516 assert!(as_resp.2.unwrap() == as_commitment_update);
517 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
520 handle_initial_raa!();
522 if disconnect_count & !disconnect_flags > 3 {
523 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
525 assert!(as_resp.1.is_none());
526 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
528 assert!(as_resp.2.is_none());
529 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
531 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
536 if disconnect_count & !disconnect_flags > 4 {
537 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
539 assert!(as_resp.1.is_none());
540 assert!(bs_resp.1.is_none());
542 assert!(as_resp.2.unwrap() == as_commitment_update);
543 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
547 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
548 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
549 // No commitment_signed so get_event_msg's assert(len == 1) passes
550 check_added_monitors!(nodes[0], 1);
552 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
553 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
554 // No commitment_signed so get_event_msg's assert(len == 1) passes
555 check_added_monitors!(nodes[1], 1);
557 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
558 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
559 check_added_monitors!(nodes[1], 1);
561 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
562 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
563 check_added_monitors!(nodes[0], 1);
564 expect_payment_path_successful!(nodes[0]);
566 expect_pending_htlcs_forwardable!(nodes[1]);
568 let events_5 = nodes[1].node.get_and_clear_pending_events();
569 assert_eq!(events_5.len(), 1);
571 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
572 assert_eq!(payment_hash_2, *payment_hash);
573 assert_eq!(amount_msat, 1_000_000);
575 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
576 assert!(payment_preimage.is_none());
577 assert_eq!(payment_secret_2, *payment_secret);
579 _ => panic!("expected PaymentPurpose::InvoicePayment")
582 _ => panic!("Unexpected event"),
585 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
589 fn test_monitor_temporary_update_fail_a() {
590 do_test_monitor_temporary_update_fail(0);
591 do_test_monitor_temporary_update_fail(1);
592 do_test_monitor_temporary_update_fail(2);
593 do_test_monitor_temporary_update_fail(3);
594 do_test_monitor_temporary_update_fail(4);
595 do_test_monitor_temporary_update_fail(5);
599 fn test_monitor_temporary_update_fail_b() {
600 do_test_monitor_temporary_update_fail(2 | 8);
601 do_test_monitor_temporary_update_fail(3 | 8);
602 do_test_monitor_temporary_update_fail(4 | 8);
603 do_test_monitor_temporary_update_fail(5 | 8);
607 fn test_monitor_temporary_update_fail_c() {
608 do_test_monitor_temporary_update_fail(1 | 16);
609 do_test_monitor_temporary_update_fail(2 | 16);
610 do_test_monitor_temporary_update_fail(3 | 16);
611 do_test_monitor_temporary_update_fail(2 | 8 | 16);
612 do_test_monitor_temporary_update_fail(3 | 8 | 16);
616 fn test_monitor_update_fail_cs() {
617 // Tests handling of a monitor update failure when processing an incoming commitment_signed
618 let chanmon_cfgs = create_chanmon_cfgs(2);
619 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
620 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
621 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
622 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
624 let (route, our_payment_hash, payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
626 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
627 check_added_monitors!(nodes[0], 1);
630 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
631 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
633 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
634 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
635 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
636 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
637 check_added_monitors!(nodes[1], 1);
638 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
640 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
641 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
642 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
643 check_added_monitors!(nodes[1], 0);
644 let responses = nodes[1].node.get_and_clear_pending_msg_events();
645 assert_eq!(responses.len(), 2);
648 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
649 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
650 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
651 check_added_monitors!(nodes[0], 1);
653 _ => panic!("Unexpected event"),
656 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
657 assert!(updates.update_add_htlcs.is_empty());
658 assert!(updates.update_fulfill_htlcs.is_empty());
659 assert!(updates.update_fail_htlcs.is_empty());
660 assert!(updates.update_fail_malformed_htlcs.is_empty());
661 assert!(updates.update_fee.is_none());
662 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
664 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
665 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
666 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
667 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
668 check_added_monitors!(nodes[0], 1);
669 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
671 _ => panic!("Unexpected event"),
674 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
675 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
676 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
677 check_added_monitors!(nodes[0], 0);
679 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
680 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
681 check_added_monitors!(nodes[1], 1);
683 expect_pending_htlcs_forwardable!(nodes[1]);
685 let events = nodes[1].node.get_and_clear_pending_events();
686 assert_eq!(events.len(), 1);
688 Event::PaymentReceived { payment_hash, ref purpose, amount_msat } => {
689 assert_eq!(payment_hash, our_payment_hash);
690 assert_eq!(amount_msat, 1_000_000);
692 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
693 assert!(payment_preimage.is_none());
694 assert_eq!(our_payment_secret, *payment_secret);
696 _ => panic!("expected PaymentPurpose::InvoicePayment")
699 _ => panic!("Unexpected event"),
702 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
706 fn test_monitor_update_fail_no_rebroadcast() {
707 // Tests handling of a monitor update failure when no message rebroadcasting on
708 // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
710 let chanmon_cfgs = create_chanmon_cfgs(2);
711 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
712 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
713 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
714 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
716 let (route, our_payment_hash, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
718 nodes[0].node.send_payment(&route, our_payment_hash, &Some(payment_secret_1), PaymentId(our_payment_hash.0)).unwrap();
719 check_added_monitors!(nodes[0], 1);
722 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
723 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
724 let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
726 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
727 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
728 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
729 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
730 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
731 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
732 check_added_monitors!(nodes[1], 1);
734 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
735 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
736 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
737 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
738 check_added_monitors!(nodes[1], 0);
739 expect_pending_htlcs_forwardable!(nodes[1]);
741 let events = nodes[1].node.get_and_clear_pending_events();
742 assert_eq!(events.len(), 1);
744 Event::PaymentReceived { payment_hash, .. } => {
745 assert_eq!(payment_hash, our_payment_hash);
747 _ => panic!("Unexpected event"),
750 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
754 fn test_monitor_update_raa_while_paused() {
755 // Tests handling of an RAA while monitor updating has already been marked failed.
756 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
757 let chanmon_cfgs = create_chanmon_cfgs(2);
758 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
759 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
760 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
761 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
763 send_payment(&nodes[0], &[&nodes[1]], 5000000);
764 let (route, our_payment_hash_1, payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
766 nodes[0].node.send_payment(&route, our_payment_hash_1, &Some(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
767 check_added_monitors!(nodes[0], 1);
769 let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
771 let (route, our_payment_hash_2, payment_preimage_2, our_payment_secret_2) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000000);
773 nodes[1].node.send_payment(&route, our_payment_hash_2, &Some(our_payment_secret_2), PaymentId(our_payment_hash_2.0)).unwrap();
774 check_added_monitors!(nodes[1], 1);
776 let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
778 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
779 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
780 check_added_monitors!(nodes[1], 1);
781 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
783 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
784 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
785 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
786 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
787 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
788 check_added_monitors!(nodes[0], 1);
790 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
791 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
792 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Existing pending monitor update prevented responses to RAA".to_string(), 1);
793 check_added_monitors!(nodes[0], 1);
795 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
796 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
797 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
798 check_added_monitors!(nodes[0], 0);
800 let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
801 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
802 check_added_monitors!(nodes[1], 1);
803 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
805 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
806 check_added_monitors!(nodes[1], 1);
807 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
809 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
810 check_added_monitors!(nodes[0], 1);
811 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
813 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
814 check_added_monitors!(nodes[0], 1);
815 expect_pending_htlcs_forwardable!(nodes[0]);
816 expect_payment_received!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
818 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
819 check_added_monitors!(nodes[1], 1);
820 expect_pending_htlcs_forwardable!(nodes[1]);
821 expect_payment_received!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
823 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
824 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
827 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
828 // Tests handling of a monitor update failure when processing an incoming RAA
829 let chanmon_cfgs = create_chanmon_cfgs(3);
830 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
831 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
832 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
833 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
834 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
836 // Rebalance a bit so that we can send backwards from 2 to 1.
837 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
839 // Route a first payment that we'll fail backwards
840 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
842 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
843 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
844 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
845 check_added_monitors!(nodes[2], 1);
847 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
848 assert!(updates.update_add_htlcs.is_empty());
849 assert!(updates.update_fulfill_htlcs.is_empty());
850 assert_eq!(updates.update_fail_htlcs.len(), 1);
851 assert!(updates.update_fail_malformed_htlcs.is_empty());
852 assert!(updates.update_fee.is_none());
853 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
855 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
856 check_added_monitors!(nodes[0], 0);
858 // While the second channel is AwaitingRAA, forward a second payment to get it into the
860 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
862 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
863 check_added_monitors!(nodes[0], 1);
866 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
867 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
868 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
870 expect_pending_htlcs_forwardable!(nodes[1]);
871 check_added_monitors!(nodes[1], 0);
872 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
874 // Now fail monitor updating.
875 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
876 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
877 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
878 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
879 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
880 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
881 check_added_monitors!(nodes[1], 1);
883 // Forward a third payment which will also be added to the holding cell, despite the channel
884 // being paused waiting a monitor update.
885 let (route, payment_hash_3, _, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
887 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
888 check_added_monitors!(nodes[0], 1);
891 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed); // We succeed in updating the monitor for the first channel
892 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
893 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
894 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
895 check_added_monitors!(nodes[1], 0);
897 // Call forward_pending_htlcs and check that the new HTLC was simply added to the holding cell
898 // and not forwarded.
899 expect_pending_htlcs_forwardable!(nodes[1]);
900 check_added_monitors!(nodes[1], 0);
901 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
903 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
904 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
905 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
906 nodes[2].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4), PaymentId(payment_hash_4.0)).unwrap();
907 check_added_monitors!(nodes[2], 1);
909 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
910 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
911 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
912 check_added_monitors!(nodes[1], 1);
913 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
914 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
915 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
916 (Some(payment_preimage_4), Some(payment_hash_4))
917 } else { (None, None) };
919 // Restore monitor updating, ensuring we immediately get a fail-back update and a
920 // update_add update.
921 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
922 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
923 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
924 check_added_monitors!(nodes[1], 0);
925 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 }]);
926 check_added_monitors!(nodes[1], 1);
928 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
929 if test_ignore_second_cs {
930 assert_eq!(events_3.len(), 3);
932 assert_eq!(events_3.len(), 2);
935 // Note that the ordering of the events for different nodes is non-prescriptive, though the
936 // ordering of the two events that both go to nodes[2] have to stay in the same order.
937 let messages_a = match events_3.pop().unwrap() {
938 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
939 assert_eq!(node_id, nodes[0].node.get_our_node_id());
940 assert!(updates.update_fulfill_htlcs.is_empty());
941 assert_eq!(updates.update_fail_htlcs.len(), 1);
942 assert!(updates.update_fail_malformed_htlcs.is_empty());
943 assert!(updates.update_add_htlcs.is_empty());
944 assert!(updates.update_fee.is_none());
945 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
947 _ => panic!("Unexpected event type!"),
949 let raa = if test_ignore_second_cs {
950 match events_3.remove(1) {
951 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
952 assert_eq!(node_id, nodes[2].node.get_our_node_id());
955 _ => panic!("Unexpected event"),
958 let send_event_b = SendEvent::from_event(events_3.remove(0));
959 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
961 // Now deliver the new messages...
963 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
964 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
965 expect_payment_failed!(nodes[0], payment_hash_1, true);
967 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
969 if test_ignore_second_cs {
970 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
971 check_added_monitors!(nodes[2], 1);
972 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
973 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
974 check_added_monitors!(nodes[2], 1);
975 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
976 assert!(bs_cs.update_add_htlcs.is_empty());
977 assert!(bs_cs.update_fail_htlcs.is_empty());
978 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
979 assert!(bs_cs.update_fulfill_htlcs.is_empty());
980 assert!(bs_cs.update_fee.is_none());
982 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
983 check_added_monitors!(nodes[1], 1);
984 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
986 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
987 check_added_monitors!(nodes[1], 1);
989 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
990 check_added_monitors!(nodes[2], 1);
992 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
993 assert_eq!(bs_revoke_and_commit.len(), 2);
994 match bs_revoke_and_commit[0] {
995 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
996 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
997 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
998 check_added_monitors!(nodes[1], 1);
1000 _ => panic!("Unexpected event"),
1003 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1005 match bs_revoke_and_commit[1] {
1006 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1007 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1008 assert!(updates.update_add_htlcs.is_empty());
1009 assert!(updates.update_fail_htlcs.is_empty());
1010 assert!(updates.update_fail_malformed_htlcs.is_empty());
1011 assert!(updates.update_fulfill_htlcs.is_empty());
1012 assert!(updates.update_fee.is_none());
1013 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1014 check_added_monitors!(nodes[1], 1);
1016 _ => panic!("Unexpected event"),
1020 assert_eq!(as_cs.update_add_htlcs.len(), 1);
1021 assert!(as_cs.update_fail_htlcs.is_empty());
1022 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1023 assert!(as_cs.update_fulfill_htlcs.is_empty());
1024 assert!(as_cs.update_fee.is_none());
1025 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1028 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1029 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1030 check_added_monitors!(nodes[2], 1);
1031 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1033 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1034 check_added_monitors!(nodes[2], 1);
1035 let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1037 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1038 check_added_monitors!(nodes[1], 1);
1039 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1041 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1042 check_added_monitors!(nodes[1], 1);
1043 let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1045 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1046 check_added_monitors!(nodes[2], 1);
1047 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1049 expect_pending_htlcs_forwardable!(nodes[2]);
1051 let events_6 = nodes[2].node.get_and_clear_pending_events();
1052 assert_eq!(events_6.len(), 2);
1054 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1055 _ => panic!("Unexpected event"),
1058 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1059 _ => panic!("Unexpected event"),
1062 if test_ignore_second_cs {
1063 expect_pending_htlcs_forwardable!(nodes[1]);
1064 check_added_monitors!(nodes[1], 1);
1066 send_event = SendEvent::from_node(&nodes[1]);
1067 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1068 assert_eq!(send_event.msgs.len(), 1);
1069 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1070 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1072 expect_pending_htlcs_forwardable!(nodes[0]);
1074 let events_9 = nodes[0].node.get_and_clear_pending_events();
1075 assert_eq!(events_9.len(), 1);
1077 Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1078 _ => panic!("Unexpected event"),
1080 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1083 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1087 fn test_monitor_update_fail_raa() {
1088 do_test_monitor_update_fail_raa(false);
1089 do_test_monitor_update_fail_raa(true);
1093 fn test_monitor_update_fail_reestablish() {
1094 // Simple test for message retransmission after monitor update failure on
1095 // channel_reestablish generating a monitor update (which comes from freeing holding cell
1097 let chanmon_cfgs = create_chanmon_cfgs(3);
1098 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1099 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1100 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1101 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1102 create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1104 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
1106 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1107 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1109 nodes[2].node.claim_funds(payment_preimage);
1110 check_added_monitors!(nodes[2], 1);
1111 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
1113 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1114 assert!(updates.update_add_htlcs.is_empty());
1115 assert!(updates.update_fail_htlcs.is_empty());
1116 assert!(updates.update_fail_malformed_htlcs.is_empty());
1117 assert!(updates.update_fee.is_none());
1118 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1119 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1120 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
1121 check_added_monitors!(nodes[1], 1);
1122 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1123 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1125 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1126 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1127 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1129 let as_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1130 let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1132 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1134 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1136 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1137 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1139 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1140 check_added_monitors!(nodes[1], 1);
1142 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1143 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1145 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1146 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1148 assert_eq!(get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap(), as_reestablish);
1149 assert_eq!(get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap(), bs_reestablish);
1151 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1153 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1154 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1156 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1157 check_added_monitors!(nodes[1], 0);
1159 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1160 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1162 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1163 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1164 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1165 check_added_monitors!(nodes[1], 0);
1167 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1168 assert!(updates.update_add_htlcs.is_empty());
1169 assert!(updates.update_fail_htlcs.is_empty());
1170 assert!(updates.update_fail_malformed_htlcs.is_empty());
1171 assert!(updates.update_fee.is_none());
1172 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1173 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1174 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1175 expect_payment_sent!(nodes[0], payment_preimage);
1179 fn raa_no_response_awaiting_raa_state() {
1180 // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1181 // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1182 // in question (assuming it intends to respond with a CS after monitor updating is restored).
1183 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1184 let chanmon_cfgs = create_chanmon_cfgs(2);
1185 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1186 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1187 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1188 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1190 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1191 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1192 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1194 // Queue up two payments - one will be delivered right away, one immediately goes into the
1195 // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1196 // immediately after a CS. By setting failing the monitor update failure from the CS (which
1197 // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1198 // generation during RAA while in monitor-update-failed state.
1200 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1201 check_added_monitors!(nodes[0], 1);
1202 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1203 check_added_monitors!(nodes[0], 0);
1206 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1207 assert_eq!(events.len(), 1);
1208 let payment_event = SendEvent::from_event(events.pop().unwrap());
1209 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1210 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1211 check_added_monitors!(nodes[1], 1);
1213 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1214 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1215 check_added_monitors!(nodes[0], 1);
1216 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1217 assert_eq!(events.len(), 1);
1218 let payment_event = SendEvent::from_event(events.pop().unwrap());
1220 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1221 check_added_monitors!(nodes[0], 1);
1222 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1224 // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1225 // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1226 // then restore channel monitor updates.
1227 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1228 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1229 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1230 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1231 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1232 check_added_monitors!(nodes[1], 1);
1234 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1235 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1236 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Existing pending monitor update prevented responses to RAA".to_string(), 1);
1237 check_added_monitors!(nodes[1], 1);
1239 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1240 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1241 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1242 // nodes[1] should be AwaitingRAA here!
1243 check_added_monitors!(nodes[1], 0);
1244 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1245 expect_pending_htlcs_forwardable!(nodes[1]);
1246 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1248 // We send a third payment here, which is somewhat of a redundant test, but the
1249 // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1250 // commitment transaction states) whereas here we can explicitly check for it.
1252 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1253 check_added_monitors!(nodes[0], 0);
1254 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1256 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1257 check_added_monitors!(nodes[0], 1);
1258 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1259 assert_eq!(events.len(), 1);
1260 let payment_event = SendEvent::from_event(events.pop().unwrap());
1262 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1263 check_added_monitors!(nodes[0], 1);
1264 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1266 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1267 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1268 check_added_monitors!(nodes[1], 1);
1269 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1271 // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1272 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1273 check_added_monitors!(nodes[1], 1);
1274 expect_pending_htlcs_forwardable!(nodes[1]);
1275 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1276 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1278 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1279 check_added_monitors!(nodes[0], 1);
1281 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1282 check_added_monitors!(nodes[0], 1);
1283 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1285 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1286 check_added_monitors!(nodes[1], 1);
1287 expect_pending_htlcs_forwardable!(nodes[1]);
1288 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1290 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1291 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1292 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1296 fn claim_while_disconnected_monitor_update_fail() {
1297 // Test for claiming a payment while disconnected and then having the resulting
1298 // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1299 // contrived case for nodes with network instability.
1300 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1301 // code introduced a regression in this test (specifically, this caught a removal of the
1302 // channel_reestablish handling ensuring the order was sensical given the messages used).
1303 let chanmon_cfgs = create_chanmon_cfgs(2);
1304 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1305 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1306 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1307 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1309 // Forward a payment for B to claim
1310 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1312 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1313 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1315 nodes[1].node.claim_funds(payment_preimage_1);
1316 check_added_monitors!(nodes[1], 1);
1317 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1319 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1320 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1322 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1323 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1325 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1326 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1328 // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1330 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1332 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1333 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1334 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1335 check_added_monitors!(nodes[1], 1);
1336 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1338 // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1339 // the monitor still failed
1340 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1342 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1343 check_added_monitors!(nodes[0], 1);
1346 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1347 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1348 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1349 check_added_monitors!(nodes[1], 1);
1350 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1351 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1352 // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1353 // until we've channel_monitor_update'd and updated for the new commitment transaction.
1355 // Now un-fail the monitor, which will result in B sending its original commitment update,
1356 // receiving the commitment update from A, and the resulting commitment dances.
1357 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1358 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1359 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1360 check_added_monitors!(nodes[1], 0);
1362 let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1363 assert_eq!(bs_msgs.len(), 2);
1366 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1367 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1368 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1369 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1370 check_added_monitors!(nodes[0], 1);
1372 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1373 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1374 check_added_monitors!(nodes[1], 1);
1376 _ => panic!("Unexpected event"),
1380 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1381 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1382 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1383 check_added_monitors!(nodes[0], 1);
1385 _ => panic!("Unexpected event"),
1388 let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1390 let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1391 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1392 check_added_monitors!(nodes[0], 1);
1393 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1395 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1396 check_added_monitors!(nodes[1], 1);
1397 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1398 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1399 check_added_monitors!(nodes[1], 1);
1401 expect_pending_htlcs_forwardable!(nodes[1]);
1402 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1404 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1405 check_added_monitors!(nodes[0], 1);
1406 expect_payment_sent!(nodes[0], payment_preimage_1);
1408 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1412 fn monitor_failed_no_reestablish_response() {
1413 // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1414 // response to a commitment_signed.
1415 // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1416 // debug_assert!() failure in channel_reestablish handling.
1417 let chanmon_cfgs = create_chanmon_cfgs(2);
1418 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1419 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1420 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1421 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1424 get_channel_ref!(nodes[0], lock, channel_id).announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1425 get_channel_ref!(nodes[1], lock, channel_id).announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1428 // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1430 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1432 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1433 check_added_monitors!(nodes[0], 1);
1436 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1437 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1438 assert_eq!(events.len(), 1);
1439 let payment_event = SendEvent::from_event(events.pop().unwrap());
1440 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1441 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1442 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1443 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1444 check_added_monitors!(nodes[1], 1);
1446 // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1447 // is still failing to update monitors.
1448 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1449 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1451 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1452 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1454 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1455 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1457 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1458 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1459 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1460 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1462 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1463 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1464 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1465 check_added_monitors!(nodes[1], 0);
1466 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1468 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1469 check_added_monitors!(nodes[0], 1);
1470 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1471 check_added_monitors!(nodes[0], 1);
1473 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1474 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1475 check_added_monitors!(nodes[1], 1);
1477 expect_pending_htlcs_forwardable!(nodes[1]);
1478 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1480 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1484 fn first_message_on_recv_ordering() {
1485 // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1486 // messages, we're willing to flip the order of response messages if neccessary in resposne to
1487 // a commitment_signed which needs to send an RAA first.
1488 // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1489 // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1490 // response. To do this, we start routing two payments, with the final RAA for the first being
1491 // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1492 // have no pending response but will want to send a RAA/CS (with the updates for the second
1493 // payment applied).
1494 // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1495 let chanmon_cfgs = create_chanmon_cfgs(2);
1496 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1497 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1498 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1499 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1501 // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1502 // can deliver it and fail the monitor update.
1503 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1505 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1506 check_added_monitors!(nodes[0], 1);
1509 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1510 assert_eq!(events.len(), 1);
1511 let payment_event = SendEvent::from_event(events.pop().unwrap());
1512 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1513 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1514 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1515 check_added_monitors!(nodes[1], 1);
1516 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1518 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1519 check_added_monitors!(nodes[0], 1);
1520 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1521 check_added_monitors!(nodes[0], 1);
1523 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1525 // Route the second payment, generating an update_add_htlc/commitment_signed
1526 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1528 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1529 check_added_monitors!(nodes[0], 1);
1531 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1532 assert_eq!(events.len(), 1);
1533 let payment_event = SendEvent::from_event(events.pop().unwrap());
1534 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1536 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1538 // Deliver the final RAA for the first payment, which does not require a response. RAAs
1539 // generally require a commitment_signed, so the fact that we're expecting an opposite response
1540 // to the next message also tests resetting the delivery order.
1541 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1542 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1543 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1544 check_added_monitors!(nodes[1], 1);
1546 // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1547 // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1548 // appropriate HTLC acceptance).
1549 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1550 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1551 check_added_monitors!(nodes[1], 1);
1552 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1553 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1555 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1556 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1557 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1558 check_added_monitors!(nodes[1], 0);
1560 expect_pending_htlcs_forwardable!(nodes[1]);
1561 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1563 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1564 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1565 check_added_monitors!(nodes[0], 1);
1566 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1567 check_added_monitors!(nodes[0], 1);
1569 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1570 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1571 check_added_monitors!(nodes[1], 1);
1573 expect_pending_htlcs_forwardable!(nodes[1]);
1574 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1576 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1577 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1581 fn test_monitor_update_fail_claim() {
1582 // Basic test for monitor update failures when processing claim_funds calls.
1583 // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1584 // update to claim the payment. We then send two payments C->B->A, which are held at B.
1585 // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1586 // the payments from C onwards to A.
1587 let chanmon_cfgs = create_chanmon_cfgs(3);
1588 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1589 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1590 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1591 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1592 create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1594 // Rebalance a bit so that we can send backwards from 3 to 2.
1595 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1597 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1599 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1600 nodes[1].node.claim_funds(payment_preimage_1);
1601 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1602 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1603 check_added_monitors!(nodes[1], 1);
1605 // Note that at this point there is a pending commitment transaction update for A being held by
1606 // B. Even when we go to send the payment from C through B to A, B will not update this
1607 // already-signed commitment transaction and will instead wait for it to resolve before
1608 // forwarding the payment onwards.
1610 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1_000_000);
1612 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1613 check_added_monitors!(nodes[2], 1);
1616 // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1617 // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1618 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1620 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1621 assert_eq!(events.len(), 1);
1622 let payment_event = SendEvent::from_event(events.pop().unwrap());
1623 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1624 let events = nodes[1].node.get_and_clear_pending_msg_events();
1625 assert_eq!(events.len(), 0);
1626 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1628 let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1629 nodes[2].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1630 check_added_monitors!(nodes[2], 1);
1632 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1633 assert_eq!(events.len(), 1);
1634 let payment_event = SendEvent::from_event(events.pop().unwrap());
1635 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1636 let events = nodes[1].node.get_and_clear_pending_msg_events();
1637 assert_eq!(events.len(), 0);
1638 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1640 // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1641 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1642 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1643 check_added_monitors!(nodes[1], 0);
1645 let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1646 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1647 commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1648 expect_payment_sent!(nodes[0], payment_preimage_1);
1650 // Get the payment forwards, note that they were batched into one commitment update.
1651 expect_pending_htlcs_forwardable!(nodes[1]);
1652 check_added_monitors!(nodes[1], 1);
1653 let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1654 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1655 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1656 commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1657 expect_pending_htlcs_forwardable!(nodes[0]);
1659 let events = nodes[0].node.get_and_clear_pending_events();
1660 assert_eq!(events.len(), 2);
1662 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1663 assert_eq!(payment_hash_2, *payment_hash);
1664 assert_eq!(1_000_000, amount_msat);
1666 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1667 assert!(payment_preimage.is_none());
1668 assert_eq!(payment_secret_2, *payment_secret);
1670 _ => panic!("expected PaymentPurpose::InvoicePayment")
1673 _ => panic!("Unexpected event"),
1676 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1677 assert_eq!(payment_hash_3, *payment_hash);
1678 assert_eq!(1_000_000, amount_msat);
1680 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1681 assert!(payment_preimage.is_none());
1682 assert_eq!(payment_secret_3, *payment_secret);
1684 _ => panic!("expected PaymentPurpose::InvoicePayment")
1687 _ => panic!("Unexpected event"),
1692 fn test_monitor_update_on_pending_forwards() {
1693 // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1694 // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1695 // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1696 // from C to A will be pending a forward to A.
1697 let chanmon_cfgs = create_chanmon_cfgs(3);
1698 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1699 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1700 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1701 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1702 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1704 // Rebalance a bit so that we can send backwards from 3 to 1.
1705 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1707 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1708 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
1709 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
1710 check_added_monitors!(nodes[2], 1);
1712 let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1713 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1714 commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1715 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1717 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
1719 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1720 check_added_monitors!(nodes[2], 1);
1723 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1724 assert_eq!(events.len(), 1);
1725 let payment_event = SendEvent::from_event(events.pop().unwrap());
1726 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1727 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1729 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1730 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 }]);
1731 check_added_monitors!(nodes[1], 1);
1732 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1733 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1735 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1736 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1737 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1738 check_added_monitors!(nodes[1], 0);
1740 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1741 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1742 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1743 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1745 let events = nodes[0].node.get_and_clear_pending_events();
1746 assert_eq!(events.len(), 2);
1747 if let Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } = events[0] {
1748 assert_eq!(payment_hash, payment_hash_1);
1749 assert!(payment_failed_permanently);
1750 } else { panic!("Unexpected event!"); }
1752 Event::PendingHTLCsForwardable { .. } => { },
1753 _ => panic!("Unexpected event"),
1755 nodes[0].node.process_pending_htlc_forwards();
1756 expect_payment_received!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1758 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1762 fn monitor_update_claim_fail_no_response() {
1763 // Test for claim_funds resulting in both a monitor update failure and no message response (due
1764 // to channel being AwaitingRAA).
1765 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1767 let chanmon_cfgs = create_chanmon_cfgs(2);
1768 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1769 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1770 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1771 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1773 // Forward a payment for B to claim
1774 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1776 // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1777 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1779 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1780 check_added_monitors!(nodes[0], 1);
1783 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1784 assert_eq!(events.len(), 1);
1785 let payment_event = SendEvent::from_event(events.pop().unwrap());
1786 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1787 let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1789 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1790 nodes[1].node.claim_funds(payment_preimage_1);
1791 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1792 check_added_monitors!(nodes[1], 1);
1794 let events = nodes[1].node.get_and_clear_pending_msg_events();
1795 assert_eq!(events.len(), 0);
1796 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1798 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1799 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1800 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1801 check_added_monitors!(nodes[1], 0);
1802 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1804 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1805 check_added_monitors!(nodes[1], 1);
1806 expect_pending_htlcs_forwardable!(nodes[1]);
1807 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1809 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1810 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1811 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1812 expect_payment_sent!(nodes[0], payment_preimage_1);
1814 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1817 // restore_b_before_conf has no meaning if !confirm_a_first
1818 // restore_b_before_lock has no meaning if confirm_a_first
1819 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool, restore_b_before_lock: bool) {
1820 // Test that if the monitor update generated by funding_transaction_generated fails we continue
1821 // the channel setup happily after the update is restored.
1822 let chanmon_cfgs = create_chanmon_cfgs(2);
1823 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1824 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1825 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1827 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1828 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()));
1829 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()));
1831 let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
1833 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
1834 check_added_monitors!(nodes[0], 0);
1836 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1837 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1838 let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1839 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1840 check_added_monitors!(nodes[1], 1);
1842 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1843 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()));
1844 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1845 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1846 check_added_monitors!(nodes[0], 1);
1847 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1848 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1849 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1850 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1851 check_added_monitors!(nodes[0], 0);
1853 let events = nodes[0].node.get_and_clear_pending_events();
1854 assert_eq!(events.len(), 0);
1855 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1856 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1858 if confirm_a_first {
1859 confirm_transaction(&nodes[0], &funding_tx);
1860 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()));
1861 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1862 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1864 assert!(!restore_b_before_conf);
1865 confirm_transaction(&nodes[1], &funding_tx);
1866 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1869 // Make sure nodes[1] isn't stupid enough to re-send the ChannelReady on reconnect
1870 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1871 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1872 reconnect_nodes(&nodes[0], &nodes[1], (false, confirm_a_first), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1873 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1874 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1876 if !restore_b_before_conf {
1877 confirm_transaction(&nodes[1], &funding_tx);
1878 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1879 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1881 if !confirm_a_first && !restore_b_before_lock {
1882 confirm_transaction(&nodes[0], &funding_tx);
1883 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()));
1884 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1885 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1888 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1889 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1890 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1891 check_added_monitors!(nodes[1], 0);
1893 let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1894 if !restore_b_before_lock {
1895 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1896 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1898 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()));
1899 confirm_transaction(&nodes[0], &funding_tx);
1900 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1901 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready))
1904 if restore_b_before_conf {
1905 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1906 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1907 confirm_transaction(&nodes[1], &funding_tx);
1909 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1910 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1912 for node in nodes.iter() {
1913 assert!(node.gossip_sync.handle_channel_announcement(&announcement).unwrap());
1914 node.gossip_sync.handle_channel_update(&as_update).unwrap();
1915 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
1918 if !restore_b_before_lock {
1919 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
1921 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
1925 send_payment(&nodes[0], &[&nodes[1]], 8000000);
1926 close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1927 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
1928 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1932 fn during_funding_monitor_fail() {
1933 do_during_funding_monitor_fail(true, true, false);
1934 do_during_funding_monitor_fail(true, false, false);
1935 do_during_funding_monitor_fail(false, false, false);
1936 do_during_funding_monitor_fail(false, false, true);
1940 fn test_path_paused_mpp() {
1941 // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1943 let chanmon_cfgs = create_chanmon_cfgs(4);
1944 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1945 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1946 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1948 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;
1949 let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1950 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;
1951 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;
1953 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
1955 // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1956 let path = route.paths[0].clone();
1957 route.paths.push(path);
1958 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
1959 route.paths[0][0].short_channel_id = chan_1_id;
1960 route.paths[0][1].short_channel_id = chan_3_id;
1961 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
1962 route.paths[1][0].short_channel_id = chan_2_ann.contents.short_channel_id;
1963 route.paths[1][1].short_channel_id = chan_4_id;
1965 // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
1966 // (for the path 0 -> 2 -> 3) fails.
1967 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1968 chanmon_cfgs[0].persister.set_next_update_ret(Some(ChannelMonitorUpdateStatus::InProgress));
1970 // Now check that we get the right return value, indicating that the first path succeeded but
1971 // the second got a MonitorUpdateInProgress err. This implies
1972 // PaymentSendFailure::PartialFailure as some paths succeeded, preventing retry.
1973 if let Err(PaymentSendFailure::PartialFailure { results, ..}) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)) {
1974 assert_eq!(results.len(), 2);
1975 if let Ok(()) = results[0] {} else { panic!(); }
1976 if let Err(APIError::MonitorUpdateInProgress) = results[1] {} else { panic!(); }
1977 } else { panic!(); }
1978 check_added_monitors!(nodes[0], 2);
1979 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1981 // Pass the first HTLC of the payment along to nodes[3].
1982 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1983 assert_eq!(events.len(), 1);
1984 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false, None);
1986 // And check that, after we successfully update the monitor for chan_2 we can pass the second
1987 // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
1988 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
1989 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1990 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1991 assert_eq!(events.len(), 1);
1992 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true, None);
1994 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
1998 fn test_pending_update_fee_ack_on_reconnect() {
1999 // In early versions of our automated fee update patch, nodes did not correctly use the
2000 // previous channel feerate after sending an undelivered revoke_and_ack when re-sending an
2001 // undelivered commitment_signed.
2003 // B sends A new HTLC + CS, not delivered
2004 // A sends B update_fee + CS
2005 // B receives the CS and sends RAA, previously causing B to lock in the new feerate
2007 // B resends initial CS, using the original fee
2009 let chanmon_cfgs = create_chanmon_cfgs(2);
2010 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2011 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2012 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2014 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2015 send_payment(&nodes[0], &[&nodes[1]], 100_000_00);
2017 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[1], nodes[0], 1_000_000);
2018 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
2019 check_added_monitors!(nodes[1], 1);
2020 let bs_initial_send_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2021 // bs_initial_send_msgs are not delivered until they are re-generated after reconnect
2024 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2027 nodes[0].node.timer_tick_occurred();
2028 check_added_monitors!(nodes[0], 1);
2029 let as_update_fee_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2030 assert!(as_update_fee_msgs.update_fee.is_some());
2032 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_update_fee_msgs.update_fee.as_ref().unwrap());
2033 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_fee_msgs.commitment_signed);
2034 check_added_monitors!(nodes[1], 1);
2035 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2036 // bs_first_raa is not delivered until it is re-generated after reconnect
2038 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2039 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2041 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2042 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2043 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2044 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2046 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2047 let bs_resend_msgs = nodes[1].node.get_and_clear_pending_msg_events();
2048 assert_eq!(bs_resend_msgs.len(), 3);
2049 if let MessageSendEvent::UpdateHTLCs { ref updates, .. } = bs_resend_msgs[0] {
2050 assert_eq!(*updates, bs_initial_send_msgs);
2051 } else { panic!(); }
2052 if let MessageSendEvent::SendRevokeAndACK { ref msg, .. } = bs_resend_msgs[1] {
2053 assert_eq!(*msg, bs_first_raa);
2054 } else { panic!(); }
2055 if let MessageSendEvent::SendChannelUpdate { .. } = bs_resend_msgs[2] { } else { panic!(); }
2057 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2058 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
2060 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.update_add_htlcs[0]);
2061 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.commitment_signed);
2062 check_added_monitors!(nodes[0], 1);
2063 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()));
2064 check_added_monitors!(nodes[1], 1);
2065 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()).commitment_signed;
2067 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2068 check_added_monitors!(nodes[0], 1);
2069 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);
2070 check_added_monitors!(nodes[1], 1);
2071 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2073 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2074 check_added_monitors!(nodes[0], 1);
2075 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2076 check_added_monitors!(nodes[0], 1);
2078 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()));
2079 check_added_monitors!(nodes[1], 1);
2081 expect_pending_htlcs_forwardable!(nodes[0]);
2082 expect_payment_received!(nodes[0], payment_hash, payment_secret, 1_000_000);
2084 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
2088 fn test_fail_htlc_on_broadcast_after_claim() {
2089 // In an earlier version of 7e78fa660cec8a73286c94c1073ee588140e7a01 we'd also fail the inbound
2090 // channel backwards if we received an HTLC failure after a HTLC fulfillment. Here we test a
2091 // specific case of that by having the HTLC failure come from the ChannelMonitor after a dust
2092 // HTLC was not included in a confirmed commitment transaction.
2094 // We first forward a payment, then claim it with an update_fulfill_htlc message, closing the
2095 // channel immediately before commitment occurs. After the commitment transaction reaches
2096 // ANTI_REORG_DELAY confirmations, will will try to fail the HTLC which was already fulfilled.
2097 let chanmon_cfgs = create_chanmon_cfgs(3);
2098 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2099 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2100 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2102 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2103 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2105 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 2000);
2107 let bs_txn = get_local_commitment_txn!(nodes[2], chan_id_2);
2108 assert_eq!(bs_txn.len(), 1);
2110 nodes[2].node.claim_funds(payment_preimage);
2111 check_added_monitors!(nodes[2], 1);
2112 expect_payment_claimed!(nodes[2], payment_hash, 2000);
2114 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2115 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
2116 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2117 check_added_monitors!(nodes[1], 1);
2118 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2120 mine_transaction(&nodes[1], &bs_txn[0]);
2121 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2122 check_closed_broadcast!(nodes[1], true);
2123 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2124 check_added_monitors!(nodes[1], 1);
2125 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 }]);
2127 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
2128 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2129 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, true, true);
2130 expect_payment_path_successful!(nodes[0]);
2133 fn do_update_fee_resend_test(deliver_update: bool, parallel_updates: bool) {
2134 // In early versions we did not handle resending of update_fee on reconnect correctly. The
2135 // chanmon_consistency fuzz target, of course, immediately found it, but we test a few cases
2137 let chanmon_cfgs = create_chanmon_cfgs(2);
2138 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2139 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2140 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2142 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2143 send_payment(&nodes[0], &[&nodes[1]], 1000);
2146 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2147 *feerate_lock += 20;
2149 nodes[0].node.timer_tick_occurred();
2150 check_added_monitors!(nodes[0], 1);
2151 let update_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2152 assert!(update_msgs.update_fee.is_some());
2154 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2157 if parallel_updates {
2159 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2160 *feerate_lock += 20;
2162 nodes[0].node.timer_tick_occurred();
2163 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2166 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2167 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2169 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2170 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2171 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2172 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2174 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2175 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
2176 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2178 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2179 let mut as_reconnect_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2180 assert_eq!(as_reconnect_msgs.len(), 2);
2181 if let MessageSendEvent::SendChannelUpdate { .. } = as_reconnect_msgs.pop().unwrap() {} else { panic!(); }
2182 let update_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = as_reconnect_msgs.pop().unwrap()
2183 { updates } else { panic!(); };
2184 assert!(update_msgs.update_fee.is_some());
2185 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2186 if parallel_updates {
2187 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update_msgs.commitment_signed);
2188 check_added_monitors!(nodes[1], 1);
2189 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2190 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2191 check_added_monitors!(nodes[0], 1);
2192 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2194 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2195 check_added_monitors!(nodes[0], 1);
2196 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2198 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_second_update.update_fee.as_ref().unwrap());
2199 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
2200 check_added_monitors!(nodes[1], 1);
2201 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2203 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2204 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2205 check_added_monitors!(nodes[1], 1);
2207 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2208 check_added_monitors!(nodes[0], 1);
2210 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs.commitment_signed);
2211 check_added_monitors!(nodes[0], 1);
2212 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2214 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2215 check_added_monitors!(nodes[1], 1);
2217 commitment_signed_dance!(nodes[1], nodes[0], update_msgs.commitment_signed, false);
2220 send_payment(&nodes[0], &[&nodes[1]], 1000);
2223 fn update_fee_resend_test() {
2224 do_update_fee_resend_test(false, false);
2225 do_update_fee_resend_test(true, false);
2226 do_update_fee_resend_test(false, true);
2227 do_update_fee_resend_test(true, true);
2230 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2231 // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2232 // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2233 // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2234 // which failed in such a case).
2235 let chanmon_cfgs = create_chanmon_cfgs(2);
2236 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2237 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2238 let persister: test_utils::TestPersister;
2239 let new_chain_monitor: test_utils::TestChainMonitor;
2240 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2241 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2243 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;
2244 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
2245 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2247 // Do a really complicated dance to get an HTLC into the holding cell, with
2248 // MonitorUpdateInProgress set but AwaitingRemoteRevoke unset. When this test was written, any
2249 // attempts to send an HTLC while MonitorUpdateInProgress is set are immediately
2250 // failed-backwards. Thus, the only way to get an AddHTLC into the holding cell is to add it
2251 // while AwaitingRemoteRevoke is set but MonitorUpdateInProgress is unset, and then swap the
2255 // a) routing a payment from node B to node A,
2256 // b) sending a payment from node A to node B without delivering any of the generated messages,
2257 // putting node A in AwaitingRemoteRevoke,
2258 // c) sending a second payment from node A to node B, which is immediately placed in the
2260 // d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2261 // when we try to persist the payment preimage,
2262 // e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2263 // clearing AwaitingRemoteRevoke on node A.
2265 // Note that because, at the end, MonitorUpdateInProgress is still set, the HTLC generated in
2266 // (c) will not be freed from the holding cell.
2267 let (payment_preimage_0, payment_hash_0, _) = route_payment(&nodes[1], &[&nodes[0]], 100_000);
2269 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
2270 check_added_monitors!(nodes[0], 1);
2271 let send = SendEvent::from_node(&nodes[0]);
2272 assert_eq!(send.msgs.len(), 1);
2274 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
2275 check_added_monitors!(nodes[0], 0);
2277 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2278 nodes[0].node.claim_funds(payment_preimage_0);
2279 check_added_monitors!(nodes[0], 1);
2280 expect_payment_claimed!(nodes[0], payment_hash_0, 100_000);
2282 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2283 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2284 check_added_monitors!(nodes[1], 1);
2286 let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2288 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2289 check_added_monitors!(nodes[0], 1);
2292 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2293 // disconnect the peers. Note that the fuzzer originally found this issue because
2294 // deserializing a ChannelManager in this state causes an assertion failure.
2296 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
2297 reload_node!(nodes[0], &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
2299 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2301 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2303 // Now reconnect the two
2304 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2305 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2306 assert_eq!(reestablish_1.len(), 1);
2307 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2308 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2309 assert_eq!(reestablish_2.len(), 1);
2311 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2312 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2313 check_added_monitors!(nodes[1], 0);
2315 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2316 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2318 assert!(resp_0.0.is_none());
2319 assert!(resp_0.1.is_none());
2320 assert!(resp_0.2.is_none());
2321 assert!(resp_1.0.is_none());
2322 assert!(resp_1.1.is_none());
2324 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2326 if let Some(pending_cs) = resp_1.2 {
2327 assert!(pending_cs.update_add_htlcs.is_empty());
2328 assert!(pending_cs.update_fail_htlcs.is_empty());
2329 assert!(pending_cs.update_fulfill_htlcs.is_empty());
2330 assert_eq!(pending_cs.commitment_signed, cs);
2331 } else { panic!(); }
2333 // There should be no monitor updates as we are still pending awaiting a failed one.
2334 check_added_monitors!(nodes[0], 0);
2335 check_added_monitors!(nodes[1], 0);
2338 // If we finish updating the monitor, we should free the holding cell right away (this did
2339 // not occur prior to #756).
2340 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2341 let (funding_txo, mon_id, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2342 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_txo, mon_id);
2344 // New outbound messages should be generated immediately upon a call to
2345 // get_and_clear_pending_msg_events (but not before).
2346 check_added_monitors!(nodes[0], 0);
2347 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2348 check_added_monitors!(nodes[0], 1);
2349 assert_eq!(events.len(), 1);
2351 // Deliver the pending in-flight CS
2352 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2353 check_added_monitors!(nodes[0], 1);
2355 let commitment_msg = match events.pop().unwrap() {
2356 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2357 assert_eq!(node_id, nodes[1].node.get_our_node_id());
2358 assert!(updates.update_fail_htlcs.is_empty());
2359 assert!(updates.update_fail_malformed_htlcs.is_empty());
2360 assert!(updates.update_fee.is_none());
2361 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2362 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2363 expect_payment_sent_without_paths!(nodes[1], payment_preimage_0);
2364 assert_eq!(updates.update_add_htlcs.len(), 1);
2365 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2366 updates.commitment_signed
2368 _ => panic!("Unexpected event type!"),
2371 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2372 check_added_monitors!(nodes[1], 1);
2374 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2375 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2376 expect_pending_htlcs_forwardable!(nodes[1]);
2377 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2378 check_added_monitors!(nodes[1], 1);
2380 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
2382 let events = nodes[1].node.get_and_clear_pending_events();
2383 assert_eq!(events.len(), 2);
2385 Event::PendingHTLCsForwardable { .. } => { },
2386 _ => panic!("Unexpected event"),
2389 Event::PaymentPathSuccessful { .. } => { },
2390 _ => panic!("Unexpected event"),
2393 nodes[1].node.process_pending_htlc_forwards();
2394 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2396 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2397 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2400 fn channel_holding_cell_serialize() {
2401 do_channel_holding_cell_serialize(true, true);
2402 do_channel_holding_cell_serialize(true, false);
2403 do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2406 #[derive(PartialEq)]
2407 enum HTLCStatusAtDupClaim {
2412 fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_fails: bool) {
2413 // When receiving an update_fulfill_htlc message, we immediately forward the claim backwards
2414 // along the payment path before waiting for a full commitment_signed dance. This is great, but
2415 // can cause duplicative claims if a node sends an update_fulfill_htlc message, disconnects,
2416 // reconnects, and then has to re-send its update_fulfill_htlc message again.
2417 // In previous code, we didn't handle the double-claim correctly, spuriously closing the
2418 // channel on which the inbound HTLC was received.
2419 let chanmon_cfgs = create_chanmon_cfgs(3);
2420 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2421 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2422 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2424 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2425 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2427 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
2429 let mut as_raa = None;
2430 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2431 // In order to get the HTLC claim into the holding cell at nodes[1], we need nodes[1] to be
2432 // awaiting a remote revoke_and_ack from nodes[0].
2433 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
2434 nodes[0].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret), PaymentId(second_payment_hash.0)).unwrap();
2435 check_added_monitors!(nodes[0], 1);
2437 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
2438 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
2439 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
2440 check_added_monitors!(nodes[1], 1);
2442 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2443 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2444 check_added_monitors!(nodes[0], 1);
2445 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
2446 check_added_monitors!(nodes[0], 1);
2448 as_raa = Some(get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2451 let fulfill_msg = msgs::UpdateFulfillHTLC {
2452 channel_id: chan_id_2,
2457 nodes[2].node.fail_htlc_backwards(&payment_hash);
2458 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash }]);
2459 check_added_monitors!(nodes[2], 1);
2460 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2462 nodes[2].node.claim_funds(payment_preimage);
2463 check_added_monitors!(nodes[2], 1);
2464 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
2466 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2467 assert_eq!(cs_updates.update_fulfill_htlcs.len(), 1);
2468 // Check that the message we're about to deliver matches the one generated:
2469 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
2471 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
2472 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2473 check_added_monitors!(nodes[1], 1);
2475 let mut bs_updates = None;
2476 if htlc_status != HTLCStatusAtDupClaim::HoldingCell {
2477 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2478 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2479 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2480 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2481 if htlc_status == HTLCStatusAtDupClaim::Cleared {
2482 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2483 expect_payment_path_successful!(nodes[0]);
2486 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2489 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
2490 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2493 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
2494 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 }]);
2496 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2499 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2500 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa.unwrap());
2501 check_added_monitors!(nodes[1], 1);
2502 expect_pending_htlcs_forwardable_ignore!(nodes[1]); // We finally receive the second payment, but don't claim it
2504 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2505 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2506 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2507 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2509 if htlc_status != HTLCStatusAtDupClaim::Cleared {
2510 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2511 expect_payment_path_successful!(nodes[0]);
2516 fn test_reconnect_dup_htlc_claims() {
2517 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, false);
2518 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, false);
2519 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, false);
2520 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, true);
2521 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, true);
2522 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, true);
2526 fn test_temporary_error_during_shutdown() {
2527 // Test that temporary failures when updating the monitor's shutdown script delay cooperative
2529 let mut config = test_default_channel_config();
2530 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2532 let chanmon_cfgs = create_chanmon_cfgs(2);
2533 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2534 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
2535 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2537 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2539 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2540 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2542 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
2543 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()));
2544 check_added_monitors!(nodes[1], 1);
2546 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()));
2547 check_added_monitors!(nodes[0], 1);
2549 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2551 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2552 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2554 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2555 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2556 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()));
2558 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2560 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2561 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2562 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2564 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()));
2565 let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
2566 let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2568 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_a.unwrap());
2569 let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
2570 assert!(none_b.is_none());
2571 let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2573 assert_eq!(txn_a, txn_b);
2574 assert_eq!(txn_a.len(), 1);
2575 check_spends!(txn_a[0], funding_tx);
2576 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
2577 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
2581 fn test_permanent_error_during_sending_shutdown() {
2582 // Test that permanent failures when updating the monitor's shutdown script result in a force
2583 // close when initiating a cooperative close.
2584 let mut config = test_default_channel_config();
2585 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2587 let chanmon_cfgs = create_chanmon_cfgs(2);
2588 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2589 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
2590 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2592 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2593 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2595 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2596 check_closed_broadcast!(nodes[0], true);
2597 check_added_monitors!(nodes[0], 2);
2598 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2602 fn test_permanent_error_during_handling_shutdown() {
2603 // Test that permanent failures when updating the monitor's shutdown script result in a force
2604 // close when handling a cooperative close.
2605 let mut config = test_default_channel_config();
2606 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2608 let chanmon_cfgs = create_chanmon_cfgs(2);
2609 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2610 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
2611 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2613 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2614 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2616 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2617 let shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
2618 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &shutdown);
2619 check_closed_broadcast!(nodes[1], true);
2620 check_added_monitors!(nodes[1], 2);
2621 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2625 fn double_temp_error() {
2626 // Test that it's OK to have multiple `ChainMonitor::update_channel` calls fail in a row.
2627 let chanmon_cfgs = create_chanmon_cfgs(2);
2628 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2629 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2630 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2632 let (_, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2634 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2635 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2637 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2638 // `claim_funds` results in a ChannelMonitorUpdate.
2639 nodes[1].node.claim_funds(payment_preimage_1);
2640 check_added_monitors!(nodes[1], 1);
2641 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
2642 let (funding_tx, latest_update_1, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2644 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2645 // Previously, this would've panicked due to a double-call to `Channel::monitor_update_failed`,
2646 // which had some asserts that prevented it from being called twice.
2647 nodes[1].node.claim_funds(payment_preimage_2);
2648 check_added_monitors!(nodes[1], 1);
2649 expect_payment_claimed!(nodes[1], payment_hash_2, 1_000_000);
2650 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2652 let (_, latest_update_2, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2653 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_1);
2654 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2655 check_added_monitors!(nodes[1], 0);
2656 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_2);
2658 // Complete the first HTLC.
2659 let events = nodes[1].node.get_and_clear_pending_msg_events();
2660 assert_eq!(events.len(), 1);
2661 let (update_fulfill_1, commitment_signed_b1, node_id) = {
2663 &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 } } => {
2664 assert!(update_add_htlcs.is_empty());
2665 assert_eq!(update_fulfill_htlcs.len(), 1);
2666 assert!(update_fail_htlcs.is_empty());
2667 assert!(update_fail_malformed_htlcs.is_empty());
2668 assert!(update_fee.is_none());
2669 (update_fulfill_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2671 _ => panic!("Unexpected event"),
2674 assert_eq!(node_id, nodes[0].node.get_our_node_id());
2675 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_1);
2676 check_added_monitors!(nodes[0], 0);
2677 expect_payment_sent_without_paths!(nodes[0], payment_preimage_1);
2678 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_b1);
2679 check_added_monitors!(nodes[0], 1);
2680 nodes[0].node.process_pending_htlc_forwards();
2681 let (raa_a1, commitment_signed_a1) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2682 check_added_monitors!(nodes[1], 0);
2683 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2684 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_a1);
2685 check_added_monitors!(nodes[1], 1);
2686 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed_a1);
2687 check_added_monitors!(nodes[1], 1);
2689 // Complete the second HTLC.
2690 let ((update_fulfill_2, commitment_signed_b2), raa_b2) = {
2691 let events = nodes[1].node.get_and_clear_pending_msg_events();
2692 assert_eq!(events.len(), 2);
2694 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2695 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2696 assert!(updates.update_add_htlcs.is_empty());
2697 assert!(updates.update_fail_htlcs.is_empty());
2698 assert!(updates.update_fail_malformed_htlcs.is_empty());
2699 assert!(updates.update_fee.is_none());
2700 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2701 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2703 _ => panic!("Unexpected event"),
2706 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2707 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2710 _ => panic!("Unexpected event"),
2713 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_b2);
2714 check_added_monitors!(nodes[0], 1);
2715 expect_payment_path_successful!(nodes[0]);
2717 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_2);
2718 check_added_monitors!(nodes[0], 0);
2719 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2720 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed_b2, false);
2721 expect_payment_sent!(nodes[0], payment_preimage_2);
2724 fn do_test_outbound_reload_without_init_mon(use_0conf: bool) {
2725 // Test that if the monitor update generated in funding_signed is stored async and we restart
2726 // with the latest ChannelManager but the ChannelMonitor persistence never completed we happily
2727 // drop the channel and move on.
2728 let chanmon_cfgs = create_chanmon_cfgs(2);
2729 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2731 let persister: test_utils::TestPersister;
2732 let new_chain_monitor: test_utils::TestChainMonitor;
2733 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2735 let mut chan_config = test_default_channel_config();
2736 chan_config.manually_accept_inbound_channels = true;
2737 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2739 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2740 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2742 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2743 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()));
2745 let events = nodes[1].node.get_and_clear_pending_events();
2746 assert_eq!(events.len(), 1);
2748 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2750 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2752 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2755 _ => panic!("Unexpected event"),
2758 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()));
2760 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2762 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2763 check_added_monitors!(nodes[0], 0);
2765 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2766 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2767 check_added_monitors!(nodes[1], 1);
2769 let bs_signed_locked = nodes[1].node.get_and_clear_pending_msg_events();
2770 assert_eq!(bs_signed_locked.len(), if use_0conf { 2 } else { 1 });
2771 match &bs_signed_locked[0] {
2772 MessageSendEvent::SendFundingSigned { msg, .. } => {
2773 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2775 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &msg);
2776 check_added_monitors!(nodes[0], 1);
2778 _ => panic!("Unexpected event"),
2781 match &bs_signed_locked[1] {
2782 MessageSendEvent::SendChannelReady { msg, .. } => {
2783 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &msg);
2785 _ => panic!("Unexpected event"),
2789 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
2790 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2791 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2793 // nodes[0] is now waiting on the first ChannelMonitor persistence to complete in order to
2794 // broadcast the funding transaction. If nodes[0] restarts at this point with the
2795 // ChannelMonitor lost, we should simply discard the channel.
2797 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2798 // not, so we have to clear them here.
2799 nodes[0].chain_source.watched_txn.lock().unwrap().clear();
2800 nodes[0].chain_source.watched_outputs.lock().unwrap().clear();
2802 reload_node!(nodes[0], &nodes[0].node.encode(), &[], persister, new_chain_monitor, nodes_0_deserialized);
2803 check_closed_event!(nodes[0], 1, ClosureReason::DisconnectedPeer);
2804 assert!(nodes[0].node.list_channels().is_empty());
2808 fn test_outbound_reload_without_init_mon() {
2809 do_test_outbound_reload_without_init_mon(true);
2810 do_test_outbound_reload_without_init_mon(false);
2813 fn do_test_inbound_reload_without_init_mon(use_0conf: bool, lock_commitment: bool) {
2814 // Test that if the monitor update generated by funding_transaction_generated is stored async
2815 // and we restart with the latest ChannelManager but the ChannelMonitor persistence never
2816 // completed we happily drop the channel and move on.
2817 let chanmon_cfgs = create_chanmon_cfgs(2);
2818 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2820 let persister: test_utils::TestPersister;
2821 let new_chain_monitor: test_utils::TestChainMonitor;
2822 let nodes_1_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2824 let mut chan_config = test_default_channel_config();
2825 chan_config.manually_accept_inbound_channels = true;
2826 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2828 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2829 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2831 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2832 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()));
2834 let events = nodes[1].node.get_and_clear_pending_events();
2835 assert_eq!(events.len(), 1);
2837 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2839 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2841 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2844 _ => panic!("Unexpected event"),
2847 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()));
2849 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2851 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2852 check_added_monitors!(nodes[0], 0);
2854 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2855 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2856 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2857 check_added_monitors!(nodes[1], 1);
2859 // nodes[1] happily sends its funding_signed even though its awaiting the persistence of the
2860 // initial ChannelMonitor, but it will decline to send its channel_ready even if the funding
2861 // transaction is confirmed.
2862 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
2864 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
2865 check_added_monitors!(nodes[0], 1);
2867 let as_funding_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2868 if lock_commitment {
2869 confirm_transaction(&nodes[0], &as_funding_tx[0]);
2870 confirm_transaction(&nodes[1], &as_funding_tx[0]);
2872 if use_0conf || lock_commitment {
2873 let as_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
2874 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_ready);
2876 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2878 // nodes[1] is now waiting on the first ChannelMonitor persistence to complete in order to
2879 // move the channel to ready (or is waiting on the funding transaction to confirm). If nodes[1]
2880 // restarts at this point with the ChannelMonitor lost, we should simply discard the channel.
2882 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2883 // not, so we have to clear them here.
2884 nodes[1].chain_source.watched_txn.lock().unwrap().clear();
2885 nodes[1].chain_source.watched_outputs.lock().unwrap().clear();
2887 reload_node!(nodes[1], &nodes[1].node.encode(), &[], persister, new_chain_monitor, nodes_1_deserialized);
2889 check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
2890 assert!(nodes[1].node.list_channels().is_empty());
2894 fn test_inbound_reload_without_init_mon() {
2895 do_test_inbound_reload_without_init_mon(true, true);
2896 do_test_inbound_reload_without_init_mon(true, false);
2897 do_test_inbound_reload_without_init_mon(false, true);
2898 do_test_inbound_reload_without_init_mon(false, false);