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 ChannelMonitorUpdateErr returns from
12 //! There are a bunch of these as their handling is relatively error-prone so they are split out
13 //! here. See also the chanmon_fail_consistency fuzz test.
15 use bitcoin::blockdata::block::{Block, BlockHeader};
16 use bitcoin::blockdata::constants::genesis_block;
17 use bitcoin::hash_types::BlockHash;
18 use bitcoin::network::constants::Network;
19 use chain::channelmonitor::ChannelMonitor;
20 use chain::transaction::OutPoint;
21 use chain::{ChannelMonitorUpdateErr, Listen, Watch};
22 use ln::{PaymentPreimage, PaymentHash};
23 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
24 use ln::features::InitFeatures;
26 use ln::msgs::{ChannelMessageHandler, ErrorAction, RoutingMessageHandler};
27 use util::config::UserConfig;
28 use util::enforcing_trait_impls::EnforcingSigner;
29 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason};
30 use util::errors::APIError;
31 use util::ser::{ReadableArgs, Writeable};
32 use util::test_utils::TestBroadcaster;
34 use bitcoin::hashes::sha256::Hash as Sha256;
35 use bitcoin::hashes::Hash;
37 use ln::functional_test_utils::*;
43 use sync::{Arc, Mutex};
46 fn test_simple_monitor_permanent_update_fail() {
47 // Test that we handle a simple permanent monitor update failure
48 let chanmon_cfgs = create_chanmon_cfgs(2);
49 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
50 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
51 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
52 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
54 let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
55 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::PermanentFailure));
56 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable {..}, {});
57 check_added_monitors!(nodes[0], 2);
59 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
60 assert_eq!(events_1.len(), 2);
62 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
63 _ => panic!("Unexpected event"),
66 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
67 _ => panic!("Unexpected event"),
70 // TODO: Once we hit the chain with the failure transaction we should check that we get a
71 // PaymentPathFailed event
73 assert_eq!(nodes[0].node.list_channels().len(), 0);
74 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
78 fn test_monitor_and_persister_update_fail() {
79 // Test that if both updating the `ChannelMonitor` and persisting the updated
80 // `ChannelMonitor` fail, then the failure from updating the `ChannelMonitor`
81 // one that gets returned.
82 let chanmon_cfgs = create_chanmon_cfgs(2);
83 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
84 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
85 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
87 // Create some initial channel
88 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
89 let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
91 // Rebalance the network to generate htlc in the two directions
92 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
94 // Route an HTLC from node 0 to node 1 (but don't settle)
95 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
97 // Make a copy of the ChainMonitor so we can capture the error it returns on a
98 // bogus update. Note that if instead we updated the nodes[0]'s ChainMonitor
99 // directly, the node would fail to be `Drop`'d at the end because its
100 // ChannelManager and ChainMonitor would be out of sync.
101 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
102 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
103 let persister = test_utils::TestPersister::new();
104 let tx_broadcaster = TestBroadcaster {
105 txn_broadcasted: Mutex::new(Vec::new()),
106 // Because we will connect a block at height 200 below, we need the TestBroadcaster to know
107 // that we are at height 200 so that it doesn't think we're violating the time lock
108 // requirements of transactions broadcasted at that point.
109 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 200); 200])),
112 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
113 let mut w = test_utils::TestVecWriter(Vec::new());
114 monitor.write(&mut w).unwrap();
115 let new_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
116 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
117 assert!(new_monitor == *monitor);
118 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
119 assert!(chain_mon.watch_channel(outpoint, new_monitor).is_ok());
122 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
123 chain_mon.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
125 // Set the persister's return value to be a TemporaryFailure.
126 persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
128 // Try to update ChannelMonitor
129 assert!(nodes[1].node.claim_funds(preimage));
130 check_added_monitors!(nodes[1], 1);
131 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
132 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
133 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
134 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2) {
135 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
136 // Check that even though the persister is returning a TemporaryFailure,
137 // because the update is bogus, ultimately the error that's returned
138 // should be a PermanentFailure.
139 if let Err(ChannelMonitorUpdateErr::PermanentFailure) = chain_mon.chain_monitor.update_channel(outpoint, update.clone()) {} else { panic!("Expected monitor error to be permanent"); }
140 logger.assert_log_regex("lightning::chain::chainmonitor".to_string(), regex::Regex::new("Failed to persist ChannelMonitor update for channel [0-9a-f]*: TemporaryFailure").unwrap(), 1);
141 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
142 } else { assert!(false); }
143 } else { assert!(false); };
145 check_added_monitors!(nodes[0], 1);
146 let events = nodes[0].node.get_and_clear_pending_events();
147 assert_eq!(events.len(), 1);
150 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
151 // Test that we can recover from a simple temporary monitor update failure optionally with
152 // a disconnect in between
153 let chanmon_cfgs = create_chanmon_cfgs(2);
154 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
155 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
156 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
157 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
159 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
161 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
164 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), false, APIError::MonitorUpdateFailed, {});
165 check_added_monitors!(nodes[0], 1);
168 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
169 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
170 assert_eq!(nodes[0].node.list_channels().len(), 1);
173 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
174 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
175 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
178 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
179 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
180 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
181 check_added_monitors!(nodes[0], 0);
183 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
184 assert_eq!(events_2.len(), 1);
185 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
186 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
187 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
188 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
190 expect_pending_htlcs_forwardable!(nodes[1]);
192 let events_3 = nodes[1].node.get_and_clear_pending_events();
193 assert_eq!(events_3.len(), 1);
195 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
196 assert_eq!(payment_hash_1, *payment_hash);
197 assert_eq!(amt, 1000000);
199 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
200 assert!(payment_preimage.is_none());
201 assert_eq!(payment_secret_1, *payment_secret);
203 _ => panic!("expected PaymentPurpose::InvoicePayment")
206 _ => panic!("Unexpected event"),
209 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
211 // Now set it to failed again...
212 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
214 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
215 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)), false, APIError::MonitorUpdateFailed, {});
216 check_added_monitors!(nodes[0], 1);
219 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
220 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
221 assert_eq!(nodes[0].node.list_channels().len(), 1);
224 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
225 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
226 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
229 // ...and make sure we can force-close a frozen channel
230 nodes[0].node.force_close_channel(&channel_id).unwrap();
231 check_added_monitors!(nodes[0], 1);
232 check_closed_broadcast!(nodes[0], true);
234 // TODO: Once we hit the chain with the failure transaction we should check that we get a
235 // PaymentPathFailed event
237 assert_eq!(nodes[0].node.list_channels().len(), 0);
238 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
242 fn test_simple_monitor_temporary_update_fail() {
243 do_test_simple_monitor_temporary_update_fail(false);
244 do_test_simple_monitor_temporary_update_fail(true);
247 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
248 let disconnect_flags = 8 | 16;
250 // Test that we can recover from a temporary monitor update failure with some in-flight
251 // HTLCs going on at the same time potentially with some disconnection thrown in.
252 // * First we route a payment, then get a temporary monitor update failure when trying to
253 // route a second payment. We then claim the first payment.
254 // * If disconnect_count is set, we will disconnect at this point (which is likely as
255 // TemporaryFailure likely indicates net disconnect which resulted in failing to update
256 // the ChannelMonitor on a watchtower).
257 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
258 // immediately, otherwise we wait disconnect and deliver them via the reconnect
259 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
260 // disconnect_count & !disconnect_flags is 0).
261 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
262 // through message sending, potentially disconnect/reconnecting multiple times based on
263 // disconnect_count, to get the update_fulfill_htlc through.
264 // * We then walk through more message exchanges to get the original update_add_htlc
265 // through, swapping message ordering based on disconnect_count & 8 and optionally
266 // disconnect/reconnecting based on disconnect_count.
267 let chanmon_cfgs = create_chanmon_cfgs(2);
268 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
269 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
270 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
271 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
273 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
275 // Now try to send a second payment which will fail to send
276 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
278 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
279 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)), false, APIError::MonitorUpdateFailed, {});
280 check_added_monitors!(nodes[0], 1);
283 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
284 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
285 assert_eq!(nodes[0].node.list_channels().len(), 1);
287 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
288 // but nodes[0] won't respond since it is frozen.
289 assert!(nodes[1].node.claim_funds(payment_preimage_1));
290 check_added_monitors!(nodes[1], 1);
291 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
292 assert_eq!(events_2.len(), 1);
293 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
294 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 } } => {
295 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
296 assert!(update_add_htlcs.is_empty());
297 assert_eq!(update_fulfill_htlcs.len(), 1);
298 assert!(update_fail_htlcs.is_empty());
299 assert!(update_fail_malformed_htlcs.is_empty());
300 assert!(update_fee.is_none());
302 if (disconnect_count & 16) == 0 {
303 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
304 let events_3 = nodes[0].node.get_and_clear_pending_events();
305 assert_eq!(events_3.len(), 1);
307 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
308 assert_eq!(*payment_preimage, payment_preimage_1);
309 assert_eq!(*payment_hash, payment_hash_1);
311 _ => panic!("Unexpected event"),
314 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
315 check_added_monitors!(nodes[0], 1);
316 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
317 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
320 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
322 _ => panic!("Unexpected event"),
325 if disconnect_count & !disconnect_flags > 0 {
326 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
327 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
330 // Now fix monitor updating...
331 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
332 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
333 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
334 check_added_monitors!(nodes[0], 0);
336 macro_rules! disconnect_reconnect_peers { () => { {
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);
340 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
341 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
342 assert_eq!(reestablish_1.len(), 1);
343 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
344 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
345 assert_eq!(reestablish_2.len(), 1);
347 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
348 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
349 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
350 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
352 assert!(as_resp.0.is_none());
353 assert!(bs_resp.0.is_none());
355 (reestablish_1, reestablish_2, as_resp, bs_resp)
358 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
359 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
360 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
362 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
363 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
364 assert_eq!(reestablish_1.len(), 1);
365 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
366 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
367 assert_eq!(reestablish_2.len(), 1);
369 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
370 check_added_monitors!(nodes[0], 0);
371 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
372 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
373 check_added_monitors!(nodes[1], 0);
374 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
376 assert!(as_resp.0.is_none());
377 assert!(bs_resp.0.is_none());
379 assert!(bs_resp.1.is_none());
380 if (disconnect_count & 16) == 0 {
381 assert!(bs_resp.2.is_none());
383 assert!(as_resp.1.is_some());
384 assert!(as_resp.2.is_some());
385 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
387 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
388 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
389 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
390 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
391 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
392 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
394 assert!(as_resp.1.is_none());
396 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
397 let events_3 = nodes[0].node.get_and_clear_pending_events();
398 assert_eq!(events_3.len(), 1);
400 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
401 assert_eq!(*payment_preimage, payment_preimage_1);
402 assert_eq!(*payment_hash, payment_hash_1);
404 _ => panic!("Unexpected event"),
407 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
408 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
409 // No commitment_signed so get_event_msg's assert(len == 1) passes
410 check_added_monitors!(nodes[0], 1);
412 as_resp.1 = Some(as_resp_raa);
416 if disconnect_count & !disconnect_flags > 1 {
417 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
419 if (disconnect_count & 16) == 0 {
420 assert!(reestablish_1 == second_reestablish_1);
421 assert!(reestablish_2 == second_reestablish_2);
423 assert!(as_resp == second_as_resp);
424 assert!(bs_resp == second_bs_resp);
427 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
429 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
430 assert_eq!(events_4.len(), 2);
431 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
432 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
433 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
436 _ => panic!("Unexpected event"),
440 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
442 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
443 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
444 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
445 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
446 check_added_monitors!(nodes[1], 1);
448 if disconnect_count & !disconnect_flags > 2 {
449 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
451 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
452 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
454 assert!(as_resp.2.is_none());
455 assert!(bs_resp.2.is_none());
458 let as_commitment_update;
459 let bs_second_commitment_update;
461 macro_rules! handle_bs_raa { () => {
462 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
463 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
464 assert!(as_commitment_update.update_add_htlcs.is_empty());
465 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
466 assert!(as_commitment_update.update_fail_htlcs.is_empty());
467 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
468 assert!(as_commitment_update.update_fee.is_none());
469 check_added_monitors!(nodes[0], 1);
472 macro_rules! handle_initial_raa { () => {
473 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
474 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
475 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
476 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
477 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
478 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
479 assert!(bs_second_commitment_update.update_fee.is_none());
480 check_added_monitors!(nodes[1], 1);
483 if (disconnect_count & 8) == 0 {
486 if disconnect_count & !disconnect_flags > 3 {
487 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
489 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
490 assert!(bs_resp.1.is_none());
492 assert!(as_resp.2.unwrap() == as_commitment_update);
493 assert!(bs_resp.2.is_none());
495 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
498 handle_initial_raa!();
500 if disconnect_count & !disconnect_flags > 4 {
501 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
503 assert!(as_resp.1.is_none());
504 assert!(bs_resp.1.is_none());
506 assert!(as_resp.2.unwrap() == as_commitment_update);
507 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
510 handle_initial_raa!();
512 if disconnect_count & !disconnect_flags > 3 {
513 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
515 assert!(as_resp.1.is_none());
516 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
518 assert!(as_resp.2.is_none());
519 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
521 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
526 if disconnect_count & !disconnect_flags > 4 {
527 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
529 assert!(as_resp.1.is_none());
530 assert!(bs_resp.1.is_none());
532 assert!(as_resp.2.unwrap() == as_commitment_update);
533 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
537 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
538 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
539 // No commitment_signed so get_event_msg's assert(len == 1) passes
540 check_added_monitors!(nodes[0], 1);
542 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
543 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
544 // No commitment_signed so get_event_msg's assert(len == 1) passes
545 check_added_monitors!(nodes[1], 1);
547 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
548 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
549 check_added_monitors!(nodes[1], 1);
551 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
552 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
553 check_added_monitors!(nodes[0], 1);
554 expect_payment_path_successful!(nodes[0]);
556 expect_pending_htlcs_forwardable!(nodes[1]);
558 let events_5 = nodes[1].node.get_and_clear_pending_events();
559 assert_eq!(events_5.len(), 1);
561 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
562 assert_eq!(payment_hash_2, *payment_hash);
563 assert_eq!(amt, 1000000);
565 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
566 assert!(payment_preimage.is_none());
567 assert_eq!(payment_secret_2, *payment_secret);
569 _ => panic!("expected PaymentPurpose::InvoicePayment")
572 _ => panic!("Unexpected event"),
575 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
579 fn test_monitor_temporary_update_fail_a() {
580 do_test_monitor_temporary_update_fail(0);
581 do_test_monitor_temporary_update_fail(1);
582 do_test_monitor_temporary_update_fail(2);
583 do_test_monitor_temporary_update_fail(3);
584 do_test_monitor_temporary_update_fail(4);
585 do_test_monitor_temporary_update_fail(5);
589 fn test_monitor_temporary_update_fail_b() {
590 do_test_monitor_temporary_update_fail(2 | 8);
591 do_test_monitor_temporary_update_fail(3 | 8);
592 do_test_monitor_temporary_update_fail(4 | 8);
593 do_test_monitor_temporary_update_fail(5 | 8);
597 fn test_monitor_temporary_update_fail_c() {
598 do_test_monitor_temporary_update_fail(1 | 16);
599 do_test_monitor_temporary_update_fail(2 | 16);
600 do_test_monitor_temporary_update_fail(3 | 16);
601 do_test_monitor_temporary_update_fail(2 | 8 | 16);
602 do_test_monitor_temporary_update_fail(3 | 8 | 16);
606 fn test_monitor_update_fail_cs() {
607 // Tests handling of a monitor update failure when processing an incoming commitment_signed
608 let chanmon_cfgs = create_chanmon_cfgs(2);
609 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
610 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
611 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
612 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
614 let (route, our_payment_hash, payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
616 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
617 check_added_monitors!(nodes[0], 1);
620 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
621 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
623 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
624 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
625 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
626 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
627 check_added_monitors!(nodes[1], 1);
628 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
630 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
631 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
632 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
633 check_added_monitors!(nodes[1], 0);
634 let responses = nodes[1].node.get_and_clear_pending_msg_events();
635 assert_eq!(responses.len(), 2);
638 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
639 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
640 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
641 check_added_monitors!(nodes[0], 1);
643 _ => panic!("Unexpected event"),
646 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
647 assert!(updates.update_add_htlcs.is_empty());
648 assert!(updates.update_fulfill_htlcs.is_empty());
649 assert!(updates.update_fail_htlcs.is_empty());
650 assert!(updates.update_fail_malformed_htlcs.is_empty());
651 assert!(updates.update_fee.is_none());
652 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
654 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
655 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
656 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
657 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
658 check_added_monitors!(nodes[0], 1);
659 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
661 _ => panic!("Unexpected event"),
664 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
665 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
666 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
667 check_added_monitors!(nodes[0], 0);
669 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
670 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
671 check_added_monitors!(nodes[1], 1);
673 expect_pending_htlcs_forwardable!(nodes[1]);
675 let events = nodes[1].node.get_and_clear_pending_events();
676 assert_eq!(events.len(), 1);
678 Event::PaymentReceived { payment_hash, ref purpose, amt } => {
679 assert_eq!(payment_hash, our_payment_hash);
680 assert_eq!(amt, 1000000);
682 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
683 assert!(payment_preimage.is_none());
684 assert_eq!(our_payment_secret, *payment_secret);
686 _ => panic!("expected PaymentPurpose::InvoicePayment")
689 _ => panic!("Unexpected event"),
692 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
696 fn test_monitor_update_fail_no_rebroadcast() {
697 // Tests handling of a monitor update failure when no message rebroadcasting on
698 // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
700 let chanmon_cfgs = create_chanmon_cfgs(2);
701 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
702 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
703 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
704 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
706 let (route, our_payment_hash, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
708 nodes[0].node.send_payment(&route, our_payment_hash, &Some(payment_secret_1)).unwrap();
709 check_added_monitors!(nodes[0], 1);
712 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
713 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
714 let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
716 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
717 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
718 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
719 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
720 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
721 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
722 check_added_monitors!(nodes[1], 1);
724 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
725 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
726 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
727 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
728 check_added_monitors!(nodes[1], 0);
729 expect_pending_htlcs_forwardable!(nodes[1]);
731 let events = nodes[1].node.get_and_clear_pending_events();
732 assert_eq!(events.len(), 1);
734 Event::PaymentReceived { payment_hash, .. } => {
735 assert_eq!(payment_hash, our_payment_hash);
737 _ => panic!("Unexpected event"),
740 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
744 fn test_monitor_update_raa_while_paused() {
745 // Tests handling of an RAA while monitor updating has already been marked failed.
746 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
747 let chanmon_cfgs = create_chanmon_cfgs(2);
748 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
749 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
750 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
751 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
753 send_payment(&nodes[0], &[&nodes[1]], 5000000);
754 let (route, our_payment_hash_1, payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
756 nodes[0].node.send_payment(&route, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
757 check_added_monitors!(nodes[0], 1);
759 let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
761 let (route, our_payment_hash_2, payment_preimage_2, our_payment_secret_2) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000000);
763 nodes[1].node.send_payment(&route, our_payment_hash_2, &Some(our_payment_secret_2)).unwrap();
764 check_added_monitors!(nodes[1], 1);
766 let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
768 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
769 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
770 check_added_monitors!(nodes[1], 1);
771 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
773 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
774 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
775 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
776 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
777 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
778 check_added_monitors!(nodes[0], 1);
780 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
781 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
782 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented responses to RAA".to_string(), 1);
783 check_added_monitors!(nodes[0], 1);
785 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
786 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
787 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
788 check_added_monitors!(nodes[0], 0);
790 let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
791 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
792 check_added_monitors!(nodes[1], 1);
793 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
795 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
796 check_added_monitors!(nodes[1], 1);
797 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
799 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
800 check_added_monitors!(nodes[0], 1);
801 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
803 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
804 check_added_monitors!(nodes[0], 1);
805 expect_pending_htlcs_forwardable!(nodes[0]);
806 expect_payment_received!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
808 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
809 check_added_monitors!(nodes[1], 1);
810 expect_pending_htlcs_forwardable!(nodes[1]);
811 expect_payment_received!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
813 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
814 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
817 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
818 // Tests handling of a monitor update failure when processing an incoming RAA
819 let chanmon_cfgs = create_chanmon_cfgs(3);
820 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
821 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
822 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
823 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
824 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
826 // Rebalance a bit so that we can send backwards from 2 to 1.
827 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
829 // Route a first payment that we'll fail backwards
830 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
832 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
833 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1));
834 expect_pending_htlcs_forwardable!(nodes[2]);
835 check_added_monitors!(nodes[2], 1);
837 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
838 assert!(updates.update_add_htlcs.is_empty());
839 assert!(updates.update_fulfill_htlcs.is_empty());
840 assert_eq!(updates.update_fail_htlcs.len(), 1);
841 assert!(updates.update_fail_malformed_htlcs.is_empty());
842 assert!(updates.update_fee.is_none());
843 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
845 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
846 check_added_monitors!(nodes[0], 0);
848 // While the second channel is AwaitingRAA, forward a second payment to get it into the
850 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
852 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
853 check_added_monitors!(nodes[0], 1);
856 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
857 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
858 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
860 expect_pending_htlcs_forwardable!(nodes[1]);
861 check_added_monitors!(nodes[1], 0);
862 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
864 // Now fail monitor updating.
865 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
866 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
867 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
868 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
869 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
870 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
871 check_added_monitors!(nodes[1], 1);
873 // Forward a third payment which will also be added to the holding cell, despite the channel
874 // being paused waiting a monitor update.
875 let (route, payment_hash_3, _, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
877 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
878 check_added_monitors!(nodes[0], 1);
881 chanmon_cfgs[1].persister.set_update_ret(Ok(())); // We succeed in updating the monitor for the first channel
882 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
883 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
884 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
885 check_added_monitors!(nodes[1], 0);
887 // Call forward_pending_htlcs and check that the new HTLC was simply added to the holding cell
888 // and not forwarded.
889 expect_pending_htlcs_forwardable!(nodes[1]);
890 check_added_monitors!(nodes[1], 0);
891 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
893 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
894 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
895 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
896 nodes[2].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
897 check_added_monitors!(nodes[2], 1);
899 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
900 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
901 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
902 check_added_monitors!(nodes[1], 1);
903 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
904 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
905 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
906 (Some(payment_preimage_4), Some(payment_hash_4))
907 } else { (None, None) };
909 // Restore monitor updating, ensuring we immediately get a fail-back update and a
910 // update_add update.
911 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
912 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
913 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
914 check_added_monitors!(nodes[1], 0);
915 expect_pending_htlcs_forwardable!(nodes[1]);
916 check_added_monitors!(nodes[1], 1);
918 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
919 if test_ignore_second_cs {
920 assert_eq!(events_3.len(), 3);
922 assert_eq!(events_3.len(), 2);
925 // Note that the ordering of the events for different nodes is non-prescriptive, though the
926 // ordering of the two events that both go to nodes[2] have to stay in the same order.
927 let messages_a = match events_3.pop().unwrap() {
928 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
929 assert_eq!(node_id, nodes[0].node.get_our_node_id());
930 assert!(updates.update_fulfill_htlcs.is_empty());
931 assert_eq!(updates.update_fail_htlcs.len(), 1);
932 assert!(updates.update_fail_malformed_htlcs.is_empty());
933 assert!(updates.update_add_htlcs.is_empty());
934 assert!(updates.update_fee.is_none());
935 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
937 _ => panic!("Unexpected event type!"),
939 let raa = if test_ignore_second_cs {
940 match events_3.remove(1) {
941 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
942 assert_eq!(node_id, nodes[2].node.get_our_node_id());
945 _ => panic!("Unexpected event"),
948 let send_event_b = SendEvent::from_event(events_3.remove(0));
949 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
951 // Now deliver the new messages...
953 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
954 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
955 expect_payment_failed!(nodes[0], payment_hash_1, true);
957 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
959 if test_ignore_second_cs {
960 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
961 check_added_monitors!(nodes[2], 1);
962 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
963 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
964 check_added_monitors!(nodes[2], 1);
965 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
966 assert!(bs_cs.update_add_htlcs.is_empty());
967 assert!(bs_cs.update_fail_htlcs.is_empty());
968 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
969 assert!(bs_cs.update_fulfill_htlcs.is_empty());
970 assert!(bs_cs.update_fee.is_none());
972 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
973 check_added_monitors!(nodes[1], 1);
974 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
976 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
977 check_added_monitors!(nodes[1], 1);
979 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
980 check_added_monitors!(nodes[2], 1);
982 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
983 assert_eq!(bs_revoke_and_commit.len(), 2);
984 match bs_revoke_and_commit[0] {
985 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
986 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
987 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
988 check_added_monitors!(nodes[1], 1);
990 _ => panic!("Unexpected event"),
993 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
995 match bs_revoke_and_commit[1] {
996 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
997 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
998 assert!(updates.update_add_htlcs.is_empty());
999 assert!(updates.update_fail_htlcs.is_empty());
1000 assert!(updates.update_fail_malformed_htlcs.is_empty());
1001 assert!(updates.update_fulfill_htlcs.is_empty());
1002 assert!(updates.update_fee.is_none());
1003 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1004 check_added_monitors!(nodes[1], 1);
1006 _ => panic!("Unexpected event"),
1010 assert_eq!(as_cs.update_add_htlcs.len(), 1);
1011 assert!(as_cs.update_fail_htlcs.is_empty());
1012 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1013 assert!(as_cs.update_fulfill_htlcs.is_empty());
1014 assert!(as_cs.update_fee.is_none());
1015 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1018 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1019 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1020 check_added_monitors!(nodes[2], 1);
1021 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1023 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1024 check_added_monitors!(nodes[2], 1);
1025 let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1027 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1028 check_added_monitors!(nodes[1], 1);
1029 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1031 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1032 check_added_monitors!(nodes[1], 1);
1033 let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1035 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1036 check_added_monitors!(nodes[2], 1);
1037 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1039 expect_pending_htlcs_forwardable!(nodes[2]);
1041 let events_6 = nodes[2].node.get_and_clear_pending_events();
1042 assert_eq!(events_6.len(), 2);
1044 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1045 _ => panic!("Unexpected event"),
1048 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1049 _ => panic!("Unexpected event"),
1052 if test_ignore_second_cs {
1053 expect_pending_htlcs_forwardable!(nodes[1]);
1054 check_added_monitors!(nodes[1], 1);
1056 send_event = SendEvent::from_node(&nodes[1]);
1057 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1058 assert_eq!(send_event.msgs.len(), 1);
1059 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1060 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1062 expect_pending_htlcs_forwardable!(nodes[0]);
1064 let events_9 = nodes[0].node.get_and_clear_pending_events();
1065 assert_eq!(events_9.len(), 1);
1067 Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1068 _ => panic!("Unexpected event"),
1070 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1073 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1077 fn test_monitor_update_fail_raa() {
1078 do_test_monitor_update_fail_raa(false);
1079 do_test_monitor_update_fail_raa(true);
1083 fn test_monitor_update_fail_reestablish() {
1084 // Simple test for message retransmission after monitor update failure on
1085 // channel_reestablish generating a monitor update (which comes from freeing holding cell
1087 let chanmon_cfgs = create_chanmon_cfgs(3);
1088 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1089 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1090 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1091 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1092 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1094 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1096 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1097 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1099 assert!(nodes[2].node.claim_funds(payment_preimage));
1100 check_added_monitors!(nodes[2], 1);
1101 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1102 assert!(updates.update_add_htlcs.is_empty());
1103 assert!(updates.update_fail_htlcs.is_empty());
1104 assert!(updates.update_fail_malformed_htlcs.is_empty());
1105 assert!(updates.update_fee.is_none());
1106 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1107 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1108 expect_payment_forwarded!(nodes[1], Some(1000), false);
1109 check_added_monitors!(nodes[1], 1);
1110 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1111 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1113 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1114 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1115 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1117 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1118 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1120 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1122 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1124 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1125 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1127 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1128 check_added_monitors!(nodes[1], 1);
1130 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1131 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1133 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1134 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1136 assert!(as_reestablish == get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id()));
1137 assert!(bs_reestablish == get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()));
1139 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1141 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1142 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1144 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1145 check_added_monitors!(nodes[1], 0);
1147 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1148 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1150 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1151 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1152 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1153 check_added_monitors!(nodes[1], 0);
1155 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1156 assert!(updates.update_add_htlcs.is_empty());
1157 assert!(updates.update_fail_htlcs.is_empty());
1158 assert!(updates.update_fail_malformed_htlcs.is_empty());
1159 assert!(updates.update_fee.is_none());
1160 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1161 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1162 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1163 expect_payment_sent!(nodes[0], payment_preimage);
1167 fn raa_no_response_awaiting_raa_state() {
1168 // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1169 // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1170 // in question (assuming it intends to respond with a CS after monitor updating is restored).
1171 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1172 let chanmon_cfgs = create_chanmon_cfgs(2);
1173 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1174 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1175 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1176 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1178 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1179 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1180 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1182 // Queue up two payments - one will be delivered right away, one immediately goes into the
1183 // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1184 // immediately after a CS. By setting failing the monitor update failure from the CS (which
1185 // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1186 // generation during RAA while in monitor-update-failed state.
1188 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1189 check_added_monitors!(nodes[0], 1);
1190 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1191 check_added_monitors!(nodes[0], 0);
1194 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1195 assert_eq!(events.len(), 1);
1196 let payment_event = SendEvent::from_event(events.pop().unwrap());
1197 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1198 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1199 check_added_monitors!(nodes[1], 1);
1201 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1202 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1203 check_added_monitors!(nodes[0], 1);
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());
1208 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1209 check_added_monitors!(nodes[0], 1);
1210 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1212 // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1213 // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1214 // then restore channel monitor updates.
1215 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1216 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1217 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1218 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1219 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1220 check_added_monitors!(nodes[1], 1);
1222 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1223 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1224 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented responses to RAA".to_string(), 1);
1225 check_added_monitors!(nodes[1], 1);
1227 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1228 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1229 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1230 // nodes[1] should be AwaitingRAA here!
1231 check_added_monitors!(nodes[1], 0);
1232 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1233 expect_pending_htlcs_forwardable!(nodes[1]);
1234 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1236 // We send a third payment here, which is somewhat of a redundant test, but the
1237 // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1238 // commitment transaction states) whereas here we can explicitly check for it.
1240 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1241 check_added_monitors!(nodes[0], 0);
1242 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1244 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1245 check_added_monitors!(nodes[0], 1);
1246 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1247 assert_eq!(events.len(), 1);
1248 let payment_event = SendEvent::from_event(events.pop().unwrap());
1250 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1251 check_added_monitors!(nodes[0], 1);
1252 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1254 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1255 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1256 check_added_monitors!(nodes[1], 1);
1257 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1259 // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1260 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1261 check_added_monitors!(nodes[1], 1);
1262 expect_pending_htlcs_forwardable!(nodes[1]);
1263 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1264 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1266 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1267 check_added_monitors!(nodes[0], 1);
1269 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1270 check_added_monitors!(nodes[0], 1);
1271 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1273 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1274 check_added_monitors!(nodes[1], 1);
1275 expect_pending_htlcs_forwardable!(nodes[1]);
1276 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1278 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1279 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1280 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1284 fn claim_while_disconnected_monitor_update_fail() {
1285 // Test for claiming a payment while disconnected and then having the resulting
1286 // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1287 // contrived case for nodes with network instability.
1288 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1289 // code introduced a regression in this test (specifically, this caught a removal of the
1290 // channel_reestablish handling ensuring the order was sensical given the messages used).
1291 let chanmon_cfgs = create_chanmon_cfgs(2);
1292 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1293 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1294 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1295 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1297 // Forward a payment for B to claim
1298 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1300 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1301 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1303 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1304 check_added_monitors!(nodes[1], 1);
1306 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1307 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1309 let as_reconnect = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1310 let bs_reconnect = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1312 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1313 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1315 // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1317 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1319 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1320 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1321 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1322 check_added_monitors!(nodes[1], 1);
1323 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1325 // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1326 // the monitor still failed
1327 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1329 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1330 check_added_monitors!(nodes[0], 1);
1333 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1334 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1335 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1336 check_added_monitors!(nodes[1], 1);
1337 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1338 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1339 // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1340 // until we've channel_monitor_update'd and updated for the new commitment transaction.
1342 // Now un-fail the monitor, which will result in B sending its original commitment update,
1343 // receiving the commitment update from A, and the resulting commitment dances.
1344 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1345 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1346 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1347 check_added_monitors!(nodes[1], 0);
1349 let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1350 assert_eq!(bs_msgs.len(), 2);
1353 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1354 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1355 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1356 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1357 check_added_monitors!(nodes[0], 1);
1359 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1360 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1361 check_added_monitors!(nodes[1], 1);
1363 _ => panic!("Unexpected event"),
1367 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1368 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1369 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1370 check_added_monitors!(nodes[0], 1);
1372 _ => panic!("Unexpected event"),
1375 let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1377 let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1378 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1379 check_added_monitors!(nodes[0], 1);
1380 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1382 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1383 check_added_monitors!(nodes[1], 1);
1384 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1385 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1386 check_added_monitors!(nodes[1], 1);
1388 expect_pending_htlcs_forwardable!(nodes[1]);
1389 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1391 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1392 check_added_monitors!(nodes[0], 1);
1393 expect_payment_sent!(nodes[0], payment_preimage_1);
1395 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1399 fn monitor_failed_no_reestablish_response() {
1400 // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1401 // response to a commitment_signed.
1402 // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1403 // debug_assert!() failure in channel_reestablish handling.
1404 let chanmon_cfgs = create_chanmon_cfgs(2);
1405 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1406 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1407 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1408 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1410 // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1412 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1414 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1415 check_added_monitors!(nodes[0], 1);
1418 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1419 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1420 assert_eq!(events.len(), 1);
1421 let payment_event = SendEvent::from_event(events.pop().unwrap());
1422 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1423 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1424 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1425 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1426 check_added_monitors!(nodes[1], 1);
1428 // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1429 // is still failing to update monitors.
1430 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1431 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1433 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1434 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1436 let as_reconnect = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1437 let bs_reconnect = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1439 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1440 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1441 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1442 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1444 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1445 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1446 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1447 check_added_monitors!(nodes[1], 0);
1448 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1450 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1451 check_added_monitors!(nodes[0], 1);
1452 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1453 check_added_monitors!(nodes[0], 1);
1455 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1456 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1457 check_added_monitors!(nodes[1], 1);
1459 expect_pending_htlcs_forwardable!(nodes[1]);
1460 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1462 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1466 fn first_message_on_recv_ordering() {
1467 // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1468 // messages, we're willing to flip the order of response messages if neccessary in resposne to
1469 // a commitment_signed which needs to send an RAA first.
1470 // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1471 // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1472 // response. To do this, we start routing two payments, with the final RAA for the first being
1473 // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1474 // have no pending response but will want to send a RAA/CS (with the updates for the second
1475 // payment applied).
1476 // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1477 let chanmon_cfgs = create_chanmon_cfgs(2);
1478 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1479 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1480 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1481 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1483 // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1484 // can deliver it and fail the monitor update.
1485 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1487 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1488 check_added_monitors!(nodes[0], 1);
1491 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1492 assert_eq!(events.len(), 1);
1493 let payment_event = SendEvent::from_event(events.pop().unwrap());
1494 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1495 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1496 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1497 check_added_monitors!(nodes[1], 1);
1498 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1500 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1501 check_added_monitors!(nodes[0], 1);
1502 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1503 check_added_monitors!(nodes[0], 1);
1505 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1507 // Route the second payment, generating an update_add_htlc/commitment_signed
1508 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1510 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1511 check_added_monitors!(nodes[0], 1);
1513 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1514 assert_eq!(events.len(), 1);
1515 let payment_event = SendEvent::from_event(events.pop().unwrap());
1516 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1518 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1520 // Deliver the final RAA for the first payment, which does not require a response. RAAs
1521 // generally require a commitment_signed, so the fact that we're expecting an opposite response
1522 // to the next message also tests resetting the delivery order.
1523 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1524 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1525 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1526 check_added_monitors!(nodes[1], 1);
1528 // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1529 // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1530 // appropriate HTLC acceptance).
1531 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1532 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1533 check_added_monitors!(nodes[1], 1);
1534 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1535 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1537 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1538 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1539 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1540 check_added_monitors!(nodes[1], 0);
1542 expect_pending_htlcs_forwardable!(nodes[1]);
1543 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1545 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1546 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1547 check_added_monitors!(nodes[0], 1);
1548 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1549 check_added_monitors!(nodes[0], 1);
1551 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1552 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1553 check_added_monitors!(nodes[1], 1);
1555 expect_pending_htlcs_forwardable!(nodes[1]);
1556 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1558 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1559 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1563 fn test_monitor_update_fail_claim() {
1564 // Basic test for monitor update failures when processing claim_funds calls.
1565 // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1566 // update to claim the payment. We then send two payments C->B->A, which are held at B.
1567 // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1568 // the payments from C onwards to A.
1569 let chanmon_cfgs = create_chanmon_cfgs(3);
1570 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1571 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1572 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1573 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1574 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1576 // Rebalance a bit so that we can send backwards from 3 to 2.
1577 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1579 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1581 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1582 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1583 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1584 check_added_monitors!(nodes[1], 1);
1586 // Note that at this point there is a pending commitment transaction update for A being held by
1587 // B. Even when we go to send the payment from C through B to A, B will not update this
1588 // already-signed commitment transaction and will instead wait for it to resolve before
1589 // forwarding the payment onwards.
1591 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1_000_000);
1593 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1594 check_added_monitors!(nodes[2], 1);
1597 // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1598 // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1599 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1601 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1602 assert_eq!(events.len(), 1);
1603 let payment_event = SendEvent::from_event(events.pop().unwrap());
1604 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1605 let events = nodes[1].node.get_and_clear_pending_msg_events();
1606 assert_eq!(events.len(), 0);
1607 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1609 let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1610 nodes[2].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1611 check_added_monitors!(nodes[2], 1);
1613 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1614 assert_eq!(events.len(), 1);
1615 let payment_event = SendEvent::from_event(events.pop().unwrap());
1616 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1617 let events = nodes[1].node.get_and_clear_pending_msg_events();
1618 assert_eq!(events.len(), 0);
1619 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1621 // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1622 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1623 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1624 check_added_monitors!(nodes[1], 0);
1626 let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1627 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1628 commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1629 expect_payment_sent!(nodes[0], payment_preimage_1);
1631 // Get the payment forwards, note that they were batched into one commitment update.
1632 expect_pending_htlcs_forwardable!(nodes[1]);
1633 check_added_monitors!(nodes[1], 1);
1634 let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1635 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1636 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1637 commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1638 expect_pending_htlcs_forwardable!(nodes[0]);
1640 let events = nodes[0].node.get_and_clear_pending_events();
1641 assert_eq!(events.len(), 2);
1643 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1644 assert_eq!(payment_hash_2, *payment_hash);
1645 assert_eq!(1_000_000, amt);
1647 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1648 assert!(payment_preimage.is_none());
1649 assert_eq!(payment_secret_2, *payment_secret);
1651 _ => panic!("expected PaymentPurpose::InvoicePayment")
1654 _ => panic!("Unexpected event"),
1657 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1658 assert_eq!(payment_hash_3, *payment_hash);
1659 assert_eq!(1_000_000, amt);
1661 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1662 assert!(payment_preimage.is_none());
1663 assert_eq!(payment_secret_3, *payment_secret);
1665 _ => panic!("expected PaymentPurpose::InvoicePayment")
1668 _ => panic!("Unexpected event"),
1673 fn test_monitor_update_on_pending_forwards() {
1674 // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1675 // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1676 // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1677 // from C to A will be pending a forward to A.
1678 let chanmon_cfgs = create_chanmon_cfgs(3);
1679 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1680 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1681 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1682 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1683 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1685 // Rebalance a bit so that we can send backwards from 3 to 1.
1686 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1688 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1689 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1));
1690 expect_pending_htlcs_forwardable!(nodes[2]);
1691 check_added_monitors!(nodes[2], 1);
1693 let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1694 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1695 commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1696 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1698 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
1700 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1701 check_added_monitors!(nodes[2], 1);
1704 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1705 assert_eq!(events.len(), 1);
1706 let payment_event = SendEvent::from_event(events.pop().unwrap());
1707 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1708 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1710 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1711 expect_pending_htlcs_forwardable!(nodes[1]);
1712 check_added_monitors!(nodes[1], 1);
1713 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1714 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1716 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1717 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1718 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1719 check_added_monitors!(nodes[1], 0);
1721 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1722 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1723 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1724 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1726 let events = nodes[0].node.get_and_clear_pending_events();
1727 assert_eq!(events.len(), 2);
1728 if let Event::PaymentPathFailed { payment_hash, rejected_by_dest, .. } = events[0] {
1729 assert_eq!(payment_hash, payment_hash_1);
1730 assert!(rejected_by_dest);
1731 } else { panic!("Unexpected event!"); }
1733 Event::PendingHTLCsForwardable { .. } => { },
1734 _ => panic!("Unexpected event"),
1736 nodes[0].node.process_pending_htlc_forwards();
1737 expect_payment_received!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1739 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1743 fn monitor_update_claim_fail_no_response() {
1744 // Test for claim_funds resulting in both a monitor update failure and no message response (due
1745 // to channel being AwaitingRAA).
1746 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1748 let chanmon_cfgs = create_chanmon_cfgs(2);
1749 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1750 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1751 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1752 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1754 // Forward a payment for B to claim
1755 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1757 // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1758 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1760 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1761 check_added_monitors!(nodes[0], 1);
1764 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1765 assert_eq!(events.len(), 1);
1766 let payment_event = SendEvent::from_event(events.pop().unwrap());
1767 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1768 let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1770 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1771 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1772 check_added_monitors!(nodes[1], 1);
1773 let events = nodes[1].node.get_and_clear_pending_msg_events();
1774 assert_eq!(events.len(), 0);
1775 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1777 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1778 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1779 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1780 check_added_monitors!(nodes[1], 0);
1781 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1783 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1784 check_added_monitors!(nodes[1], 1);
1785 expect_pending_htlcs_forwardable!(nodes[1]);
1786 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1788 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1789 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1790 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1791 expect_payment_sent!(nodes[0], payment_preimage_1);
1793 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1796 // confirm_a_first and restore_b_before_conf are wholly unrelated to earlier bools and
1797 // restore_b_before_conf has no meaning if !confirm_a_first
1798 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool) {
1799 // Test that if the monitor update generated by funding_transaction_generated fails we continue
1800 // the channel setup happily after the update is restored.
1801 let chanmon_cfgs = create_chanmon_cfgs(2);
1802 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1803 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1804 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1806 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1807 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
1808 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
1810 let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 43);
1812 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_tx.clone()).unwrap();
1813 check_added_monitors!(nodes[0], 0);
1815 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1816 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1817 let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1818 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1819 check_added_monitors!(nodes[1], 1);
1821 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1822 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()));
1823 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1824 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1825 check_added_monitors!(nodes[0], 1);
1826 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1827 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
1828 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1829 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1830 check_added_monitors!(nodes[0], 0);
1832 let events = nodes[0].node.get_and_clear_pending_events();
1833 assert_eq!(events.len(), 0);
1834 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1835 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1837 if confirm_a_first {
1838 confirm_transaction(&nodes[0], &funding_tx);
1839 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id()));
1841 assert!(!restore_b_before_conf);
1842 confirm_transaction(&nodes[1], &funding_tx);
1843 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1846 // Make sure nodes[1] isn't stupid enough to re-send the FundingLocked on reconnect
1847 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1848 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1849 reconnect_nodes(&nodes[0], &nodes[1], (false, confirm_a_first), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1850 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1851 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1853 if !restore_b_before_conf {
1854 confirm_transaction(&nodes[1], &funding_tx);
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());
1859 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1860 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1861 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1862 check_added_monitors!(nodes[1], 0);
1864 let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1865 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
1867 confirm_transaction(&nodes[0], &funding_tx);
1868 let (funding_locked, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1869 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked))
1871 if restore_b_before_conf {
1872 confirm_transaction(&nodes[1], &funding_tx);
1874 let (funding_locked, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1875 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &funding_locked))
1877 for node in nodes.iter() {
1878 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
1879 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1880 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1883 send_payment(&nodes[0], &[&nodes[1]], 8000000);
1884 close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1885 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
1886 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1890 fn during_funding_monitor_fail() {
1891 do_during_funding_monitor_fail(true, true);
1892 do_during_funding_monitor_fail(true, false);
1893 do_during_funding_monitor_fail(false, false);
1897 fn test_path_paused_mpp() {
1898 // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1900 let chanmon_cfgs = create_chanmon_cfgs(4);
1901 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1902 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1903 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1905 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1906 let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
1907 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1908 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1910 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
1912 // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1913 let path = route.paths[0].clone();
1914 route.paths.push(path);
1915 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
1916 route.paths[0][0].short_channel_id = chan_1_id;
1917 route.paths[0][1].short_channel_id = chan_3_id;
1918 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
1919 route.paths[1][0].short_channel_id = chan_2_ann.contents.short_channel_id;
1920 route.paths[1][1].short_channel_id = chan_4_id;
1922 // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
1923 // (for the path 0 -> 2 -> 3) fails.
1924 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
1925 chanmon_cfgs[0].persister.set_next_update_ret(Some(Err(ChannelMonitorUpdateErr::TemporaryFailure)));
1927 // Now check that we get the right return value, indicating that the first path succeeded but
1928 // the second got a MonitorUpdateFailed err. This implies PaymentSendFailure::PartialFailure as
1929 // some paths succeeded, preventing retry.
1930 if let Err(PaymentSendFailure::PartialFailure { results, ..}) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)) {
1931 assert_eq!(results.len(), 2);
1932 if let Ok(()) = results[0] {} else { panic!(); }
1933 if let Err(APIError::MonitorUpdateFailed) = results[1] {} else { panic!(); }
1934 } else { panic!(); }
1935 check_added_monitors!(nodes[0], 2);
1936 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
1938 // Pass the first HTLC of the payment along to nodes[3].
1939 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1940 assert_eq!(events.len(), 1);
1941 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false, None);
1943 // And check that, after we successfully update the monitor for chan_2 we can pass the second
1944 // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
1945 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
1946 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1947 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1948 assert_eq!(events.len(), 1);
1949 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true, None);
1951 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
1955 fn test_pending_update_fee_ack_on_reconnect() {
1956 // In early versions of our automated fee update patch, nodes did not correctly use the
1957 // previous channel feerate after sending an undelivered revoke_and_ack when re-sending an
1958 // undelivered commitment_signed.
1960 // B sends A new HTLC + CS, not delivered
1961 // A sends B update_fee + CS
1962 // B receives the CS and sends RAA, previously causing B to lock in the new feerate
1964 // B resends initial CS, using the original fee
1966 let chanmon_cfgs = create_chanmon_cfgs(2);
1967 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1968 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1969 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1971 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1972 send_payment(&nodes[0], &[&nodes[1]], 100_000_00);
1974 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[1], nodes[0], 1_000_000);
1975 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1976 check_added_monitors!(nodes[1], 1);
1977 let bs_initial_send_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1978 // bs_initial_send_msgs are not delivered until they are re-generated after reconnect
1981 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1984 nodes[0].node.timer_tick_occurred();
1985 check_added_monitors!(nodes[0], 1);
1986 let as_update_fee_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1987 assert!(as_update_fee_msgs.update_fee.is_some());
1989 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_update_fee_msgs.update_fee.as_ref().unwrap());
1990 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_fee_msgs.commitment_signed);
1991 check_added_monitors!(nodes[1], 1);
1992 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1993 // bs_first_raa is not delivered until it is re-generated after reconnect
1995 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1996 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1998 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
1999 let as_connect_msg = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
2000 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
2001 let bs_connect_msg = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
2003 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2004 let bs_resend_msgs = nodes[1].node.get_and_clear_pending_msg_events();
2005 assert_eq!(bs_resend_msgs.len(), 3);
2006 if let MessageSendEvent::UpdateHTLCs { ref updates, .. } = bs_resend_msgs[0] {
2007 assert_eq!(*updates, bs_initial_send_msgs);
2008 } else { panic!(); }
2009 if let MessageSendEvent::SendRevokeAndACK { ref msg, .. } = bs_resend_msgs[1] {
2010 assert_eq!(*msg, bs_first_raa);
2011 } else { panic!(); }
2012 if let MessageSendEvent::SendChannelUpdate { .. } = bs_resend_msgs[2] { } else { panic!(); }
2014 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2015 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
2017 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.update_add_htlcs[0]);
2018 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.commitment_signed);
2019 check_added_monitors!(nodes[0], 1);
2020 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()));
2021 check_added_monitors!(nodes[1], 1);
2022 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()).commitment_signed;
2024 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2025 check_added_monitors!(nodes[0], 1);
2026 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);
2027 check_added_monitors!(nodes[1], 1);
2028 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2030 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2031 check_added_monitors!(nodes[0], 1);
2032 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2033 check_added_monitors!(nodes[0], 1);
2035 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()));
2036 check_added_monitors!(nodes[1], 1);
2038 expect_pending_htlcs_forwardable!(nodes[0]);
2039 expect_payment_received!(nodes[0], payment_hash, payment_secret, 1_000_000);
2041 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
2044 fn do_update_fee_resend_test(deliver_update: bool, parallel_updates: bool) {
2045 // In early versions we did not handle resending of update_fee on reconnect correctly. The
2046 // chanmon_consistency fuzz target, of course, immediately found it, but we test a few cases
2048 let chanmon_cfgs = create_chanmon_cfgs(2);
2049 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2050 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2051 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2053 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2054 send_payment(&nodes[0], &[&nodes[1]], 1000);
2057 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2058 *feerate_lock += 20;
2060 nodes[0].node.timer_tick_occurred();
2061 check_added_monitors!(nodes[0], 1);
2062 let update_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2063 assert!(update_msgs.update_fee.is_some());
2065 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2068 if parallel_updates {
2070 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2071 *feerate_lock += 20;
2073 nodes[0].node.timer_tick_occurred();
2074 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2077 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2078 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2080 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
2081 let as_connect_msg = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
2082 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
2083 let bs_connect_msg = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
2085 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2086 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
2087 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2089 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2090 let mut as_reconnect_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2091 assert_eq!(as_reconnect_msgs.len(), 2);
2092 if let MessageSendEvent::SendChannelUpdate { .. } = as_reconnect_msgs.pop().unwrap() {} else { panic!(); }
2093 let update_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = as_reconnect_msgs.pop().unwrap()
2094 { updates } else { panic!(); };
2095 assert!(update_msgs.update_fee.is_some());
2096 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2097 if parallel_updates {
2098 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update_msgs.commitment_signed);
2099 check_added_monitors!(nodes[1], 1);
2100 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2101 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2102 check_added_monitors!(nodes[0], 1);
2103 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2105 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2106 check_added_monitors!(nodes[0], 1);
2107 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2109 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_second_update.update_fee.as_ref().unwrap());
2110 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
2111 check_added_monitors!(nodes[1], 1);
2112 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2114 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2115 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2116 check_added_monitors!(nodes[1], 1);
2118 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2119 check_added_monitors!(nodes[0], 1);
2121 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs.commitment_signed);
2122 check_added_monitors!(nodes[0], 1);
2123 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2125 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2126 check_added_monitors!(nodes[1], 1);
2128 commitment_signed_dance!(nodes[1], nodes[0], update_msgs.commitment_signed, false);
2131 send_payment(&nodes[0], &[&nodes[1]], 1000);
2134 fn update_fee_resend_test() {
2135 do_update_fee_resend_test(false, false);
2136 do_update_fee_resend_test(true, false);
2137 do_update_fee_resend_test(false, true);
2138 do_update_fee_resend_test(true, true);
2141 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2142 // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2143 // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2144 // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2145 // which failed in such a case).
2146 let chanmon_cfgs = create_chanmon_cfgs(2);
2147 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2148 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2149 let persister: test_utils::TestPersister;
2150 let new_chain_monitor: test_utils::TestChainMonitor;
2151 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2152 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2154 let chan_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 15_000_000, 7_000_000_000, InitFeatures::known(), InitFeatures::known()).2;
2155 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
2156 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2158 // Do a really complicated dance to get an HTLC into the holding cell, with MonitorUpdateFailed
2159 // set but AwaitingRemoteRevoke unset. When this test was written, any attempts to send an HTLC
2160 // while MonitorUpdateFailed is set are immediately failed-backwards. Thus, the only way to get
2161 // an AddHTLC into the holding cell is to add it while AwaitingRemoteRevoke is set but
2162 // MonitorUpdateFailed is unset, and then swap the flags.
2165 // a) routing a payment from node B to node A,
2166 // b) sending a payment from node A to node B without delivering any of the generated messages,
2167 // putting node A in AwaitingRemoteRevoke,
2168 // c) sending a second payment from node A to node B, which is immediately placed in the
2170 // d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2171 // when we try to persist the payment preimage,
2172 // e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2173 // clearing AwaitingRemoteRevoke on node A.
2175 // Note that because, at the end, MonitorUpdateFailed is still set, the HTLC generated in (c)
2176 // will not be freed from the holding cell.
2177 let (payment_preimage_0, _, _) = route_payment(&nodes[1], &[&nodes[0]], 100000);
2179 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
2180 check_added_monitors!(nodes[0], 1);
2181 let send = SendEvent::from_node(&nodes[0]);
2182 assert_eq!(send.msgs.len(), 1);
2184 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
2185 check_added_monitors!(nodes[0], 0);
2187 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2188 assert!(nodes[0].node.claim_funds(payment_preimage_0));
2189 check_added_monitors!(nodes[0], 1);
2191 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2192 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2193 check_added_monitors!(nodes[1], 1);
2195 let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2197 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2198 check_added_monitors!(nodes[0], 1);
2201 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2202 // disconnect the peers. Note that the fuzzer originally found this issue because
2203 // deserializing a ChannelManager in this state causes an assertion failure.
2205 let nodes_0_serialized = nodes[0].node.encode();
2206 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
2207 get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
2209 persister = test_utils::TestPersister::new();
2210 let keys_manager = &chanmon_cfgs[0].keys_manager;
2211 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
2212 nodes[0].chain_monitor = &new_chain_monitor;
2213 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
2214 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
2215 &mut chan_0_monitor_read, keys_manager).unwrap();
2216 assert!(chan_0_monitor_read.is_empty());
2218 let mut nodes_0_read = &nodes_0_serialized[..];
2219 let config = UserConfig::default();
2220 nodes_0_deserialized = {
2221 let mut channel_monitors = HashMap::new();
2222 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
2223 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
2224 default_config: config,
2226 fee_estimator: node_cfgs[0].fee_estimator,
2227 chain_monitor: nodes[0].chain_monitor,
2228 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
2229 logger: nodes[0].logger,
2233 nodes[0].node = &nodes_0_deserialized;
2234 assert!(nodes_0_read.is_empty());
2236 nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0.clone(), chan_0_monitor).unwrap();
2237 check_added_monitors!(nodes[0], 1);
2239 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2241 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2243 // Now reconnect the two
2244 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2245 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2246 assert_eq!(reestablish_1.len(), 1);
2247 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2248 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2249 assert_eq!(reestablish_2.len(), 1);
2251 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2252 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2253 check_added_monitors!(nodes[1], 0);
2255 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2256 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2258 assert!(resp_0.0.is_none());
2259 assert!(resp_0.1.is_none());
2260 assert!(resp_0.2.is_none());
2261 assert!(resp_1.0.is_none());
2262 assert!(resp_1.1.is_none());
2264 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2266 if let Some(pending_cs) = resp_1.2 {
2267 assert!(pending_cs.update_add_htlcs.is_empty());
2268 assert!(pending_cs.update_fail_htlcs.is_empty());
2269 assert!(pending_cs.update_fulfill_htlcs.is_empty());
2270 assert_eq!(pending_cs.commitment_signed, cs);
2271 } else { panic!(); }
2273 // There should be no monitor updates as we are still pending awaiting a failed one.
2274 check_added_monitors!(nodes[0], 0);
2275 check_added_monitors!(nodes[1], 0);
2278 // If we finish updating the monitor, we should free the holding cell right away (this did
2279 // not occur prior to #756).
2280 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
2281 let (funding_txo, mon_id, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2282 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_txo, mon_id);
2284 // New outbound messages should be generated immediately upon a call to
2285 // get_and_clear_pending_msg_events (but not before).
2286 check_added_monitors!(nodes[0], 0);
2287 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2288 check_added_monitors!(nodes[0], 1);
2289 assert_eq!(events.len(), 1);
2291 // Deliver the pending in-flight CS
2292 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2293 check_added_monitors!(nodes[0], 1);
2295 let commitment_msg = match events.pop().unwrap() {
2296 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2297 assert_eq!(node_id, nodes[1].node.get_our_node_id());
2298 assert!(updates.update_fail_htlcs.is_empty());
2299 assert!(updates.update_fail_malformed_htlcs.is_empty());
2300 assert!(updates.update_fee.is_none());
2301 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2302 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2303 expect_payment_sent_without_paths!(nodes[1], payment_preimage_0);
2304 assert_eq!(updates.update_add_htlcs.len(), 1);
2305 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2306 updates.commitment_signed
2308 _ => panic!("Unexpected event type!"),
2311 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2312 check_added_monitors!(nodes[1], 1);
2314 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2315 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2316 expect_pending_htlcs_forwardable!(nodes[1]);
2317 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2318 check_added_monitors!(nodes[1], 1);
2320 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
2322 let events = nodes[1].node.get_and_clear_pending_events();
2323 assert_eq!(events.len(), 2);
2325 Event::PendingHTLCsForwardable { .. } => { },
2326 _ => panic!("Unexpected event"),
2329 Event::PaymentPathSuccessful { .. } => { },
2330 _ => panic!("Unexpected event"),
2333 nodes[1].node.process_pending_htlc_forwards();
2334 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2336 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2337 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2340 fn channel_holding_cell_serialize() {
2341 do_channel_holding_cell_serialize(true, true);
2342 do_channel_holding_cell_serialize(true, false);
2343 do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2346 #[derive(PartialEq)]
2347 enum HTLCStatusAtDupClaim {
2352 fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_fails: bool) {
2353 // When receiving an update_fulfill_htlc message, we immediately forward the claim backwards
2354 // along the payment path before waiting for a full commitment_signed dance. This is great, but
2355 // can cause duplicative claims if a node sends an update_fulfill_htlc message, disconnects,
2356 // reconnects, and then has to re-send its update_fulfill_htlc message again.
2357 // In previous code, we didn't handle the double-claim correctly, spuriously closing the
2358 // channel on which the inbound HTLC was received.
2359 let chanmon_cfgs = create_chanmon_cfgs(3);
2360 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2361 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2362 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2364 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2365 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;
2367 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
2369 let mut as_raa = None;
2370 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2371 // In order to get the HTLC claim into the holding cell at nodes[1], we need nodes[1] to be
2372 // awaiting a remote revoke_and_ack from nodes[0].
2373 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
2374 nodes[0].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
2375 check_added_monitors!(nodes[0], 1);
2377 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
2378 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
2379 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
2380 check_added_monitors!(nodes[1], 1);
2382 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2383 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2384 check_added_monitors!(nodes[0], 1);
2385 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
2386 check_added_monitors!(nodes[0], 1);
2388 as_raa = Some(get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2391 let fulfill_msg = msgs::UpdateFulfillHTLC {
2397 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash));
2398 expect_pending_htlcs_forwardable!(nodes[2]);
2399 check_added_monitors!(nodes[2], 1);
2400 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2402 assert!(nodes[2].node.claim_funds(payment_preimage));
2403 check_added_monitors!(nodes[2], 1);
2404 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2405 assert_eq!(cs_updates.update_fulfill_htlcs.len(), 1);
2406 // Check that the message we're about to deliver matches the one generated:
2407 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
2409 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
2410 expect_payment_forwarded!(nodes[1], Some(1000), false);
2411 check_added_monitors!(nodes[1], 1);
2413 let mut bs_updates = None;
2414 if htlc_status != HTLCStatusAtDupClaim::HoldingCell {
2415 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2416 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2417 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2418 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2419 if htlc_status == HTLCStatusAtDupClaim::Cleared {
2420 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2421 expect_payment_path_successful!(nodes[0]);
2424 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2427 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
2428 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2431 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
2432 expect_pending_htlcs_forwardable!(nodes[1]);
2434 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2437 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2438 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa.unwrap());
2439 check_added_monitors!(nodes[1], 1);
2440 expect_pending_htlcs_forwardable_ignore!(nodes[1]); // We finally receive the second payment, but don't claim it
2442 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2443 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2444 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2445 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2447 if htlc_status != HTLCStatusAtDupClaim::Cleared {
2448 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2449 expect_payment_path_successful!(nodes[0]);
2454 fn test_reconnect_dup_htlc_claims() {
2455 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, false);
2456 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, false);
2457 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, false);
2458 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, true);
2459 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, true);
2460 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, true);
2464 fn test_temporary_error_during_shutdown() {
2465 // Test that temporary failures when updating the monitor's shutdown script delay cooperative
2467 let mut config = test_default_channel_config();
2468 config.channel_options.commit_upfront_shutdown_pubkey = false;
2470 let chanmon_cfgs = create_chanmon_cfgs(2);
2471 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2472 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
2473 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2475 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2477 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2478 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2480 nodes[0].node.close_channel(&channel_id).unwrap();
2481 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
2482 check_added_monitors!(nodes[1], 1);
2484 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id()));
2485 check_added_monitors!(nodes[0], 1);
2487 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2489 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
2490 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
2492 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2493 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2494 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()));
2496 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2498 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
2499 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2500 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2502 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()));
2503 let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
2504 let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2506 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_a.unwrap());
2507 let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
2508 assert!(none_b.is_none());
2509 let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2511 assert_eq!(txn_a, txn_b);
2512 assert_eq!(txn_a.len(), 1);
2513 check_spends!(txn_a[0], funding_tx);
2514 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
2515 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
2519 fn test_permanent_error_during_sending_shutdown() {
2520 // Test that permanent failures when updating the monitor's shutdown script result in a force
2521 // close when initiating a cooperative close.
2522 let mut config = test_default_channel_config();
2523 config.channel_options.commit_upfront_shutdown_pubkey = false;
2525 let chanmon_cfgs = create_chanmon_cfgs(2);
2526 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2527 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
2528 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2530 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
2531 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::PermanentFailure));
2533 assert!(nodes[0].node.close_channel(&channel_id).is_ok());
2534 check_closed_broadcast!(nodes[0], true);
2535 check_added_monitors!(nodes[0], 2);
2536 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2540 fn test_permanent_error_during_handling_shutdown() {
2541 // Test that permanent failures when updating the monitor's shutdown script result in a force
2542 // close when handling a cooperative close.
2543 let mut config = test_default_channel_config();
2544 config.channel_options.commit_upfront_shutdown_pubkey = false;
2546 let chanmon_cfgs = create_chanmon_cfgs(2);
2547 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2548 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
2549 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2551 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
2552 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::PermanentFailure));
2554 assert!(nodes[0].node.close_channel(&channel_id).is_ok());
2555 let shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
2556 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &shutdown);
2557 check_closed_broadcast!(nodes[1], true);
2558 check_added_monitors!(nodes[1], 2);
2559 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2563 fn double_temp_error() {
2564 // Test that it's OK to have multiple `ChainMonitor::update_channel` calls fail in a row.
2565 let chanmon_cfgs = create_chanmon_cfgs(2);
2566 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2567 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2568 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2570 let (_, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2572 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
2573 let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
2575 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2576 // `claim_funds` results in a ChannelMonitorUpdate.
2577 assert!(nodes[1].node.claim_funds(payment_preimage_1));
2578 check_added_monitors!(nodes[1], 1);
2579 let (funding_tx, latest_update_1, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2581 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2582 // Previously, this would've panicked due to a double-call to `Channel::monitor_update_failed`,
2583 // which had some asserts that prevented it from being called twice.
2584 assert!(nodes[1].node.claim_funds(payment_preimage_2));
2585 check_added_monitors!(nodes[1], 1);
2586 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
2588 let (_, latest_update_2, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2589 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_1);
2590 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2591 check_added_monitors!(nodes[1], 0);
2592 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_2);
2594 // Complete the first HTLC.
2595 let events = nodes[1].node.get_and_clear_pending_msg_events();
2596 assert_eq!(events.len(), 1);
2597 let (update_fulfill_1, commitment_signed_b1, node_id) = {
2599 &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 } } => {
2600 assert!(update_add_htlcs.is_empty());
2601 assert_eq!(update_fulfill_htlcs.len(), 1);
2602 assert!(update_fail_htlcs.is_empty());
2603 assert!(update_fail_malformed_htlcs.is_empty());
2604 assert!(update_fee.is_none());
2605 (update_fulfill_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2607 _ => panic!("Unexpected event"),
2610 assert_eq!(node_id, nodes[0].node.get_our_node_id());
2611 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_1);
2612 check_added_monitors!(nodes[0], 0);
2613 expect_payment_sent_without_paths!(nodes[0], payment_preimage_1);
2614 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_b1);
2615 check_added_monitors!(nodes[0], 1);
2616 nodes[0].node.process_pending_htlc_forwards();
2617 let (raa_a1, commitment_signed_a1) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2618 check_added_monitors!(nodes[1], 0);
2619 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2620 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_a1);
2621 check_added_monitors!(nodes[1], 1);
2622 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed_a1);
2623 check_added_monitors!(nodes[1], 1);
2625 // Complete the second HTLC.
2626 let ((update_fulfill_2, commitment_signed_b2), raa_b2) = {
2627 let events = nodes[1].node.get_and_clear_pending_msg_events();
2628 assert_eq!(events.len(), 2);
2630 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2631 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2632 assert!(updates.update_add_htlcs.is_empty());
2633 assert!(updates.update_fail_htlcs.is_empty());
2634 assert!(updates.update_fail_malformed_htlcs.is_empty());
2635 assert!(updates.update_fee.is_none());
2636 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2637 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2639 _ => panic!("Unexpected event"),
2642 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2643 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2646 _ => panic!("Unexpected event"),
2649 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_b2);
2650 check_added_monitors!(nodes[0], 1);
2651 expect_payment_path_successful!(nodes[0]);
2653 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_2);
2654 check_added_monitors!(nodes[0], 0);
2655 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2656 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed_b2, false);
2657 expect_payment_sent!(nodes[0], payment_preimage_2);