1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Functional tests which test the correct handling of ChannelMonitorUpdateErr returns from
12 //! There are a bunch of these as their handling is relatively error-prone so they are split out
13 //! here. See also the chanmon_fail_consistency fuzz test.
15 use bitcoin::blockdata::block::{Block, BlockHeader};
16 use bitcoin::blockdata::constants::genesis_block;
17 use bitcoin::hash_types::BlockHash;
18 use bitcoin::network::constants::Network;
19 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr};
20 use chain::transaction::OutPoint;
23 use ln::{PaymentPreimage, PaymentHash};
24 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
25 use ln::features::{InitFeatures, InvoiceFeatures};
27 use ln::msgs::{ChannelMessageHandler, ErrorAction, RoutingMessageHandler};
28 use routing::router::get_route;
29 use util::config::UserConfig;
30 use util::enforcing_trait_impls::EnforcingSigner;
31 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
32 use util::errors::APIError;
33 use util::ser::{ReadableArgs, Writeable};
34 use util::test_utils::TestBroadcaster;
36 use bitcoin::hashes::sha256::Hash as Sha256;
37 use bitcoin::hashes::Hash;
39 use ln::functional_test_utils::*;
44 use std::sync::{Arc, Mutex};
46 // If persister_fail is true, we have the persister return a PermanentFailure
47 // instead of the higher-level ChainMonitor.
48 fn do_test_simple_monitor_permanent_update_fail(persister_fail: bool) {
49 // Test that we handle a simple permanent monitor update failure
50 let mut chanmon_cfgs = create_chanmon_cfgs(2);
51 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
52 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
53 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
54 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
55 let logger = test_utils::TestLogger::new();
57 let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(&nodes[1]);
59 match persister_fail {
60 true => chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::PermanentFailure)),
61 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::PermanentFailure))
63 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
64 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
65 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable {..}, {});
66 check_added_monitors!(nodes[0], 2);
68 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
69 assert_eq!(events_1.len(), 2);
71 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
72 _ => panic!("Unexpected event"),
75 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
76 _ => panic!("Unexpected event"),
79 // TODO: Once we hit the chain with the failure transaction we should check that we get a
80 // PaymentFailed event
82 assert_eq!(nodes[0].node.list_channels().len(), 0);
86 fn test_monitor_and_persister_update_fail() {
87 // Test that if both updating the `ChannelMonitor` and persisting the updated
88 // `ChannelMonitor` fail, then the failure from updating the `ChannelMonitor`
89 // one that gets returned.
90 let chanmon_cfgs = create_chanmon_cfgs(2);
91 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
92 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
93 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
95 // Create some initial channel
96 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
97 let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
99 // Rebalance the network to generate htlc in the two directions
100 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
102 // Route an HTLC from node 0 to node 1 (but don't settle)
103 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
105 // Make a copy of the ChainMonitor so we can capture the error it returns on a
106 // bogus update. Note that if instead we updated the nodes[0]'s ChainMonitor
107 // directly, the node would fail to be `Drop`'d at the end because its
108 // ChannelManager and ChainMonitor would be out of sync.
109 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
110 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
111 let persister = test_utils::TestPersister::new();
112 let tx_broadcaster = TestBroadcaster {
113 txn_broadcasted: Mutex::new(Vec::new()),
114 // Because we will connect a block at height 200 below, we need the TestBroadcaster to know
115 // that we are at height 200 so that it doesn't think we're violating the time lock
116 // requirements of transactions broadcasted at that point.
117 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 200); 200])),
120 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
121 let monitor = monitors.get(&outpoint).unwrap();
122 let mut w = test_utils::TestVecWriter(Vec::new());
123 monitor.write(&mut w).unwrap();
124 let new_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
125 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
126 assert!(new_monitor == *monitor);
127 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
128 assert!(chain_mon.watch_channel(outpoint, new_monitor).is_ok());
131 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
132 chain_mon.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
134 // Set the persister's return value to be a TemporaryFailure.
135 persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
137 // Try to update ChannelMonitor
138 assert!(nodes[1].node.claim_funds(preimage));
139 check_added_monitors!(nodes[1], 1);
140 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
141 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
142 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
143 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2) {
144 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
145 // Check that even though the persister is returning a TemporaryFailure,
146 // because the update is bogus, ultimately the error that's returned
147 // should be a PermanentFailure.
148 if let Err(ChannelMonitorUpdateErr::PermanentFailure) = chain_mon.chain_monitor.update_channel(outpoint, update.clone()) {} else { panic!("Expected monitor error to be permanent"); }
149 logger.assert_log_contains("lightning::chain::chainmonitor".to_string(), "Failed to persist channel monitor update: TemporaryFailure".to_string(), 1);
150 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
151 } else { assert!(false); }
152 } else { assert!(false); };
154 check_added_monitors!(nodes[0], 1);
155 let events = nodes[0].node.get_and_clear_pending_events();
156 assert_eq!(events.len(), 1);
160 fn test_simple_monitor_permanent_update_fail() {
161 do_test_simple_monitor_permanent_update_fail(false);
163 // Test behavior when the persister returns a PermanentFailure.
164 do_test_simple_monitor_permanent_update_fail(true);
167 // If persister_fail is true, we have the persister return a TemporaryFailure instead of the
168 // higher-level ChainMonitor.
169 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool, persister_fail: bool) {
170 // Test that we can recover from a simple temporary monitor update failure optionally with
171 // a disconnect in between
172 let mut chanmon_cfgs = create_chanmon_cfgs(2);
173 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
174 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
175 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
176 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
177 let logger = test_utils::TestLogger::new();
179 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(&nodes[1]);
181 match persister_fail {
182 true => chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure)),
183 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure))
187 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
188 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
189 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), false, APIError::MonitorUpdateFailed, {});
190 check_added_monitors!(nodes[0], 1);
193 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
194 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
195 assert_eq!(nodes[0].node.list_channels().len(), 1);
198 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
199 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
200 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
203 match persister_fail {
204 true => chanmon_cfgs[0].persister.set_update_ret(Ok(())),
205 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()))
207 let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
208 nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
209 check_added_monitors!(nodes[0], 0);
211 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
212 assert_eq!(events_2.len(), 1);
213 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
214 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
215 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
216 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
218 expect_pending_htlcs_forwardable!(nodes[1]);
220 let events_3 = nodes[1].node.get_and_clear_pending_events();
221 assert_eq!(events_3.len(), 1);
223 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
224 assert_eq!(payment_hash_1, *payment_hash);
225 assert!(payment_preimage.is_none());
226 assert_eq!(payment_secret_1, *payment_secret);
227 assert_eq!(amt, 1000000);
229 _ => panic!("Unexpected event"),
232 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
234 // Now set it to failed again...
235 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
237 match persister_fail {
238 true => chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure)),
239 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure))
241 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
242 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
243 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)), false, APIError::MonitorUpdateFailed, {});
244 check_added_monitors!(nodes[0], 1);
247 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
248 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
249 assert_eq!(nodes[0].node.list_channels().len(), 1);
252 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
253 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
254 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
257 // ...and make sure we can force-close a frozen channel
258 nodes[0].node.force_close_channel(&channel_id).unwrap();
259 check_added_monitors!(nodes[0], 1);
260 check_closed_broadcast!(nodes[0], true);
262 // TODO: Once we hit the chain with the failure transaction we should check that we get a
263 // PaymentFailed event
265 assert_eq!(nodes[0].node.list_channels().len(), 0);
269 fn test_simple_monitor_temporary_update_fail() {
270 do_test_simple_monitor_temporary_update_fail(false, false);
271 do_test_simple_monitor_temporary_update_fail(true, false);
273 // Test behavior when the persister returns a TemporaryFailure.
274 do_test_simple_monitor_temporary_update_fail(false, true);
275 do_test_simple_monitor_temporary_update_fail(true, true);
278 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
279 let disconnect_flags = 8 | 16;
281 // Test that we can recover from a temporary monitor update failure with some in-flight
282 // HTLCs going on at the same time potentially with some disconnection thrown in.
283 // * First we route a payment, then get a temporary monitor update failure when trying to
284 // route a second payment. We then claim the first payment.
285 // * If disconnect_count is set, we will disconnect at this point (which is likely as
286 // TemporaryFailure likely indicates net disconnect which resulted in failing to update
287 // the ChannelMonitor on a watchtower).
288 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
289 // immediately, otherwise we wait disconnect and deliver them via the reconnect
290 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
291 // disconnect_count & !disconnect_flags is 0).
292 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
293 // through message sending, potentially disconnect/reconnecting multiple times based on
294 // disconnect_count, to get the update_fulfill_htlc through.
295 // * We then walk through more message exchanges to get the original update_add_htlc
296 // through, swapping message ordering based on disconnect_count & 8 and optionally
297 // disconnect/reconnecting based on disconnect_count.
298 let chanmon_cfgs = create_chanmon_cfgs(2);
299 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
300 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
301 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
302 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
303 let logger = test_utils::TestLogger::new();
305 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
307 // Now try to send a second payment which will fail to send
308 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
310 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
311 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
312 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
313 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)), false, APIError::MonitorUpdateFailed, {});
314 check_added_monitors!(nodes[0], 1);
317 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
318 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
319 assert_eq!(nodes[0].node.list_channels().len(), 1);
321 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
322 // but nodes[0] won't respond since it is frozen.
323 assert!(nodes[1].node.claim_funds(payment_preimage_1));
324 check_added_monitors!(nodes[1], 1);
325 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
326 assert_eq!(events_2.len(), 1);
327 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
328 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 } } => {
329 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
330 assert!(update_add_htlcs.is_empty());
331 assert_eq!(update_fulfill_htlcs.len(), 1);
332 assert!(update_fail_htlcs.is_empty());
333 assert!(update_fail_malformed_htlcs.is_empty());
334 assert!(update_fee.is_none());
336 if (disconnect_count & 16) == 0 {
337 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
338 let events_3 = nodes[0].node.get_and_clear_pending_events();
339 assert_eq!(events_3.len(), 1);
341 Event::PaymentSent { ref payment_preimage } => {
342 assert_eq!(*payment_preimage, payment_preimage_1);
344 _ => panic!("Unexpected event"),
347 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
348 check_added_monitors!(nodes[0], 1);
349 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
350 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
353 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
355 _ => panic!("Unexpected event"),
358 if disconnect_count & !disconnect_flags > 0 {
359 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
360 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
363 // Now fix monitor updating...
364 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
365 let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
366 nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
367 check_added_monitors!(nodes[0], 0);
369 macro_rules! disconnect_reconnect_peers { () => { {
370 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
371 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
373 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
374 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
375 assert_eq!(reestablish_1.len(), 1);
376 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
377 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
378 assert_eq!(reestablish_2.len(), 1);
380 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
381 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
382 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
383 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
385 assert!(as_resp.0.is_none());
386 assert!(bs_resp.0.is_none());
388 (reestablish_1, reestablish_2, as_resp, bs_resp)
391 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
392 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
393 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
395 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
396 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
397 assert_eq!(reestablish_1.len(), 1);
398 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
399 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
400 assert_eq!(reestablish_2.len(), 1);
402 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
403 check_added_monitors!(nodes[0], 0);
404 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
405 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
406 check_added_monitors!(nodes[1], 0);
407 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
409 assert!(as_resp.0.is_none());
410 assert!(bs_resp.0.is_none());
412 assert!(bs_resp.1.is_none());
413 if (disconnect_count & 16) == 0 {
414 assert!(bs_resp.2.is_none());
416 assert!(as_resp.1.is_some());
417 assert!(as_resp.2.is_some());
418 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
420 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
421 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
422 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
423 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
424 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
425 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
427 assert!(as_resp.1.is_none());
429 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
430 let events_3 = nodes[0].node.get_and_clear_pending_events();
431 assert_eq!(events_3.len(), 1);
433 Event::PaymentSent { ref payment_preimage } => {
434 assert_eq!(*payment_preimage, payment_preimage_1);
436 _ => panic!("Unexpected event"),
439 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
440 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
441 // No commitment_signed so get_event_msg's assert(len == 1) passes
442 check_added_monitors!(nodes[0], 1);
444 as_resp.1 = Some(as_resp_raa);
448 if disconnect_count & !disconnect_flags > 1 {
449 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
451 if (disconnect_count & 16) == 0 {
452 assert!(reestablish_1 == second_reestablish_1);
453 assert!(reestablish_2 == second_reestablish_2);
455 assert!(as_resp == second_as_resp);
456 assert!(bs_resp == second_bs_resp);
459 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
461 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
462 assert_eq!(events_4.len(), 2);
463 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
464 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
465 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
468 _ => panic!("Unexpected event"),
472 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
474 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
475 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
476 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
477 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
478 check_added_monitors!(nodes[1], 1);
480 if disconnect_count & !disconnect_flags > 2 {
481 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
483 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
484 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
486 assert!(as_resp.2.is_none());
487 assert!(bs_resp.2.is_none());
490 let as_commitment_update;
491 let bs_second_commitment_update;
493 macro_rules! handle_bs_raa { () => {
494 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
495 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
496 assert!(as_commitment_update.update_add_htlcs.is_empty());
497 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
498 assert!(as_commitment_update.update_fail_htlcs.is_empty());
499 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
500 assert!(as_commitment_update.update_fee.is_none());
501 check_added_monitors!(nodes[0], 1);
504 macro_rules! handle_initial_raa { () => {
505 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
506 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
507 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
508 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
509 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
510 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
511 assert!(bs_second_commitment_update.update_fee.is_none());
512 check_added_monitors!(nodes[1], 1);
515 if (disconnect_count & 8) == 0 {
518 if disconnect_count & !disconnect_flags > 3 {
519 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
521 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
522 assert!(bs_resp.1.is_none());
524 assert!(as_resp.2.unwrap() == as_commitment_update);
525 assert!(bs_resp.2.is_none());
527 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
530 handle_initial_raa!();
532 if disconnect_count & !disconnect_flags > 4 {
533 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
535 assert!(as_resp.1.is_none());
536 assert!(bs_resp.1.is_none());
538 assert!(as_resp.2.unwrap() == as_commitment_update);
539 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
542 handle_initial_raa!();
544 if disconnect_count & !disconnect_flags > 3 {
545 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
547 assert!(as_resp.1.is_none());
548 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
550 assert!(as_resp.2.is_none());
551 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
553 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
558 if disconnect_count & !disconnect_flags > 4 {
559 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
561 assert!(as_resp.1.is_none());
562 assert!(bs_resp.1.is_none());
564 assert!(as_resp.2.unwrap() == as_commitment_update);
565 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
569 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
570 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
571 // No commitment_signed so get_event_msg's assert(len == 1) passes
572 check_added_monitors!(nodes[0], 1);
574 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
575 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
576 // No commitment_signed so get_event_msg's assert(len == 1) passes
577 check_added_monitors!(nodes[1], 1);
579 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
580 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
581 check_added_monitors!(nodes[1], 1);
583 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
584 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
585 check_added_monitors!(nodes[0], 1);
587 expect_pending_htlcs_forwardable!(nodes[1]);
589 let events_5 = nodes[1].node.get_and_clear_pending_events();
590 assert_eq!(events_5.len(), 1);
592 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
593 assert_eq!(payment_hash_2, *payment_hash);
594 assert!(payment_preimage.is_none());
595 assert_eq!(payment_secret_2, *payment_secret);
596 assert_eq!(amt, 1000000);
598 _ => panic!("Unexpected event"),
601 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
605 fn test_monitor_temporary_update_fail_a() {
606 do_test_monitor_temporary_update_fail(0);
607 do_test_monitor_temporary_update_fail(1);
608 do_test_monitor_temporary_update_fail(2);
609 do_test_monitor_temporary_update_fail(3);
610 do_test_monitor_temporary_update_fail(4);
611 do_test_monitor_temporary_update_fail(5);
615 fn test_monitor_temporary_update_fail_b() {
616 do_test_monitor_temporary_update_fail(2 | 8);
617 do_test_monitor_temporary_update_fail(3 | 8);
618 do_test_monitor_temporary_update_fail(4 | 8);
619 do_test_monitor_temporary_update_fail(5 | 8);
623 fn test_monitor_temporary_update_fail_c() {
624 do_test_monitor_temporary_update_fail(1 | 16);
625 do_test_monitor_temporary_update_fail(2 | 16);
626 do_test_monitor_temporary_update_fail(3 | 16);
627 do_test_monitor_temporary_update_fail(2 | 8 | 16);
628 do_test_monitor_temporary_update_fail(3 | 8 | 16);
632 fn test_monitor_update_fail_cs() {
633 // Tests handling of a monitor update failure when processing an incoming commitment_signed
634 let chanmon_cfgs = create_chanmon_cfgs(2);
635 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
636 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
637 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
638 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
639 let logger = test_utils::TestLogger::new();
641 let (payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
643 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
644 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
645 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
646 check_added_monitors!(nodes[0], 1);
649 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
650 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
652 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
653 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
654 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
655 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
656 check_added_monitors!(nodes[1], 1);
657 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
659 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
660 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
661 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
662 check_added_monitors!(nodes[1], 0);
663 let responses = nodes[1].node.get_and_clear_pending_msg_events();
664 assert_eq!(responses.len(), 2);
667 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
668 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
669 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
670 check_added_monitors!(nodes[0], 1);
672 _ => panic!("Unexpected event"),
675 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
676 assert!(updates.update_add_htlcs.is_empty());
677 assert!(updates.update_fulfill_htlcs.is_empty());
678 assert!(updates.update_fail_htlcs.is_empty());
679 assert!(updates.update_fail_malformed_htlcs.is_empty());
680 assert!(updates.update_fee.is_none());
681 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
683 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
684 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
685 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
686 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
687 check_added_monitors!(nodes[0], 1);
688 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
690 _ => panic!("Unexpected event"),
693 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
694 let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
695 nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
696 check_added_monitors!(nodes[0], 0);
698 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
699 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
700 check_added_monitors!(nodes[1], 1);
702 expect_pending_htlcs_forwardable!(nodes[1]);
704 let events = nodes[1].node.get_and_clear_pending_events();
705 assert_eq!(events.len(), 1);
707 Event::PaymentReceived { payment_hash, payment_preimage, payment_secret, amt, user_payment_id: _ } => {
708 assert_eq!(payment_hash, our_payment_hash);
709 assert!(payment_preimage.is_none());
710 assert_eq!(our_payment_secret, payment_secret);
711 assert_eq!(amt, 1000000);
713 _ => panic!("Unexpected event"),
716 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
720 fn test_monitor_update_fail_no_rebroadcast() {
721 // Tests handling of a monitor update failure when no message rebroadcasting on
722 // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
724 let chanmon_cfgs = create_chanmon_cfgs(2);
725 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
726 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
727 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
728 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
729 let logger = test_utils::TestLogger::new();
731 let (payment_preimage_1, our_payment_hash, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
733 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
734 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
735 nodes[0].node.send_payment(&route, our_payment_hash, &Some(payment_secret_1)).unwrap();
736 check_added_monitors!(nodes[0], 1);
739 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
740 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
741 let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
743 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
744 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
745 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
746 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
747 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
748 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
749 check_added_monitors!(nodes[1], 1);
751 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
752 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
753 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
754 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
755 check_added_monitors!(nodes[1], 0);
756 expect_pending_htlcs_forwardable!(nodes[1]);
758 let events = nodes[1].node.get_and_clear_pending_events();
759 assert_eq!(events.len(), 1);
761 Event::PaymentReceived { payment_hash, .. } => {
762 assert_eq!(payment_hash, our_payment_hash);
764 _ => panic!("Unexpected event"),
767 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
771 fn test_monitor_update_raa_while_paused() {
772 // Tests handling of an RAA while monitor updating has already been marked failed.
773 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
774 let chanmon_cfgs = create_chanmon_cfgs(2);
775 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
776 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
777 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
778 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
779 let logger = test_utils::TestLogger::new();
781 send_payment(&nodes[0], &[&nodes[1]], 5000000);
782 let (payment_preimage_1, our_payment_hash_1, our_payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
784 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
785 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
786 nodes[0].node.send_payment(&route, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
787 check_added_monitors!(nodes[0], 1);
789 let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
791 let (payment_preimage_2, our_payment_hash_2, our_payment_secret_2) = get_payment_preimage_hash!(nodes[0]);
793 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
794 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
795 nodes[1].node.send_payment(&route, our_payment_hash_2, &Some(our_payment_secret_2)).unwrap();
796 check_added_monitors!(nodes[1], 1);
798 let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
800 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
801 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
802 check_added_monitors!(nodes[1], 1);
803 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
805 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
806 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
807 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
808 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
809 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
810 check_added_monitors!(nodes[0], 1);
812 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
813 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
814 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented responses to RAA".to_string(), 1);
815 check_added_monitors!(nodes[0], 1);
817 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
818 let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
819 nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
820 check_added_monitors!(nodes[0], 0);
822 let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
823 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
824 check_added_monitors!(nodes[1], 1);
825 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
827 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
828 check_added_monitors!(nodes[1], 1);
829 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
831 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
832 check_added_monitors!(nodes[0], 1);
833 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
835 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
836 check_added_monitors!(nodes[0], 1);
837 expect_pending_htlcs_forwardable!(nodes[0]);
838 expect_payment_received!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
840 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
841 check_added_monitors!(nodes[1], 1);
842 expect_pending_htlcs_forwardable!(nodes[1]);
843 expect_payment_received!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
845 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
846 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
849 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
850 // Tests handling of a monitor update failure when processing an incoming RAA
851 let chanmon_cfgs = create_chanmon_cfgs(3);
852 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
853 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
854 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
855 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
856 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
857 let logger = test_utils::TestLogger::new();
859 // Rebalance a bit so that we can send backwards from 2 to 1.
860 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
862 // Route a first payment that we'll fail backwards
863 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
865 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
866 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1));
867 expect_pending_htlcs_forwardable!(nodes[2]);
868 check_added_monitors!(nodes[2], 1);
870 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
871 assert!(updates.update_add_htlcs.is_empty());
872 assert!(updates.update_fulfill_htlcs.is_empty());
873 assert_eq!(updates.update_fail_htlcs.len(), 1);
874 assert!(updates.update_fail_malformed_htlcs.is_empty());
875 assert!(updates.update_fee.is_none());
876 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
878 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
879 check_added_monitors!(nodes[0], 0);
881 // While the second channel is AwaitingRAA, forward a second payment to get it into the
883 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
885 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
886 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
887 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
888 check_added_monitors!(nodes[0], 1);
891 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
892 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
893 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
895 expect_pending_htlcs_forwardable!(nodes[1]);
896 check_added_monitors!(nodes[1], 0);
897 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
899 // Now fail monitor updating.
900 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
901 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
902 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
903 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
904 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
905 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
906 check_added_monitors!(nodes[1], 1);
908 // Forward a third payment which will also be added to the holding cell, despite the channel
909 // being paused waiting a monitor update.
910 let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[2]);
912 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
913 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
914 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
915 check_added_monitors!(nodes[0], 1);
918 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(())); // We succeed in updating the monitor for the first channel
919 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
920 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
921 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
922 check_added_monitors!(nodes[1], 0);
924 // Call forward_pending_htlcs and check that the new HTLC was simply added to the holding cell
925 // and not forwarded.
926 expect_pending_htlcs_forwardable!(nodes[1]);
927 check_added_monitors!(nodes[1], 0);
928 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
930 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
931 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
932 let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
933 let net_graph_msg_handler = &nodes[2].net_graph_msg_handler;
934 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
935 nodes[2].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
936 check_added_monitors!(nodes[2], 1);
938 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
939 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
940 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
941 check_added_monitors!(nodes[1], 1);
942 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
943 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
944 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
945 (Some(payment_preimage_4), Some(payment_hash_4))
946 } else { (None, None) };
948 // Restore monitor updating, ensuring we immediately get a fail-back update and a
949 // update_add update.
950 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
951 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
952 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
953 check_added_monitors!(nodes[1], 0);
954 expect_pending_htlcs_forwardable!(nodes[1]);
955 check_added_monitors!(nodes[1], 1);
957 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
958 if test_ignore_second_cs {
959 assert_eq!(events_3.len(), 3);
961 assert_eq!(events_3.len(), 2);
964 // Note that the ordering of the events for different nodes is non-prescriptive, though the
965 // ordering of the two events that both go to nodes[2] have to stay in the same order.
966 let messages_a = match events_3.pop().unwrap() {
967 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
968 assert_eq!(node_id, nodes[0].node.get_our_node_id());
969 assert!(updates.update_fulfill_htlcs.is_empty());
970 assert_eq!(updates.update_fail_htlcs.len(), 1);
971 assert!(updates.update_fail_malformed_htlcs.is_empty());
972 assert!(updates.update_add_htlcs.is_empty());
973 assert!(updates.update_fee.is_none());
974 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
976 _ => panic!("Unexpected event type!"),
978 let raa = if test_ignore_second_cs {
979 match events_3.remove(1) {
980 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
981 assert_eq!(node_id, nodes[2].node.get_our_node_id());
984 _ => panic!("Unexpected event"),
987 let send_event_b = SendEvent::from_event(events_3.remove(0));
988 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
990 // Now deliver the new messages...
992 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
993 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
994 expect_payment_failed!(nodes[0], payment_hash_1, true);
996 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
998 if test_ignore_second_cs {
999 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
1000 check_added_monitors!(nodes[2], 1);
1001 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1002 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
1003 check_added_monitors!(nodes[2], 1);
1004 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1005 assert!(bs_cs.update_add_htlcs.is_empty());
1006 assert!(bs_cs.update_fail_htlcs.is_empty());
1007 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
1008 assert!(bs_cs.update_fulfill_htlcs.is_empty());
1009 assert!(bs_cs.update_fee.is_none());
1011 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1012 check_added_monitors!(nodes[1], 1);
1013 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1015 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
1016 check_added_monitors!(nodes[1], 1);
1018 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
1019 check_added_monitors!(nodes[2], 1);
1021 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
1022 assert_eq!(bs_revoke_and_commit.len(), 2);
1023 match bs_revoke_and_commit[0] {
1024 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1025 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1026 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
1027 check_added_monitors!(nodes[1], 1);
1029 _ => panic!("Unexpected event"),
1032 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1034 match bs_revoke_and_commit[1] {
1035 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1036 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1037 assert!(updates.update_add_htlcs.is_empty());
1038 assert!(updates.update_fail_htlcs.is_empty());
1039 assert!(updates.update_fail_malformed_htlcs.is_empty());
1040 assert!(updates.update_fulfill_htlcs.is_empty());
1041 assert!(updates.update_fee.is_none());
1042 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1043 check_added_monitors!(nodes[1], 1);
1045 _ => panic!("Unexpected event"),
1049 assert_eq!(as_cs.update_add_htlcs.len(), 1);
1050 assert!(as_cs.update_fail_htlcs.is_empty());
1051 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1052 assert!(as_cs.update_fulfill_htlcs.is_empty());
1053 assert!(as_cs.update_fee.is_none());
1054 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1057 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1058 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1059 check_added_monitors!(nodes[2], 1);
1060 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1062 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1063 check_added_monitors!(nodes[2], 1);
1064 let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1066 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1067 check_added_monitors!(nodes[1], 1);
1068 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1070 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1071 check_added_monitors!(nodes[1], 1);
1072 let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1074 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1075 check_added_monitors!(nodes[2], 1);
1076 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1078 expect_pending_htlcs_forwardable!(nodes[2]);
1080 let events_6 = nodes[2].node.get_and_clear_pending_events();
1081 assert_eq!(events_6.len(), 2);
1083 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1084 _ => panic!("Unexpected event"),
1087 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1088 _ => panic!("Unexpected event"),
1091 if test_ignore_second_cs {
1092 expect_pending_htlcs_forwardable!(nodes[1]);
1093 check_added_monitors!(nodes[1], 1);
1095 send_event = SendEvent::from_node(&nodes[1]);
1096 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1097 assert_eq!(send_event.msgs.len(), 1);
1098 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1099 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1101 expect_pending_htlcs_forwardable!(nodes[0]);
1103 let events_9 = nodes[0].node.get_and_clear_pending_events();
1104 assert_eq!(events_9.len(), 1);
1106 Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1107 _ => panic!("Unexpected event"),
1109 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1112 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1116 fn test_monitor_update_fail_raa() {
1117 do_test_monitor_update_fail_raa(false);
1118 do_test_monitor_update_fail_raa(true);
1122 fn test_monitor_update_fail_reestablish() {
1123 // Simple test for message retransmission after monitor update failure on
1124 // channel_reestablish generating a monitor update (which comes from freeing holding cell
1126 let chanmon_cfgs = create_chanmon_cfgs(3);
1127 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1128 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1129 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1130 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1131 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1133 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1135 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1136 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1138 assert!(nodes[2].node.claim_funds(our_payment_preimage));
1139 check_added_monitors!(nodes[2], 1);
1140 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1141 assert!(updates.update_add_htlcs.is_empty());
1142 assert!(updates.update_fail_htlcs.is_empty());
1143 assert!(updates.update_fail_malformed_htlcs.is_empty());
1144 assert!(updates.update_fee.is_none());
1145 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1146 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1147 check_added_monitors!(nodes[1], 1);
1148 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1149 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1151 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1152 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1153 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1155 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1156 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1158 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1160 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1162 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1163 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1165 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1166 check_added_monitors!(nodes[1], 1);
1168 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1169 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1171 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1172 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1174 assert!(as_reestablish == get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id()));
1175 assert!(bs_reestablish == get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()));
1177 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1179 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1180 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1182 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1183 check_added_monitors!(nodes[1], 0);
1185 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1186 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1188 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1189 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1190 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1191 check_added_monitors!(nodes[1], 0);
1193 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1194 assert!(updates.update_add_htlcs.is_empty());
1195 assert!(updates.update_fail_htlcs.is_empty());
1196 assert!(updates.update_fail_malformed_htlcs.is_empty());
1197 assert!(updates.update_fee.is_none());
1198 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1199 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1200 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1202 let events = nodes[0].node.get_and_clear_pending_events();
1203 assert_eq!(events.len(), 1);
1205 Event::PaymentSent { payment_preimage, .. } => assert_eq!(payment_preimage, our_payment_preimage),
1206 _ => panic!("Unexpected event"),
1211 fn raa_no_response_awaiting_raa_state() {
1212 // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1213 // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1214 // in question (assuming it intends to respond with a CS after monitor updating is restored).
1215 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1216 let chanmon_cfgs = create_chanmon_cfgs(2);
1217 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1218 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1219 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1220 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1221 let logger = test_utils::TestLogger::new();
1223 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
1224 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1225 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1227 // Queue up two payments - one will be delivered right away, one immediately goes into the
1228 // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1229 // immediately after a CS. By setting failing the monitor update failure from the CS (which
1230 // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1231 // generation during RAA while in monitor-update-failed state.
1233 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1234 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1235 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1236 check_added_monitors!(nodes[0], 1);
1237 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1238 check_added_monitors!(nodes[0], 0);
1241 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1242 assert_eq!(events.len(), 1);
1243 let payment_event = SendEvent::from_event(events.pop().unwrap());
1244 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1245 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1246 check_added_monitors!(nodes[1], 1);
1248 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1249 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1250 check_added_monitors!(nodes[0], 1);
1251 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1252 assert_eq!(events.len(), 1);
1253 let payment_event = SendEvent::from_event(events.pop().unwrap());
1255 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1256 check_added_monitors!(nodes[0], 1);
1257 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1259 // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1260 // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1261 // then restore channel monitor updates.
1262 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1263 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1264 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1265 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1266 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1267 check_added_monitors!(nodes[1], 1);
1269 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1270 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1271 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented responses to RAA".to_string(), 1);
1272 check_added_monitors!(nodes[1], 1);
1274 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1275 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1276 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1277 // nodes[1] should be AwaitingRAA here!
1278 check_added_monitors!(nodes[1], 0);
1279 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1280 expect_pending_htlcs_forwardable!(nodes[1]);
1281 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1283 // We send a third payment here, which is somewhat of a redundant test, but the
1284 // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1285 // commitment transaction states) whereas here we can explicitly check for it.
1287 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1288 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1289 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1290 check_added_monitors!(nodes[0], 0);
1291 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1293 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1294 check_added_monitors!(nodes[0], 1);
1295 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1296 assert_eq!(events.len(), 1);
1297 let payment_event = SendEvent::from_event(events.pop().unwrap());
1299 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1300 check_added_monitors!(nodes[0], 1);
1301 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1303 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1304 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1305 check_added_monitors!(nodes[1], 1);
1306 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1308 // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1309 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1310 check_added_monitors!(nodes[1], 1);
1311 expect_pending_htlcs_forwardable!(nodes[1]);
1312 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1313 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1315 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1316 check_added_monitors!(nodes[0], 1);
1318 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1319 check_added_monitors!(nodes[0], 1);
1320 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1322 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1323 check_added_monitors!(nodes[1], 1);
1324 expect_pending_htlcs_forwardable!(nodes[1]);
1325 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1327 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1328 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1329 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1333 fn claim_while_disconnected_monitor_update_fail() {
1334 // Test for claiming a payment while disconnected and then having the resulting
1335 // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1336 // contrived case for nodes with network instability.
1337 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1338 // code introduced a regression in this test (specifically, this caught a removal of the
1339 // channel_reestablish handling ensuring the order was sensical given the messages used).
1340 let chanmon_cfgs = create_chanmon_cfgs(2);
1341 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1342 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1343 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1344 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1345 let logger = test_utils::TestLogger::new();
1347 // Forward a payment for B to claim
1348 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1350 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1351 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1353 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1354 check_added_monitors!(nodes[1], 1);
1356 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1357 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1359 let as_reconnect = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1360 let bs_reconnect = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1362 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1363 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1365 // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1367 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1369 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1370 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1371 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1372 check_added_monitors!(nodes[1], 1);
1373 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1375 // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1376 // the monitor still failed
1377 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1379 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1380 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1381 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1382 check_added_monitors!(nodes[0], 1);
1385 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1386 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1387 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1388 check_added_monitors!(nodes[1], 1);
1389 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1390 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1391 // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1392 // until we've channel_monitor_update'd and updated for the new commitment transaction.
1394 // Now un-fail the monitor, which will result in B sending its original commitment update,
1395 // receiving the commitment update from A, and the resulting commitment dances.
1396 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1397 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1398 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1399 check_added_monitors!(nodes[1], 0);
1401 let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1402 assert_eq!(bs_msgs.len(), 2);
1405 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1406 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1407 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1408 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1409 check_added_monitors!(nodes[0], 1);
1411 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1412 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1413 check_added_monitors!(nodes[1], 1);
1415 _ => panic!("Unexpected event"),
1419 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1420 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1421 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1422 check_added_monitors!(nodes[0], 1);
1424 _ => panic!("Unexpected event"),
1427 let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1429 let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1430 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1431 check_added_monitors!(nodes[0], 1);
1432 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1434 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1435 check_added_monitors!(nodes[1], 1);
1436 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1437 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1438 check_added_monitors!(nodes[1], 1);
1440 expect_pending_htlcs_forwardable!(nodes[1]);
1441 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1443 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1444 check_added_monitors!(nodes[0], 1);
1446 let events = nodes[0].node.get_and_clear_pending_events();
1447 assert_eq!(events.len(), 1);
1449 Event::PaymentSent { ref payment_preimage } => {
1450 assert_eq!(*payment_preimage, payment_preimage_1);
1452 _ => panic!("Unexpected event"),
1455 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1459 fn monitor_failed_no_reestablish_response() {
1460 // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1461 // response to a commitment_signed.
1462 // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1463 // debug_assert!() failure in channel_reestablish handling.
1464 let chanmon_cfgs = create_chanmon_cfgs(2);
1465 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1466 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1467 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1468 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1469 let logger = test_utils::TestLogger::new();
1471 // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1473 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
1475 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1476 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1477 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1478 check_added_monitors!(nodes[0], 1);
1481 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1482 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1483 assert_eq!(events.len(), 1);
1484 let payment_event = SendEvent::from_event(events.pop().unwrap());
1485 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1486 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1487 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1488 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1489 check_added_monitors!(nodes[1], 1);
1491 // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1492 // is still failing to update monitors.
1493 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1494 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1496 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1497 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1499 let as_reconnect = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1500 let bs_reconnect = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1502 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1503 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1504 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1505 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1507 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1508 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1509 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1510 check_added_monitors!(nodes[1], 0);
1511 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1513 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1514 check_added_monitors!(nodes[0], 1);
1515 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1516 check_added_monitors!(nodes[0], 1);
1518 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1519 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1520 check_added_monitors!(nodes[1], 1);
1522 expect_pending_htlcs_forwardable!(nodes[1]);
1523 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1525 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1529 fn first_message_on_recv_ordering() {
1530 // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1531 // messages, we're willing to flip the order of response messages if neccessary in resposne to
1532 // a commitment_signed which needs to send an RAA first.
1533 // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1534 // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1535 // response. To do this, we start routing two payments, with the final RAA for the first being
1536 // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1537 // have no pending response but will want to send a RAA/CS (with the updates for the second
1538 // payment applied).
1539 // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1540 let chanmon_cfgs = create_chanmon_cfgs(2);
1541 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1542 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1543 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1544 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1545 let logger = test_utils::TestLogger::new();
1547 // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1548 // can deliver it and fail the monitor update.
1549 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
1551 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1552 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1553 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1554 check_added_monitors!(nodes[0], 1);
1557 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1558 assert_eq!(events.len(), 1);
1559 let payment_event = SendEvent::from_event(events.pop().unwrap());
1560 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1561 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1562 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1563 check_added_monitors!(nodes[1], 1);
1564 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1566 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1567 check_added_monitors!(nodes[0], 1);
1568 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1569 check_added_monitors!(nodes[0], 1);
1571 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1573 // Route the second payment, generating an update_add_htlc/commitment_signed
1574 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1576 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1577 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1578 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1579 check_added_monitors!(nodes[0], 1);
1581 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1582 assert_eq!(events.len(), 1);
1583 let payment_event = SendEvent::from_event(events.pop().unwrap());
1584 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1586 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1588 // Deliver the final RAA for the first payment, which does not require a response. RAAs
1589 // generally require a commitment_signed, so the fact that we're expecting an opposite response
1590 // to the next message also tests resetting the delivery order.
1591 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1592 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1593 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1594 check_added_monitors!(nodes[1], 1);
1596 // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1597 // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1598 // appropriate HTLC acceptance).
1599 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1600 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1601 check_added_monitors!(nodes[1], 1);
1602 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1603 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1605 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1606 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1607 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1608 check_added_monitors!(nodes[1], 0);
1610 expect_pending_htlcs_forwardable!(nodes[1]);
1611 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1613 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1614 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1615 check_added_monitors!(nodes[0], 1);
1616 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1617 check_added_monitors!(nodes[0], 1);
1619 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1620 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1621 check_added_monitors!(nodes[1], 1);
1623 expect_pending_htlcs_forwardable!(nodes[1]);
1624 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1626 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1627 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1631 fn test_monitor_update_fail_claim() {
1632 // Basic test for monitor update failures when processing claim_funds calls.
1633 // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1634 // update to claim the payment. We then send two payments C->B->A, which are held at B.
1635 // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1636 // the payments from C onwards to A.
1637 let chanmon_cfgs = create_chanmon_cfgs(3);
1638 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1639 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1640 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1641 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1642 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1643 let logger = test_utils::TestLogger::new();
1645 // Rebalance a bit so that we can send backwards from 3 to 2.
1646 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1648 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1650 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1651 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1652 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1653 check_added_monitors!(nodes[1], 1);
1655 // Note that at this point there is a pending commitment transaction update for A being held by
1656 // B. Even when we go to send the payment from C through B to A, B will not update this
1657 // already-signed commitment transaction and will instead wait for it to resolve before
1658 // forwarding the payment onwards.
1660 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[0]);
1663 let net_graph_msg_handler = &nodes[2].net_graph_msg_handler;
1664 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1_000_000, TEST_FINAL_CLTV, &logger).unwrap();
1665 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1666 check_added_monitors!(nodes[2], 1);
1669 // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1670 // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1671 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1673 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1674 assert_eq!(events.len(), 1);
1675 let payment_event = SendEvent::from_event(events.pop().unwrap());
1676 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1677 let events = nodes[1].node.get_and_clear_pending_msg_events();
1678 assert_eq!(events.len(), 0);
1679 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1681 let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1682 nodes[2].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1683 check_added_monitors!(nodes[2], 1);
1685 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1686 assert_eq!(events.len(), 1);
1687 let payment_event = SendEvent::from_event(events.pop().unwrap());
1688 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1689 let events = nodes[1].node.get_and_clear_pending_msg_events();
1690 assert_eq!(events.len(), 0);
1691 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1693 // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1694 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1695 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1696 check_added_monitors!(nodes[1], 0);
1698 let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1699 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1700 commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1701 expect_payment_sent!(nodes[0], payment_preimage_1);
1703 // Get the payment forwards, note that they were batched into one commitment update.
1704 expect_pending_htlcs_forwardable!(nodes[1]);
1705 check_added_monitors!(nodes[1], 1);
1706 let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1707 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1708 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1709 commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1710 expect_pending_htlcs_forwardable!(nodes[0]);
1712 let events = nodes[0].node.get_and_clear_pending_events();
1713 assert_eq!(events.len(), 2);
1715 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
1716 assert_eq!(payment_hash_2, *payment_hash);
1717 assert!(payment_preimage.is_none());
1718 assert_eq!(payment_secret_2, *payment_secret);
1719 assert_eq!(1_000_000, amt);
1721 _ => panic!("Unexpected event"),
1724 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
1725 assert_eq!(payment_hash_3, *payment_hash);
1726 assert!(payment_preimage.is_none());
1727 assert_eq!(payment_secret_3, *payment_secret);
1728 assert_eq!(1_000_000, amt);
1730 _ => panic!("Unexpected event"),
1735 fn test_monitor_update_on_pending_forwards() {
1736 // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1737 // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1738 // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1739 // from C to A will be pending a forward to A.
1740 let chanmon_cfgs = create_chanmon_cfgs(3);
1741 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1742 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1743 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1744 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1745 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1746 let logger = test_utils::TestLogger::new();
1748 // Rebalance a bit so that we can send backwards from 3 to 1.
1749 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1751 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1752 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1));
1753 expect_pending_htlcs_forwardable!(nodes[2]);
1754 check_added_monitors!(nodes[2], 1);
1756 let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1757 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1758 commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1759 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1761 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[0]);
1763 let net_graph_msg_handler = &nodes[2].net_graph_msg_handler;
1764 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1765 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1766 check_added_monitors!(nodes[2], 1);
1769 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1770 assert_eq!(events.len(), 1);
1771 let payment_event = SendEvent::from_event(events.pop().unwrap());
1772 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1773 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1775 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1776 expect_pending_htlcs_forwardable!(nodes[1]);
1777 check_added_monitors!(nodes[1], 1);
1778 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1779 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1781 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1782 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1783 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1784 check_added_monitors!(nodes[1], 0);
1786 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1787 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1788 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1789 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1791 let events = nodes[0].node.get_and_clear_pending_events();
1792 assert_eq!(events.len(), 2);
1793 if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events[0] {
1794 assert_eq!(payment_hash, payment_hash_1);
1795 assert!(rejected_by_dest);
1796 } else { panic!("Unexpected event!"); }
1798 Event::PendingHTLCsForwardable { .. } => { },
1799 _ => panic!("Unexpected event"),
1801 nodes[0].node.process_pending_htlc_forwards();
1802 expect_payment_received!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1804 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1808 fn monitor_update_claim_fail_no_response() {
1809 // Test for claim_funds resulting in both a monitor update failure and no message response (due
1810 // to channel being AwaitingRAA).
1811 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1813 let chanmon_cfgs = create_chanmon_cfgs(2);
1814 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1815 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1816 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1817 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1818 let logger = test_utils::TestLogger::new();
1820 // Forward a payment for B to claim
1821 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1823 // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1824 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1826 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1827 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1828 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1829 check_added_monitors!(nodes[0], 1);
1832 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1833 assert_eq!(events.len(), 1);
1834 let payment_event = SendEvent::from_event(events.pop().unwrap());
1835 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1836 let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1838 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1839 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1840 check_added_monitors!(nodes[1], 1);
1841 let events = nodes[1].node.get_and_clear_pending_msg_events();
1842 assert_eq!(events.len(), 0);
1843 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1845 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1846 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1847 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1848 check_added_monitors!(nodes[1], 0);
1849 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1851 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1852 check_added_monitors!(nodes[1], 1);
1853 expect_pending_htlcs_forwardable!(nodes[1]);
1854 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1856 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1857 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1858 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1860 let events = nodes[0].node.get_and_clear_pending_events();
1861 assert_eq!(events.len(), 1);
1863 Event::PaymentSent { ref payment_preimage } => {
1864 assert_eq!(*payment_preimage, payment_preimage_1);
1866 _ => panic!("Unexpected event"),
1869 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1872 // confirm_a_first and restore_b_before_conf are wholly unrelated to earlier bools and
1873 // restore_b_before_conf has no meaning if !confirm_a_first
1874 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool) {
1875 // Test that if the monitor update generated by funding_transaction_generated fails we continue
1876 // the channel setup happily after the update is restored.
1877 let chanmon_cfgs = create_chanmon_cfgs(2);
1878 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1879 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1880 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1882 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1883 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()));
1884 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()));
1886 let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 43);
1888 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_tx.clone()).unwrap();
1889 check_added_monitors!(nodes[0], 0);
1891 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1892 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1893 let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1894 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1895 check_added_monitors!(nodes[1], 1);
1897 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1898 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()));
1899 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1900 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1901 check_added_monitors!(nodes[0], 1);
1902 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1903 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1904 let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1905 nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
1906 check_added_monitors!(nodes[0], 0);
1908 let events = nodes[0].node.get_and_clear_pending_events();
1909 assert_eq!(events.len(), 0);
1910 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1911 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1913 if confirm_a_first {
1914 confirm_transaction(&nodes[0], &funding_tx);
1915 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()));
1917 assert!(!restore_b_before_conf);
1918 confirm_transaction(&nodes[1], &funding_tx);
1919 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1922 // Make sure nodes[1] isn't stupid enough to re-send the FundingLocked on reconnect
1923 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1924 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1925 reconnect_nodes(&nodes[0], &nodes[1], (false, confirm_a_first), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1926 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1927 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1929 if !restore_b_before_conf {
1930 confirm_transaction(&nodes[1], &funding_tx);
1931 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1932 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1935 *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1936 let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1937 nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1938 check_added_monitors!(nodes[1], 0);
1940 let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1941 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()));
1943 confirm_transaction(&nodes[0], &funding_tx);
1944 let (funding_locked, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1945 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked))
1947 if restore_b_before_conf {
1948 confirm_transaction(&nodes[1], &funding_tx);
1950 let (funding_locked, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1951 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &funding_locked))
1953 for node in nodes.iter() {
1954 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
1955 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1956 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1959 send_payment(&nodes[0], &[&nodes[1]], 8000000);
1960 close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1964 fn during_funding_monitor_fail() {
1965 do_during_funding_monitor_fail(true, true);
1966 do_during_funding_monitor_fail(true, false);
1967 do_during_funding_monitor_fail(false, false);
1971 fn test_path_paused_mpp() {
1972 // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1974 let chanmon_cfgs = create_chanmon_cfgs(4);
1975 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1976 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1977 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1979 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1980 let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
1981 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1982 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1983 let logger = test_utils::TestLogger::new();
1985 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
1986 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(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
1988 // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1989 let path = route.paths[0].clone();
1990 route.paths.push(path);
1991 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
1992 route.paths[0][0].short_channel_id = chan_1_id;
1993 route.paths[0][1].short_channel_id = chan_3_id;
1994 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
1995 route.paths[1][0].short_channel_id = chan_2_ann.contents.short_channel_id;
1996 route.paths[1][1].short_channel_id = chan_4_id;
1998 // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
1999 // (for the path 0 -> 2 -> 3) fails.
2000 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
2001 *nodes[0].chain_monitor.next_update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2003 // Now check that we get the right return value, indicating that the first path succeeded but
2004 // the second got a MonitorUpdateFailed err. This implies PaymentSendFailure::PartialFailure as
2005 // some paths succeeded, preventing retry.
2006 if let Err(PaymentSendFailure::PartialFailure(results)) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)) {
2007 assert_eq!(results.len(), 2);
2008 if let Ok(()) = results[0] {} else { panic!(); }
2009 if let Err(APIError::MonitorUpdateFailed) = results[1] {} else { panic!(); }
2010 } else { panic!(); }
2011 check_added_monitors!(nodes[0], 2);
2012 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
2014 // Pass the first HTLC of the payment along to nodes[3].
2015 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2016 assert_eq!(events.len(), 1);
2017 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), payment_secret, events.pop().unwrap(), false);
2019 // And check that, after we successfully update the monitor for chan_2 we can pass the second
2020 // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
2021 let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
2022 nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
2023 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2024 assert_eq!(events.len(), 1);
2025 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), payment_secret, events.pop().unwrap(), true);
2027 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
2030 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2031 // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2032 // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2033 // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2034 // which failed in such a case).
2035 let chanmon_cfgs = create_chanmon_cfgs(2);
2036 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2037 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2038 let persister: test_utils::TestPersister;
2039 let new_chain_monitor: test_utils::TestChainMonitor;
2040 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2041 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2043 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;
2044 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(&nodes[1]);
2045 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2047 // Do a really complicated dance to get an HTLC into the holding cell, with MonitorUpdateFailed
2048 // set but AwaitingRemoteRevoke unset. When this test was written, any attempts to send an HTLC
2049 // while MonitorUpdateFailed is set are immediately failed-backwards. Thus, the only way to get
2050 // an AddHTLC into the holding cell is to add it while AwaitingRemoteRevoke is set but
2051 // MonitorUpdateFailed is unset, and then swap the flags.
2054 // a) routing a payment from node B to node A,
2055 // b) sending a payment from node A to node B without delivering any of the generated messages,
2056 // putting node A in AwaitingRemoteRevoke,
2057 // c) sending a second payment from node A to node B, which is immediately placed in the
2059 // d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2060 // when we try to persist the payment preimage,
2061 // e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2062 // clearing AwaitingRemoteRevoke on node A.
2064 // Note that because, at the end, MonitorUpdateFailed is still set, the HTLC generated in (c)
2065 // will not be freed from the holding cell.
2066 let (payment_preimage_0, _, _) = route_payment(&nodes[1], &[&nodes[0]], 100000);
2069 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2070 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, None, &Vec::new(), 100000, TEST_FINAL_CLTV, nodes[0].logger).unwrap()
2073 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
2074 check_added_monitors!(nodes[0], 1);
2075 let send = SendEvent::from_node(&nodes[0]);
2076 assert_eq!(send.msgs.len(), 1);
2078 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
2079 check_added_monitors!(nodes[0], 0);
2081 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2082 assert!(nodes[0].node.claim_funds(payment_preimage_0));
2083 check_added_monitors!(nodes[0], 1);
2085 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2086 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2087 check_added_monitors!(nodes[1], 1);
2089 let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2091 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2092 check_added_monitors!(nodes[0], 1);
2095 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2096 // disconnect the peers. Note that the fuzzer originally found this issue because
2097 // deserializing a ChannelManager in this state causes an assertion failure.
2099 let nodes_0_serialized = nodes[0].node.encode();
2100 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
2101 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
2103 persister = test_utils::TestPersister::new();
2104 let keys_manager = &chanmon_cfgs[0].keys_manager;
2105 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);
2106 nodes[0].chain_monitor = &new_chain_monitor;
2107 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
2108 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
2109 &mut chan_0_monitor_read, keys_manager).unwrap();
2110 assert!(chan_0_monitor_read.is_empty());
2112 let mut nodes_0_read = &nodes_0_serialized[..];
2113 let config = UserConfig::default();
2114 nodes_0_deserialized = {
2115 let mut channel_monitors = HashMap::new();
2116 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
2117 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
2118 default_config: config,
2120 fee_estimator: node_cfgs[0].fee_estimator,
2121 chain_monitor: nodes[0].chain_monitor,
2122 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
2123 logger: nodes[0].logger,
2127 nodes[0].node = &nodes_0_deserialized;
2128 assert!(nodes_0_read.is_empty());
2130 nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0.clone(), chan_0_monitor).unwrap();
2131 check_added_monitors!(nodes[0], 1);
2133 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2135 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2137 // Now reconnect the two
2138 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2139 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2140 assert_eq!(reestablish_1.len(), 1);
2141 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2142 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2143 assert_eq!(reestablish_2.len(), 1);
2145 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2146 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2147 check_added_monitors!(nodes[1], 0);
2149 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2150 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2152 assert!(resp_0.0.is_none());
2153 assert!(resp_0.1.is_none());
2154 assert!(resp_0.2.is_none());
2155 assert!(resp_1.0.is_none());
2156 assert!(resp_1.1.is_none());
2158 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2160 if let Some(pending_cs) = resp_1.2 {
2161 assert!(pending_cs.update_add_htlcs.is_empty());
2162 assert!(pending_cs.update_fail_htlcs.is_empty());
2163 assert!(pending_cs.update_fulfill_htlcs.is_empty());
2164 assert_eq!(pending_cs.commitment_signed, cs);
2165 } else { panic!(); }
2167 // There should be no monitor updates as we are still pending awaiting a failed one.
2168 check_added_monitors!(nodes[0], 0);
2169 check_added_monitors!(nodes[1], 0);
2172 // If we finish updating the monitor, we should free the holding cell right away (this did
2173 // not occur prior to #756).
2174 *nodes[0].chain_monitor.update_ret.lock().unwrap() = None;
2175 let (funding_txo, mon_id) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2176 nodes[0].node.channel_monitor_updated(&funding_txo, mon_id);
2178 // New outbound messages should be generated immediately upon a call to
2179 // get_and_clear_pending_msg_events (but not before).
2180 check_added_monitors!(nodes[0], 0);
2181 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2182 check_added_monitors!(nodes[0], 1);
2183 assert_eq!(events.len(), 1);
2185 // Deliver the pending in-flight CS
2186 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2187 check_added_monitors!(nodes[0], 1);
2189 let commitment_msg = match events.pop().unwrap() {
2190 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2191 assert_eq!(node_id, nodes[1].node.get_our_node_id());
2192 assert!(updates.update_fail_htlcs.is_empty());
2193 assert!(updates.update_fail_malformed_htlcs.is_empty());
2194 assert!(updates.update_fee.is_none());
2195 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2196 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2197 expect_payment_sent!(nodes[1], payment_preimage_0);
2198 assert_eq!(updates.update_add_htlcs.len(), 1);
2199 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2200 updates.commitment_signed
2202 _ => panic!("Unexpected event type!"),
2205 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2206 check_added_monitors!(nodes[1], 1);
2208 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2209 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2210 expect_pending_htlcs_forwardable!(nodes[1]);
2211 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2212 check_added_monitors!(nodes[1], 1);
2214 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
2216 expect_pending_htlcs_forwardable!(nodes[1]);
2217 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2219 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2220 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2223 fn channel_holding_cell_serialize() {
2224 do_channel_holding_cell_serialize(true, true);
2225 do_channel_holding_cell_serialize(true, false);
2226 do_channel_holding_cell_serialize(false, true); // last arg doesn't matter