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::BlockHeader;
16 use bitcoin::hash_types::BlockHash;
17 use bitcoin::network::constants::Network;
18 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr};
19 use chain::transaction::OutPoint;
21 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure};
22 use ln::features::InitFeatures;
24 use ln::msgs::{ChannelMessageHandler, ErrorAction, RoutingMessageHandler};
25 use routing::router::get_route;
26 use util::config::UserConfig;
27 use util::enforcing_trait_impls::EnforcingSigner;
28 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
29 use util::errors::APIError;
30 use util::ser::{ReadableArgs, Writeable};
32 use bitcoin::hashes::sha256::Hash as Sha256;
33 use bitcoin::hashes::Hash;
35 use ln::functional_test_utils::*;
39 use std::collections::HashMap;
41 // If persister_fail is true, we have the persister return a PermanentFailure
42 // instead of the higher-level ChainMonitor.
43 fn do_test_simple_monitor_permanent_update_fail(persister_fail: bool) {
44 // Test that we handle a simple permanent monitor update failure
45 let mut chanmon_cfgs = create_chanmon_cfgs(2);
46 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
47 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
48 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
49 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
50 let logger = test_utils::TestLogger::new();
52 let (_, payment_hash_1) = get_payment_preimage_hash!(&nodes[0]);
54 match persister_fail {
55 true => chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::PermanentFailure)),
56 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::PermanentFailure))
58 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
59 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
60 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable {..}, {});
61 check_added_monitors!(nodes[0], 2);
63 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
64 assert_eq!(events_1.len(), 2);
66 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
67 _ => panic!("Unexpected event"),
70 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
71 _ => panic!("Unexpected event"),
74 // TODO: Once we hit the chain with the failure transaction we should check that we get a
75 // PaymentFailed event
77 assert_eq!(nodes[0].node.list_channels().len(), 0);
81 fn test_monitor_and_persister_update_fail() {
82 // Test that if both updating the `ChannelMonitor` and persisting the updated
83 // `ChannelMonitor` fail, then the failure from updating the `ChannelMonitor`
84 // one that gets returned.
85 let chanmon_cfgs = create_chanmon_cfgs(2);
86 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
87 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
88 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
90 // Create some initial channel
91 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
92 let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
94 // Rebalance the network to generate htlc in the two directions
95 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
97 // Route an HTLC from node 0 to node 1 (but don't settle)
98 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
100 // Make a copy of the ChainMonitor so we can capture the error it returns on a
101 // bogus update. Note that if instead we updated the nodes[0]'s ChainMonitor
102 // directly, the node would fail to be `Drop`'d at the end because its
103 // ChannelManager and ChainMonitor would be out of sync.
104 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
105 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
106 let persister = test_utils::TestPersister::new();
108 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
109 let monitor = monitors.get(&outpoint).unwrap();
110 let mut w = test_utils::TestVecWriter(Vec::new());
111 monitor.write(&mut w).unwrap();
112 let new_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
113 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
114 assert!(new_monitor == *monitor);
115 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
116 assert!(chain_mon.watch_channel(outpoint, new_monitor).is_ok());
119 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
120 chain_mon.chain_monitor.block_connected(&header, &[], 200);
122 // Set the persister's return value to be a TemporaryFailure.
123 persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
125 // Try to update ChannelMonitor
126 assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
127 check_added_monitors!(nodes[1], 1);
128 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
129 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
130 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
131 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2) {
132 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
133 // Check that even though the persister is returning a TemporaryFailure,
134 // because the update is bogus, ultimately the error that's returned
135 // should be a PermanentFailure.
136 if let Err(ChannelMonitorUpdateErr::PermanentFailure) = chain_mon.chain_monitor.update_channel(outpoint, update.clone()) {} else { panic!("Expected monitor error to be permanent"); }
137 logger.assert_log_contains("lightning::chain::chainmonitor".to_string(), "Failed to persist channel monitor update: TemporaryFailure".to_string(), 1);
138 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
139 } else { assert!(false); }
140 } else { assert!(false); };
142 check_added_monitors!(nodes[0], 1);
143 let events = nodes[0].node.get_and_clear_pending_events();
144 assert_eq!(events.len(), 1);
148 fn test_simple_monitor_permanent_update_fail() {
149 do_test_simple_monitor_permanent_update_fail(false);
151 // Test behavior when the persister returns a PermanentFailure.
152 do_test_simple_monitor_permanent_update_fail(true);
155 // If persister_fail is true, we have the persister return a TemporaryFailure instead of the
156 // higher-level ChainMonitor.
157 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool, persister_fail: bool) {
158 // Test that we can recover from a simple temporary monitor update failure optionally with
159 // a disconnect in between
160 let mut chanmon_cfgs = create_chanmon_cfgs(2);
161 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
162 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
163 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
164 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
165 let logger = test_utils::TestLogger::new();
167 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(&nodes[0]);
169 match persister_fail {
170 true => chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure)),
171 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure))
175 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
176 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
177 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &None), false, APIError::MonitorUpdateFailed, {});
178 check_added_monitors!(nodes[0], 1);
181 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
182 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
183 assert_eq!(nodes[0].node.list_channels().len(), 1);
186 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
187 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
188 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
191 match persister_fail {
192 true => chanmon_cfgs[0].persister.set_update_ret(Ok(())),
193 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()))
195 let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
196 nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
197 check_added_monitors!(nodes[0], 0);
199 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
200 assert_eq!(events_2.len(), 1);
201 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
202 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
203 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
204 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
206 expect_pending_htlcs_forwardable!(nodes[1]);
208 let events_3 = nodes[1].node.get_and_clear_pending_events();
209 assert_eq!(events_3.len(), 1);
211 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
212 assert_eq!(payment_hash_1, *payment_hash);
213 assert_eq!(*payment_secret, None);
214 assert_eq!(amt, 1000000);
216 _ => panic!("Unexpected event"),
219 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1, 1_000_000);
221 // Now set it to failed again...
222 let (_, payment_hash_2) = get_payment_preimage_hash!(&nodes[0]);
224 match persister_fail {
225 true => chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure)),
226 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure))
228 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
229 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
230 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &None), false, APIError::MonitorUpdateFailed, {});
231 check_added_monitors!(nodes[0], 1);
234 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
235 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
236 assert_eq!(nodes[0].node.list_channels().len(), 1);
239 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
240 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
241 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
244 // ...and make sure we can force-close a frozen channel
245 nodes[0].node.force_close_channel(&channel_id).unwrap();
246 check_added_monitors!(nodes[0], 1);
247 check_closed_broadcast!(nodes[0], false);
249 // TODO: Once we hit the chain with the failure transaction we should check that we get a
250 // PaymentFailed event
252 assert_eq!(nodes[0].node.list_channels().len(), 0);
256 fn test_simple_monitor_temporary_update_fail() {
257 do_test_simple_monitor_temporary_update_fail(false, false);
258 do_test_simple_monitor_temporary_update_fail(true, false);
260 // Test behavior when the persister returns a TemporaryFailure.
261 do_test_simple_monitor_temporary_update_fail(false, true);
262 do_test_simple_monitor_temporary_update_fail(true, true);
265 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
266 let disconnect_flags = 8 | 16;
268 // Test that we can recover from a temporary monitor update failure with some in-flight
269 // HTLCs going on at the same time potentially with some disconnection thrown in.
270 // * First we route a payment, then get a temporary monitor update failure when trying to
271 // route a second payment. We then claim the first payment.
272 // * If disconnect_count is set, we will disconnect at this point (which is likely as
273 // TemporaryFailure likely indicates net disconnect which resulted in failing to update
274 // the ChannelMonitor on a watchtower).
275 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
276 // immediately, otherwise we wait disconnect and deliver them via the reconnect
277 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
278 // disconnect_count & !disconnect_flags is 0).
279 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
280 // through message sending, potentially disconnect/reconnecting multiple times based on
281 // disconnect_count, to get the update_fulfill_htlc through.
282 // * We then walk through more message exchanges to get the original update_add_htlc
283 // through, swapping message ordering based on disconnect_count & 8 and optionally
284 // disconnect/reconnecting based on disconnect_count.
285 let chanmon_cfgs = create_chanmon_cfgs(2);
286 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
287 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
288 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
289 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
290 let logger = test_utils::TestLogger::new();
292 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
294 // Now try to send a second payment which will fail to send
295 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
297 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
298 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
299 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
300 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &None), false, APIError::MonitorUpdateFailed, {});
301 check_added_monitors!(nodes[0], 1);
304 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
305 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
306 assert_eq!(nodes[0].node.list_channels().len(), 1);
308 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
309 // but nodes[0] won't respond since it is frozen.
310 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
311 check_added_monitors!(nodes[1], 1);
312 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
313 assert_eq!(events_2.len(), 1);
314 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
315 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 } } => {
316 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
317 assert!(update_add_htlcs.is_empty());
318 assert_eq!(update_fulfill_htlcs.len(), 1);
319 assert!(update_fail_htlcs.is_empty());
320 assert!(update_fail_malformed_htlcs.is_empty());
321 assert!(update_fee.is_none());
323 if (disconnect_count & 16) == 0 {
324 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
325 let events_3 = nodes[0].node.get_and_clear_pending_events();
326 assert_eq!(events_3.len(), 1);
328 Event::PaymentSent { ref payment_preimage } => {
329 assert_eq!(*payment_preimage, payment_preimage_1);
331 _ => panic!("Unexpected event"),
334 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
335 check_added_monitors!(nodes[0], 1);
336 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
337 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
340 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
342 _ => panic!("Unexpected event"),
345 if disconnect_count & !disconnect_flags > 0 {
346 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
347 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
350 // Now fix monitor updating...
351 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
352 let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
353 nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
354 check_added_monitors!(nodes[0], 0);
356 macro_rules! disconnect_reconnect_peers { () => { {
357 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
358 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
360 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
361 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
362 assert_eq!(reestablish_1.len(), 1);
363 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
364 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
365 assert_eq!(reestablish_2.len(), 1);
367 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
368 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
369 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
370 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
372 assert!(as_resp.0.is_none());
373 assert!(bs_resp.0.is_none());
375 (reestablish_1, reestablish_2, as_resp, bs_resp)
378 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
379 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
380 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
382 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
383 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
384 assert_eq!(reestablish_1.len(), 1);
385 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
386 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
387 assert_eq!(reestablish_2.len(), 1);
389 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
390 check_added_monitors!(nodes[0], 0);
391 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
392 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
393 check_added_monitors!(nodes[1], 0);
394 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
396 assert!(as_resp.0.is_none());
397 assert!(bs_resp.0.is_none());
399 assert!(bs_resp.1.is_none());
400 if (disconnect_count & 16) == 0 {
401 assert!(bs_resp.2.is_none());
403 assert!(as_resp.1.is_some());
404 assert!(as_resp.2.is_some());
405 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
407 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
408 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
409 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
410 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
411 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
412 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
414 assert!(as_resp.1.is_none());
416 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
417 let events_3 = nodes[0].node.get_and_clear_pending_events();
418 assert_eq!(events_3.len(), 1);
420 Event::PaymentSent { ref payment_preimage } => {
421 assert_eq!(*payment_preimage, payment_preimage_1);
423 _ => panic!("Unexpected event"),
426 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
427 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
428 // No commitment_signed so get_event_msg's assert(len == 1) passes
429 check_added_monitors!(nodes[0], 1);
431 as_resp.1 = Some(as_resp_raa);
435 if disconnect_count & !disconnect_flags > 1 {
436 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
438 if (disconnect_count & 16) == 0 {
439 assert!(reestablish_1 == second_reestablish_1);
440 assert!(reestablish_2 == second_reestablish_2);
442 assert!(as_resp == second_as_resp);
443 assert!(bs_resp == second_bs_resp);
446 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
448 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
449 assert_eq!(events_4.len(), 2);
450 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
451 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
452 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
455 _ => panic!("Unexpected event"),
459 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
461 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
462 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
463 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
464 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
465 check_added_monitors!(nodes[1], 1);
467 if disconnect_count & !disconnect_flags > 2 {
468 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
470 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
471 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
473 assert!(as_resp.2.is_none());
474 assert!(bs_resp.2.is_none());
477 let as_commitment_update;
478 let bs_second_commitment_update;
480 macro_rules! handle_bs_raa { () => {
481 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
482 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
483 assert!(as_commitment_update.update_add_htlcs.is_empty());
484 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
485 assert!(as_commitment_update.update_fail_htlcs.is_empty());
486 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
487 assert!(as_commitment_update.update_fee.is_none());
488 check_added_monitors!(nodes[0], 1);
491 macro_rules! handle_initial_raa { () => {
492 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
493 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
494 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
495 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
496 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
497 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
498 assert!(bs_second_commitment_update.update_fee.is_none());
499 check_added_monitors!(nodes[1], 1);
502 if (disconnect_count & 8) == 0 {
505 if disconnect_count & !disconnect_flags > 3 {
506 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
508 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
509 assert!(bs_resp.1.is_none());
511 assert!(as_resp.2.unwrap() == as_commitment_update);
512 assert!(bs_resp.2.is_none());
514 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
517 handle_initial_raa!();
519 if disconnect_count & !disconnect_flags > 4 {
520 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
522 assert!(as_resp.1.is_none());
523 assert!(bs_resp.1.is_none());
525 assert!(as_resp.2.unwrap() == as_commitment_update);
526 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
529 handle_initial_raa!();
531 if disconnect_count & !disconnect_flags > 3 {
532 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
534 assert!(as_resp.1.is_none());
535 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
537 assert!(as_resp.2.is_none());
538 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
540 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
545 if disconnect_count & !disconnect_flags > 4 {
546 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
548 assert!(as_resp.1.is_none());
549 assert!(bs_resp.1.is_none());
551 assert!(as_resp.2.unwrap() == as_commitment_update);
552 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
556 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
557 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
558 // No commitment_signed so get_event_msg's assert(len == 1) passes
559 check_added_monitors!(nodes[0], 1);
561 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
562 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
563 // No commitment_signed so get_event_msg's assert(len == 1) passes
564 check_added_monitors!(nodes[1], 1);
566 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
567 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
568 check_added_monitors!(nodes[1], 1);
570 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
571 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
572 check_added_monitors!(nodes[0], 1);
574 expect_pending_htlcs_forwardable!(nodes[1]);
576 let events_5 = nodes[1].node.get_and_clear_pending_events();
577 assert_eq!(events_5.len(), 1);
579 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
580 assert_eq!(payment_hash_2, *payment_hash);
581 assert_eq!(*payment_secret, None);
582 assert_eq!(amt, 1000000);
584 _ => panic!("Unexpected event"),
587 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
591 fn test_monitor_temporary_update_fail_a() {
592 do_test_monitor_temporary_update_fail(0);
593 do_test_monitor_temporary_update_fail(1);
594 do_test_monitor_temporary_update_fail(2);
595 do_test_monitor_temporary_update_fail(3);
596 do_test_monitor_temporary_update_fail(4);
597 do_test_monitor_temporary_update_fail(5);
601 fn test_monitor_temporary_update_fail_b() {
602 do_test_monitor_temporary_update_fail(2 | 8);
603 do_test_monitor_temporary_update_fail(3 | 8);
604 do_test_monitor_temporary_update_fail(4 | 8);
605 do_test_monitor_temporary_update_fail(5 | 8);
609 fn test_monitor_temporary_update_fail_c() {
610 do_test_monitor_temporary_update_fail(1 | 16);
611 do_test_monitor_temporary_update_fail(2 | 16);
612 do_test_monitor_temporary_update_fail(3 | 16);
613 do_test_monitor_temporary_update_fail(2 | 8 | 16);
614 do_test_monitor_temporary_update_fail(3 | 8 | 16);
618 fn test_monitor_update_fail_cs() {
619 // Tests handling of a monitor update failure when processing an incoming commitment_signed
620 let chanmon_cfgs = create_chanmon_cfgs(2);
621 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
622 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
623 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
624 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
625 let logger = test_utils::TestLogger::new();
627 let (payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
629 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
630 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
631 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
632 check_added_monitors!(nodes[0], 1);
635 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
636 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
638 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
639 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
640 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
641 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
642 check_added_monitors!(nodes[1], 1);
643 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
645 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
646 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
647 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
648 check_added_monitors!(nodes[1], 0);
649 let responses = nodes[1].node.get_and_clear_pending_msg_events();
650 assert_eq!(responses.len(), 2);
653 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
654 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
655 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
656 check_added_monitors!(nodes[0], 1);
658 _ => panic!("Unexpected event"),
661 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
662 assert!(updates.update_add_htlcs.is_empty());
663 assert!(updates.update_fulfill_htlcs.is_empty());
664 assert!(updates.update_fail_htlcs.is_empty());
665 assert!(updates.update_fail_malformed_htlcs.is_empty());
666 assert!(updates.update_fee.is_none());
667 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
669 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
670 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
671 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
672 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
673 check_added_monitors!(nodes[0], 1);
674 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
676 _ => panic!("Unexpected event"),
679 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
680 let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
681 nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
682 check_added_monitors!(nodes[0], 0);
684 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
685 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
686 check_added_monitors!(nodes[1], 1);
688 expect_pending_htlcs_forwardable!(nodes[1]);
690 let events = nodes[1].node.get_and_clear_pending_events();
691 assert_eq!(events.len(), 1);
693 Event::PaymentReceived { payment_hash, payment_secret, amt } => {
694 assert_eq!(payment_hash, our_payment_hash);
695 assert_eq!(payment_secret, None);
696 assert_eq!(amt, 1000000);
698 _ => panic!("Unexpected event"),
701 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
705 fn test_monitor_update_fail_no_rebroadcast() {
706 // Tests handling of a monitor update failure when no message rebroadcasting on
707 // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
709 let chanmon_cfgs = create_chanmon_cfgs(2);
710 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
711 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
712 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
713 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
714 let logger = test_utils::TestLogger::new();
716 let (payment_preimage_1, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
718 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
719 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
720 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
721 check_added_monitors!(nodes[0], 1);
724 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
725 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
726 let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
728 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
729 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
730 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
731 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
732 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
733 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
734 check_added_monitors!(nodes[1], 1);
736 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
737 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
738 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
739 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
740 check_added_monitors!(nodes[1], 0);
741 expect_pending_htlcs_forwardable!(nodes[1]);
743 let events = nodes[1].node.get_and_clear_pending_events();
744 assert_eq!(events.len(), 1);
746 Event::PaymentReceived { payment_hash, .. } => {
747 assert_eq!(payment_hash, our_payment_hash);
749 _ => panic!("Unexpected event"),
752 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1, 1_000_000);
756 fn test_monitor_update_raa_while_paused() {
757 // Tests handling of an RAA while monitor updating has already been marked failed.
758 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
759 let chanmon_cfgs = create_chanmon_cfgs(2);
760 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
761 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
762 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
763 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
764 let logger = test_utils::TestLogger::new();
766 send_payment(&nodes[0], &[&nodes[1]], 5000000, 5_000_000);
767 let (payment_preimage_1, our_payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
769 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
770 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
771 nodes[0].node.send_payment(&route, our_payment_hash_1, &None).unwrap();
772 check_added_monitors!(nodes[0], 1);
774 let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
776 let (payment_preimage_2, our_payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
778 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
779 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
780 nodes[1].node.send_payment(&route, our_payment_hash_2, &None).unwrap();
781 check_added_monitors!(nodes[1], 1);
783 let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
785 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
786 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
787 check_added_monitors!(nodes[1], 1);
788 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
790 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
791 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
792 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
793 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
794 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
795 check_added_monitors!(nodes[0], 1);
797 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
798 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
799 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented responses to RAA".to_string(), 1);
800 check_added_monitors!(nodes[0], 1);
802 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
803 let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
804 nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
805 check_added_monitors!(nodes[0], 0);
807 let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
808 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
809 check_added_monitors!(nodes[1], 1);
810 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
812 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
813 check_added_monitors!(nodes[1], 1);
814 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
816 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
817 check_added_monitors!(nodes[0], 1);
818 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
820 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
821 check_added_monitors!(nodes[0], 1);
822 expect_pending_htlcs_forwardable!(nodes[0]);
823 expect_payment_received!(nodes[0], our_payment_hash_2, 1000000);
825 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
826 check_added_monitors!(nodes[1], 1);
827 expect_pending_htlcs_forwardable!(nodes[1]);
828 expect_payment_received!(nodes[1], our_payment_hash_1, 1000000);
830 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1, 1_000_000);
831 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2, 1_000_000);
834 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
835 // Tests handling of a monitor update failure when processing an incoming RAA
836 let chanmon_cfgs = create_chanmon_cfgs(3);
837 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
838 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
839 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
840 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
841 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
842 let logger = test_utils::TestLogger::new();
844 // Rebalance a bit so that we can send backwards from 2 to 1.
845 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000, 5_000_000);
847 // Route a first payment that we'll fail backwards
848 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
850 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
851 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1, &None));
852 expect_pending_htlcs_forwardable!(nodes[2]);
853 check_added_monitors!(nodes[2], 1);
855 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
856 assert!(updates.update_add_htlcs.is_empty());
857 assert!(updates.update_fulfill_htlcs.is_empty());
858 assert_eq!(updates.update_fail_htlcs.len(), 1);
859 assert!(updates.update_fail_malformed_htlcs.is_empty());
860 assert!(updates.update_fee.is_none());
861 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
863 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
864 check_added_monitors!(nodes[0], 0);
866 // While the second channel is AwaitingRAA, forward a second payment to get it into the
868 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
870 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
871 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
872 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
873 check_added_monitors!(nodes[0], 1);
876 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
877 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
878 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
880 expect_pending_htlcs_forwardable!(nodes[1]);
881 check_added_monitors!(nodes[1], 0);
882 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
884 // Now fail monitor updating.
885 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
886 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
887 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
888 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
889 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
890 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
891 check_added_monitors!(nodes[1], 1);
893 // Attempt to forward a third payment but fail due to the second channel being unavailable
895 let (_, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
897 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
898 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
899 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
900 check_added_monitors!(nodes[0], 1);
903 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(())); // We succeed in updating the monitor for the first channel
904 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
905 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
906 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
907 check_added_monitors!(nodes[1], 0);
909 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
910 assert_eq!(events_2.len(), 1);
911 match events_2.remove(0) {
912 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
913 assert_eq!(node_id, nodes[0].node.get_our_node_id());
914 assert!(updates.update_fulfill_htlcs.is_empty());
915 assert_eq!(updates.update_fail_htlcs.len(), 1);
916 assert!(updates.update_fail_malformed_htlcs.is_empty());
917 assert!(updates.update_add_htlcs.is_empty());
918 assert!(updates.update_fee.is_none());
920 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
921 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false, true);
923 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
924 assert_eq!(msg_events.len(), 1);
925 match msg_events[0] {
926 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
927 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
928 assert_eq!(msg.contents.flags & 2, 2); // temp disabled
930 _ => panic!("Unexpected event"),
933 let events = nodes[0].node.get_and_clear_pending_events();
934 assert_eq!(events.len(), 1);
935 if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events[0] {
936 assert_eq!(payment_hash, payment_hash_3);
937 assert!(!rejected_by_dest);
938 } else { panic!("Unexpected event!"); }
940 _ => panic!("Unexpected event type!"),
943 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
944 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
945 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[0]);
946 let net_graph_msg_handler = &nodes[2].net_graph_msg_handler;
947 let route = get_route(&nodes[2].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
948 nodes[2].node.send_payment(&route, payment_hash_4, &None).unwrap();
949 check_added_monitors!(nodes[2], 1);
951 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
952 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
953 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
954 check_added_monitors!(nodes[1], 1);
955 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
956 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
957 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
958 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
959 (Some(payment_preimage_4), Some(payment_hash_4))
960 } else { (None, None) };
962 // Restore monitor updating, ensuring we immediately get a fail-back update and a
963 // update_add update.
964 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
965 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
966 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
967 check_added_monitors!(nodes[1], 0);
968 expect_pending_htlcs_forwardable!(nodes[1]);
969 check_added_monitors!(nodes[1], 1);
971 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
972 if test_ignore_second_cs {
973 assert_eq!(events_3.len(), 3);
975 assert_eq!(events_3.len(), 2);
978 // Note that the ordering of the events for different nodes is non-prescriptive, though the
979 // ordering of the two events that both go to nodes[2] have to stay in the same order.
980 let messages_a = match events_3.pop().unwrap() {
981 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
982 assert_eq!(node_id, nodes[0].node.get_our_node_id());
983 assert!(updates.update_fulfill_htlcs.is_empty());
984 assert_eq!(updates.update_fail_htlcs.len(), 1);
985 assert!(updates.update_fail_malformed_htlcs.is_empty());
986 assert!(updates.update_add_htlcs.is_empty());
987 assert!(updates.update_fee.is_none());
988 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
990 _ => panic!("Unexpected event type!"),
992 let raa = if test_ignore_second_cs {
993 match events_3.remove(1) {
994 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
995 assert_eq!(node_id, nodes[2].node.get_our_node_id());
998 _ => panic!("Unexpected event"),
1001 let send_event_b = SendEvent::from_event(events_3.remove(0));
1002 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
1004 // Now deliver the new messages...
1006 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
1007 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
1008 let events_4 = nodes[0].node.get_and_clear_pending_events();
1009 assert_eq!(events_4.len(), 1);
1010 if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events_4[0] {
1011 assert_eq!(payment_hash, payment_hash_1);
1012 assert!(rejected_by_dest);
1013 } else { panic!("Unexpected event!"); }
1015 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
1016 if test_ignore_second_cs {
1017 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
1018 check_added_monitors!(nodes[2], 1);
1019 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1020 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
1021 check_added_monitors!(nodes[2], 1);
1022 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1023 assert!(bs_cs.update_add_htlcs.is_empty());
1024 assert!(bs_cs.update_fail_htlcs.is_empty());
1025 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
1026 assert!(bs_cs.update_fulfill_htlcs.is_empty());
1027 assert!(bs_cs.update_fee.is_none());
1029 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1030 check_added_monitors!(nodes[1], 1);
1031 let as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1032 assert!(as_cs.update_add_htlcs.is_empty());
1033 assert!(as_cs.update_fail_htlcs.is_empty());
1034 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1035 assert!(as_cs.update_fulfill_htlcs.is_empty());
1036 assert!(as_cs.update_fee.is_none());
1038 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
1039 check_added_monitors!(nodes[1], 1);
1040 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1042 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1043 check_added_monitors!(nodes[2], 1);
1044 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1046 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1047 check_added_monitors!(nodes[2], 1);
1048 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1050 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1051 check_added_monitors!(nodes[1], 1);
1052 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1054 commitment_signed_dance!(nodes[2], nodes[1], send_event_b.commitment_msg, false);
1057 expect_pending_htlcs_forwardable!(nodes[2]);
1059 let events_6 = nodes[2].node.get_and_clear_pending_events();
1060 assert_eq!(events_6.len(), 1);
1062 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1063 _ => panic!("Unexpected event"),
1066 if test_ignore_second_cs {
1067 expect_pending_htlcs_forwardable!(nodes[1]);
1068 check_added_monitors!(nodes[1], 1);
1070 send_event = SendEvent::from_node(&nodes[1]);
1071 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1072 assert_eq!(send_event.msgs.len(), 1);
1073 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1074 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1076 expect_pending_htlcs_forwardable!(nodes[0]);
1078 let events_9 = nodes[0].node.get_and_clear_pending_events();
1079 assert_eq!(events_9.len(), 1);
1081 Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1082 _ => panic!("Unexpected event"),
1084 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap(), 1_000_000);
1087 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2, 1_000_000);
1091 fn test_monitor_update_fail_raa() {
1092 do_test_monitor_update_fail_raa(false);
1093 do_test_monitor_update_fail_raa(true);
1097 fn test_monitor_update_fail_reestablish() {
1098 // Simple test for message retransmission after monitor update failure on
1099 // channel_reestablish generating a monitor update (which comes from freeing holding cell
1101 let chanmon_cfgs = create_chanmon_cfgs(3);
1102 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1103 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1104 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1105 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1106 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1108 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1110 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1111 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1113 assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 1_000_000));
1114 check_added_monitors!(nodes[2], 1);
1115 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1116 assert!(updates.update_add_htlcs.is_empty());
1117 assert!(updates.update_fail_htlcs.is_empty());
1118 assert!(updates.update_fail_malformed_htlcs.is_empty());
1119 assert!(updates.update_fee.is_none());
1120 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1121 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1122 check_added_monitors!(nodes[1], 1);
1123 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1124 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1126 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1127 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1128 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1130 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1131 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1133 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1135 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1136 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1137 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1138 check_added_monitors!(nodes[1], 1);
1140 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1141 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1143 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1144 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1146 assert!(as_reestablish == get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id()));
1147 assert!(bs_reestablish == get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()));
1149 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1151 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1152 check_added_monitors!(nodes[1], 0);
1153 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1155 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1156 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1157 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1158 check_added_monitors!(nodes[1], 0);
1160 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1161 assert!(updates.update_add_htlcs.is_empty());
1162 assert!(updates.update_fail_htlcs.is_empty());
1163 assert!(updates.update_fail_malformed_htlcs.is_empty());
1164 assert!(updates.update_fee.is_none());
1165 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1166 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1167 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1169 let events = nodes[0].node.get_and_clear_pending_events();
1170 assert_eq!(events.len(), 1);
1172 Event::PaymentSent { payment_preimage, .. } => assert_eq!(payment_preimage, our_payment_preimage),
1173 _ => panic!("Unexpected event"),
1178 fn raa_no_response_awaiting_raa_state() {
1179 // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1180 // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1181 // in question (assuming it intends to respond with a CS after monitor updating is restored).
1182 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1183 let chanmon_cfgs = create_chanmon_cfgs(2);
1184 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1185 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1186 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1187 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1188 let logger = test_utils::TestLogger::new();
1190 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1191 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1192 let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1194 // Queue up two payments - one will be delivered right away, one immediately goes into the
1195 // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1196 // immediately after a CS. By setting failing the monitor update failure from the CS (which
1197 // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1198 // generation during RAA while in monitor-update-failed state.
1200 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1201 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1202 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
1203 check_added_monitors!(nodes[0], 1);
1204 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1205 check_added_monitors!(nodes[0], 0);
1208 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1209 assert_eq!(events.len(), 1);
1210 let payment_event = SendEvent::from_event(events.pop().unwrap());
1211 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1212 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1213 check_added_monitors!(nodes[1], 1);
1215 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1216 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1217 check_added_monitors!(nodes[0], 1);
1218 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1219 assert_eq!(events.len(), 1);
1220 let payment_event = SendEvent::from_event(events.pop().unwrap());
1222 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1223 check_added_monitors!(nodes[0], 1);
1224 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1226 // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1227 // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1228 // then restore channel monitor updates.
1229 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1230 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1231 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1232 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1233 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1234 check_added_monitors!(nodes[1], 1);
1236 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1237 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1238 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented responses to RAA".to_string(), 1);
1239 check_added_monitors!(nodes[1], 1);
1241 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1242 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1243 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1244 // nodes[1] should be AwaitingRAA here!
1245 check_added_monitors!(nodes[1], 0);
1246 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1247 expect_pending_htlcs_forwardable!(nodes[1]);
1248 expect_payment_received!(nodes[1], payment_hash_1, 1000000);
1250 // We send a third payment here, which is somewhat of a redundant test, but the
1251 // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1252 // commitment transaction states) whereas here we can explicitly check for it.
1254 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1255 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1256 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
1257 check_added_monitors!(nodes[0], 0);
1258 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1260 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1261 check_added_monitors!(nodes[0], 1);
1262 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1263 assert_eq!(events.len(), 1);
1264 let payment_event = SendEvent::from_event(events.pop().unwrap());
1266 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1267 check_added_monitors!(nodes[0], 1);
1268 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1270 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1271 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1272 check_added_monitors!(nodes[1], 1);
1273 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1275 // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1276 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1277 check_added_monitors!(nodes[1], 1);
1278 expect_pending_htlcs_forwardable!(nodes[1]);
1279 expect_payment_received!(nodes[1], payment_hash_2, 1000000);
1280 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1282 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1283 check_added_monitors!(nodes[0], 1);
1285 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1286 check_added_monitors!(nodes[0], 1);
1287 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1289 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1290 check_added_monitors!(nodes[1], 1);
1291 expect_pending_htlcs_forwardable!(nodes[1]);
1292 expect_payment_received!(nodes[1], payment_hash_3, 1000000);
1294 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1, 1_000_000);
1295 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
1296 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 1_000_000);
1300 fn claim_while_disconnected_monitor_update_fail() {
1301 // Test for claiming a payment while disconnected and then having the resulting
1302 // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1303 // contrived case for nodes with network instability.
1304 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1305 // code introduced a regression in this test (specifically, this caught a removal of the
1306 // channel_reestablish handling ensuring the order was sensical given the messages used).
1307 let chanmon_cfgs = create_chanmon_cfgs(2);
1308 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1309 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1310 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1311 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1312 let logger = test_utils::TestLogger::new();
1314 // Forward a payment for B to claim
1315 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1317 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1318 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1320 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
1321 check_added_monitors!(nodes[1], 1);
1323 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1324 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1326 let as_reconnect = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1327 let bs_reconnect = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1329 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1330 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1332 // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1334 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1336 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1337 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1338 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1339 check_added_monitors!(nodes[1], 1);
1340 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1342 // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1343 // the monitor still failed
1344 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1346 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1347 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1348 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1349 check_added_monitors!(nodes[0], 1);
1352 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1353 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1354 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1355 check_added_monitors!(nodes[1], 1);
1356 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1357 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1358 // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1359 // until we've channel_monitor_update'd and updated for the new commitment transaction.
1361 // Now un-fail the monitor, which will result in B sending its original commitment update,
1362 // receiving the commitment update from A, and the resulting commitment dances.
1363 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1364 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1365 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1366 check_added_monitors!(nodes[1], 0);
1368 let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1369 assert_eq!(bs_msgs.len(), 2);
1372 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1373 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1374 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1375 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1376 check_added_monitors!(nodes[0], 1);
1378 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1379 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1380 check_added_monitors!(nodes[1], 1);
1382 _ => panic!("Unexpected event"),
1386 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1387 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1388 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1389 check_added_monitors!(nodes[0], 1);
1391 _ => panic!("Unexpected event"),
1394 let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1396 let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1397 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1398 check_added_monitors!(nodes[0], 1);
1399 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1401 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1402 check_added_monitors!(nodes[1], 1);
1403 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1404 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1405 check_added_monitors!(nodes[1], 1);
1407 expect_pending_htlcs_forwardable!(nodes[1]);
1408 expect_payment_received!(nodes[1], payment_hash_2, 1000000);
1410 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1411 check_added_monitors!(nodes[0], 1);
1413 let events = nodes[0].node.get_and_clear_pending_events();
1414 assert_eq!(events.len(), 1);
1416 Event::PaymentSent { ref payment_preimage } => {
1417 assert_eq!(*payment_preimage, payment_preimage_1);
1419 _ => panic!("Unexpected event"),
1422 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
1426 fn monitor_failed_no_reestablish_response() {
1427 // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1428 // response to a commitment_signed.
1429 // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1430 // debug_assert!() failure in channel_reestablish handling.
1431 let chanmon_cfgs = create_chanmon_cfgs(2);
1432 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1433 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1434 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1435 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1436 let logger = test_utils::TestLogger::new();
1438 // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1440 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1442 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1443 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1444 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
1445 check_added_monitors!(nodes[0], 1);
1448 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1449 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1450 assert_eq!(events.len(), 1);
1451 let payment_event = SendEvent::from_event(events.pop().unwrap());
1452 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1453 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1454 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1455 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1456 check_added_monitors!(nodes[1], 1);
1458 // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1459 // is still failing to update monitors.
1460 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1461 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1463 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1464 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1466 let as_reconnect = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1467 let bs_reconnect = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1469 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1470 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1472 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1473 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1474 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1475 check_added_monitors!(nodes[1], 0);
1476 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1478 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1479 check_added_monitors!(nodes[0], 1);
1480 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1481 check_added_monitors!(nodes[0], 1);
1483 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1484 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1485 check_added_monitors!(nodes[1], 1);
1487 expect_pending_htlcs_forwardable!(nodes[1]);
1488 expect_payment_received!(nodes[1], payment_hash_1, 1000000);
1490 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1, 1_000_000);
1494 fn first_message_on_recv_ordering() {
1495 // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1496 // messages, we're willing to flip the order of response messages if neccessary in resposne to
1497 // a commitment_signed which needs to send an RAA first.
1498 // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1499 // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1500 // response. To do this, we start routing two payments, with the final RAA for the first being
1501 // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1502 // have no pending response but will want to send a RAA/CS (with the updates for the second
1503 // payment applied).
1504 // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1505 let chanmon_cfgs = create_chanmon_cfgs(2);
1506 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1507 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1508 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1509 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1510 let logger = test_utils::TestLogger::new();
1512 // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1513 // can deliver it and fail the monitor update.
1514 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1516 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1517 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1518 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
1519 check_added_monitors!(nodes[0], 1);
1522 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1523 assert_eq!(events.len(), 1);
1524 let payment_event = SendEvent::from_event(events.pop().unwrap());
1525 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1526 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1527 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1528 check_added_monitors!(nodes[1], 1);
1529 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1531 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1532 check_added_monitors!(nodes[0], 1);
1533 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1534 check_added_monitors!(nodes[0], 1);
1536 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1538 // Route the second payment, generating an update_add_htlc/commitment_signed
1539 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1541 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1542 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1543 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1544 check_added_monitors!(nodes[0], 1);
1546 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1547 assert_eq!(events.len(), 1);
1548 let payment_event = SendEvent::from_event(events.pop().unwrap());
1549 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1551 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1553 // Deliver the final RAA for the first payment, which does not require a response. RAAs
1554 // generally require a commitment_signed, so the fact that we're expecting an opposite response
1555 // to the next message also tests resetting the delivery order.
1556 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1557 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1558 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1559 check_added_monitors!(nodes[1], 1);
1561 // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1562 // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1563 // appropriate HTLC acceptance).
1564 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1565 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1566 check_added_monitors!(nodes[1], 1);
1567 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1568 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1570 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1571 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1572 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1573 check_added_monitors!(nodes[1], 0);
1575 expect_pending_htlcs_forwardable!(nodes[1]);
1576 expect_payment_received!(nodes[1], payment_hash_1, 1000000);
1578 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1579 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1580 check_added_monitors!(nodes[0], 1);
1581 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1582 check_added_monitors!(nodes[0], 1);
1584 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1585 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1586 check_added_monitors!(nodes[1], 1);
1588 expect_pending_htlcs_forwardable!(nodes[1]);
1589 expect_payment_received!(nodes[1], payment_hash_2, 1000000);
1591 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1, 1_000_000);
1592 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
1596 fn test_monitor_update_fail_claim() {
1597 // Basic test for monitor update failures when processing claim_funds calls.
1598 // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1599 // update to claim the payment. We then send a payment C->B->A, making the forward of this
1600 // payment from B to A fail due to the paused channel. Finally, we restore the channel monitor
1601 // updating and claim the payment on B.
1602 let chanmon_cfgs = create_chanmon_cfgs(3);
1603 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1604 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1605 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1606 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1607 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1608 let logger = test_utils::TestLogger::new();
1610 // Rebalance a bit so that we can send backwards from 3 to 2.
1611 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000, 5_000_000);
1613 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1615 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1616 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
1617 check_added_monitors!(nodes[1], 1);
1619 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1621 let net_graph_msg_handler = &nodes[2].net_graph_msg_handler;
1622 let route = get_route(&nodes[2].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1623 nodes[2].node.send_payment(&route, payment_hash_2, &None).unwrap();
1624 check_added_monitors!(nodes[2], 1);
1627 // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1628 // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1629 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1631 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1632 assert_eq!(events.len(), 1);
1633 let payment_event = SendEvent::from_event(events.pop().unwrap());
1634 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1635 let events = nodes[1].node.get_and_clear_pending_msg_events();
1636 assert_eq!(events.len(), 0);
1637 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1638 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1640 let bs_fail_update = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1641 nodes[2].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_update.update_fail_htlcs[0]);
1642 commitment_signed_dance!(nodes[2], nodes[1], bs_fail_update.commitment_signed, false, true);
1644 let msg_events = nodes[2].node.get_and_clear_pending_msg_events();
1645 assert_eq!(msg_events.len(), 1);
1646 match msg_events[0] {
1647 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1648 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
1649 assert_eq!(msg.contents.flags & 2, 2); // temp disabled
1651 _ => panic!("Unexpected event"),
1654 let events = nodes[2].node.get_and_clear_pending_events();
1655 assert_eq!(events.len(), 1);
1656 if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events[0] {
1657 assert_eq!(payment_hash, payment_hash_2);
1658 assert!(!rejected_by_dest);
1659 } else { panic!("Unexpected event!"); }
1661 // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1662 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1663 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1664 check_added_monitors!(nodes[1], 0);
1666 let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1667 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1668 commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1670 let events = nodes[0].node.get_and_clear_pending_events();
1671 assert_eq!(events.len(), 1);
1672 if let Event::PaymentSent { payment_preimage, .. } = events[0] {
1673 assert_eq!(payment_preimage, payment_preimage_1);
1674 } else { panic!("Unexpected event!"); }
1678 fn test_monitor_update_on_pending_forwards() {
1679 // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1680 // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1681 // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1682 // from C to A will be pending a forward to A.
1683 let chanmon_cfgs = create_chanmon_cfgs(3);
1684 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1685 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1686 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1687 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1688 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1689 let logger = test_utils::TestLogger::new();
1691 // Rebalance a bit so that we can send backwards from 3 to 1.
1692 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000, 5_000_000);
1694 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1695 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1, &None));
1696 expect_pending_htlcs_forwardable!(nodes[2]);
1697 check_added_monitors!(nodes[2], 1);
1699 let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1700 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1701 commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1702 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1704 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1706 let net_graph_msg_handler = &nodes[2].net_graph_msg_handler;
1707 let route = get_route(&nodes[2].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1708 nodes[2].node.send_payment(&route, payment_hash_2, &None).unwrap();
1709 check_added_monitors!(nodes[2], 1);
1712 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1713 assert_eq!(events.len(), 1);
1714 let payment_event = SendEvent::from_event(events.pop().unwrap());
1715 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1716 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1718 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1719 expect_pending_htlcs_forwardable!(nodes[1]);
1720 check_added_monitors!(nodes[1], 1);
1721 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1722 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1724 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1725 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1726 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1727 check_added_monitors!(nodes[1], 0);
1729 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1730 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1731 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1732 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1734 let events = nodes[0].node.get_and_clear_pending_events();
1735 assert_eq!(events.len(), 2);
1736 if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events[0] {
1737 assert_eq!(payment_hash, payment_hash_1);
1738 assert!(rejected_by_dest);
1739 } else { panic!("Unexpected event!"); }
1741 Event::PendingHTLCsForwardable { .. } => { },
1742 _ => panic!("Unexpected event"),
1744 nodes[0].node.process_pending_htlc_forwards();
1745 expect_payment_received!(nodes[0], payment_hash_2, 1000000);
1747 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2, 1_000_000);
1751 fn monitor_update_claim_fail_no_response() {
1752 // Test for claim_funds resulting in both a monitor update failure and no message response (due
1753 // to channel being AwaitingRAA).
1754 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1756 let chanmon_cfgs = create_chanmon_cfgs(2);
1757 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1758 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1759 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1760 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1761 let logger = test_utils::TestLogger::new();
1763 // Forward a payment for B to claim
1764 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1766 // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1767 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1769 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1770 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1771 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1772 check_added_monitors!(nodes[0], 1);
1775 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1776 assert_eq!(events.len(), 1);
1777 let payment_event = SendEvent::from_event(events.pop().unwrap());
1778 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1779 let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1781 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1782 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
1783 check_added_monitors!(nodes[1], 1);
1784 let events = nodes[1].node.get_and_clear_pending_msg_events();
1785 assert_eq!(events.len(), 0);
1786 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1788 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1789 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1790 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1791 check_added_monitors!(nodes[1], 0);
1792 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1794 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1795 check_added_monitors!(nodes[1], 1);
1796 expect_pending_htlcs_forwardable!(nodes[1]);
1797 expect_payment_received!(nodes[1], payment_hash_2, 1000000);
1799 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1800 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1801 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1803 let events = nodes[0].node.get_and_clear_pending_events();
1804 assert_eq!(events.len(), 1);
1806 Event::PaymentSent { ref payment_preimage } => {
1807 assert_eq!(*payment_preimage, payment_preimage_1);
1809 _ => panic!("Unexpected event"),
1812 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
1815 // confirm_a_first and restore_b_before_conf are wholly unrelated to earlier bools and
1816 // restore_b_before_conf has no meaning if !confirm_a_first
1817 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool) {
1818 // Test that if the monitor update generated by funding_transaction_generated fails we continue
1819 // the channel setup happily after the update is restored.
1820 let chanmon_cfgs = create_chanmon_cfgs(2);
1821 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1822 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1823 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1825 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1826 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()));
1827 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()));
1829 let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 43);
1831 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
1832 check_added_monitors!(nodes[0], 0);
1834 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1835 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1836 let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1837 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1838 check_added_monitors!(nodes[1], 1);
1840 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1841 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()));
1842 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1843 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1844 check_added_monitors!(nodes[0], 1);
1845 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1846 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1847 let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1848 nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
1849 check_added_monitors!(nodes[0], 0);
1851 let events = nodes[0].node.get_and_clear_pending_events();
1852 assert_eq!(events.len(), 1);
1854 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
1855 assert_eq!(user_channel_id, 43);
1856 assert_eq!(*funding_txo, funding_output);
1858 _ => panic!("Unexpected event"),
1861 if confirm_a_first {
1862 confirm_transaction(&nodes[0], &funding_tx);
1863 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()));
1865 assert!(!restore_b_before_conf);
1866 confirm_transaction(&nodes[1], &funding_tx);
1867 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1870 // Make sure nodes[1] isn't stupid enough to re-send the FundingLocked on reconnect
1871 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1872 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1873 reconnect_nodes(&nodes[0], &nodes[1], (false, confirm_a_first), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1874 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1875 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1877 if !restore_b_before_conf {
1878 confirm_transaction(&nodes[1], &funding_tx);
1879 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1880 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1883 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1884 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1885 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1886 check_added_monitors!(nodes[1], 0);
1888 let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1889 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()));
1891 confirm_transaction(&nodes[0], &funding_tx);
1892 let (funding_locked, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1893 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked))
1895 if restore_b_before_conf {
1896 confirm_transaction(&nodes[1], &funding_tx);
1898 let (funding_locked, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1899 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &funding_locked))
1901 for node in nodes.iter() {
1902 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
1903 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1904 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1907 send_payment(&nodes[0], &[&nodes[1]], 8000000, 8_000_000);
1908 close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1912 fn during_funding_monitor_fail() {
1913 do_during_funding_monitor_fail(true, true);
1914 do_during_funding_monitor_fail(true, false);
1915 do_during_funding_monitor_fail(false, false);
1919 fn test_path_paused_mpp() {
1920 // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1922 let chanmon_cfgs = create_chanmon_cfgs(4);
1923 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1924 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1925 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1927 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1928 let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
1929 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1930 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1931 let logger = test_utils::TestLogger::new();
1933 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
1934 let payment_secret = PaymentSecret([0xdb; 32]);
1935 let mut route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
1937 // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1938 let path = route.paths[0].clone();
1939 route.paths.push(path);
1940 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
1941 route.paths[0][0].short_channel_id = chan_1_id;
1942 route.paths[0][1].short_channel_id = chan_3_id;
1943 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
1944 route.paths[1][0].short_channel_id = chan_2_ann.contents.short_channel_id;
1945 route.paths[1][1].short_channel_id = chan_4_id;
1947 // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
1948 // (for the path 0 -> 2 -> 3) fails.
1949 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1950 *nodes[0].chain_monitor.next_update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1952 // Now check that we get the right return value, indicating that the first path succeeded but
1953 // the second got a MonitorUpdateFailed err. This implies PaymentSendFailure::PartialFailure as
1954 // some paths succeeded, preventing retry.
1955 if let Err(PaymentSendFailure::PartialFailure(results)) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)) {
1956 assert_eq!(results.len(), 2);
1957 if let Ok(()) = results[0] {} else { panic!(); }
1958 if let Err(APIError::MonitorUpdateFailed) = results[1] {} else { panic!(); }
1959 } else { panic!(); }
1960 check_added_monitors!(nodes[0], 2);
1961 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1963 // Pass the first HTLC of the payment along to nodes[3].
1964 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1965 assert_eq!(events.len(), 1);
1966 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false);
1968 // And check that, after we successfully update the monitor for chan_2 we can pass the second
1969 // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
1970 let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
1971 nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
1972 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1973 assert_eq!(events.len(), 1);
1974 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true);
1976 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
1979 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
1980 // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
1981 // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
1982 // that behavior was both somewhat unexpected and also broken (there was a debug assertion
1983 // which failed in such a case).
1984 let chanmon_cfgs = create_chanmon_cfgs(2);
1985 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1986 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1987 let persister: test_utils::TestPersister;
1988 let new_chain_monitor: test_utils::TestChainMonitor;
1989 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
1990 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1992 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;
1993 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(&nodes[0]);
1994 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(&nodes[0]);
1996 // Do a really complicated dance to get an HTLC into the holding cell, with MonitorUpdateFailed
1997 // set but AwaitingRemoteRevoke unset. When this test was written, any attempts to send an HTLC
1998 // while MonitorUpdateFailed is set are immediately failed-backwards. Thus, the only way to get
1999 // an AddHTLC into the holding cell is to add it while AwaitingRemoteRevoke is set but
2000 // MonitorUpdateFailed is unset, and then swap the flags.
2003 // a) routing a payment from node B to node A,
2004 // b) sending a payment from node A to node B without delivering any of the generated messages,
2005 // putting node A in AwaitingRemoteRevoke,
2006 // c) sending a second payment from node A to node B, which is immediately placed in the
2008 // d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2009 // when we try to persist the payment preimage,
2010 // e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2011 // clearing AwaitingRemoteRevoke on node A.
2013 // Note that because, at the end, MonitorUpdateFailed is still set, the HTLC generated in (c)
2014 // will not be freed from the holding cell.
2015 let (payment_preimage_0, payment_hash_0) = route_payment(&nodes[1], &[&nodes[0]], 100000);
2018 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2019 get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, nodes[0].logger).unwrap()
2022 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
2023 check_added_monitors!(nodes[0], 1);
2024 let send = SendEvent::from_node(&nodes[0]);
2025 assert_eq!(send.msgs.len(), 1);
2027 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
2028 check_added_monitors!(nodes[0], 0);
2030 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2031 assert!(nodes[0].node.claim_funds(payment_preimage_0, &None, 100000));
2032 check_added_monitors!(nodes[0], 1);
2034 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2035 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2036 check_added_monitors!(nodes[1], 1);
2038 let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2040 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2041 check_added_monitors!(nodes[0], 1);
2044 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2045 // disconnect the peers. Note that the fuzzer originally found this issue because
2046 // deserializing a ChannelManager in this state causes an assertion failure.
2048 let nodes_0_serialized = nodes[0].node.encode();
2049 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
2050 nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
2052 persister = test_utils::TestPersister::new();
2053 let keys_manager = &chanmon_cfgs[0].keys_manager;
2054 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);
2055 nodes[0].chain_monitor = &new_chain_monitor;
2056 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
2057 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
2058 &mut chan_0_monitor_read, keys_manager).unwrap();
2059 assert!(chan_0_monitor_read.is_empty());
2061 let mut nodes_0_read = &nodes_0_serialized[..];
2062 let config = UserConfig::default();
2063 nodes_0_deserialized = {
2064 let mut channel_monitors = HashMap::new();
2065 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
2066 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
2067 default_config: config,
2069 fee_estimator: node_cfgs[0].fee_estimator,
2070 chain_monitor: nodes[0].chain_monitor,
2071 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
2072 logger: nodes[0].logger,
2076 nodes[0].node = &nodes_0_deserialized;
2077 assert!(nodes_0_read.is_empty());
2079 nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0.clone(), chan_0_monitor).unwrap();
2080 check_added_monitors!(nodes[0], 1);
2082 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2084 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2086 // Now reconnect the two
2087 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2088 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2089 assert_eq!(reestablish_1.len(), 1);
2090 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2091 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2092 assert_eq!(reestablish_2.len(), 1);
2094 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2095 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2096 check_added_monitors!(nodes[1], 0);
2098 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2099 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2101 assert!(resp_0.0.is_none());
2102 assert!(resp_0.1.is_none());
2103 assert!(resp_0.2.is_none());
2104 assert!(resp_1.0.is_none());
2105 assert!(resp_1.1.is_none());
2107 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2109 if let Some(pending_cs) = resp_1.2 {
2110 assert!(pending_cs.update_add_htlcs.is_empty());
2111 assert!(pending_cs.update_fail_htlcs.is_empty());
2112 assert!(pending_cs.update_fulfill_htlcs.is_empty());
2113 assert_eq!(pending_cs.commitment_signed, cs);
2114 } else { panic!(); }
2116 // There should be no monitor updates as we are still pending awaiting a failed one.
2117 check_added_monitors!(nodes[0], 0);
2118 check_added_monitors!(nodes[1], 0);
2121 // If we finish updating the monitor, we should free the holding cell right away (this did
2122 // not occur prior to #756).
2123 *nodes[0].chain_monitor.update_ret.lock().unwrap() = None;
2124 let (funding_txo, mon_id) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2125 nodes[0].node.channel_monitor_updated(&funding_txo, mon_id);
2127 // New outbound messages should be generated immediately.
2128 check_added_monitors!(nodes[0], 1);
2129 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2130 assert_eq!(events.len(), 1);
2132 // Deliver the pending in-flight CS
2133 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2134 check_added_monitors!(nodes[0], 1);
2136 let commitment_msg = match events.pop().unwrap() {
2137 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2138 assert!(updates.update_fail_htlcs.is_empty());
2139 assert!(updates.update_fail_malformed_htlcs.is_empty());
2140 assert!(updates.update_fee.is_none());
2141 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2142 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2143 expect_payment_sent!(nodes[1], payment_preimage_0);
2144 assert_eq!(updates.update_add_htlcs.len(), 1);
2145 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2146 updates.commitment_signed
2148 _ => panic!("Unexpected event type!"),
2151 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2152 check_added_monitors!(nodes[1], 1);
2154 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2155 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2156 expect_pending_htlcs_forwardable!(nodes[1]);
2157 expect_payment_received!(nodes[1], payment_hash_1, 100000);
2158 check_added_monitors!(nodes[1], 1);
2160 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
2162 expect_pending_htlcs_forwardable!(nodes[1]);
2163 expect_payment_received!(nodes[1], payment_hash_2, 100000);
2165 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1, 100000);
2166 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 100000);
2169 fn channel_holding_cell_serialize() {
2170 do_channel_holding_cell_serialize(true, true);
2171 do_channel_holding_cell_serialize(true, false);
2172 do_channel_holding_cell_serialize(false, true); // last arg doesn't matter