1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Functional tests which test the correct handling of ChannelMonitorUpdateErr returns from
12 //! There are a bunch of these as their handling is relatively error-prone so they are split out
13 //! here. See also the chanmon_fail_consistency fuzz test.
15 use bitcoin::blockdata::block::{Block, BlockHeader};
16 use bitcoin::blockdata::constants::genesis_block;
17 use bitcoin::hash_types::BlockHash;
18 use bitcoin::network::constants::Network;
19 use chain::channelmonitor::ChannelMonitor;
20 use chain::transaction::OutPoint;
21 use chain::{ChannelMonitorUpdateErr, Listen, Watch};
22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
23 use ln::features::InitFeatures;
25 use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
26 use util::config::UserConfig;
27 use util::enforcing_trait_impls::EnforcingSigner;
28 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason};
29 use util::errors::APIError;
30 use util::ser::{ReadableArgs, Writeable};
31 use util::test_utils::TestBroadcaster;
33 use ln::functional_test_utils::*;
39 use sync::{Arc, Mutex};
42 fn test_simple_monitor_permanent_update_fail() {
43 // Test that we handle a simple permanent monitor update failure
44 let chanmon_cfgs = create_chanmon_cfgs(2);
45 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
46 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
47 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
48 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
50 let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
51 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::PermanentFailure));
52 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable {..}, {});
53 check_added_monitors!(nodes[0], 2);
55 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
56 assert_eq!(events_1.len(), 2);
58 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
59 _ => panic!("Unexpected event"),
62 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
63 _ => panic!("Unexpected event"),
66 // TODO: Once we hit the chain with the failure transaction we should check that we get a
67 // PaymentPathFailed event
69 assert_eq!(nodes[0].node.list_channels().len(), 0);
70 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
74 fn test_monitor_and_persister_update_fail() {
75 // Test that if both updating the `ChannelMonitor` and persisting the updated
76 // `ChannelMonitor` fail, then the failure from updating the `ChannelMonitor`
77 // one that gets returned.
78 let chanmon_cfgs = create_chanmon_cfgs(2);
79 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
80 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
81 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
83 // Create some initial channel
84 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
85 let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
87 // Rebalance the network to generate htlc in the two directions
88 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
90 // Route an HTLC from node 0 to node 1 (but don't settle)
91 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
93 // Make a copy of the ChainMonitor so we can capture the error it returns on a
94 // bogus update. Note that if instead we updated the nodes[0]'s ChainMonitor
95 // directly, the node would fail to be `Drop`'d at the end because its
96 // ChannelManager and ChainMonitor would be out of sync.
97 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
98 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
99 let persister = test_utils::TestPersister::new();
100 let tx_broadcaster = TestBroadcaster {
101 txn_broadcasted: Mutex::new(Vec::new()),
102 // Because we will connect a block at height 200 below, we need the TestBroadcaster to know
103 // that we are at height 200 so that it doesn't think we're violating the time lock
104 // requirements of transactions broadcasted at that point.
105 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 200); 200])),
108 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
109 let mut w = test_utils::TestVecWriter(Vec::new());
110 monitor.write(&mut w).unwrap();
111 let new_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
112 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
113 assert!(new_monitor == *monitor);
114 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
115 assert!(chain_mon.watch_channel(outpoint, new_monitor).is_ok());
118 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
119 chain_mon.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
121 // Set the persister's return value to be a TemporaryFailure.
122 persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
124 // Try to update ChannelMonitor
125 assert!(nodes[1].node.claim_funds(preimage));
126 check_added_monitors!(nodes[1], 1);
127 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
128 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
129 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
130 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2) {
131 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
132 // Check that even though the persister is returning a TemporaryFailure,
133 // because the update is bogus, ultimately the error that's returned
134 // should be a PermanentFailure.
135 if let Err(ChannelMonitorUpdateErr::PermanentFailure) = chain_mon.chain_monitor.update_channel(outpoint, update.clone()) {} else { panic!("Expected monitor error to be permanent"); }
136 logger.assert_log_regex("lightning::chain::chainmonitor".to_string(), regex::Regex::new("Failed to persist ChannelMonitor update for channel [0-9a-f]*: TemporaryFailure").unwrap(), 1);
137 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
138 } else { assert!(false); }
139 } else { assert!(false); };
141 check_added_monitors!(nodes[0], 1);
142 let events = nodes[0].node.get_and_clear_pending_events();
143 assert_eq!(events.len(), 1);
146 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
147 // Test that we can recover from a simple temporary monitor update failure optionally with
148 // a disconnect in between
149 let chanmon_cfgs = create_chanmon_cfgs(2);
150 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
151 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
152 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
153 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
155 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
157 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
160 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), false, APIError::MonitorUpdateFailed, {});
161 check_added_monitors!(nodes[0], 1);
164 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
165 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
166 assert_eq!(nodes[0].node.list_channels().len(), 1);
169 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
170 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
171 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
174 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
175 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
176 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
177 check_added_monitors!(nodes[0], 0);
179 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
180 assert_eq!(events_2.len(), 1);
181 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
182 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
183 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
184 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
186 expect_pending_htlcs_forwardable!(nodes[1]);
188 let events_3 = nodes[1].node.get_and_clear_pending_events();
189 assert_eq!(events_3.len(), 1);
191 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
192 assert_eq!(payment_hash_1, *payment_hash);
193 assert_eq!(amt, 1000000);
195 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
196 assert!(payment_preimage.is_none());
197 assert_eq!(payment_secret_1, *payment_secret);
199 _ => panic!("expected PaymentPurpose::InvoicePayment")
202 _ => panic!("Unexpected event"),
205 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
207 // Now set it to failed again...
208 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(&nodes[0], nodes[1], 1000000);
210 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
211 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)), false, APIError::MonitorUpdateFailed, {});
212 check_added_monitors!(nodes[0], 1);
215 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
216 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
217 assert_eq!(nodes[0].node.list_channels().len(), 1);
220 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
221 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
222 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
225 // ...and make sure we can force-close a frozen channel
226 nodes[0].node.force_close_channel(&channel_id).unwrap();
227 check_added_monitors!(nodes[0], 1);
228 check_closed_broadcast!(nodes[0], true);
230 // TODO: Once we hit the chain with the failure transaction we should check that we get a
231 // PaymentPathFailed event
233 assert_eq!(nodes[0].node.list_channels().len(), 0);
234 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
238 fn test_simple_monitor_temporary_update_fail() {
239 do_test_simple_monitor_temporary_update_fail(false);
240 do_test_simple_monitor_temporary_update_fail(true);
243 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
244 let disconnect_flags = 8 | 16;
246 // Test that we can recover from a temporary monitor update failure with some in-flight
247 // HTLCs going on at the same time potentially with some disconnection thrown in.
248 // * First we route a payment, then get a temporary monitor update failure when trying to
249 // route a second payment. We then claim the first payment.
250 // * If disconnect_count is set, we will disconnect at this point (which is likely as
251 // TemporaryFailure likely indicates net disconnect which resulted in failing to update
252 // the ChannelMonitor on a watchtower).
253 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
254 // immediately, otherwise we wait disconnect and deliver them via the reconnect
255 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
256 // disconnect_count & !disconnect_flags is 0).
257 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
258 // through message sending, potentially disconnect/reconnecting multiple times based on
259 // disconnect_count, to get the update_fulfill_htlc through.
260 // * We then walk through more message exchanges to get the original update_add_htlc
261 // through, swapping message ordering based on disconnect_count & 8 and optionally
262 // disconnect/reconnecting based on disconnect_count.
263 let chanmon_cfgs = create_chanmon_cfgs(2);
264 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
265 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
266 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
267 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
269 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
271 // Now try to send a second payment which will fail to send
272 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
274 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
275 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)), false, APIError::MonitorUpdateFailed, {});
276 check_added_monitors!(nodes[0], 1);
279 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
280 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
281 assert_eq!(nodes[0].node.list_channels().len(), 1);
283 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
284 // but nodes[0] won't respond since it is frozen.
285 assert!(nodes[1].node.claim_funds(payment_preimage_1));
286 check_added_monitors!(nodes[1], 1);
287 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
288 assert_eq!(events_2.len(), 1);
289 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
290 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 } } => {
291 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
292 assert!(update_add_htlcs.is_empty());
293 assert_eq!(update_fulfill_htlcs.len(), 1);
294 assert!(update_fail_htlcs.is_empty());
295 assert!(update_fail_malformed_htlcs.is_empty());
296 assert!(update_fee.is_none());
298 if (disconnect_count & 16) == 0 {
299 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
300 let events_3 = nodes[0].node.get_and_clear_pending_events();
301 assert_eq!(events_3.len(), 1);
303 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
304 assert_eq!(*payment_preimage, payment_preimage_1);
305 assert_eq!(*payment_hash, payment_hash_1);
307 _ => panic!("Unexpected event"),
310 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
311 check_added_monitors!(nodes[0], 1);
312 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
313 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
316 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
318 _ => panic!("Unexpected event"),
321 if disconnect_count & !disconnect_flags > 0 {
322 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
323 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
326 // Now fix monitor updating...
327 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
328 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
329 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
330 check_added_monitors!(nodes[0], 0);
332 macro_rules! disconnect_reconnect_peers { () => { {
333 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
334 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
336 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
337 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
338 assert_eq!(reestablish_1.len(), 1);
339 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
340 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
341 assert_eq!(reestablish_2.len(), 1);
343 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
344 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
345 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
346 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
348 assert!(as_resp.0.is_none());
349 assert!(bs_resp.0.is_none());
351 (reestablish_1, reestablish_2, as_resp, bs_resp)
354 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
355 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
356 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
358 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
359 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
360 assert_eq!(reestablish_1.len(), 1);
361 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
362 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
363 assert_eq!(reestablish_2.len(), 1);
365 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
366 check_added_monitors!(nodes[0], 0);
367 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
368 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
369 check_added_monitors!(nodes[1], 0);
370 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
372 assert!(as_resp.0.is_none());
373 assert!(bs_resp.0.is_none());
375 assert!(bs_resp.1.is_none());
376 if (disconnect_count & 16) == 0 {
377 assert!(bs_resp.2.is_none());
379 assert!(as_resp.1.is_some());
380 assert!(as_resp.2.is_some());
381 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
383 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
384 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
385 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
386 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
387 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
388 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
390 assert!(as_resp.1.is_none());
392 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
393 let events_3 = nodes[0].node.get_and_clear_pending_events();
394 assert_eq!(events_3.len(), 1);
396 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
397 assert_eq!(*payment_preimage, payment_preimage_1);
398 assert_eq!(*payment_hash, payment_hash_1);
400 _ => panic!("Unexpected event"),
403 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
404 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
405 // No commitment_signed so get_event_msg's assert(len == 1) passes
406 check_added_monitors!(nodes[0], 1);
408 as_resp.1 = Some(as_resp_raa);
412 if disconnect_count & !disconnect_flags > 1 {
413 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
415 if (disconnect_count & 16) == 0 {
416 assert!(reestablish_1 == second_reestablish_1);
417 assert!(reestablish_2 == second_reestablish_2);
419 assert!(as_resp == second_as_resp);
420 assert!(bs_resp == second_bs_resp);
423 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
425 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
426 assert_eq!(events_4.len(), 2);
427 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
428 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
429 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
432 _ => panic!("Unexpected event"),
436 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
438 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
439 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
440 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
441 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
442 check_added_monitors!(nodes[1], 1);
444 if disconnect_count & !disconnect_flags > 2 {
445 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
447 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
448 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
450 assert!(as_resp.2.is_none());
451 assert!(bs_resp.2.is_none());
454 let as_commitment_update;
455 let bs_second_commitment_update;
457 macro_rules! handle_bs_raa { () => {
458 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
459 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
460 assert!(as_commitment_update.update_add_htlcs.is_empty());
461 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
462 assert!(as_commitment_update.update_fail_htlcs.is_empty());
463 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
464 assert!(as_commitment_update.update_fee.is_none());
465 check_added_monitors!(nodes[0], 1);
468 macro_rules! handle_initial_raa { () => {
469 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
470 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
471 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
472 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
473 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
474 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
475 assert!(bs_second_commitment_update.update_fee.is_none());
476 check_added_monitors!(nodes[1], 1);
479 if (disconnect_count & 8) == 0 {
482 if disconnect_count & !disconnect_flags > 3 {
483 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
485 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
486 assert!(bs_resp.1.is_none());
488 assert!(as_resp.2.unwrap() == as_commitment_update);
489 assert!(bs_resp.2.is_none());
491 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
494 handle_initial_raa!();
496 if disconnect_count & !disconnect_flags > 4 {
497 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
499 assert!(as_resp.1.is_none());
500 assert!(bs_resp.1.is_none());
502 assert!(as_resp.2.unwrap() == as_commitment_update);
503 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
506 handle_initial_raa!();
508 if disconnect_count & !disconnect_flags > 3 {
509 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
511 assert!(as_resp.1.is_none());
512 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
514 assert!(as_resp.2.is_none());
515 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
517 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
522 if disconnect_count & !disconnect_flags > 4 {
523 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
525 assert!(as_resp.1.is_none());
526 assert!(bs_resp.1.is_none());
528 assert!(as_resp.2.unwrap() == as_commitment_update);
529 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
533 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
534 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
535 // No commitment_signed so get_event_msg's assert(len == 1) passes
536 check_added_monitors!(nodes[0], 1);
538 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
539 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
540 // No commitment_signed so get_event_msg's assert(len == 1) passes
541 check_added_monitors!(nodes[1], 1);
543 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
544 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
545 check_added_monitors!(nodes[1], 1);
547 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
548 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
549 check_added_monitors!(nodes[0], 1);
550 expect_payment_path_successful!(nodes[0]);
552 expect_pending_htlcs_forwardable!(nodes[1]);
554 let events_5 = nodes[1].node.get_and_clear_pending_events();
555 assert_eq!(events_5.len(), 1);
557 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
558 assert_eq!(payment_hash_2, *payment_hash);
559 assert_eq!(amt, 1000000);
561 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
562 assert!(payment_preimage.is_none());
563 assert_eq!(payment_secret_2, *payment_secret);
565 _ => panic!("expected PaymentPurpose::InvoicePayment")
568 _ => panic!("Unexpected event"),
571 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
575 fn test_monitor_temporary_update_fail_a() {
576 do_test_monitor_temporary_update_fail(0);
577 do_test_monitor_temporary_update_fail(1);
578 do_test_monitor_temporary_update_fail(2);
579 do_test_monitor_temporary_update_fail(3);
580 do_test_monitor_temporary_update_fail(4);
581 do_test_monitor_temporary_update_fail(5);
585 fn test_monitor_temporary_update_fail_b() {
586 do_test_monitor_temporary_update_fail(2 | 8);
587 do_test_monitor_temporary_update_fail(3 | 8);
588 do_test_monitor_temporary_update_fail(4 | 8);
589 do_test_monitor_temporary_update_fail(5 | 8);
593 fn test_monitor_temporary_update_fail_c() {
594 do_test_monitor_temporary_update_fail(1 | 16);
595 do_test_monitor_temporary_update_fail(2 | 16);
596 do_test_monitor_temporary_update_fail(3 | 16);
597 do_test_monitor_temporary_update_fail(2 | 8 | 16);
598 do_test_monitor_temporary_update_fail(3 | 8 | 16);
602 fn test_monitor_update_fail_cs() {
603 // Tests handling of a monitor update failure when processing an incoming commitment_signed
604 let chanmon_cfgs = create_chanmon_cfgs(2);
605 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
606 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
607 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
608 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
610 let (route, our_payment_hash, payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
612 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
613 check_added_monitors!(nodes[0], 1);
616 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
617 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
619 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
620 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
621 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
622 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
623 check_added_monitors!(nodes[1], 1);
624 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
626 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
627 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
628 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
629 check_added_monitors!(nodes[1], 0);
630 let responses = nodes[1].node.get_and_clear_pending_msg_events();
631 assert_eq!(responses.len(), 2);
634 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
635 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
636 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
637 check_added_monitors!(nodes[0], 1);
639 _ => panic!("Unexpected event"),
642 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
643 assert!(updates.update_add_htlcs.is_empty());
644 assert!(updates.update_fulfill_htlcs.is_empty());
645 assert!(updates.update_fail_htlcs.is_empty());
646 assert!(updates.update_fail_malformed_htlcs.is_empty());
647 assert!(updates.update_fee.is_none());
648 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
650 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
651 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
652 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
653 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
654 check_added_monitors!(nodes[0], 1);
655 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
657 _ => panic!("Unexpected event"),
660 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
661 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
662 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
663 check_added_monitors!(nodes[0], 0);
665 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
666 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
667 check_added_monitors!(nodes[1], 1);
669 expect_pending_htlcs_forwardable!(nodes[1]);
671 let events = nodes[1].node.get_and_clear_pending_events();
672 assert_eq!(events.len(), 1);
674 Event::PaymentReceived { payment_hash, ref purpose, amt } => {
675 assert_eq!(payment_hash, our_payment_hash);
676 assert_eq!(amt, 1000000);
678 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
679 assert!(payment_preimage.is_none());
680 assert_eq!(our_payment_secret, *payment_secret);
682 _ => panic!("expected PaymentPurpose::InvoicePayment")
685 _ => panic!("Unexpected event"),
688 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
692 fn test_monitor_update_fail_no_rebroadcast() {
693 // Tests handling of a monitor update failure when no message rebroadcasting on
694 // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
696 let chanmon_cfgs = create_chanmon_cfgs(2);
697 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
698 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
699 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
700 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
702 let (route, our_payment_hash, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
704 nodes[0].node.send_payment(&route, our_payment_hash, &Some(payment_secret_1)).unwrap();
705 check_added_monitors!(nodes[0], 1);
708 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
709 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
710 let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
712 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
713 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
714 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
715 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
716 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
717 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
718 check_added_monitors!(nodes[1], 1);
720 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
721 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
722 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
723 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
724 check_added_monitors!(nodes[1], 0);
725 expect_pending_htlcs_forwardable!(nodes[1]);
727 let events = nodes[1].node.get_and_clear_pending_events();
728 assert_eq!(events.len(), 1);
730 Event::PaymentReceived { payment_hash, .. } => {
731 assert_eq!(payment_hash, our_payment_hash);
733 _ => panic!("Unexpected event"),
736 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
740 fn test_monitor_update_raa_while_paused() {
741 // Tests handling of an RAA while monitor updating has already been marked failed.
742 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
743 let chanmon_cfgs = create_chanmon_cfgs(2);
744 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
745 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
746 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
747 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
749 send_payment(&nodes[0], &[&nodes[1]], 5000000);
750 let (route, our_payment_hash_1, payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
752 nodes[0].node.send_payment(&route, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
753 check_added_monitors!(nodes[0], 1);
755 let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
757 let (route, our_payment_hash_2, payment_preimage_2, our_payment_secret_2) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000000);
759 nodes[1].node.send_payment(&route, our_payment_hash_2, &Some(our_payment_secret_2)).unwrap();
760 check_added_monitors!(nodes[1], 1);
762 let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
764 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
765 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
766 check_added_monitors!(nodes[1], 1);
767 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
769 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
770 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
771 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
772 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
773 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
774 check_added_monitors!(nodes[0], 1);
776 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
777 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
778 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented responses to RAA".to_string(), 1);
779 check_added_monitors!(nodes[0], 1);
781 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
782 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
783 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
784 check_added_monitors!(nodes[0], 0);
786 let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
787 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
788 check_added_monitors!(nodes[1], 1);
789 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
791 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
792 check_added_monitors!(nodes[1], 1);
793 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
795 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
796 check_added_monitors!(nodes[0], 1);
797 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
799 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
800 check_added_monitors!(nodes[0], 1);
801 expect_pending_htlcs_forwardable!(nodes[0]);
802 expect_payment_received!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
804 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
805 check_added_monitors!(nodes[1], 1);
806 expect_pending_htlcs_forwardable!(nodes[1]);
807 expect_payment_received!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
809 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
810 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
813 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
814 // Tests handling of a monitor update failure when processing an incoming RAA
815 let chanmon_cfgs = create_chanmon_cfgs(3);
816 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
817 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
818 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
819 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
820 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
822 // Rebalance a bit so that we can send backwards from 2 to 1.
823 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
825 // Route a first payment that we'll fail backwards
826 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
828 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
829 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1));
830 expect_pending_htlcs_forwardable!(nodes[2]);
831 check_added_monitors!(nodes[2], 1);
833 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
834 assert!(updates.update_add_htlcs.is_empty());
835 assert!(updates.update_fulfill_htlcs.is_empty());
836 assert_eq!(updates.update_fail_htlcs.len(), 1);
837 assert!(updates.update_fail_malformed_htlcs.is_empty());
838 assert!(updates.update_fee.is_none());
839 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
841 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
842 check_added_monitors!(nodes[0], 0);
844 // While the second channel is AwaitingRAA, forward a second payment to get it into the
846 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
848 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
849 check_added_monitors!(nodes[0], 1);
852 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
853 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
854 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
856 expect_pending_htlcs_forwardable!(nodes[1]);
857 check_added_monitors!(nodes[1], 0);
858 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
860 // Now fail monitor updating.
861 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
862 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
863 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
864 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
865 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
866 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
867 check_added_monitors!(nodes[1], 1);
869 // Forward a third payment which will also be added to the holding cell, despite the channel
870 // being paused waiting a monitor update.
871 let (route, payment_hash_3, _, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
873 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
874 check_added_monitors!(nodes[0], 1);
877 chanmon_cfgs[1].persister.set_update_ret(Ok(())); // We succeed in updating the monitor for the first channel
878 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
879 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
880 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
881 check_added_monitors!(nodes[1], 0);
883 // Call forward_pending_htlcs and check that the new HTLC was simply added to the holding cell
884 // and not forwarded.
885 expect_pending_htlcs_forwardable!(nodes[1]);
886 check_added_monitors!(nodes[1], 0);
887 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
889 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
890 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
891 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
892 nodes[2].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
893 check_added_monitors!(nodes[2], 1);
895 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
896 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
897 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
898 check_added_monitors!(nodes[1], 1);
899 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
900 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
901 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
902 (Some(payment_preimage_4), Some(payment_hash_4))
903 } else { (None, None) };
905 // Restore monitor updating, ensuring we immediately get a fail-back update and a
906 // update_add update.
907 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
908 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
909 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
910 check_added_monitors!(nodes[1], 0);
911 expect_pending_htlcs_forwardable!(nodes[1]);
912 check_added_monitors!(nodes[1], 1);
914 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
915 if test_ignore_second_cs {
916 assert_eq!(events_3.len(), 3);
918 assert_eq!(events_3.len(), 2);
921 // Note that the ordering of the events for different nodes is non-prescriptive, though the
922 // ordering of the two events that both go to nodes[2] have to stay in the same order.
923 let messages_a = match events_3.pop().unwrap() {
924 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
925 assert_eq!(node_id, nodes[0].node.get_our_node_id());
926 assert!(updates.update_fulfill_htlcs.is_empty());
927 assert_eq!(updates.update_fail_htlcs.len(), 1);
928 assert!(updates.update_fail_malformed_htlcs.is_empty());
929 assert!(updates.update_add_htlcs.is_empty());
930 assert!(updates.update_fee.is_none());
931 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
933 _ => panic!("Unexpected event type!"),
935 let raa = if test_ignore_second_cs {
936 match events_3.remove(1) {
937 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
938 assert_eq!(node_id, nodes[2].node.get_our_node_id());
941 _ => panic!("Unexpected event"),
944 let send_event_b = SendEvent::from_event(events_3.remove(0));
945 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
947 // Now deliver the new messages...
949 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
950 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
951 expect_payment_failed!(nodes[0], payment_hash_1, true);
953 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
955 if test_ignore_second_cs {
956 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
957 check_added_monitors!(nodes[2], 1);
958 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
959 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
960 check_added_monitors!(nodes[2], 1);
961 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
962 assert!(bs_cs.update_add_htlcs.is_empty());
963 assert!(bs_cs.update_fail_htlcs.is_empty());
964 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
965 assert!(bs_cs.update_fulfill_htlcs.is_empty());
966 assert!(bs_cs.update_fee.is_none());
968 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
969 check_added_monitors!(nodes[1], 1);
970 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
972 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
973 check_added_monitors!(nodes[1], 1);
975 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
976 check_added_monitors!(nodes[2], 1);
978 let bs_revoke_and_commit = nodes[2].node.get_and_clear_pending_msg_events();
979 assert_eq!(bs_revoke_and_commit.len(), 2);
980 match bs_revoke_and_commit[0] {
981 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
982 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
983 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &msg);
984 check_added_monitors!(nodes[1], 1);
986 _ => panic!("Unexpected event"),
989 as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
991 match bs_revoke_and_commit[1] {
992 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
993 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
994 assert!(updates.update_add_htlcs.is_empty());
995 assert!(updates.update_fail_htlcs.is_empty());
996 assert!(updates.update_fail_malformed_htlcs.is_empty());
997 assert!(updates.update_fulfill_htlcs.is_empty());
998 assert!(updates.update_fee.is_none());
999 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
1000 check_added_monitors!(nodes[1], 1);
1002 _ => panic!("Unexpected event"),
1006 assert_eq!(as_cs.update_add_htlcs.len(), 1);
1007 assert!(as_cs.update_fail_htlcs.is_empty());
1008 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1009 assert!(as_cs.update_fulfill_htlcs.is_empty());
1010 assert!(as_cs.update_fee.is_none());
1011 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1014 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &as_cs.update_add_htlcs[0]);
1015 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1016 check_added_monitors!(nodes[2], 1);
1017 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1019 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1020 check_added_monitors!(nodes[2], 1);
1021 let bs_second_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1023 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1024 check_added_monitors!(nodes[1], 1);
1025 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1027 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_second_cs.commitment_signed);
1028 check_added_monitors!(nodes[1], 1);
1029 let as_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1031 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_second_raa);
1032 check_added_monitors!(nodes[2], 1);
1033 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1035 expect_pending_htlcs_forwardable!(nodes[2]);
1037 let events_6 = nodes[2].node.get_and_clear_pending_events();
1038 assert_eq!(events_6.len(), 2);
1040 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1041 _ => panic!("Unexpected event"),
1044 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1045 _ => panic!("Unexpected event"),
1048 if test_ignore_second_cs {
1049 expect_pending_htlcs_forwardable!(nodes[1]);
1050 check_added_monitors!(nodes[1], 1);
1052 send_event = SendEvent::from_node(&nodes[1]);
1053 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1054 assert_eq!(send_event.msgs.len(), 1);
1055 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1056 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1058 expect_pending_htlcs_forwardable!(nodes[0]);
1060 let events_9 = nodes[0].node.get_and_clear_pending_events();
1061 assert_eq!(events_9.len(), 1);
1063 Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1064 _ => panic!("Unexpected event"),
1066 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1069 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1073 fn test_monitor_update_fail_raa() {
1074 do_test_monitor_update_fail_raa(false);
1075 do_test_monitor_update_fail_raa(true);
1079 fn test_monitor_update_fail_reestablish() {
1080 // Simple test for message retransmission after monitor update failure on
1081 // channel_reestablish generating a monitor update (which comes from freeing holding cell
1083 let chanmon_cfgs = create_chanmon_cfgs(3);
1084 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1085 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1086 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1087 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1088 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1090 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1092 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1093 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1095 assert!(nodes[2].node.claim_funds(payment_preimage));
1096 check_added_monitors!(nodes[2], 1);
1097 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1098 assert!(updates.update_add_htlcs.is_empty());
1099 assert!(updates.update_fail_htlcs.is_empty());
1100 assert!(updates.update_fail_malformed_htlcs.is_empty());
1101 assert!(updates.update_fee.is_none());
1102 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1103 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1104 expect_payment_forwarded!(nodes[1], Some(1000), false);
1105 check_added_monitors!(nodes[1], 1);
1106 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1107 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1109 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1110 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1111 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1113 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1114 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1116 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1118 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1120 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1121 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1123 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1124 check_added_monitors!(nodes[1], 1);
1126 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1127 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1129 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1130 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1132 assert!(as_reestablish == get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id()));
1133 assert!(bs_reestablish == get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()));
1135 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1137 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id())
1138 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1140 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1141 check_added_monitors!(nodes[1], 0);
1143 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id())
1144 .contents.flags & 2, 0); // The "disabled" bit should be unset as we just reconnected
1146 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1147 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1148 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1149 check_added_monitors!(nodes[1], 0);
1151 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1152 assert!(updates.update_add_htlcs.is_empty());
1153 assert!(updates.update_fail_htlcs.is_empty());
1154 assert!(updates.update_fail_malformed_htlcs.is_empty());
1155 assert!(updates.update_fee.is_none());
1156 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1157 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1158 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1159 expect_payment_sent!(nodes[0], payment_preimage);
1163 fn raa_no_response_awaiting_raa_state() {
1164 // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1165 // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1166 // in question (assuming it intends to respond with a CS after monitor updating is restored).
1167 // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1168 let chanmon_cfgs = create_chanmon_cfgs(2);
1169 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1170 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1171 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1172 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1174 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1175 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1176 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1178 // Queue up two payments - one will be delivered right away, one immediately goes into the
1179 // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1180 // immediately after a CS. By setting failing the monitor update failure from the CS (which
1181 // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1182 // generation during RAA while in monitor-update-failed state.
1184 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1185 check_added_monitors!(nodes[0], 1);
1186 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1187 check_added_monitors!(nodes[0], 0);
1190 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1191 assert_eq!(events.len(), 1);
1192 let payment_event = SendEvent::from_event(events.pop().unwrap());
1193 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1194 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1195 check_added_monitors!(nodes[1], 1);
1197 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1198 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1199 check_added_monitors!(nodes[0], 1);
1200 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1201 assert_eq!(events.len(), 1);
1202 let payment_event = SendEvent::from_event(events.pop().unwrap());
1204 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1205 check_added_monitors!(nodes[0], 1);
1206 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1208 // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1209 // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1210 // then restore channel monitor updates.
1211 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1212 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1213 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1214 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1215 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1216 check_added_monitors!(nodes[1], 1);
1218 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1219 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1220 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented responses to RAA".to_string(), 1);
1221 check_added_monitors!(nodes[1], 1);
1223 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1224 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1225 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1226 // nodes[1] should be AwaitingRAA here!
1227 check_added_monitors!(nodes[1], 0);
1228 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1229 expect_pending_htlcs_forwardable!(nodes[1]);
1230 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1232 // We send a third payment here, which is somewhat of a redundant test, but the
1233 // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1234 // commitment transaction states) whereas here we can explicitly check for it.
1236 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1237 check_added_monitors!(nodes[0], 0);
1238 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1240 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1241 check_added_monitors!(nodes[0], 1);
1242 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1243 assert_eq!(events.len(), 1);
1244 let payment_event = SendEvent::from_event(events.pop().unwrap());
1246 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1247 check_added_monitors!(nodes[0], 1);
1248 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1250 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1251 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1252 check_added_monitors!(nodes[1], 1);
1253 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1255 // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1256 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1257 check_added_monitors!(nodes[1], 1);
1258 expect_pending_htlcs_forwardable!(nodes[1]);
1259 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1260 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1262 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1263 check_added_monitors!(nodes[0], 1);
1265 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1266 check_added_monitors!(nodes[0], 1);
1267 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1269 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1270 check_added_monitors!(nodes[1], 1);
1271 expect_pending_htlcs_forwardable!(nodes[1]);
1272 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1274 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1275 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1276 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1280 fn claim_while_disconnected_monitor_update_fail() {
1281 // Test for claiming a payment while disconnected and then having the resulting
1282 // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1283 // contrived case for nodes with network instability.
1284 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1285 // code introduced a regression in this test (specifically, this caught a removal of the
1286 // channel_reestablish handling ensuring the order was sensical given the messages used).
1287 let chanmon_cfgs = create_chanmon_cfgs(2);
1288 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1289 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1290 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1291 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1293 // Forward a payment for B to claim
1294 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1296 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1297 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1299 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1300 check_added_monitors!(nodes[1], 1);
1302 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1303 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1305 let as_reconnect = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1306 let bs_reconnect = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1308 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1309 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1311 // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1313 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1315 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1316 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1317 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1318 check_added_monitors!(nodes[1], 1);
1319 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1321 // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1322 // the monitor still failed
1323 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1325 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1326 check_added_monitors!(nodes[0], 1);
1329 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1330 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1331 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1332 check_added_monitors!(nodes[1], 1);
1333 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1334 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1335 // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1336 // until we've channel_monitor_update'd and updated for the new commitment transaction.
1338 // Now un-fail the monitor, which will result in B sending its original commitment update,
1339 // receiving the commitment update from A, and the resulting commitment dances.
1340 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1341 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1342 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1343 check_added_monitors!(nodes[1], 0);
1345 let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1346 assert_eq!(bs_msgs.len(), 2);
1349 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1350 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1351 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1352 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1353 check_added_monitors!(nodes[0], 1);
1355 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1356 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1357 check_added_monitors!(nodes[1], 1);
1359 _ => panic!("Unexpected event"),
1363 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1364 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1365 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1366 check_added_monitors!(nodes[0], 1);
1368 _ => panic!("Unexpected event"),
1371 let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1373 let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1374 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1375 check_added_monitors!(nodes[0], 1);
1376 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1378 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1379 check_added_monitors!(nodes[1], 1);
1380 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1381 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1382 check_added_monitors!(nodes[1], 1);
1384 expect_pending_htlcs_forwardable!(nodes[1]);
1385 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1387 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1388 check_added_monitors!(nodes[0], 1);
1389 expect_payment_sent!(nodes[0], payment_preimage_1);
1391 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1395 fn monitor_failed_no_reestablish_response() {
1396 // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1397 // response to a commitment_signed.
1398 // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1399 // debug_assert!() failure in channel_reestablish handling.
1400 let chanmon_cfgs = create_chanmon_cfgs(2);
1401 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1402 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1403 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1404 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1406 // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1408 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1410 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1411 check_added_monitors!(nodes[0], 1);
1414 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1415 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1416 assert_eq!(events.len(), 1);
1417 let payment_event = SendEvent::from_event(events.pop().unwrap());
1418 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1419 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1420 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1421 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1422 check_added_monitors!(nodes[1], 1);
1424 // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1425 // is still failing to update monitors.
1426 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1427 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1429 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1430 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1432 let as_reconnect = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1433 let bs_reconnect = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1435 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1436 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1437 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1438 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1440 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1441 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1442 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1443 check_added_monitors!(nodes[1], 0);
1444 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1446 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1447 check_added_monitors!(nodes[0], 1);
1448 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1449 check_added_monitors!(nodes[0], 1);
1451 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1452 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1453 check_added_monitors!(nodes[1], 1);
1455 expect_pending_htlcs_forwardable!(nodes[1]);
1456 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1458 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1462 fn first_message_on_recv_ordering() {
1463 // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1464 // messages, we're willing to flip the order of response messages if neccessary in resposne to
1465 // a commitment_signed which needs to send an RAA first.
1466 // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1467 // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1468 // response. To do this, we start routing two payments, with the final RAA for the first being
1469 // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1470 // have no pending response but will want to send a RAA/CS (with the updates for the second
1471 // payment applied).
1472 // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1473 let chanmon_cfgs = create_chanmon_cfgs(2);
1474 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1475 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1476 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1477 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1479 // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1480 // can deliver it and fail the monitor update.
1481 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1483 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1484 check_added_monitors!(nodes[0], 1);
1487 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1488 assert_eq!(events.len(), 1);
1489 let payment_event = SendEvent::from_event(events.pop().unwrap());
1490 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1491 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1492 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1493 check_added_monitors!(nodes[1], 1);
1494 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1496 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1497 check_added_monitors!(nodes[0], 1);
1498 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1499 check_added_monitors!(nodes[0], 1);
1501 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1503 // Route the second payment, generating an update_add_htlc/commitment_signed
1504 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1506 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1507 check_added_monitors!(nodes[0], 1);
1509 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1510 assert_eq!(events.len(), 1);
1511 let payment_event = SendEvent::from_event(events.pop().unwrap());
1512 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1514 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1516 // Deliver the final RAA for the first payment, which does not require a response. RAAs
1517 // generally require a commitment_signed, so the fact that we're expecting an opposite response
1518 // to the next message also tests resetting the delivery order.
1519 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1520 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1521 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1522 check_added_monitors!(nodes[1], 1);
1524 // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1525 // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1526 // appropriate HTLC acceptance).
1527 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1528 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1529 check_added_monitors!(nodes[1], 1);
1530 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1531 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1533 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1534 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1535 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1536 check_added_monitors!(nodes[1], 0);
1538 expect_pending_htlcs_forwardable!(nodes[1]);
1539 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1541 let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1542 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1543 check_added_monitors!(nodes[0], 1);
1544 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1545 check_added_monitors!(nodes[0], 1);
1547 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1548 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1549 check_added_monitors!(nodes[1], 1);
1551 expect_pending_htlcs_forwardable!(nodes[1]);
1552 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1554 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1555 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1559 fn test_monitor_update_fail_claim() {
1560 // Basic test for monitor update failures when processing claim_funds calls.
1561 // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1562 // update to claim the payment. We then send two payments C->B->A, which are held at B.
1563 // Finally, we restore the channel monitor updating and claim the payment on B, forwarding
1564 // the payments from C onwards to A.
1565 let chanmon_cfgs = create_chanmon_cfgs(3);
1566 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1567 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1568 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1569 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1570 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1572 // Rebalance a bit so that we can send backwards from 3 to 2.
1573 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1575 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1577 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1578 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1579 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1580 check_added_monitors!(nodes[1], 1);
1582 // Note that at this point there is a pending commitment transaction update for A being held by
1583 // B. Even when we go to send the payment from C through B to A, B will not update this
1584 // already-signed commitment transaction and will instead wait for it to resolve before
1585 // forwarding the payment onwards.
1587 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1_000_000);
1589 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1590 check_added_monitors!(nodes[2], 1);
1593 // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1594 // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1595 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1597 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1598 assert_eq!(events.len(), 1);
1599 let payment_event = SendEvent::from_event(events.pop().unwrap());
1600 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1601 let events = nodes[1].node.get_and_clear_pending_msg_events();
1602 assert_eq!(events.len(), 0);
1603 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1605 let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
1606 nodes[2].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1607 check_added_monitors!(nodes[2], 1);
1609 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1610 assert_eq!(events.len(), 1);
1611 let payment_event = SendEvent::from_event(events.pop().unwrap());
1612 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1613 let events = nodes[1].node.get_and_clear_pending_msg_events();
1614 assert_eq!(events.len(), 0);
1615 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1617 // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1618 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1619 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1620 check_added_monitors!(nodes[1], 0);
1622 let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1623 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1624 commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1625 expect_payment_sent!(nodes[0], payment_preimage_1);
1627 // Get the payment forwards, note that they were batched into one commitment update.
1628 expect_pending_htlcs_forwardable!(nodes[1]);
1629 check_added_monitors!(nodes[1], 1);
1630 let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1631 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
1632 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
1633 commitment_signed_dance!(nodes[0], nodes[1], bs_forward_update.commitment_signed, false);
1634 expect_pending_htlcs_forwardable!(nodes[0]);
1636 let events = nodes[0].node.get_and_clear_pending_events();
1637 assert_eq!(events.len(), 2);
1639 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1640 assert_eq!(payment_hash_2, *payment_hash);
1641 assert_eq!(1_000_000, amt);
1643 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1644 assert!(payment_preimage.is_none());
1645 assert_eq!(payment_secret_2, *payment_secret);
1647 _ => panic!("expected PaymentPurpose::InvoicePayment")
1650 _ => panic!("Unexpected event"),
1653 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1654 assert_eq!(payment_hash_3, *payment_hash);
1655 assert_eq!(1_000_000, amt);
1657 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1658 assert!(payment_preimage.is_none());
1659 assert_eq!(payment_secret_3, *payment_secret);
1661 _ => panic!("expected PaymentPurpose::InvoicePayment")
1664 _ => panic!("Unexpected event"),
1669 fn test_monitor_update_on_pending_forwards() {
1670 // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1671 // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1672 // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1673 // from C to A will be pending a forward to A.
1674 let chanmon_cfgs = create_chanmon_cfgs(3);
1675 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1676 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1677 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1678 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1679 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1681 // Rebalance a bit so that we can send backwards from 3 to 1.
1682 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1684 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1685 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1));
1686 expect_pending_htlcs_forwardable!(nodes[2]);
1687 check_added_monitors!(nodes[2], 1);
1689 let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1690 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1691 commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1692 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1694 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[2], nodes[0], 1000000);
1696 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1697 check_added_monitors!(nodes[2], 1);
1700 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1701 assert_eq!(events.len(), 1);
1702 let payment_event = SendEvent::from_event(events.pop().unwrap());
1703 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1704 commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1706 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1707 expect_pending_htlcs_forwardable!(nodes[1]);
1708 check_added_monitors!(nodes[1], 1);
1709 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1710 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1712 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1713 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1714 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1715 check_added_monitors!(nodes[1], 0);
1717 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1718 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1719 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1720 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1722 let events = nodes[0].node.get_and_clear_pending_events();
1723 assert_eq!(events.len(), 2);
1724 if let Event::PaymentPathFailed { payment_hash, rejected_by_dest, .. } = events[0] {
1725 assert_eq!(payment_hash, payment_hash_1);
1726 assert!(rejected_by_dest);
1727 } else { panic!("Unexpected event!"); }
1729 Event::PendingHTLCsForwardable { .. } => { },
1730 _ => panic!("Unexpected event"),
1732 nodes[0].node.process_pending_htlc_forwards();
1733 expect_payment_received!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1735 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1739 fn monitor_update_claim_fail_no_response() {
1740 // Test for claim_funds resulting in both a monitor update failure and no message response (due
1741 // to channel being AwaitingRAA).
1742 // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1744 let chanmon_cfgs = create_chanmon_cfgs(2);
1745 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1746 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1747 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1748 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1750 // Forward a payment for B to claim
1751 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1753 // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1754 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1756 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1757 check_added_monitors!(nodes[0], 1);
1760 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1761 assert_eq!(events.len(), 1);
1762 let payment_event = SendEvent::from_event(events.pop().unwrap());
1763 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1764 let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1766 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1767 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1768 check_added_monitors!(nodes[1], 1);
1769 let events = nodes[1].node.get_and_clear_pending_msg_events();
1770 assert_eq!(events.len(), 0);
1771 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1773 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1774 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1775 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1776 check_added_monitors!(nodes[1], 0);
1777 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1779 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1780 check_added_monitors!(nodes[1], 1);
1781 expect_pending_htlcs_forwardable!(nodes[1]);
1782 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1784 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1785 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1786 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1787 expect_payment_sent!(nodes[0], payment_preimage_1);
1789 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1792 // confirm_a_first and restore_b_before_conf are wholly unrelated to earlier bools and
1793 // restore_b_before_conf has no meaning if !confirm_a_first
1794 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool) {
1795 // Test that if the monitor update generated by funding_transaction_generated fails we continue
1796 // the channel setup happily after the update is restored.
1797 let chanmon_cfgs = create_chanmon_cfgs(2);
1798 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1799 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1800 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1802 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1803 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()));
1804 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()));
1806 let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 43);
1808 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_tx.clone()).unwrap();
1809 check_added_monitors!(nodes[0], 0);
1811 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1812 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1813 let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1814 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1815 check_added_monitors!(nodes[1], 1);
1817 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1818 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()));
1819 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1820 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1821 check_added_monitors!(nodes[0], 1);
1822 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1823 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
1824 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1825 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1826 check_added_monitors!(nodes[0], 0);
1828 let events = nodes[0].node.get_and_clear_pending_events();
1829 assert_eq!(events.len(), 0);
1830 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1831 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1833 if confirm_a_first {
1834 confirm_transaction(&nodes[0], &funding_tx);
1835 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()));
1837 assert!(!restore_b_before_conf);
1838 confirm_transaction(&nodes[1], &funding_tx);
1839 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1842 // Make sure nodes[1] isn't stupid enough to re-send the FundingLocked on reconnect
1843 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1844 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1845 reconnect_nodes(&nodes[0], &nodes[1], (false, confirm_a_first), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1846 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1847 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1849 if !restore_b_before_conf {
1850 confirm_transaction(&nodes[1], &funding_tx);
1851 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1852 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1855 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
1856 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1857 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1858 check_added_monitors!(nodes[1], 0);
1860 let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1861 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()));
1863 confirm_transaction(&nodes[0], &funding_tx);
1864 let (funding_locked, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1865 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked))
1867 if restore_b_before_conf {
1868 confirm_transaction(&nodes[1], &funding_tx);
1870 let (funding_locked, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1871 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &funding_locked))
1873 for node in nodes.iter() {
1874 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
1875 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1876 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1879 send_payment(&nodes[0], &[&nodes[1]], 8000000);
1880 close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1881 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
1882 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1886 fn during_funding_monitor_fail() {
1887 do_during_funding_monitor_fail(true, true);
1888 do_during_funding_monitor_fail(true, false);
1889 do_during_funding_monitor_fail(false, false);
1893 fn test_path_paused_mpp() {
1894 // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1896 let chanmon_cfgs = create_chanmon_cfgs(4);
1897 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1898 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1899 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1901 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1902 let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
1903 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1904 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1906 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
1908 // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1909 let path = route.paths[0].clone();
1910 route.paths.push(path);
1911 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
1912 route.paths[0][0].short_channel_id = chan_1_id;
1913 route.paths[0][1].short_channel_id = chan_3_id;
1914 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
1915 route.paths[1][0].short_channel_id = chan_2_ann.contents.short_channel_id;
1916 route.paths[1][1].short_channel_id = chan_4_id;
1918 // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
1919 // (for the path 0 -> 2 -> 3) fails.
1920 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
1921 chanmon_cfgs[0].persister.set_next_update_ret(Some(Err(ChannelMonitorUpdateErr::TemporaryFailure)));
1923 // Now check that we get the right return value, indicating that the first path succeeded but
1924 // the second got a MonitorUpdateFailed err. This implies PaymentSendFailure::PartialFailure as
1925 // some paths succeeded, preventing retry.
1926 if let Err(PaymentSendFailure::PartialFailure { results, ..}) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)) {
1927 assert_eq!(results.len(), 2);
1928 if let Ok(()) = results[0] {} else { panic!(); }
1929 if let Err(APIError::MonitorUpdateFailed) = results[1] {} else { panic!(); }
1930 } else { panic!(); }
1931 check_added_monitors!(nodes[0], 2);
1932 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
1934 // Pass the first HTLC of the payment along to nodes[3].
1935 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1936 assert_eq!(events.len(), 1);
1937 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), false, None);
1939 // And check that, after we successfully update the monitor for chan_2 we can pass the second
1940 // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
1941 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
1942 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1943 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1944 assert_eq!(events.len(), 1);
1945 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), Some(payment_secret), events.pop().unwrap(), true, None);
1947 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
1951 fn test_pending_update_fee_ack_on_reconnect() {
1952 // In early versions of our automated fee update patch, nodes did not correctly use the
1953 // previous channel feerate after sending an undelivered revoke_and_ack when re-sending an
1954 // undelivered commitment_signed.
1956 // B sends A new HTLC + CS, not delivered
1957 // A sends B update_fee + CS
1958 // B receives the CS and sends RAA, previously causing B to lock in the new feerate
1960 // B resends initial CS, using the original fee
1962 let chanmon_cfgs = create_chanmon_cfgs(2);
1963 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1964 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1965 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1967 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1968 send_payment(&nodes[0], &[&nodes[1]], 100_000_00);
1970 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[1], nodes[0], 1_000_000);
1971 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1972 check_added_monitors!(nodes[1], 1);
1973 let bs_initial_send_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1974 // bs_initial_send_msgs are not delivered until they are re-generated after reconnect
1977 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1980 nodes[0].node.timer_tick_occurred();
1981 check_added_monitors!(nodes[0], 1);
1982 let as_update_fee_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1983 assert!(as_update_fee_msgs.update_fee.is_some());
1985 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_update_fee_msgs.update_fee.as_ref().unwrap());
1986 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_fee_msgs.commitment_signed);
1987 check_added_monitors!(nodes[1], 1);
1988 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1989 // bs_first_raa is not delivered until it is re-generated after reconnect
1991 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1992 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1994 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
1995 let as_connect_msg = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1996 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
1997 let bs_connect_msg = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1999 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2000 let bs_resend_msgs = nodes[1].node.get_and_clear_pending_msg_events();
2001 assert_eq!(bs_resend_msgs.len(), 3);
2002 if let MessageSendEvent::UpdateHTLCs { ref updates, .. } = bs_resend_msgs[0] {
2003 assert_eq!(*updates, bs_initial_send_msgs);
2004 } else { panic!(); }
2005 if let MessageSendEvent::SendRevokeAndACK { ref msg, .. } = bs_resend_msgs[1] {
2006 assert_eq!(*msg, bs_first_raa);
2007 } else { panic!(); }
2008 if let MessageSendEvent::SendChannelUpdate { .. } = bs_resend_msgs[2] { } else { panic!(); }
2010 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2011 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
2013 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.update_add_htlcs[0]);
2014 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_initial_send_msgs.commitment_signed);
2015 check_added_monitors!(nodes[0], 1);
2016 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2017 check_added_monitors!(nodes[1], 1);
2018 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()).commitment_signed;
2020 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2021 check_added_monitors!(nodes[0], 1);
2022 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id()).commitment_signed);
2023 check_added_monitors!(nodes[1], 1);
2024 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2026 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2027 check_added_monitors!(nodes[0], 1);
2028 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2029 check_added_monitors!(nodes[0], 1);
2031 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2032 check_added_monitors!(nodes[1], 1);
2034 expect_pending_htlcs_forwardable!(nodes[0]);
2035 expect_payment_received!(nodes[0], payment_hash, payment_secret, 1_000_000);
2037 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
2040 fn do_update_fee_resend_test(deliver_update: bool, parallel_updates: bool) {
2041 // In early versions we did not handle resending of update_fee on reconnect correctly. The
2042 // chanmon_consistency fuzz target, of course, immediately found it, but we test a few cases
2044 let chanmon_cfgs = create_chanmon_cfgs(2);
2045 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2046 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2047 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2049 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2050 send_payment(&nodes[0], &[&nodes[1]], 1000);
2053 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2054 *feerate_lock += 20;
2056 nodes[0].node.timer_tick_occurred();
2057 check_added_monitors!(nodes[0], 1);
2058 let update_msgs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2059 assert!(update_msgs.update_fee.is_some());
2061 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2064 if parallel_updates {
2066 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
2067 *feerate_lock += 20;
2069 nodes[0].node.timer_tick_occurred();
2070 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2073 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2074 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2076 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
2077 let as_connect_msg = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
2078 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
2079 let bs_connect_msg = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
2081 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_connect_msg);
2082 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
2083 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2085 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_connect_msg);
2086 let mut as_reconnect_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2087 assert_eq!(as_reconnect_msgs.len(), 2);
2088 if let MessageSendEvent::SendChannelUpdate { .. } = as_reconnect_msgs.pop().unwrap() {} else { panic!(); }
2089 let update_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = as_reconnect_msgs.pop().unwrap()
2090 { updates } else { panic!(); };
2091 assert!(update_msgs.update_fee.is_some());
2092 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msgs.update_fee.as_ref().unwrap());
2093 if parallel_updates {
2094 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update_msgs.commitment_signed);
2095 check_added_monitors!(nodes[1], 1);
2096 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2097 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2098 check_added_monitors!(nodes[0], 1);
2099 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2101 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2102 check_added_monitors!(nodes[0], 1);
2103 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2105 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), as_second_update.update_fee.as_ref().unwrap());
2106 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
2107 check_added_monitors!(nodes[1], 1);
2108 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2110 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2111 let bs_second_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2112 check_added_monitors!(nodes[1], 1);
2114 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2115 check_added_monitors!(nodes[0], 1);
2117 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs.commitment_signed);
2118 check_added_monitors!(nodes[0], 1);
2119 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2121 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2122 check_added_monitors!(nodes[1], 1);
2124 commitment_signed_dance!(nodes[1], nodes[0], update_msgs.commitment_signed, false);
2127 send_payment(&nodes[0], &[&nodes[1]], 1000);
2130 fn update_fee_resend_test() {
2131 do_update_fee_resend_test(false, false);
2132 do_update_fee_resend_test(true, false);
2133 do_update_fee_resend_test(false, true);
2134 do_update_fee_resend_test(true, true);
2137 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
2138 // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
2139 // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
2140 // that behavior was both somewhat unexpected and also broken (there was a debug assertion
2141 // which failed in such a case).
2142 let chanmon_cfgs = create_chanmon_cfgs(2);
2143 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2144 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2145 let persister: test_utils::TestPersister;
2146 let new_chain_monitor: test_utils::TestChainMonitor;
2147 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
2148 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2150 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;
2151 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
2152 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2154 // Do a really complicated dance to get an HTLC into the holding cell, with MonitorUpdateFailed
2155 // set but AwaitingRemoteRevoke unset. When this test was written, any attempts to send an HTLC
2156 // while MonitorUpdateFailed is set are immediately failed-backwards. Thus, the only way to get
2157 // an AddHTLC into the holding cell is to add it while AwaitingRemoteRevoke is set but
2158 // MonitorUpdateFailed is unset, and then swap the flags.
2161 // a) routing a payment from node B to node A,
2162 // b) sending a payment from node A to node B without delivering any of the generated messages,
2163 // putting node A in AwaitingRemoteRevoke,
2164 // c) sending a second payment from node A to node B, which is immediately placed in the
2166 // d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2167 // when we try to persist the payment preimage,
2168 // e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2169 // clearing AwaitingRemoteRevoke on node A.
2171 // Note that because, at the end, MonitorUpdateFailed is still set, the HTLC generated in (c)
2172 // will not be freed from the holding cell.
2173 let (payment_preimage_0, _, _) = route_payment(&nodes[1], &[&nodes[0]], 100000);
2175 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
2176 check_added_monitors!(nodes[0], 1);
2177 let send = SendEvent::from_node(&nodes[0]);
2178 assert_eq!(send.msgs.len(), 1);
2180 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
2181 check_added_monitors!(nodes[0], 0);
2183 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2184 assert!(nodes[0].node.claim_funds(payment_preimage_0));
2185 check_added_monitors!(nodes[0], 1);
2187 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2188 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2189 check_added_monitors!(nodes[1], 1);
2191 let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2193 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2194 check_added_monitors!(nodes[0], 1);
2197 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2198 // disconnect the peers. Note that the fuzzer originally found this issue because
2199 // deserializing a ChannelManager in this state causes an assertion failure.
2201 let nodes_0_serialized = nodes[0].node.encode();
2202 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
2203 get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
2205 persister = test_utils::TestPersister::new();
2206 let keys_manager = &chanmon_cfgs[0].keys_manager;
2207 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);
2208 nodes[0].chain_monitor = &new_chain_monitor;
2209 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
2210 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
2211 &mut chan_0_monitor_read, keys_manager).unwrap();
2212 assert!(chan_0_monitor_read.is_empty());
2214 let mut nodes_0_read = &nodes_0_serialized[..];
2215 let config = UserConfig::default();
2216 nodes_0_deserialized = {
2217 let mut channel_monitors = HashMap::new();
2218 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
2219 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
2220 default_config: config,
2222 fee_estimator: node_cfgs[0].fee_estimator,
2223 chain_monitor: nodes[0].chain_monitor,
2224 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
2225 logger: nodes[0].logger,
2229 nodes[0].node = &nodes_0_deserialized;
2230 assert!(nodes_0_read.is_empty());
2232 nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0.clone(), chan_0_monitor).unwrap();
2233 check_added_monitors!(nodes[0], 1);
2235 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2237 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2239 // Now reconnect the two
2240 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2241 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2242 assert_eq!(reestablish_1.len(), 1);
2243 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2244 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2245 assert_eq!(reestablish_2.len(), 1);
2247 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2248 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2249 check_added_monitors!(nodes[1], 0);
2251 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2252 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2254 assert!(resp_0.0.is_none());
2255 assert!(resp_0.1.is_none());
2256 assert!(resp_0.2.is_none());
2257 assert!(resp_1.0.is_none());
2258 assert!(resp_1.1.is_none());
2260 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2262 if let Some(pending_cs) = resp_1.2 {
2263 assert!(pending_cs.update_add_htlcs.is_empty());
2264 assert!(pending_cs.update_fail_htlcs.is_empty());
2265 assert!(pending_cs.update_fulfill_htlcs.is_empty());
2266 assert_eq!(pending_cs.commitment_signed, cs);
2267 } else { panic!(); }
2269 // There should be no monitor updates as we are still pending awaiting a failed one.
2270 check_added_monitors!(nodes[0], 0);
2271 check_added_monitors!(nodes[1], 0);
2274 // If we finish updating the monitor, we should free the holding cell right away (this did
2275 // not occur prior to #756).
2276 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
2277 let (funding_txo, mon_id, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2278 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_txo, mon_id);
2280 // New outbound messages should be generated immediately upon a call to
2281 // get_and_clear_pending_msg_events (but not before).
2282 check_added_monitors!(nodes[0], 0);
2283 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2284 check_added_monitors!(nodes[0], 1);
2285 assert_eq!(events.len(), 1);
2287 // Deliver the pending in-flight CS
2288 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2289 check_added_monitors!(nodes[0], 1);
2291 let commitment_msg = match events.pop().unwrap() {
2292 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2293 assert_eq!(node_id, nodes[1].node.get_our_node_id());
2294 assert!(updates.update_fail_htlcs.is_empty());
2295 assert!(updates.update_fail_malformed_htlcs.is_empty());
2296 assert!(updates.update_fee.is_none());
2297 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2298 nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2299 expect_payment_sent_without_paths!(nodes[1], payment_preimage_0);
2300 assert_eq!(updates.update_add_htlcs.len(), 1);
2301 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2302 updates.commitment_signed
2304 _ => panic!("Unexpected event type!"),
2307 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2308 check_added_monitors!(nodes[1], 1);
2310 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2311 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2312 expect_pending_htlcs_forwardable!(nodes[1]);
2313 expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2314 check_added_monitors!(nodes[1], 1);
2316 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
2318 let events = nodes[1].node.get_and_clear_pending_events();
2319 assert_eq!(events.len(), 2);
2321 Event::PendingHTLCsForwardable { .. } => { },
2322 _ => panic!("Unexpected event"),
2325 Event::PaymentPathSuccessful { .. } => { },
2326 _ => panic!("Unexpected event"),
2329 nodes[1].node.process_pending_htlc_forwards();
2330 expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2332 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2333 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2336 fn channel_holding_cell_serialize() {
2337 do_channel_holding_cell_serialize(true, true);
2338 do_channel_holding_cell_serialize(true, false);
2339 do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2342 #[derive(PartialEq)]
2343 enum HTLCStatusAtDupClaim {
2348 fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_fails: bool) {
2349 // When receiving an update_fulfill_htlc message, we immediately forward the claim backwards
2350 // along the payment path before waiting for a full commitment_signed dance. This is great, but
2351 // can cause duplicative claims if a node sends an update_fulfill_htlc message, disconnects,
2352 // reconnects, and then has to re-send its update_fulfill_htlc message again.
2353 // In previous code, we didn't handle the double-claim correctly, spuriously closing the
2354 // channel on which the inbound HTLC was received.
2355 let chanmon_cfgs = create_chanmon_cfgs(3);
2356 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2357 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2358 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2360 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2361 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known()).2;
2363 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
2365 let mut as_raa = None;
2366 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2367 // In order to get the HTLC claim into the holding cell at nodes[1], we need nodes[1] to be
2368 // awaiting a remote revoke_and_ack from nodes[0].
2369 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
2370 nodes[0].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
2371 check_added_monitors!(nodes[0], 1);
2373 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
2374 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
2375 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
2376 check_added_monitors!(nodes[1], 1);
2378 let (bs_raa, bs_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2379 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2380 check_added_monitors!(nodes[0], 1);
2381 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
2382 check_added_monitors!(nodes[0], 1);
2384 as_raa = Some(get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id()));
2387 let fulfill_msg = msgs::UpdateFulfillHTLC {
2393 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash));
2394 expect_pending_htlcs_forwardable!(nodes[2]);
2395 check_added_monitors!(nodes[2], 1);
2396 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2398 assert!(nodes[2].node.claim_funds(payment_preimage));
2399 check_added_monitors!(nodes[2], 1);
2400 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2401 assert_eq!(cs_updates.update_fulfill_htlcs.len(), 1);
2402 // Check that the message we're about to deliver matches the one generated:
2403 assert_eq!(fulfill_msg, cs_updates.update_fulfill_htlcs[0]);
2405 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &fulfill_msg);
2406 expect_payment_forwarded!(nodes[1], Some(1000), false);
2407 check_added_monitors!(nodes[1], 1);
2409 let mut bs_updates = None;
2410 if htlc_status != HTLCStatusAtDupClaim::HoldingCell {
2411 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2412 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2413 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2414 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2415 if htlc_status == HTLCStatusAtDupClaim::Cleared {
2416 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2417 expect_payment_path_successful!(nodes[0]);
2420 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2423 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
2424 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2427 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
2428 expect_pending_htlcs_forwardable!(nodes[1]);
2430 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2433 if htlc_status == HTLCStatusAtDupClaim::HoldingCell {
2434 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa.unwrap());
2435 check_added_monitors!(nodes[1], 1);
2436 expect_pending_htlcs_forwardable_ignore!(nodes[1]); // We finally receive the second payment, but don't claim it
2438 bs_updates = Some(get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()));
2439 assert_eq!(bs_updates.as_ref().unwrap().update_fulfill_htlcs.len(), 1);
2440 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.as_ref().unwrap().update_fulfill_htlcs[0]);
2441 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
2443 if htlc_status != HTLCStatusAtDupClaim::Cleared {
2444 commitment_signed_dance!(nodes[0], nodes[1], &bs_updates.as_ref().unwrap().commitment_signed, false);
2445 expect_payment_path_successful!(nodes[0]);
2450 fn test_reconnect_dup_htlc_claims() {
2451 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, false);
2452 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, false);
2453 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, false);
2454 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Received, true);
2455 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::HoldingCell, true);
2456 do_test_reconnect_dup_htlc_claims(HTLCStatusAtDupClaim::Cleared, true);
2460 fn test_temporary_error_during_shutdown() {
2461 // Test that temporary failures when updating the monitor's shutdown script delay cooperative
2463 let mut config = test_default_channel_config();
2464 config.channel_options.commit_upfront_shutdown_pubkey = false;
2466 let chanmon_cfgs = create_chanmon_cfgs(2);
2467 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2468 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
2469 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2471 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2473 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2474 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2476 nodes[0].node.close_channel(&channel_id).unwrap();
2477 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
2478 check_added_monitors!(nodes[1], 1);
2480 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id()));
2481 check_added_monitors!(nodes[0], 1);
2483 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2485 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
2486 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
2488 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2489 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2490 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id()));
2492 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2494 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
2495 let (outpoint, latest_update, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2496 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
2498 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id()));
2499 let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
2500 let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2502 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_a.unwrap());
2503 let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
2504 assert!(none_b.is_none());
2505 let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2507 assert_eq!(txn_a, txn_b);
2508 assert_eq!(txn_a.len(), 1);
2509 check_spends!(txn_a[0], funding_tx);
2510 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
2511 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
2515 fn test_permanent_error_during_sending_shutdown() {
2516 // Test that permanent failures when updating the monitor's shutdown script result in a force
2517 // close when initiating a cooperative close.
2518 let mut config = test_default_channel_config();
2519 config.channel_options.commit_upfront_shutdown_pubkey = false;
2521 let chanmon_cfgs = create_chanmon_cfgs(2);
2522 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2523 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
2524 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2526 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
2527 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::PermanentFailure));
2529 assert!(nodes[0].node.close_channel(&channel_id).is_ok());
2530 check_closed_broadcast!(nodes[0], true);
2531 check_added_monitors!(nodes[0], 2);
2532 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2536 fn test_permanent_error_during_handling_shutdown() {
2537 // Test that permanent failures when updating the monitor's shutdown script result in a force
2538 // close when handling a cooperative close.
2539 let mut config = test_default_channel_config();
2540 config.channel_options.commit_upfront_shutdown_pubkey = false;
2542 let chanmon_cfgs = create_chanmon_cfgs(2);
2543 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2544 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
2545 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2547 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
2548 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::PermanentFailure));
2550 assert!(nodes[0].node.close_channel(&channel_id).is_ok());
2551 let shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
2552 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &shutdown);
2553 check_closed_broadcast!(nodes[1], true);
2554 check_added_monitors!(nodes[1], 2);
2555 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
2559 fn double_temp_error() {
2560 // Test that it's OK to have multiple `ChainMonitor::update_channel` calls fail in a row.
2561 let chanmon_cfgs = create_chanmon_cfgs(2);
2562 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2563 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2564 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2566 let (_, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2568 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
2569 let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
2571 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2572 // `claim_funds` results in a ChannelMonitorUpdate.
2573 assert!(nodes[1].node.claim_funds(payment_preimage_1));
2574 check_added_monitors!(nodes[1], 1);
2575 let (funding_tx, latest_update_1, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2577 chanmon_cfgs[1].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2578 // Previously, this would've panicked due to a double-call to `Channel::monitor_update_failed`,
2579 // which had some asserts that prevented it from being called twice.
2580 assert!(nodes[1].node.claim_funds(payment_preimage_2));
2581 check_added_monitors!(nodes[1], 1);
2582 chanmon_cfgs[1].persister.set_update_ret(Ok(()));
2584 let (_, latest_update_2, _) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
2585 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_1);
2586 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2587 check_added_monitors!(nodes[1], 0);
2588 nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(funding_tx, latest_update_2);
2590 // Complete the first HTLC.
2591 let events = nodes[1].node.get_and_clear_pending_msg_events();
2592 assert_eq!(events.len(), 1);
2593 let (update_fulfill_1, commitment_signed_b1, node_id) = {
2595 &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 } } => {
2596 assert!(update_add_htlcs.is_empty());
2597 assert_eq!(update_fulfill_htlcs.len(), 1);
2598 assert!(update_fail_htlcs.is_empty());
2599 assert!(update_fail_malformed_htlcs.is_empty());
2600 assert!(update_fee.is_none());
2601 (update_fulfill_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2603 _ => panic!("Unexpected event"),
2606 assert_eq!(node_id, nodes[0].node.get_our_node_id());
2607 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_1);
2608 check_added_monitors!(nodes[0], 0);
2609 expect_payment_sent_without_paths!(nodes[0], payment_preimage_1);
2610 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_b1);
2611 check_added_monitors!(nodes[0], 1);
2612 nodes[0].node.process_pending_htlc_forwards();
2613 let (raa_a1, commitment_signed_a1) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2614 check_added_monitors!(nodes[1], 0);
2615 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2616 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_a1);
2617 check_added_monitors!(nodes[1], 1);
2618 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed_a1);
2619 check_added_monitors!(nodes[1], 1);
2621 // Complete the second HTLC.
2622 let ((update_fulfill_2, commitment_signed_b2), raa_b2) = {
2623 let events = nodes[1].node.get_and_clear_pending_msg_events();
2624 assert_eq!(events.len(), 2);
2626 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2627 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2628 assert!(updates.update_add_htlcs.is_empty());
2629 assert!(updates.update_fail_htlcs.is_empty());
2630 assert!(updates.update_fail_malformed_htlcs.is_empty());
2631 assert!(updates.update_fee.is_none());
2632 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2633 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2635 _ => panic!("Unexpected event"),
2638 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2639 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2642 _ => panic!("Unexpected event"),
2645 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_b2);
2646 check_added_monitors!(nodes[0], 1);
2647 expect_payment_path_successful!(nodes[0]);
2649 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_2);
2650 check_added_monitors!(nodes[0], 0);
2651 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2652 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed_b2, false);
2653 expect_payment_sent!(nodes[0], payment_preimage_2);