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::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
204 assert_eq!(payment_hash_1, *payment_hash);
205 assert_eq!(amount_msat, 1_000_000);
206 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
207 assert_eq!(via_channel_id, Some(channel_id));
209 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
210 assert!(payment_preimage.is_none());
211 assert_eq!(payment_secret_1, *payment_secret);
213 _ => panic!("expected PaymentPurpose::InvoicePayment")
216 _ => panic!("Unexpected event"),
219 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
221 // Now set it to failed again...
222 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
224 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
225 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)), false, APIError::MonitorUpdateInProgress, {});
226 check_added_monitors!(nodes[0], 1);
229 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
230 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
231 assert_eq!(nodes[0].node.list_channels().len(), 1);
234 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
235 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
236 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
239 // ...and make sure we can force-close a frozen channel
240 nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
241 check_added_monitors!(nodes[0], 1);
242 check_closed_broadcast!(nodes[0], true);
244 // TODO: Once we hit the chain with the failure transaction we should check that we get a
245 // PaymentPathFailed event
247 assert_eq!(nodes[0].node.list_channels().len(), 0);
248 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
252 fn test_simple_monitor_temporary_update_fail() {
253 do_test_simple_monitor_temporary_update_fail(false);
254 do_test_simple_monitor_temporary_update_fail(true);
257 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
258 let disconnect_flags = 8 | 16;
260 // Test that we can recover from a temporary monitor update failure with some in-flight
261 // HTLCs going on at the same time potentially with some disconnection thrown in.
262 // * First we route a payment, then get a temporary monitor update failure when trying to
263 // route a second payment. We then claim the first payment.
264 // * If disconnect_count is set, we will disconnect at this point (which is likely as
265 // InProgress likely indicates net disconnect which resulted in failing to update the
266 // ChannelMonitor on a watchtower).
267 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
268 // immediately, otherwise we wait disconnect and deliver them via the reconnect
269 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
270 // disconnect_count & !disconnect_flags is 0).
271 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
272 // through message sending, potentially disconnect/reconnecting multiple times based on
273 // disconnect_count, to get the update_fulfill_htlc through.
274 // * We then walk through more message exchanges to get the original update_add_htlc
275 // through, swapping message ordering based on disconnect_count & 8 and optionally
276 // disconnect/reconnecting based on disconnect_count.
277 let chanmon_cfgs = create_chanmon_cfgs(2);
278 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
279 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
280 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
281 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
283 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
285 // Now try to send a second payment which will fail to send
286 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
288 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
289 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)), false, APIError::MonitorUpdateInProgress, {});
290 check_added_monitors!(nodes[0], 1);
293 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
294 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
295 assert_eq!(nodes[0].node.list_channels().len(), 1);
297 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
298 // but nodes[0] won't respond since it is frozen.
299 nodes[1].node.claim_funds(payment_preimage_1);
300 check_added_monitors!(nodes[1], 1);
301 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
303 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
304 assert_eq!(events_2.len(), 1);
305 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
306 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 } } => {
307 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
308 assert!(update_add_htlcs.is_empty());
309 assert_eq!(update_fulfill_htlcs.len(), 1);
310 assert!(update_fail_htlcs.is_empty());
311 assert!(update_fail_malformed_htlcs.is_empty());
312 assert!(update_fee.is_none());
314 if (disconnect_count & 16) == 0 {
315 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
316 let events_3 = nodes[0].node.get_and_clear_pending_events();
317 assert_eq!(events_3.len(), 1);
319 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
320 assert_eq!(*payment_preimage, payment_preimage_1);
321 assert_eq!(*payment_hash, payment_hash_1);
323 _ => panic!("Unexpected event"),
326 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
327 check_added_monitors!(nodes[0], 1);
328 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
331 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
333 _ => panic!("Unexpected event"),
336 if disconnect_count & !disconnect_flags > 0 {
337 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
338 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
341 // Now fix monitor updating...
342 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
343 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
344 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
345 check_added_monitors!(nodes[0], 0);
347 macro_rules! disconnect_reconnect_peers { () => { {
348 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
349 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
351 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
352 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
353 assert_eq!(reestablish_1.len(), 1);
354 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
355 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
356 assert_eq!(reestablish_2.len(), 1);
358 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
359 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
360 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
361 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
363 assert!(as_resp.0.is_none());
364 assert!(bs_resp.0.is_none());
366 (reestablish_1, reestablish_2, as_resp, bs_resp)
369 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
370 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
371 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
373 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
374 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
375 assert_eq!(reestablish_1.len(), 1);
376 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
377 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
378 assert_eq!(reestablish_2.len(), 1);
380 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
381 check_added_monitors!(nodes[0], 0);
382 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
383 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
384 check_added_monitors!(nodes[1], 0);
385 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
387 assert!(as_resp.0.is_none());
388 assert!(bs_resp.0.is_none());
390 assert!(bs_resp.1.is_none());
391 if (disconnect_count & 16) == 0 {
392 assert!(bs_resp.2.is_none());
394 assert!(as_resp.1.is_some());
395 assert!(as_resp.2.is_some());
396 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
398 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
399 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
400 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
401 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
402 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
403 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
405 assert!(as_resp.1.is_none());
407 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
408 let events_3 = nodes[0].node.get_and_clear_pending_events();
409 assert_eq!(events_3.len(), 1);
411 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
412 assert_eq!(*payment_preimage, payment_preimage_1);
413 assert_eq!(*payment_hash, payment_hash_1);
415 _ => panic!("Unexpected event"),
418 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
419 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
420 // No commitment_signed so get_event_msg's assert(len == 1) passes
421 check_added_monitors!(nodes[0], 1);
423 as_resp.1 = Some(as_resp_raa);
427 if disconnect_count & !disconnect_flags > 1 {
428 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
430 if (disconnect_count & 16) == 0 {
431 assert!(reestablish_1 == second_reestablish_1);
432 assert!(reestablish_2 == second_reestablish_2);
434 assert!(as_resp == second_as_resp);
435 assert!(bs_resp == second_bs_resp);
438 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
440 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
441 assert_eq!(events_4.len(), 2);
442 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
443 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
444 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
447 _ => panic!("Unexpected event"),
451 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
453 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
454 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
455 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
456 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
457 check_added_monitors!(nodes[1], 1);
459 if disconnect_count & !disconnect_flags > 2 {
460 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
462 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
463 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
465 assert!(as_resp.2.is_none());
466 assert!(bs_resp.2.is_none());
469 let as_commitment_update;
470 let bs_second_commitment_update;
472 macro_rules! handle_bs_raa { () => {
473 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
474 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
475 assert!(as_commitment_update.update_add_htlcs.is_empty());
476 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
477 assert!(as_commitment_update.update_fail_htlcs.is_empty());
478 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
479 assert!(as_commitment_update.update_fee.is_none());
480 check_added_monitors!(nodes[0], 1);
483 macro_rules! handle_initial_raa { () => {
484 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
485 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
486 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
487 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
488 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
489 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
490 assert!(bs_second_commitment_update.update_fee.is_none());
491 check_added_monitors!(nodes[1], 1);
494 if (disconnect_count & 8) == 0 {
497 if disconnect_count & !disconnect_flags > 3 {
498 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
500 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
501 assert!(bs_resp.1.is_none());
503 assert!(as_resp.2.unwrap() == as_commitment_update);
504 assert!(bs_resp.2.is_none());
506 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
509 handle_initial_raa!();
511 if disconnect_count & !disconnect_flags > 4 {
512 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
514 assert!(as_resp.1.is_none());
515 assert!(bs_resp.1.is_none());
517 assert!(as_resp.2.unwrap() == as_commitment_update);
518 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
521 handle_initial_raa!();
523 if disconnect_count & !disconnect_flags > 3 {
524 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
526 assert!(as_resp.1.is_none());
527 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
529 assert!(as_resp.2.is_none());
530 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
532 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
537 if disconnect_count & !disconnect_flags > 4 {
538 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
540 assert!(as_resp.1.is_none());
541 assert!(bs_resp.1.is_none());
543 assert!(as_resp.2.unwrap() == as_commitment_update);
544 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
548 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
549 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
550 // No commitment_signed so get_event_msg's assert(len == 1) passes
551 check_added_monitors!(nodes[0], 1);
553 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
554 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
555 // No commitment_signed so get_event_msg's assert(len == 1) passes
556 check_added_monitors!(nodes[1], 1);
558 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
559 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
560 check_added_monitors!(nodes[1], 1);
562 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
563 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
564 check_added_monitors!(nodes[0], 1);
565 expect_payment_path_successful!(nodes[0]);
567 expect_pending_htlcs_forwardable!(nodes[1]);
569 let events_5 = nodes[1].node.get_and_clear_pending_events();
570 assert_eq!(events_5.len(), 1);
572 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
573 assert_eq!(payment_hash_2, *payment_hash);
574 assert_eq!(amount_msat, 1_000_000);
575 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
576 assert_eq!(via_channel_id, Some(channel_id));
578 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
579 assert!(payment_preimage.is_none());
580 assert_eq!(payment_secret_2, *payment_secret);
582 _ => panic!("expected PaymentPurpose::InvoicePayment")
585 _ => panic!("Unexpected event"),
588 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
592 fn test_monitor_temporary_update_fail_a() {
593 do_test_monitor_temporary_update_fail(0);
594 do_test_monitor_temporary_update_fail(1);
595 do_test_monitor_temporary_update_fail(2);
596 do_test_monitor_temporary_update_fail(3);
597 do_test_monitor_temporary_update_fail(4);
598 do_test_monitor_temporary_update_fail(5);
602 fn test_monitor_temporary_update_fail_b() {
603 do_test_monitor_temporary_update_fail(2 | 8);
604 do_test_monitor_temporary_update_fail(3 | 8);
605 do_test_monitor_temporary_update_fail(4 | 8);
606 do_test_monitor_temporary_update_fail(5 | 8);
610 fn test_monitor_temporary_update_fail_c() {
611 do_test_monitor_temporary_update_fail(1 | 16);
612 do_test_monitor_temporary_update_fail(2 | 16);
613 do_test_monitor_temporary_update_fail(3 | 16);
614 do_test_monitor_temporary_update_fail(2 | 8 | 16);
615 do_test_monitor_temporary_update_fail(3 | 8 | 16);
619 fn test_monitor_update_fail_cs() {
620 // Tests handling of a monitor update failure when processing an incoming commitment_signed
621 let chanmon_cfgs = create_chanmon_cfgs(2);
622 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
623 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
624 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
625 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
627 let (route, our_payment_hash, payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
629 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
630 check_added_monitors!(nodes[0], 1);
633 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
634 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
636 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
637 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
638 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
639 check_added_monitors!(nodes[1], 1);
640 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
642 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
643 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
644 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
645 check_added_monitors!(nodes[1], 0);
646 let responses = nodes[1].node.get_and_clear_pending_msg_events();
647 assert_eq!(responses.len(), 2);
650 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
651 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
652 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
653 check_added_monitors!(nodes[0], 1);
655 _ => panic!("Unexpected event"),
658 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
659 assert!(updates.update_add_htlcs.is_empty());
660 assert!(updates.update_fulfill_htlcs.is_empty());
661 assert!(updates.update_fail_htlcs.is_empty());
662 assert!(updates.update_fail_malformed_htlcs.is_empty());
663 assert!(updates.update_fee.is_none());
664 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
666 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
667 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
668 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
669 check_added_monitors!(nodes[0], 1);
670 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
672 _ => panic!("Unexpected event"),
675 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
676 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
677 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
678 check_added_monitors!(nodes[0], 0);
680 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
681 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
682 check_added_monitors!(nodes[1], 1);
684 expect_pending_htlcs_forwardable!(nodes[1]);
686 let events = nodes[1].node.get_and_clear_pending_events();
687 assert_eq!(events.len(), 1);
689 Event::PaymentClaimable { payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
690 assert_eq!(payment_hash, our_payment_hash);
691 assert_eq!(amount_msat, 1_000_000);
692 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
693 assert_eq!(via_channel_id, Some(channel_id));
695 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
696 assert!(payment_preimage.is_none());
697 assert_eq!(our_payment_secret, *payment_secret);
699 _ => panic!("expected PaymentPurpose::InvoicePayment")
702 _ => panic!("Unexpected event"),
705 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
709 fn test_monitor_update_fail_no_rebroadcast() {
710 // Tests handling of a monitor update failure when no message rebroadcasting on
711 // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
713 let chanmon_cfgs = create_chanmon_cfgs(2);
714 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
715 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
716 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
717 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
719 let (route, our_payment_hash, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
721 nodes[0].node.send_payment(&route, our_payment_hash, &Some(payment_secret_1), PaymentId(our_payment_hash.0)).unwrap();
722 check_added_monitors!(nodes[0], 1);
725 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
726 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
727 let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
729 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
730 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
731 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
732 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
733 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
734 check_added_monitors!(nodes[1], 1);
736 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
737 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
738 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
739 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
740 check_added_monitors!(nodes[1], 0);
741 expect_pending_htlcs_forwardable!(nodes[1]);
743 let events = nodes[1].node.get_and_clear_pending_events();
744 assert_eq!(events.len(), 1);
746 Event::PaymentClaimable { payment_hash, .. } => {
747 assert_eq!(payment_hash, our_payment_hash);
749 _ => panic!("Unexpected event"),
752 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
756 fn test_monitor_update_raa_while_paused() {
757 // Tests handling of an RAA while monitor updating has already been marked failed.
758 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
759 let chanmon_cfgs = create_chanmon_cfgs(2);
760 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
761 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
762 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
763 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
765 send_payment(&nodes[0], &[&nodes[1]], 5000000);
766 let (route, our_payment_hash_1, payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
768 nodes[0].node.send_payment(&route, our_payment_hash_1, &Some(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
769 check_added_monitors!(nodes[0], 1);
771 let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
773 let (route, our_payment_hash_2, payment_preimage_2, our_payment_secret_2) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000000);
775 nodes[1].node.send_payment(&route, our_payment_hash_2, &Some(our_payment_secret_2), PaymentId(our_payment_hash_2.0)).unwrap();
776 check_added_monitors!(nodes[1], 1);
778 let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
780 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
781 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
782 check_added_monitors!(nodes[1], 1);
783 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
785 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
786 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
787 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
788 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
789 check_added_monitors!(nodes[0], 1);
790 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
792 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
793 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
794 check_added_monitors!(nodes[0], 1);
796 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
797 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
798 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
799 check_added_monitors!(nodes[0], 0);
801 let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
802 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
803 check_added_monitors!(nodes[1], 1);
804 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
806 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
807 check_added_monitors!(nodes[1], 1);
808 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
810 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
811 check_added_monitors!(nodes[0], 1);
812 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
814 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
815 check_added_monitors!(nodes[0], 1);
816 expect_pending_htlcs_forwardable!(nodes[0]);
817 expect_payment_claimable!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
819 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
820 check_added_monitors!(nodes[1], 1);
821 expect_pending_htlcs_forwardable!(nodes[1]);
822 expect_payment_claimable!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
824 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
825 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
828 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
829 // Tests handling of a monitor update failure when processing an incoming RAA
830 let chanmon_cfgs = create_chanmon_cfgs(3);
831 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
832 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
833 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
834 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
835 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
837 // Rebalance a bit so that we can send backwards from 2 to 1.
838 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
840 // Route a first payment that we'll fail backwards
841 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
843 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
844 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
845 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
846 check_added_monitors!(nodes[2], 1);
848 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
849 assert!(updates.update_add_htlcs.is_empty());
850 assert!(updates.update_fulfill_htlcs.is_empty());
851 assert_eq!(updates.update_fail_htlcs.len(), 1);
852 assert!(updates.update_fail_malformed_htlcs.is_empty());
853 assert!(updates.update_fee.is_none());
854 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
856 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
857 check_added_monitors!(nodes[0], 0);
859 // While the second channel is AwaitingRAA, forward a second payment to get it into the
861 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
863 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
864 check_added_monitors!(nodes[0], 1);
867 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
868 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
869 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
871 expect_pending_htlcs_forwardable!(nodes[1]);
872 check_added_monitors!(nodes[1], 0);
873 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
875 // Now fail monitor updating.
876 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
877 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
878 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
879 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 (Some(payment_preimage_4), Some(payment_hash_4))
915 } else { (None, None) };
917 // Restore monitor updating, ensuring we immediately get a fail-back update and a
918 // update_add update.
919 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
920 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
921 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
922 check_added_monitors!(nodes[1], 0);
923 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 }]);
924 check_added_monitors!(nodes[1], 1);
926 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
927 if test_ignore_second_cs {
928 assert_eq!(events_3.len(), 3);
930 assert_eq!(events_3.len(), 2);
933 // Note that the ordering of the events for different nodes is non-prescriptive, though the
934 // ordering of the two events that both go to nodes[2] have to stay in the same order.
935 let messages_a = match events_3.pop().unwrap() {
936 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
937 assert_eq!(node_id, nodes[0].node.get_our_node_id());
938 assert!(updates.update_fulfill_htlcs.is_empty());
939 assert_eq!(updates.update_fail_htlcs.len(), 1);
940 assert!(updates.update_fail_malformed_htlcs.is_empty());
941 assert!(updates.update_add_htlcs.is_empty());
942 assert!(updates.update_fee.is_none());
943 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
945 _ => panic!("Unexpected event type!"),
947 let raa = if test_ignore_second_cs {
948 match events_3.remove(1) {
949 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
950 assert_eq!(node_id, nodes[2].node.get_our_node_id());
953 _ => panic!("Unexpected event"),
956 let send_event_b = SendEvent::from_event(events_3.remove(0));
957 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
959 // Now deliver the new messages...
961 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
962 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
963 expect_payment_failed!(nodes[0], payment_hash_1, true);
965 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
967 if test_ignore_second_cs {
968 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
969 check_added_monitors!(nodes[2], 1);
970 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
971 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
972 check_added_monitors!(nodes[2], 1);
973 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
974 assert!(bs_cs.update_add_htlcs.is_empty());
975 assert!(bs_cs.update_fail_htlcs.is_empty());
976 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
977 assert!(bs_cs.update_fulfill_htlcs.is_empty());
978 assert!(bs_cs.update_fee.is_none());
980 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
981 check_added_monitors!(nodes[1], 1);
982 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
984 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
985 check_added_monitors!(nodes[1], 1);
987 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
988 check_added_monitors!(nodes[2], 1);
990 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
991 assert_eq!(bs_revoke_and_commit.len(), 2);
992 match bs_revoke_and_commit[0] {
993 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
994 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
995 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
996 check_added_monitors!(nodes[1], 1);
998 _ => panic!("Unexpected event"),
1001 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1003 match bs_revoke_and_commit[1] {
1004 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1005 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1006 assert!(updates.update_add_htlcs.is_empty());
1007 assert!(updates.update_fail_htlcs.is_empty());
1008 assert!(updates.update_fail_malformed_htlcs.is_empty());
1009 assert!(updates.update_fulfill_htlcs.is_empty());
1010 assert!(updates.update_fee.is_none());
1011 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1012 check_added_monitors!(nodes[1], 1);
1014 _ => panic!("Unexpected event"),
1018 assert_eq!(as_cs.update_add_htlcs.len(), 1);
1019 assert!(as_cs.update_fail_htlcs.is_empty());
1020 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1021 assert!(as_cs.update_fulfill_htlcs.is_empty());
1022 assert!(as_cs.update_fee.is_none());
1023 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1026 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1027 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1028 check_added_monitors!(nodes[2], 1);
1029 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1031 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1032 check_added_monitors!(nodes[2], 1);
1033 let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1035 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1036 check_added_monitors!(nodes[1], 1);
1037 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1039 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1040 check_added_monitors!(nodes[1], 1);
1041 let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1043 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1044 check_added_monitors!(nodes[2], 1);
1045 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1047 expect_pending_htlcs_forwardable!(nodes[2]);
1049 let events_6 = nodes[2].node.get_and_clear_pending_events();
1050 assert_eq!(events_6.len(), 2);
1052 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1053 _ => panic!("Unexpected event"),
1056 Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1057 _ => panic!("Unexpected event"),
1060 if test_ignore_second_cs {
1061 expect_pending_htlcs_forwardable!(nodes[1]);
1062 check_added_monitors!(nodes[1], 1);
1064 send_event = SendEvent::from_node(&nodes[1]);
1065 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1066 assert_eq!(send_event.msgs.len(), 1);
1067 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1068 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1070 expect_pending_htlcs_forwardable!(nodes[0]);
1072 let events_9 = nodes[0].node.get_and_clear_pending_events();
1073 assert_eq!(events_9.len(), 1);
1075 Event::PaymentClaimable { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1076 _ => panic!("Unexpected event"),
1078 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1081 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1085 fn test_monitor_update_fail_raa() {
1086 do_test_monitor_update_fail_raa(false);
1087 do_test_monitor_update_fail_raa(true);
1091 fn test_monitor_update_fail_reestablish() {
1092 // Simple test for message retransmission after monitor update failure on
1093 // channel_reestablish generating a monitor update (which comes from freeing holding cell
1095 let chanmon_cfgs = create_chanmon_cfgs(3);
1096 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1097 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1098 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1099 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1100 create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1102 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
1104 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1105 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1107 nodes[2].node.claim_funds(payment_preimage);
1108 check_added_monitors!(nodes[2], 1);
1109 expect_payment_claimed!(nodes[2], payment_hash, 1_000_000);
1111 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1112 assert!(updates.update_add_htlcs.is_empty());
1113 assert!(updates.update_fail_htlcs.is_empty());
1114 assert!(updates.update_fail_malformed_htlcs.is_empty());
1115 assert!(updates.update_fee.is_none());
1116 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1117 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1118 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
1119 check_added_monitors!(nodes[1], 1);
1120 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1121 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1123 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1124 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1125 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1127 let as_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1128 let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1130 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1132 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1134 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1135 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1137 nodes[1].node.get_and_clear_pending_msg_events(); // Free the holding cell
1138 check_added_monitors!(nodes[1], 1);
1140 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1141 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1143 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1144 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1146 assert_eq!(get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap(), as_reestablish);
1147 assert_eq!(get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap(), bs_reestablish);
1149 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1151 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1152 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1154 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1155 check_added_monitors!(nodes[1], 0);
1157 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1158 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1160 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1161 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1162 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1163 check_added_monitors!(nodes[1], 0);
1165 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1166 assert!(updates.update_add_htlcs.is_empty());
1167 assert!(updates.update_fail_htlcs.is_empty());
1168 assert!(updates.update_fail_malformed_htlcs.is_empty());
1169 assert!(updates.update_fee.is_none());
1170 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1171 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1172 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1173 expect_payment_sent!(nodes[0], payment_preimage);
1177 fn raa_no_response_awaiting_raa_state() {
1178 // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1179 // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1180 // in question (assuming it intends to respond with a CS after monitor updating is restored).
1181 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1182 let chanmon_cfgs = create_chanmon_cfgs(2);
1183 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1184 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1185 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1186 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1188 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1189 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1190 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1192 // Queue up two payments - one will be delivered right away, one immediately goes into the
1193 // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1194 // immediately after a CS. By setting failing the monitor update failure from the CS (which
1195 // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1196 // generation during RAA while in monitor-update-failed state.
1198 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1199 check_added_monitors!(nodes[0], 1);
1200 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1201 check_added_monitors!(nodes[0], 0);
1204 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1205 assert_eq!(events.len(), 1);
1206 let payment_event = SendEvent::from_event(events.pop().unwrap());
1207 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1208 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1209 check_added_monitors!(nodes[1], 1);
1211 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1212 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1213 check_added_monitors!(nodes[0], 1);
1214 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1215 assert_eq!(events.len(), 1);
1216 let payment_event = SendEvent::from_event(events.pop().unwrap());
1218 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1219 check_added_monitors!(nodes[0], 1);
1220 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1222 // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1223 // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1224 // then restore channel monitor updates.
1225 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1226 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1227 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1228 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1229 check_added_monitors!(nodes[1], 1);
1230 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1232 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1233 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1234 check_added_monitors!(nodes[1], 1);
1236 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1237 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1238 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1239 // nodes[1] should be AwaitingRAA here!
1240 check_added_monitors!(nodes[1], 0);
1241 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1242 expect_pending_htlcs_forwardable!(nodes[1]);
1243 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1245 // We send a third payment here, which is somewhat of a redundant test, but the
1246 // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1247 // commitment transaction states) whereas here we can explicitly check for it.
1249 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1250 check_added_monitors!(nodes[0], 0);
1251 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1253 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1254 check_added_monitors!(nodes[0], 1);
1255 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1256 assert_eq!(events.len(), 1);
1257 let payment_event = SendEvent::from_event(events.pop().unwrap());
1259 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1260 check_added_monitors!(nodes[0], 1);
1261 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1263 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1264 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1265 check_added_monitors!(nodes[1], 1);
1266 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1268 // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1269 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1270 check_added_monitors!(nodes[1], 1);
1271 expect_pending_htlcs_forwardable!(nodes[1]);
1272 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1273 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1275 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1276 check_added_monitors!(nodes[0], 1);
1278 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1279 check_added_monitors!(nodes[0], 1);
1280 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1282 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1283 check_added_monitors!(nodes[1], 1);
1284 expect_pending_htlcs_forwardable!(nodes[1]);
1285 expect_payment_claimable!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1287 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1288 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1289 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1293 fn claim_while_disconnected_monitor_update_fail() {
1294 // Test for claiming a payment while disconnected and then having the resulting
1295 // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1296 // contrived case for nodes with network instability.
1297 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1298 // code introduced a regression in this test (specifically, this caught a removal of the
1299 // channel_reestablish handling ensuring the order was sensical given the messages used).
1300 let chanmon_cfgs = create_chanmon_cfgs(2);
1301 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1302 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1303 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1304 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1306 // Forward a payment for B to claim
1307 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1309 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1310 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1312 nodes[1].node.claim_funds(payment_preimage_1);
1313 check_added_monitors!(nodes[1], 1);
1314 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1316 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1317 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1319 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1320 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1322 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1323 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1325 // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1327 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1329 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1330 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1331 check_added_monitors!(nodes[1], 1);
1332 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1334 // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1335 // the monitor still failed
1336 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1338 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1339 check_added_monitors!(nodes[0], 1);
1342 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1343 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1344 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1345 check_added_monitors!(nodes[1], 1);
1346 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1347 // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1348 // until we've channel_monitor_update'd and updated for the new commitment transaction.
1350 // Now un-fail the monitor, which will result in B sending its original commitment update,
1351 // receiving the commitment update from A, and the resulting commitment dances.
1352 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1353 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1354 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1355 check_added_monitors!(nodes[1], 0);
1357 let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1358 assert_eq!(bs_msgs.len(), 2);
1361 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1362 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1363 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1364 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1365 check_added_monitors!(nodes[0], 1);
1367 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1368 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1369 check_added_monitors!(nodes[1], 1);
1371 _ => panic!("Unexpected event"),
1375 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1376 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1377 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1378 check_added_monitors!(nodes[0], 1);
1380 _ => panic!("Unexpected event"),
1383 let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1385 let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1386 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1387 check_added_monitors!(nodes[0], 1);
1388 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1390 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1391 check_added_monitors!(nodes[1], 1);
1392 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1393 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1394 check_added_monitors!(nodes[1], 1);
1396 expect_pending_htlcs_forwardable!(nodes[1]);
1397 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1399 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1400 check_added_monitors!(nodes[0], 1);
1401 expect_payment_sent!(nodes[0], payment_preimage_1);
1403 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1407 fn monitor_failed_no_reestablish_response() {
1408 // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1409 // response to a commitment_signed.
1410 // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1411 // debug_assert!() failure in channel_reestablish handling.
1412 let chanmon_cfgs = create_chanmon_cfgs(2);
1413 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1414 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1415 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1416 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1419 get_channel_ref!(nodes[0], lock, channel_id).announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1420 get_channel_ref!(nodes[1], lock, channel_id).announcement_sigs_state = AnnouncementSigsState::PeerReceived;
1423 // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1425 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1427 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1428 check_added_monitors!(nodes[0], 1);
1431 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1432 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1433 assert_eq!(events.len(), 1);
1434 let payment_event = SendEvent::from_event(events.pop().unwrap());
1435 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1436 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1437 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1438 check_added_monitors!(nodes[1], 1);
1440 // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1441 // is still failing to update monitors.
1442 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1443 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1445 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1446 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1448 let as_reconnect = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
1449 let bs_reconnect = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
1451 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1452 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1453 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1454 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1456 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1457 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1458 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1459 check_added_monitors!(nodes[1], 0);
1460 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1462 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1463 check_added_monitors!(nodes[0], 1);
1464 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1465 check_added_monitors!(nodes[0], 1);
1467 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1468 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1469 check_added_monitors!(nodes[1], 1);
1471 expect_pending_htlcs_forwardable!(nodes[1]);
1472 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1474 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1478 fn first_message_on_recv_ordering() {
1479 // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1480 // messages, we're willing to flip the order of response messages if neccessary in resposne to
1481 // a commitment_signed which needs to send an RAA first.
1482 // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1483 // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1484 // response. To do this, we start routing two payments, with the final RAA for the first being
1485 // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1486 // have no pending response but will want to send a RAA/CS (with the updates for the second
1487 // payment applied).
1488 // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1489 let chanmon_cfgs = create_chanmon_cfgs(2);
1490 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1491 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1492 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1493 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1495 // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1496 // can deliver it and fail the monitor update.
1497 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1499 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1500 check_added_monitors!(nodes[0], 1);
1503 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1504 assert_eq!(events.len(), 1);
1505 let payment_event = SendEvent::from_event(events.pop().unwrap());
1506 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1507 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1508 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1509 check_added_monitors!(nodes[1], 1);
1510 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1512 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1513 check_added_monitors!(nodes[0], 1);
1514 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1515 check_added_monitors!(nodes[0], 1);
1517 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1519 // Route the second payment, generating an update_add_htlc/commitment_signed
1520 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1522 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1523 check_added_monitors!(nodes[0], 1);
1525 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1526 assert_eq!(events.len(), 1);
1527 let payment_event = SendEvent::from_event(events.pop().unwrap());
1528 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1530 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1532 // Deliver the final RAA for the first payment, which does not require a response. RAAs
1533 // generally require a commitment_signed, so the fact that we're expecting an opposite response
1534 // to the next message also tests resetting the delivery order.
1535 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1536 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1537 check_added_monitors!(nodes[1], 1);
1539 // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1540 // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1541 // appropriate HTLC acceptance).
1542 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1543 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1544 check_added_monitors!(nodes[1], 1);
1545 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1547 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1548 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1549 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1550 check_added_monitors!(nodes[1], 0);
1552 expect_pending_htlcs_forwardable!(nodes[1]);
1553 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1555 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1556 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1557 check_added_monitors!(nodes[0], 1);
1558 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1559 check_added_monitors!(nodes[0], 1);
1561 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1562 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1563 check_added_monitors!(nodes[1], 1);
1565 expect_pending_htlcs_forwardable!(nodes[1]);
1566 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1568 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1569 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1573 fn test_monitor_update_fail_claim() {
1574 // Basic test for monitor update failures when processing claim_funds calls.
1575 // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1576 // update to claim the payment. We then send two payments C->B->A, which are held at B.
1577 // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1578 // the payments from C onwards to A.
1579 let chanmon_cfgs = create_chanmon_cfgs(3);
1580 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1581 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1582 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1583 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1584 create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1586 // Rebalance a bit so that we can send backwards from 3 to 2.
1587 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1589 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1591 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1592 nodes[1].node.claim_funds(payment_preimage_1);
1593 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1594 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1595 check_added_monitors!(nodes[1], 1);
1597 // Note that at this point there is a pending commitment transaction update for A being held by
1598 // B. Even when we go to send the payment from C through B to A, B will not update this
1599 // already-signed commitment transaction and will instead wait for it to resolve before
1600 // forwarding the payment onwards.
1602 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1_000_000);
1604 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1605 check_added_monitors!(nodes[2], 1);
1608 // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1609 // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1610 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1612 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1613 assert_eq!(events.len(), 1);
1614 let payment_event = SendEvent::from_event(events.pop().unwrap());
1615 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1616 let events = nodes[1].node.get_and_clear_pending_msg_events();
1617 assert_eq!(events.len(), 0);
1618 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1620 let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1621 nodes[2].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
1622 check_added_monitors!(nodes[2], 1);
1624 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1625 assert_eq!(events.len(), 1);
1626 let payment_event = SendEvent::from_event(events.pop().unwrap());
1627 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1628 let events = nodes[1].node.get_and_clear_pending_msg_events();
1629 assert_eq!(events.len(), 0);
1630 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1632 // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1633 let channel_id = chan_1.2;
1634 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1635 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1636 check_added_monitors!(nodes[1], 0);
1638 let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1639 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1640 commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1641 expect_payment_sent!(nodes[0], payment_preimage_1);
1643 // Get the payment forwards, note that they were batched into one commitment update.
1644 expect_pending_htlcs_forwardable!(nodes[1]);
1645 check_added_monitors!(nodes[1], 1);
1646 let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1647 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1648 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1649 commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1650 expect_pending_htlcs_forwardable!(nodes[0]);
1652 let events = nodes[0].node.get_and_clear_pending_events();
1653 assert_eq!(events.len(), 2);
1655 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id } => {
1656 assert_eq!(payment_hash_2, *payment_hash);
1657 assert_eq!(1_000_000, amount_msat);
1658 assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1659 assert_eq!(via_channel_id, Some(channel_id));
1660 assert_eq!(via_user_channel_id, Some(42));
1662 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1663 assert!(payment_preimage.is_none());
1664 assert_eq!(payment_secret_2, *payment_secret);
1666 _ => panic!("expected PaymentPurpose::InvoicePayment")
1669 _ => panic!("Unexpected event"),
1672 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
1673 assert_eq!(payment_hash_3, *payment_hash);
1674 assert_eq!(1_000_000, amount_msat);
1675 assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
1676 assert_eq!(via_channel_id, Some(channel_id));
1678 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1679 assert!(payment_preimage.is_none());
1680 assert_eq!(payment_secret_3, *payment_secret);
1682 _ => panic!("expected PaymentPurpose::InvoicePayment")
1685 _ => panic!("Unexpected event"),
1690 fn test_monitor_update_on_pending_forwards() {
1691 // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1692 // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1693 // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1694 // from C to A will be pending a forward to A.
1695 let chanmon_cfgs = create_chanmon_cfgs(3);
1696 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1697 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1698 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1699 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1700 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1702 // Rebalance a bit so that we can send backwards from 3 to 1.
1703 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1705 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1706 nodes[2].node.fail_htlc_backwards(&payment_hash_1);
1707 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_1 }]);
1708 check_added_monitors!(nodes[2], 1);
1710 let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1711 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1712 commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1713 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1715 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
1717 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1718 check_added_monitors!(nodes[2], 1);
1721 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1722 assert_eq!(events.len(), 1);
1723 let payment_event = SendEvent::from_event(events.pop().unwrap());
1724 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1725 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1727 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1728 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 }]);
1729 check_added_monitors!(nodes[1], 1);
1730 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1732 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1733 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1734 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1735 check_added_monitors!(nodes[1], 0);
1737 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1738 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1739 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1740 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1742 let events = nodes[0].node.get_and_clear_pending_events();
1743 assert_eq!(events.len(), 2);
1744 if let Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } = events[0] {
1745 assert_eq!(payment_hash, payment_hash_1);
1746 assert!(payment_failed_permanently);
1747 } else { panic!("Unexpected event!"); }
1749 Event::PendingHTLCsForwardable { .. } => { },
1750 _ => panic!("Unexpected event"),
1752 nodes[0].node.process_pending_htlc_forwards();
1753 expect_payment_claimable!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1755 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1759 fn monitor_update_claim_fail_no_response() {
1760 // Test for claim_funds resulting in both a monitor update failure and no message response (due
1761 // to channel being AwaitingRAA).
1762 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1764 let chanmon_cfgs = create_chanmon_cfgs(2);
1765 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1766 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1767 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1768 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
1770 // Forward a payment for B to claim
1771 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1773 // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1774 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1776 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1777 check_added_monitors!(nodes[0], 1);
1780 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1781 assert_eq!(events.len(), 1);
1782 let payment_event = SendEvent::from_event(events.pop().unwrap());
1783 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1784 let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1786 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1787 nodes[1].node.claim_funds(payment_preimage_1);
1788 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
1789 check_added_monitors!(nodes[1], 1);
1791 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1793 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1794 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1795 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1796 check_added_monitors!(nodes[1], 0);
1797 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1799 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1800 check_added_monitors!(nodes[1], 1);
1801 expect_pending_htlcs_forwardable!(nodes[1]);
1802 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1804 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1805 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1806 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1807 expect_payment_sent!(nodes[0], payment_preimage_1);
1809 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1812 // restore_b_before_conf has no meaning if !confirm_a_first
1813 // restore_b_before_lock has no meaning if confirm_a_first
1814 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool, restore_b_before_lock: bool) {
1815 // Test that if the monitor update generated by funding_transaction_generated fails we continue
1816 // the channel setup happily after the update is restored.
1817 let chanmon_cfgs = create_chanmon_cfgs(2);
1818 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1819 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1820 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1822 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1823 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()));
1824 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()));
1826 let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
1828 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
1829 check_added_monitors!(nodes[0], 0);
1831 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1832 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1833 let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1834 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1835 check_added_monitors!(nodes[1], 1);
1837 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1838 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()));
1839 check_added_monitors!(nodes[0], 1);
1840 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1841 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1842 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1843 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1844 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1845 check_added_monitors!(nodes[0], 0);
1847 let events = nodes[0].node.get_and_clear_pending_events();
1848 assert_eq!(events.len(), 0);
1849 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1850 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1852 if confirm_a_first {
1853 confirm_transaction(&nodes[0], &funding_tx);
1854 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()));
1855 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1856 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1858 assert!(!restore_b_before_conf);
1859 confirm_transaction(&nodes[1], &funding_tx);
1860 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1863 // Make sure nodes[1] isn't stupid enough to re-send the ChannelReady on reconnect
1864 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1865 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1866 reconnect_nodes(&nodes[0], &nodes[1], (false, confirm_a_first), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1867 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1868 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1870 if !restore_b_before_conf {
1871 confirm_transaction(&nodes[1], &funding_tx);
1872 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1873 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1875 if !confirm_a_first && !restore_b_before_lock {
1876 confirm_transaction(&nodes[0], &funding_tx);
1877 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()));
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());
1882 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1883 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1884 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1885 check_added_monitors!(nodes[1], 0);
1887 let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1888 if !restore_b_before_lock {
1889 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1890 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1892 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()));
1893 confirm_transaction(&nodes[0], &funding_tx);
1894 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1895 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready))
1898 if restore_b_before_conf {
1899 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1900 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1901 confirm_transaction(&nodes[1], &funding_tx);
1903 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1904 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &channel_ready))
1906 for node in nodes.iter() {
1907 assert!(node.gossip_sync.handle_channel_announcement(&announcement).unwrap());
1908 node.gossip_sync.handle_channel_update(&as_update).unwrap();
1909 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
1912 if !restore_b_before_lock {
1913 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
1915 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
1919 send_payment(&nodes[0], &[&nodes[1]], 8000000);
1920 close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1921 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
1922 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1926 fn during_funding_monitor_fail() {
1927 do_during_funding_monitor_fail(true, true, false);
1928 do_during_funding_monitor_fail(true, false, false);
1929 do_during_funding_monitor_fail(false, false, false);
1930 do_during_funding_monitor_fail(false, false, true);
1934 fn test_path_paused_mpp() {
1935 // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1937 let chanmon_cfgs = create_chanmon_cfgs(4);
1938 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1939 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1940 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1942 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
1943 let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1944 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
1945 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
1947 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
1949 // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1950 let path = route.paths[0].clone();
1951 route.paths.push(path);
1952 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
1953 route.paths[0][0].short_channel_id = chan_1_id;
1954 route.paths[0][1].short_channel_id = chan_3_id;
1955 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
1956 route.paths[1][0].short_channel_id = chan_2_ann.contents.short_channel_id;
1957 route.paths[1][1].short_channel_id = chan_4_id;
1959 // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
1960 // (for the path 0 -> 2 -> 3) fails.
1961 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1962 chanmon_cfgs[0].persister.set_next_update_ret(Some(ChannelMonitorUpdateStatus::InProgress));
1964 // Now check that we get the right return value, indicating that the first path succeeded but
1965 // the second got a MonitorUpdateInProgress err. This implies
1966 // PaymentSendFailure::PartialFailure as some paths succeeded, preventing retry.
1967 if let Err(PaymentSendFailure::PartialFailure { results, ..}) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)) {
1968 assert_eq!(results.len(), 2);
1969 if let Ok(()) = results[0] {} else { panic!(); }
1970 if let Err(APIError::MonitorUpdateInProgress) = results[1] {} else { panic!(); }
1971 } else { panic!(); }
1972 check_added_monitors!(nodes[0], 2);
1973 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1975 // Pass the first HTLC of the payment along to nodes[3].
1976 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1977 assert_eq!(events.len(), 1);
1978 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false, None);
1980 // And check that, after we successfully update the monitor for chan_2 we can pass the second
1981 // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
1982 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
1983 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1984 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1985 assert_eq!(events.len(), 1);
1986 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true, None);
1988 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
1992 fn test_pending_update_fee_ack_on_reconnect() {
1993 // In early versions of our automated fee update patch, nodes did not correctly use the
1994 // previous channel feerate after sending an undelivered revoke_and_ack when re-sending an
1995 // undelivered commitment_signed.
1997 // B sends A new HTLC + CS, not delivered
1998 // A sends B update_fee + CS
1999 // B receives the CS and sends RAA, previously causing B to lock in the new feerate
2001 // B resends initial CS, using the original fee
2003 let chanmon_cfgs = create_chanmon_cfgs(2);
2004 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2005 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2006 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2008 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2009 send_payment(&nodes[0], &[&nodes[1]], 100_000_00);
2011 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[1], nodes[0], 1_000_000);
2012 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
2013 check_added_monitors!(nodes[1], 1);
2014 let bs_initial_send_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2015 // bs_initial_send_msgs are not delivered until they are re-generated after reconnect
2018 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2021 nodes[0].node.timer_tick_occurred();
2022 check_added_monitors!(nodes[0], 1);
2023 let as_update_fee_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2024 assert!(as_update_fee_msgs.update_fee.is_some());
2026 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_update_fee_msgs.update_fee.as_ref().unwrap());
2027 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_fee_msgs.commitment_signed);
2028 check_added_monitors!(nodes[1], 1);
2029 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2030 // bs_first_raa is not delivered until it is re-generated after reconnect
2032 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2033 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2035 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2036 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2037 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2038 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2040 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2041 let bs_resend_msgs = nodes[1].node.get_and_clear_pending_msg_events();
2042 assert_eq!(bs_resend_msgs.len(), 3);
2043 if let MessageSendEvent::UpdateHTLCs { ref updates, .. } = bs_resend_msgs[0] {
2044 assert_eq!(*updates, bs_initial_send_msgs);
2045 } else { panic!(); }
2046 if let MessageSendEvent::SendRevokeAndACK { ref msg, .. } = bs_resend_msgs[1] {
2047 assert_eq!(*msg, bs_first_raa);
2048 } else { panic!(); }
2049 if let MessageSendEvent::SendChannelUpdate { .. } = bs_resend_msgs[2] { } else { panic!(); }
2051 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2052 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
2054 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.update_add_htlcs[0]);
2055 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.commitment_signed);
2056 check_added_monitors!(nodes[0], 1);
2057 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2058 check_added_monitors!(nodes[1], 1);
2059 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()).commitment_signed;
2061 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2062 check_added_monitors!(nodes[0], 1);
2063 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id()).commitment_signed);
2064 check_added_monitors!(nodes[1], 1);
2065 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2067 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2068 check_added_monitors!(nodes[0], 1);
2069 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2070 check_added_monitors!(nodes[0], 1);
2072 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2073 check_added_monitors!(nodes[1], 1);
2075 expect_pending_htlcs_forwardable!(nodes[0]);
2076 expect_payment_claimable!(nodes[0], payment_hash, payment_secret, 1_000_000);
2078 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
2082 fn test_fail_htlc_on_broadcast_after_claim() {
2083 // In an earlier version of 7e78fa660cec8a73286c94c1073ee588140e7a01 we'd also fail the inbound
2084 // channel backwards if we received an HTLC failure after a HTLC fulfillment. Here we test a
2085 // specific case of that by having the HTLC failure come from the ChannelMonitor after a dust
2086 // HTLC was not included in a confirmed commitment transaction.
2088 // We first forward a payment, then claim it with an update_fulfill_htlc message, closing the
2089 // channel immediately before commitment occurs. After the commitment transaction reaches
2090 // ANTI_REORG_DELAY confirmations, will will try to fail the HTLC which was already fulfilled.
2091 let chanmon_cfgs = create_chanmon_cfgs(3);
2092 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2093 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2094 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2096 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2097 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2099 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 2000);
2101 let bs_txn = get_local_commitment_txn!(nodes[2], chan_id_2);
2102 assert_eq!(bs_txn.len(), 1);
2104 nodes[2].node.claim_funds(payment_preimage);
2105 check_added_monitors!(nodes[2], 1);
2106 expect_payment_claimed!(nodes[2], payment_hash, 2000);
2108 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2109 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
2110 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2111 check_added_monitors!(nodes[1], 1);
2112 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2114 mine_transaction(&nodes[1], &bs_txn[0]);
2115 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2116 check_closed_broadcast!(nodes[1], true);
2117 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2118 check_added_monitors!(nodes[1], 1);
2119 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_id_2 }]);
2121 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
2122 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2123 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, true, true);
2124 expect_payment_path_successful!(nodes[0]);
2127 fn do_update_fee_resend_test(deliver_update: bool, parallel_updates: bool) {
2128 // In early versions we did not handle resending of update_fee on reconnect correctly. The
2129 // chanmon_consistency fuzz target, of course, immediately found it, but we test a few cases
2131 let chanmon_cfgs = create_chanmon_cfgs(2);
2132 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2133 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2134 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2136 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2137 send_payment(&nodes[0], &[&nodes[1]], 1000);
2140 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2141 *feerate_lock += 20;
2143 nodes[0].node.timer_tick_occurred();
2144 check_added_monitors!(nodes[0], 1);
2145 let update_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2146 assert!(update_msgs.update_fee.is_some());
2148 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2151 if parallel_updates {
2153 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2154 *feerate_lock += 20;
2156 nodes[0].node.timer_tick_occurred();
2157 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2160 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2161 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2163 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2164 let as_connect_msg = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
2165 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2166 let bs_connect_msg = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
2168 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2169 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
2170 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2172 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2173 let mut as_reconnect_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2174 assert_eq!(as_reconnect_msgs.len(), 2);
2175 if let MessageSendEvent::SendChannelUpdate { .. } = as_reconnect_msgs.pop().unwrap() {} else { panic!(); }
2176 let update_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = as_reconnect_msgs.pop().unwrap()
2177 { updates } else { panic!(); };
2178 assert!(update_msgs.update_fee.is_some());
2179 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2180 if parallel_updates {
2181 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update_msgs.commitment_signed);
2182 check_added_monitors!(nodes[1], 1);
2183 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2184 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2185 check_added_monitors!(nodes[0], 1);
2186 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2188 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2189 check_added_monitors!(nodes[0], 1);
2190 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2192 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_second_update.update_fee.as_ref().unwrap());
2193 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
2194 check_added_monitors!(nodes[1], 1);
2195 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2197 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2198 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2199 check_added_monitors!(nodes[1], 1);
2201 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2202 check_added_monitors!(nodes[0], 1);
2204 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs.commitment_signed);
2205 check_added_monitors!(nodes[0], 1);
2206 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2208 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2209 check_added_monitors!(nodes[1], 1);
2211 commitment_signed_dance!(nodes[1], nodes[0], update_msgs.commitment_signed, false);
2214 send_payment(&nodes[0], &[&nodes[1]], 1000);
2217 fn update_fee_resend_test() {
2218 do_update_fee_resend_test(false, false);
2219 do_update_fee_resend_test(true, false);
2220 do_update_fee_resend_test(false, true);
2221 do_update_fee_resend_test(true, true);
2224 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2225 // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2226 // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2227 // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2228 // which failed in such a case).
2229 let chanmon_cfgs = create_chanmon_cfgs(2);
2230 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2231 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2232 let persister: test_utils::TestPersister;
2233 let new_chain_monitor: test_utils::TestChainMonitor;
2234 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2235 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2237 let chan_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 15_000_000, 7_000_000_000, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2238 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
2239 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2241 // Do a really complicated dance to get an HTLC into the holding cell, with
2242 // MonitorUpdateInProgress set but AwaitingRemoteRevoke unset. When this test was written, any
2243 // attempts to send an HTLC while MonitorUpdateInProgress is set are immediately
2244 // failed-backwards. Thus, the only way to get an AddHTLC into the holding cell is to add it
2245 // while AwaitingRemoteRevoke is set but MonitorUpdateInProgress is unset, and then swap the
2249 // a) routing a payment from node B to node A,
2250 // b) sending a payment from node A to node B without delivering any of the generated messages,
2251 // putting node A in AwaitingRemoteRevoke,
2252 // c) sending a second payment from node A to node B, which is immediately placed in the
2254 // d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2255 // when we try to persist the payment preimage,
2256 // e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2257 // clearing AwaitingRemoteRevoke on node A.
2259 // Note that because, at the end, MonitorUpdateInProgress is still set, the HTLC generated in
2260 // (c) will not be freed from the holding cell.
2261 let (payment_preimage_0, payment_hash_0, _) = route_payment(&nodes[1], &[&nodes[0]], 100_000);
2263 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
2264 check_added_monitors!(nodes[0], 1);
2265 let send = SendEvent::from_node(&nodes[0]);
2266 assert_eq!(send.msgs.len(), 1);
2268 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
2269 check_added_monitors!(nodes[0], 0);
2271 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2272 nodes[0].node.claim_funds(payment_preimage_0);
2273 check_added_monitors!(nodes[0], 1);
2274 expect_payment_claimed!(nodes[0], payment_hash_0, 100_000);
2276 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2277 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2278 check_added_monitors!(nodes[1], 1);
2280 let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2282 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2283 check_added_monitors!(nodes[0], 1);
2286 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2287 // disconnect the peers. Note that the fuzzer originally found this issue because
2288 // deserializing a ChannelManager in this state causes an assertion failure.
2290 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
2291 reload_node!(nodes[0], &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
2293 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2295 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2297 // Now reconnect the two
2298 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2299 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2300 assert_eq!(reestablish_1.len(), 1);
2301 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2302 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2303 assert_eq!(reestablish_2.len(), 1);
2305 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2306 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2307 check_added_monitors!(nodes[1], 0);
2309 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2310 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2312 assert!(resp_0.0.is_none());
2313 assert!(resp_0.1.is_none());
2314 assert!(resp_0.2.is_none());
2315 assert!(resp_1.0.is_none());
2316 assert!(resp_1.1.is_none());
2318 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2320 if let Some(pending_cs) = resp_1.2 {
2321 assert!(pending_cs.update_add_htlcs.is_empty());
2322 assert!(pending_cs.update_fail_htlcs.is_empty());
2323 assert!(pending_cs.update_fulfill_htlcs.is_empty());
2324 assert_eq!(pending_cs.commitment_signed, cs);
2325 } else { panic!(); }
2327 // There should be no monitor updates as we are still pending awaiting a failed one.
2328 check_added_monitors!(nodes[0], 0);
2329 check_added_monitors!(nodes[1], 0);
2332 // If we finish updating the monitor, we should free the holding cell right away (this did
2333 // not occur prior to #756).
2334 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2335 let (funding_txo, mon_id, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2336 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_txo, mon_id);
2338 // New outbound messages should be generated immediately upon a call to
2339 // get_and_clear_pending_msg_events (but not before).
2340 check_added_monitors!(nodes[0], 0);
2341 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2342 check_added_monitors!(nodes[0], 1);
2343 assert_eq!(events.len(), 1);
2345 // Deliver the pending in-flight CS
2346 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2347 check_added_monitors!(nodes[0], 1);
2349 let commitment_msg = match events.pop().unwrap() {
2350 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2351 assert_eq!(node_id, nodes[1].node.get_our_node_id());
2352 assert!(updates.update_fail_htlcs.is_empty());
2353 assert!(updates.update_fail_malformed_htlcs.is_empty());
2354 assert!(updates.update_fee.is_none());
2355 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2356 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2357 expect_payment_sent_without_paths!(nodes[1], payment_preimage_0);
2358 assert_eq!(updates.update_add_htlcs.len(), 1);
2359 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2360 updates.commitment_signed
2362 _ => panic!("Unexpected event type!"),
2365 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2366 check_added_monitors!(nodes[1], 1);
2368 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2369 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2370 expect_pending_htlcs_forwardable!(nodes[1]);
2371 expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2372 check_added_monitors!(nodes[1], 1);
2374 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
2376 let events = nodes[1].node.get_and_clear_pending_events();
2377 assert_eq!(events.len(), 2);
2379 Event::PendingHTLCsForwardable { .. } => { },
2380 _ => panic!("Unexpected event"),
2383 Event::PaymentPathSuccessful { .. } => { },
2384 _ => panic!("Unexpected event"),
2387 nodes[1].node.process_pending_htlc_forwards();
2388 expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2390 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2391 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2394 fn channel_holding_cell_serialize() {
2395 do_channel_holding_cell_serialize(true, true);
2396 do_channel_holding_cell_serialize(true, false);
2397 do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2400 #[derive(PartialEq)]
2401 enum HTLCStatusAtDupClaim {
2406 fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_fails: bool) {
2407 // When receiving an update_fulfill_htlc message, we immediately forward the claim backwards
2408 // along the payment path before waiting for a full commitment_signed dance. This is great, but
2409 // can cause duplicative claims if a node sends an update_fulfill_htlc message, disconnects,
2410 // reconnects, and then has to re-send its update_fulfill_htlc message again.
2411 // In previous code, we didn't handle the double-claim correctly, spuriously closing the
2412 // channel on which the inbound HTLC was received.
2413 let chanmon_cfgs = create_chanmon_cfgs(3);
2414 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2415 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2416 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2418 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2419 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2421 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
2423 let mut as_raa = None;
2424 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2425 // In order to get the HTLC claim into the holding cell at nodes[1], we need nodes[1] to be
2426 // awaiting a remote revoke_and_ack from nodes[0].
2427 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
2428 nodes[0].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret), PaymentId(second_payment_hash.0)).unwrap();
2429 check_added_monitors!(nodes[0], 1);
2431 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
2432 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
2433 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
2434 check_added_monitors!(nodes[1], 1);
2436 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2437 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2438 check_added_monitors!(nodes[0], 1);
2439 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
2440 check_added_monitors!(nodes[0], 1);
2442 as_raa = Some(get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2445 let fulfill_msg = msgs::UpdateFulfillHTLC {
2446 channel_id: chan_id_2,
2451 nodes[2].node.fail_htlc_backwards(&payment_hash);
2452 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash }]);
2453 check_added_monitors!(nodes[2], 1);
2454 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2456 nodes[2].node.claim_funds(payment_preimage);
2457 check_added_monitors!(nodes[2], 1);
2458 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
2460 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2461 assert_eq!(cs_updates.update_fulfill_htlcs.len(), 1);
2462 // Check that the message we're about to deliver matches the one generated:
2463 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
2465 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
2466 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
2467 check_added_monitors!(nodes[1], 1);
2469 let mut bs_updates = None;
2470 if htlc_status != HTLCStatusAtDupClaim::HoldingCell {
2471 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2472 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2473 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2474 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2475 if htlc_status == HTLCStatusAtDupClaim::Cleared {
2476 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2477 expect_payment_path_successful!(nodes[0]);
2480 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2483 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
2484 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2487 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
2488 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 }]);
2490 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2493 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2494 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa.unwrap());
2495 check_added_monitors!(nodes[1], 1);
2496 expect_pending_htlcs_forwardable_ignore!(nodes[1]); // We finally receive the second payment, but don't claim it
2498 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2499 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2500 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2501 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2503 if htlc_status != HTLCStatusAtDupClaim::Cleared {
2504 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2505 expect_payment_path_successful!(nodes[0]);
2510 fn test_reconnect_dup_htlc_claims() {
2511 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, false);
2512 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, false);
2513 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, false);
2514 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, true);
2515 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, true);
2516 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, true);
2520 fn test_temporary_error_during_shutdown() {
2521 // Test that temporary failures when updating the monitor's shutdown script delay cooperative
2523 let mut config = test_default_channel_config();
2524 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2526 let chanmon_cfgs = create_chanmon_cfgs(2);
2527 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2528 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
2529 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2531 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2533 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2534 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2536 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
2537 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()));
2538 check_added_monitors!(nodes[1], 1);
2540 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()));
2541 check_added_monitors!(nodes[0], 1);
2543 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2545 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2546 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2548 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2549 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2550 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()));
2552 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2554 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2555 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2556 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2558 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()));
2559 let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
2560 let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2562 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_a.unwrap());
2563 let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
2564 assert!(none_b.is_none());
2565 let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2567 assert_eq!(txn_a, txn_b);
2568 assert_eq!(txn_a.len(), 1);
2569 check_spends!(txn_a[0], funding_tx);
2570 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
2571 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
2575 fn test_permanent_error_during_sending_shutdown() {
2576 // Test that permanent failures when updating the monitor's shutdown script result in a force
2577 // close when initiating a cooperative close.
2578 let mut config = test_default_channel_config();
2579 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2581 let chanmon_cfgs = create_chanmon_cfgs(2);
2582 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2583 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
2584 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2586 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2587 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2589 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2590 check_closed_broadcast!(nodes[0], true);
2591 check_added_monitors!(nodes[0], 2);
2592 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2596 fn test_permanent_error_during_handling_shutdown() {
2597 // Test that permanent failures when updating the monitor's shutdown script result in a force
2598 // close when handling a cooperative close.
2599 let mut config = test_default_channel_config();
2600 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
2602 let chanmon_cfgs = create_chanmon_cfgs(2);
2603 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2604 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
2605 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2607 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
2608 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
2610 assert!(nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).is_ok());
2611 let shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
2612 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &shutdown);
2613 check_closed_broadcast!(nodes[1], true);
2614 check_added_monitors!(nodes[1], 2);
2615 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2619 fn double_temp_error() {
2620 // Test that it's OK to have multiple `ChainMonitor::update_channel` calls fail in a row.
2621 let chanmon_cfgs = create_chanmon_cfgs(2);
2622 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2623 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2624 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2626 let (_, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2628 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2629 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2631 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2632 // `claim_funds` results in a ChannelMonitorUpdate.
2633 nodes[1].node.claim_funds(payment_preimage_1);
2634 check_added_monitors!(nodes[1], 1);
2635 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
2636 let (funding_tx, latest_update_1, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2638 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2639 // Previously, this would've panicked due to a double-call to `Channel::monitor_update_failed`,
2640 // which had some asserts that prevented it from being called twice.
2641 nodes[1].node.claim_funds(payment_preimage_2);
2642 check_added_monitors!(nodes[1], 1);
2643 expect_payment_claimed!(nodes[1], payment_hash_2, 1_000_000);
2644 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
2646 let (_, latest_update_2, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2647 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_1);
2648 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2649 check_added_monitors!(nodes[1], 0);
2650 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_2);
2652 // Complete the first HTLC.
2653 let events = nodes[1].node.get_and_clear_pending_msg_events();
2654 assert_eq!(events.len(), 1);
2655 let (update_fulfill_1, commitment_signed_b1, node_id) = {
2657 &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 } } => {
2658 assert!(update_add_htlcs.is_empty());
2659 assert_eq!(update_fulfill_htlcs.len(), 1);
2660 assert!(update_fail_htlcs.is_empty());
2661 assert!(update_fail_malformed_htlcs.is_empty());
2662 assert!(update_fee.is_none());
2663 (update_fulfill_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2665 _ => panic!("Unexpected event"),
2668 assert_eq!(node_id, nodes[0].node.get_our_node_id());
2669 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_1);
2670 check_added_monitors!(nodes[0], 0);
2671 expect_payment_sent_without_paths!(nodes[0], payment_preimage_1);
2672 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_b1);
2673 check_added_monitors!(nodes[0], 1);
2674 nodes[0].node.process_pending_htlc_forwards();
2675 let (raa_a1, commitment_signed_a1) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2676 check_added_monitors!(nodes[1], 0);
2677 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2678 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_a1);
2679 check_added_monitors!(nodes[1], 1);
2680 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed_a1);
2681 check_added_monitors!(nodes[1], 1);
2683 // Complete the second HTLC.
2684 let ((update_fulfill_2, commitment_signed_b2), raa_b2) = {
2685 let events = nodes[1].node.get_and_clear_pending_msg_events();
2686 assert_eq!(events.len(), 2);
2688 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2689 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2690 assert!(updates.update_add_htlcs.is_empty());
2691 assert!(updates.update_fail_htlcs.is_empty());
2692 assert!(updates.update_fail_malformed_htlcs.is_empty());
2693 assert!(updates.update_fee.is_none());
2694 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2695 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2697 _ => panic!("Unexpected event"),
2700 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2701 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2704 _ => panic!("Unexpected event"),
2707 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_b2);
2708 check_added_monitors!(nodes[0], 1);
2709 expect_payment_path_successful!(nodes[0]);
2711 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_2);
2712 check_added_monitors!(nodes[0], 0);
2713 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2714 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed_b2, false);
2715 expect_payment_sent!(nodes[0], payment_preimage_2);
2718 fn do_test_outbound_reload_without_init_mon(use_0conf: bool) {
2719 // Test that if the monitor update generated in funding_signed is stored async and we restart
2720 // with the latest ChannelManager but the ChannelMonitor persistence never completed we happily
2721 // drop the channel and move on.
2722 let chanmon_cfgs = create_chanmon_cfgs(2);
2723 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2725 let persister: test_utils::TestPersister;
2726 let new_chain_monitor: test_utils::TestChainMonitor;
2727 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2729 let mut chan_config = test_default_channel_config();
2730 chan_config.manually_accept_inbound_channels = true;
2731 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2733 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2734 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2736 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2737 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()));
2739 let events = nodes[1].node.get_and_clear_pending_events();
2740 assert_eq!(events.len(), 1);
2742 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2744 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2746 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2749 _ => panic!("Unexpected event"),
2752 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()));
2754 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2756 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2757 check_added_monitors!(nodes[0], 0);
2759 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2760 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2761 check_added_monitors!(nodes[1], 1);
2763 let bs_signed_locked = nodes[1].node.get_and_clear_pending_msg_events();
2764 assert_eq!(bs_signed_locked.len(), if use_0conf { 2 } else { 1 });
2765 match &bs_signed_locked[0] {
2766 MessageSendEvent::SendFundingSigned { msg, .. } => {
2767 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2769 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &msg);
2770 check_added_monitors!(nodes[0], 1);
2772 _ => panic!("Unexpected event"),
2775 match &bs_signed_locked[1] {
2776 MessageSendEvent::SendChannelReady { msg, .. } => {
2777 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &msg);
2779 _ => panic!("Unexpected event"),
2783 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
2784 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2785 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2787 // nodes[0] is now waiting on the first ChannelMonitor persistence to complete in order to
2788 // broadcast the funding transaction. If nodes[0] restarts at this point with the
2789 // ChannelMonitor lost, we should simply discard the channel.
2791 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2792 // not, so we have to clear them here.
2793 nodes[0].chain_source.watched_txn.lock().unwrap().clear();
2794 nodes[0].chain_source.watched_outputs.lock().unwrap().clear();
2796 reload_node!(nodes[0], &nodes[0].node.encode(), &[], persister, new_chain_monitor, nodes_0_deserialized);
2797 check_closed_event!(nodes[0], 1, ClosureReason::DisconnectedPeer);
2798 assert!(nodes[0].node.list_channels().is_empty());
2802 fn test_outbound_reload_without_init_mon() {
2803 do_test_outbound_reload_without_init_mon(true);
2804 do_test_outbound_reload_without_init_mon(false);
2807 fn do_test_inbound_reload_without_init_mon(use_0conf: bool, lock_commitment: bool) {
2808 // Test that if the monitor update generated by funding_transaction_generated is stored async
2809 // and we restart with the latest ChannelManager but the ChannelMonitor persistence never
2810 // completed we happily drop the channel and move on.
2811 let chanmon_cfgs = create_chanmon_cfgs(2);
2812 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2814 let persister: test_utils::TestPersister;
2815 let new_chain_monitor: test_utils::TestChainMonitor;
2816 let nodes_1_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2818 let mut chan_config = test_default_channel_config();
2819 chan_config.manually_accept_inbound_channels = true;
2820 chan_config.channel_handshake_limits.trust_own_funding_0conf = true;
2822 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(chan_config), Some(chan_config)]);
2823 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2825 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
2826 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()));
2828 let events = nodes[1].node.get_and_clear_pending_events();
2829 assert_eq!(events.len(), 1);
2831 Event::OpenChannelRequest { temporary_channel_id, .. } => {
2833 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2835 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
2838 _ => panic!("Unexpected event"),
2841 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()));
2843 let (temporary_channel_id, funding_tx, ..) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 43);
2845 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
2846 check_added_monitors!(nodes[0], 0);
2848 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
2849 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
2850 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
2851 check_added_monitors!(nodes[1], 1);
2853 // nodes[1] happily sends its funding_signed even though its awaiting the persistence of the
2854 // initial ChannelMonitor, but it will decline to send its channel_ready even if the funding
2855 // transaction is confirmed.
2856 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
2858 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
2859 check_added_monitors!(nodes[0], 1);
2861 let as_funding_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2862 if lock_commitment {
2863 confirm_transaction(&nodes[0], &as_funding_tx[0]);
2864 confirm_transaction(&nodes[1], &as_funding_tx[0]);
2866 if use_0conf || lock_commitment {
2867 let as_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
2868 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_ready);
2870 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2872 // nodes[1] is now waiting on the first ChannelMonitor persistence to complete in order to
2873 // move the channel to ready (or is waiting on the funding transaction to confirm). If nodes[1]
2874 // restarts at this point with the ChannelMonitor lost, we should simply discard the channel.
2876 // The test framework checks that watched_txn/outputs match the monitor set, which they will
2877 // not, so we have to clear them here.
2878 nodes[1].chain_source.watched_txn.lock().unwrap().clear();
2879 nodes[1].chain_source.watched_outputs.lock().unwrap().clear();
2881 reload_node!(nodes[1], &nodes[1].node.encode(), &[], persister, new_chain_monitor, nodes_1_deserialized);
2883 check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
2884 assert!(nodes[1].node.list_channels().is_empty());
2888 fn test_inbound_reload_without_init_mon() {
2889 do_test_inbound_reload_without_init_mon(true, true);
2890 do_test_inbound_reload_without_init_mon(true, false);
2891 do_test_inbound_reload_without_init_mon(false, true);
2892 do_test_inbound_reload_without_init_mon(false, false);