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 for correct behavior across node restarts.
12 use crate::chain::{ChannelMonitorUpdateStatus, Watch};
13 use crate::chain::chaininterface::LowerBoundedFeeEstimator;
14 use crate::chain::channelmonitor::ChannelMonitor;
15 use crate::chain::keysinterface::EntropySource;
16 use crate::chain::transaction::OutPoint;
17 use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider};
18 use crate::ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, PaymentId};
20 use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
21 use crate::util::enforcing_trait_impls::EnforcingSigner;
22 use crate::util::test_utils;
23 use crate::util::errors::APIError;
24 use crate::util::ser::{Writeable, ReadableArgs};
25 use crate::util::config::UserConfig;
26 use crate::util::string::UntrustedString;
28 use bitcoin::hash_types::BlockHash;
30 use crate::prelude::*;
31 use core::default::Default;
32 use crate::sync::Mutex;
34 use crate::ln::functional_test_utils::*;
37 fn test_funding_peer_disconnect() {
38 // Test that we can lock in our funding tx while disconnected
39 let chanmon_cfgs = create_chanmon_cfgs(2);
40 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
41 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
42 let persister: test_utils::TestPersister;
43 let new_chain_monitor: test_utils::TestChainMonitor;
44 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
45 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
46 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
48 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
49 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
51 confirm_transaction(&nodes[0], &tx);
52 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
53 assert!(events_1.is_empty());
55 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
57 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
58 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
60 confirm_transaction(&nodes[1], &tx);
61 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
62 assert!(events_2.is_empty());
64 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
65 let as_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
66 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
67 let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
69 // nodes[0] hasn't yet received a channel_ready, so it only sends that on reconnect.
70 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
71 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
72 assert_eq!(events_3.len(), 1);
73 let as_channel_ready = match events_3[0] {
74 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
75 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
78 _ => panic!("Unexpected event {:?}", events_3[0]),
81 // nodes[1] received nodes[0]'s channel_ready on the first reconnect above, so it should send
82 // announcement_signatures as well as channel_update.
83 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
84 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
85 assert_eq!(events_4.len(), 3);
87 let bs_channel_ready = match events_4[0] {
88 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
89 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
90 chan_id = msg.channel_id;
93 _ => panic!("Unexpected event {:?}", events_4[0]),
95 let bs_announcement_sigs = match events_4[1] {
96 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
97 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
100 _ => panic!("Unexpected event {:?}", events_4[1]),
103 MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } => {
104 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
106 _ => panic!("Unexpected event {:?}", events_4[2]),
109 // Re-deliver nodes[0]'s channel_ready, which nodes[1] can safely ignore. It currently
110 // generates a duplicative private channel_update
111 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_channel_ready);
112 let events_5 = nodes[1].node.get_and_clear_pending_msg_events();
113 assert_eq!(events_5.len(), 1);
115 MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } => {
116 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
118 _ => panic!("Unexpected event {:?}", events_5[0]),
121 // When we deliver nodes[1]'s channel_ready, however, nodes[0] will generate its
122 // announcement_signatures.
123 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &bs_channel_ready);
124 let events_6 = nodes[0].node.get_and_clear_pending_msg_events();
125 assert_eq!(events_6.len(), 1);
126 let as_announcement_sigs = match events_6[0] {
127 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
128 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
131 _ => panic!("Unexpected event {:?}", events_6[0]),
133 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
134 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
136 // When we deliver nodes[1]'s announcement_signatures to nodes[0], nodes[0] should immediately
137 // broadcast the channel announcement globally, as well as re-send its (now-public)
139 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
140 let events_7 = nodes[0].node.get_and_clear_pending_msg_events();
141 assert_eq!(events_7.len(), 1);
142 let (chan_announcement, as_update) = match events_7[0] {
143 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
144 (msg.clone(), update_msg.clone().unwrap())
146 _ => panic!("Unexpected event {:?}", events_7[0]),
149 // Finally, deliver nodes[0]'s announcement_signatures to nodes[1] and make sure it creates the
150 // same channel_announcement.
151 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
152 let events_8 = nodes[1].node.get_and_clear_pending_msg_events();
153 assert_eq!(events_8.len(), 1);
154 let bs_update = match events_8[0] {
155 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
156 assert_eq!(*msg, chan_announcement);
157 update_msg.clone().unwrap()
159 _ => panic!("Unexpected event {:?}", events_8[0]),
162 // Provide the channel announcement and public updates to the network graph
163 nodes[0].gossip_sync.handle_channel_announcement(&chan_announcement).unwrap();
164 nodes[0].gossip_sync.handle_channel_update(&bs_update).unwrap();
165 nodes[0].gossip_sync.handle_channel_update(&as_update).unwrap();
167 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
168 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
169 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
171 // Check that after deserialization and reconnection we can still generate an identical
172 // channel_announcement from the cached signatures.
173 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
175 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
177 reload_node!(nodes[0], &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
179 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
183 fn test_no_txn_manager_serialize_deserialize() {
184 let chanmon_cfgs = create_chanmon_cfgs(2);
185 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
186 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
187 let persister: test_utils::TestPersister;
188 let new_chain_monitor: test_utils::TestChainMonitor;
189 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
190 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
192 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
194 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
196 let chan_0_monitor_serialized =
197 get_monitor!(nodes[0], OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).encode();
198 reload_node!(nodes[0], nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
200 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
201 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
202 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
203 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
205 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
206 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
207 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
208 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
210 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
211 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
212 for node in nodes.iter() {
213 assert!(node.gossip_sync.handle_channel_announcement(&announcement).unwrap());
214 node.gossip_sync.handle_channel_update(&as_update).unwrap();
215 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
218 send_payment(&nodes[0], &[&nodes[1]], 1000000);
222 fn test_manager_serialize_deserialize_events() {
223 // This test makes sure the events field in ChannelManager survives de/serialization
224 let chanmon_cfgs = create_chanmon_cfgs(2);
225 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
226 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
227 let persister: test_utils::TestPersister;
228 let new_chain_monitor: test_utils::TestChainMonitor;
229 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
230 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
232 // Start creating a channel, but stop right before broadcasting the funding transaction
233 let channel_value = 100000;
234 let push_msat = 10001;
235 let node_a = nodes.remove(0);
236 let node_b = nodes.remove(0);
237 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
238 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
239 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
241 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, &node_b.node.get_our_node_id(), channel_value, 42);
243 node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).unwrap();
244 check_added_monitors!(node_a, 0);
246 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
248 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
249 assert_eq!(added_monitors.len(), 1);
250 assert_eq!(added_monitors[0].0, funding_output);
251 added_monitors.clear();
254 let bs_funding_signed = get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id());
255 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &bs_funding_signed);
257 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
258 assert_eq!(added_monitors.len(), 1);
259 assert_eq!(added_monitors[0].0, funding_output);
260 added_monitors.clear();
262 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
267 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
268 let chan_0_monitor_serialized = get_monitor!(nodes[0], bs_funding_signed.channel_id).encode();
269 reload_node!(nodes[0], nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
271 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
273 // After deserializing, make sure the funding_transaction is still held by the channel manager
274 let events_4 = nodes[0].node.get_and_clear_pending_events();
275 assert_eq!(events_4.len(), 0);
276 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
277 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
279 // Make sure the channel is functioning as though the de/serialization never happened
280 assert_eq!(nodes[0].node.list_channels().len(), 1);
282 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
283 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
284 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
285 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
287 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
288 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
289 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
290 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
292 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
293 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
294 for node in nodes.iter() {
295 assert!(node.gossip_sync.handle_channel_announcement(&announcement).unwrap());
296 node.gossip_sync.handle_channel_update(&as_update).unwrap();
297 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
300 send_payment(&nodes[0], &[&nodes[1]], 1000000);
304 fn test_simple_manager_serialize_deserialize() {
305 let chanmon_cfgs = create_chanmon_cfgs(2);
306 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
307 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
308 let persister: test_utils::TestPersister;
309 let new_chain_monitor: test_utils::TestChainMonitor;
310 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
311 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
312 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
314 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
315 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
317 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
319 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
320 reload_node!(nodes[0], nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
322 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
324 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
325 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
329 fn test_manager_serialize_deserialize_inconsistent_monitor() {
330 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
331 let chanmon_cfgs = create_chanmon_cfgs(4);
332 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
333 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
334 let logger: test_utils::TestLogger;
335 let fee_estimator: test_utils::TestFeeEstimator;
336 let persister: test_utils::TestPersister;
337 let new_chain_monitor: test_utils::TestChainMonitor;
338 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
339 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
340 let chan_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1).2;
341 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 2, 0).2;
342 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3);
344 let mut node_0_stale_monitors_serialized = Vec::new();
345 for chan_id_iter in &[chan_id_1, chan_id_2, channel_id] {
346 let mut writer = test_utils::TestVecWriter(Vec::new());
347 get_monitor!(nodes[0], chan_id_iter).write(&mut writer).unwrap();
348 node_0_stale_monitors_serialized.push(writer.0);
351 let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
353 // Serialize the ChannelManager here, but the monitor we keep up-to-date
354 let nodes_0_serialized = nodes[0].node.encode();
356 route_payment(&nodes[0], &[&nodes[3]], 1000000);
357 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
358 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id());
359 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id());
361 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
363 let mut node_0_monitors_serialized = Vec::new();
364 for chan_id_iter in &[chan_id_1, chan_id_2, channel_id] {
365 node_0_monitors_serialized.push(get_monitor!(nodes[0], chan_id_iter).encode());
368 logger = test_utils::TestLogger::new();
369 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
370 persister = test_utils::TestPersister::new();
371 let keys_manager = &chanmon_cfgs[0].keys_manager;
372 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
373 nodes[0].chain_monitor = &new_chain_monitor;
376 let mut node_0_stale_monitors = Vec::new();
377 for serialized in node_0_stale_monitors_serialized.iter() {
378 let mut read = &serialized[..];
379 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, (keys_manager, keys_manager)).unwrap();
380 assert!(read.is_empty());
381 node_0_stale_monitors.push(monitor);
384 let mut node_0_monitors = Vec::new();
385 for serialized in node_0_monitors_serialized.iter() {
386 let mut read = &serialized[..];
387 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, (keys_manager, keys_manager)).unwrap();
388 assert!(read.is_empty());
389 node_0_monitors.push(monitor);
392 let mut nodes_0_read = &nodes_0_serialized[..];
393 if let Err(msgs::DecodeError::InvalidValue) =
394 <(BlockHash, ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
395 default_config: UserConfig::default(),
396 entropy_source: keys_manager,
397 node_signer: keys_manager,
398 signer_provider: keys_manager,
399 fee_estimator: &fee_estimator,
400 router: &nodes[0].router,
401 chain_monitor: nodes[0].chain_monitor,
402 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
404 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
406 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
409 let mut nodes_0_read = &nodes_0_serialized[..];
410 let (_, nodes_0_deserialized_tmp) =
411 <(BlockHash, ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
412 default_config: UserConfig::default(),
413 entropy_source: keys_manager,
414 node_signer: keys_manager,
415 signer_provider: keys_manager,
416 fee_estimator: &fee_estimator,
417 router: nodes[0].router,
418 chain_monitor: nodes[0].chain_monitor,
419 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
421 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
423 nodes_0_deserialized = nodes_0_deserialized_tmp;
424 assert!(nodes_0_read.is_empty());
426 for monitor in node_0_monitors.drain(..) {
427 assert_eq!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
428 ChannelMonitorUpdateStatus::Completed);
429 check_added_monitors!(nodes[0], 1);
431 nodes[0].node = &nodes_0_deserialized;
433 check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager);
434 { // Channel close should result in a commitment tx
435 nodes[0].node.timer_tick_occurred();
436 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
437 assert_eq!(txn.len(), 1);
438 check_spends!(txn[0], funding_tx);
439 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
441 check_added_monitors!(nodes[0], 1);
443 // nodes[1] and nodes[2] have no lost state with nodes[0]...
444 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
445 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
446 //... and we can even still claim the payment!
447 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
449 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap();
450 let reestablish = get_chan_reestablish_msgs!(nodes[3], nodes[0]).pop().unwrap();
451 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: nodes[3].node.init_features(), remote_network_address: None }, false).unwrap();
452 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
453 let mut found_err = false;
454 for msg_event in nodes[0].node.get_and_clear_pending_msg_events() {
455 if let MessageSendEvent::HandleError { ref action, .. } = msg_event {
457 &ErrorAction::SendErrorMessage { ref msg } => {
458 assert_eq!(msg.channel_id, channel_id);
462 _ => panic!("Unexpected event!"),
469 fn do_test_data_loss_protect(reconnect_panicing: bool) {
470 // When we get a data_loss_protect proving we're behind, we immediately panic as the
471 // chain::Watch API requirements have been violated (e.g. the user restored from a backup). The
472 // panic message informs the user they should force-close without broadcasting, which is tested
473 // if `reconnect_panicing` is not set.
474 let mut chanmon_cfgs = create_chanmon_cfgs(2);
475 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
476 // during signing due to revoked tx
477 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
479 let new_chain_monitor;
480 let nodes_0_deserialized;
481 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
482 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
483 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
485 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
487 // Cache node A state before any channel update
488 let previous_node_state = nodes[0].node.encode();
489 let previous_chain_monitor_state = get_monitor!(nodes[0], chan.2).encode();
491 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
492 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
494 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
495 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
497 reload_node!(nodes[0], previous_node_state, &[&previous_chain_monitor_state], persister, new_chain_monitor, nodes_0_deserialized);
499 if reconnect_panicing {
500 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
501 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
503 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
505 // Check we close channel detecting A is fallen-behind
506 // Check that we sent the warning message when we detected that A has fallen behind,
507 // and give the possibility for A to recover from the warning.
508 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
509 let warn_msg = "Peer attempted to reestablish channel with a very old local commitment transaction".to_owned();
510 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan.2).contains(&warn_msg));
513 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
514 // The node B should not broadcast the transaction to force close the channel!
515 assert!(node_txn.is_empty());
518 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
519 // Check A panics upon seeing proof it has fallen behind.
520 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
521 return; // By this point we should have panic'ed!
524 nodes[0].node.force_close_without_broadcasting_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
525 check_added_monitors!(nodes[0], 1);
526 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
528 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
529 assert_eq!(node_txn.len(), 0);
532 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
533 if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
534 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
536 &ErrorAction::SendErrorMessage { ref msg } => {
537 assert_eq!(msg.data, "Channel force-closed");
539 _ => panic!("Unexpected event!"),
542 panic!("Unexpected event {:?}", msg)
546 // after the warning message sent by B, we should not able to
547 // use the channel, or reconnect with success to the channel.
548 assert!(nodes[0].node.list_usable_channels().is_empty());
549 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
550 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
551 let retry_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
553 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &retry_reestablish[0]);
554 let mut err_msgs_0 = Vec::with_capacity(1);
555 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
556 if let MessageSendEvent::HandleError { ref action, .. } = msg {
558 &ErrorAction::SendErrorMessage { ref msg } => {
559 assert_eq!(msg.data, format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", &nodes[1].node.get_our_node_id()));
560 err_msgs_0.push(msg.clone());
562 _ => panic!("Unexpected event!"),
565 panic!("Unexpected event!");
568 assert_eq!(err_msgs_0.len(), 1);
569 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &err_msgs_0[0]);
570 assert!(nodes[1].node.list_usable_channels().is_empty());
571 check_added_monitors!(nodes[1], 1);
572 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", &nodes[1].node.get_our_node_id())) });
573 check_closed_broadcast!(nodes[1], false);
578 fn test_data_loss_protect_showing_stale_state_panics() {
579 do_test_data_loss_protect(true);
583 fn test_force_close_without_broadcast() {
584 do_test_data_loss_protect(false);
588 fn test_forwardable_regen() {
589 // Tests that if we reload a ChannelManager while forwards are pending we will regenerate the
590 // PendingHTLCsForwardable event automatically, ensuring we don't forget to forward/receive
592 // We test it for both payment receipt and payment forwarding.
594 let chanmon_cfgs = create_chanmon_cfgs(3);
595 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
596 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
597 let persister: test_utils::TestPersister;
598 let new_chain_monitor: test_utils::TestChainMonitor;
599 let nodes_1_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
600 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
601 let chan_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1).2;
602 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
604 // First send a payment to nodes[1]
605 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
606 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
607 check_added_monitors!(nodes[0], 1);
609 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
610 assert_eq!(events.len(), 1);
611 let payment_event = SendEvent::from_event(events.pop().unwrap());
612 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
613 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
615 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
617 // Next send a payment which is forwarded by nodes[1]
618 let (route_2, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 200_000);
619 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
620 check_added_monitors!(nodes[0], 1);
622 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
623 assert_eq!(events.len(), 1);
624 let payment_event = SendEvent::from_event(events.pop().unwrap());
625 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
626 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
628 // There is already a PendingHTLCsForwardable event "pending" so another one will not be
630 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
632 // Now restart nodes[1] and make sure it regenerates a single PendingHTLCsForwardable
633 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
634 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
636 let chan_0_monitor_serialized = get_monitor!(nodes[1], chan_id_1).encode();
637 let chan_1_monitor_serialized = get_monitor!(nodes[1], chan_id_2).encode();
638 reload_node!(nodes[1], nodes[1].node.encode(), &[&chan_0_monitor_serialized, &chan_1_monitor_serialized], persister, new_chain_monitor, nodes_1_deserialized);
640 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
641 // Note that nodes[1] and nodes[2] resend their channel_ready here since they haven't updated
642 // the commitment state.
643 reconnect_nodes(&nodes[1], &nodes[2], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
645 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
647 expect_pending_htlcs_forwardable!(nodes[1]);
648 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, 100_000);
649 check_added_monitors!(nodes[1], 1);
651 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
652 assert_eq!(events.len(), 1);
653 let payment_event = SendEvent::from_event(events.pop().unwrap());
654 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
655 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false);
656 expect_pending_htlcs_forwardable!(nodes[2]);
657 expect_payment_claimable!(nodes[2], payment_hash_2, payment_secret_2, 200_000);
659 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
660 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
663 fn do_test_partial_claim_before_restart(persist_both_monitors: bool) {
664 // Test what happens if a node receives an MPP payment, claims it, but crashes before
665 // persisting the ChannelManager. If `persist_both_monitors` is false, also crash after only
666 // updating one of the two channels' ChannelMonitors. As a result, on startup, we'll (a) still
667 // have the PaymentClaimable event, (b) have one (or two) channel(s) that goes on chain with the
668 // HTLC preimage in them, and (c) optionally have one channel that is live off-chain but does
669 // not have the preimage tied to the still-pending HTLC.
671 // To get to the correct state, on startup we should propagate the preimage to the
672 // still-off-chain channel, claiming the HTLC as soon as the peer connects, with the monitor
673 // receiving the preimage without a state update.
675 // Further, we should generate a `PaymentClaimed` event to inform the user that the payment was
676 // definitely claimed.
677 let chanmon_cfgs = create_chanmon_cfgs(4);
678 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
679 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
681 let persister: test_utils::TestPersister;
682 let new_chain_monitor: test_utils::TestChainMonitor;
683 let nodes_3_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
685 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
687 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
688 create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100_000, 0);
689 let chan_id_persisted = create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 100_000, 0).2;
690 let chan_id_not_persisted = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 100_000, 0).2;
692 // Create an MPP route for 15k sats, more than the default htlc-max of 10%
693 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 15_000_000);
694 assert_eq!(route.paths.len(), 2);
695 route.paths.sort_by(|path_a, _| {
696 // Sort the path so that the path through nodes[1] comes first
697 if path_a[0].pubkey == nodes[1].node.get_our_node_id() {
698 core::cmp::Ordering::Less } else { core::cmp::Ordering::Greater }
701 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
702 check_added_monitors!(nodes[0], 2);
704 // Send the payment through to nodes[3] *without* clearing the PaymentClaimable event
705 let mut send_events = nodes[0].node.get_and_clear_pending_msg_events();
706 assert_eq!(send_events.len(), 2);
707 let node_1_msgs = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut send_events);
708 let node_2_msgs = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut send_events);
709 do_pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 15_000_000, payment_hash, Some(payment_secret), node_1_msgs, true, false, None);
710 do_pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 15_000_000, payment_hash, Some(payment_secret), node_2_msgs, true, false, None);
712 // Now that we have an MPP payment pending, get the latest encoded copies of nodes[3]'s
713 // monitors and ChannelManager, for use later, if we don't want to persist both monitors.
714 let mut original_monitor = test_utils::TestVecWriter(Vec::new());
715 if !persist_both_monitors {
716 for outpoint in nodes[3].chain_monitor.chain_monitor.list_monitors() {
717 if outpoint.to_channel_id() == chan_id_not_persisted {
718 assert!(original_monitor.0.is_empty());
719 nodes[3].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut original_monitor).unwrap();
724 let original_manager = nodes[3].node.encode();
726 expect_payment_claimable!(nodes[3], payment_hash, payment_secret, 15_000_000);
728 nodes[3].node.claim_funds(payment_preimage);
729 check_added_monitors!(nodes[3], 2);
730 expect_payment_claimed!(nodes[3], payment_hash, 15_000_000);
732 // Now fetch one of the two updated ChannelMonitors from nodes[3], and restart pretending we
733 // crashed in between the two persistence calls - using one old ChannelMonitor and one new one,
734 // with the old ChannelManager.
735 let mut updated_monitor = test_utils::TestVecWriter(Vec::new());
736 for outpoint in nodes[3].chain_monitor.chain_monitor.list_monitors() {
737 if outpoint.to_channel_id() == chan_id_persisted {
738 assert!(updated_monitor.0.is_empty());
739 nodes[3].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut updated_monitor).unwrap();
742 // If `persist_both_monitors` is set, get the second monitor here as well
743 if persist_both_monitors {
744 for outpoint in nodes[3].chain_monitor.chain_monitor.list_monitors() {
745 if outpoint.to_channel_id() == chan_id_not_persisted {
746 assert!(original_monitor.0.is_empty());
747 nodes[3].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut original_monitor).unwrap();
752 // Now restart nodes[3].
753 reload_node!(nodes[3], original_manager, &[&updated_monitor.0, &original_monitor.0], persister, new_chain_monitor, nodes_3_deserialized);
755 // On startup the preimage should have been copied into the non-persisted monitor:
756 assert!(get_monitor!(nodes[3], chan_id_persisted).get_stored_preimages().contains_key(&payment_hash));
757 assert!(get_monitor!(nodes[3], chan_id_not_persisted).get_stored_preimages().contains_key(&payment_hash));
759 nodes[1].node.peer_disconnected(&nodes[3].node.get_our_node_id());
760 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id());
762 // During deserialization, we should have closed one channel and broadcast its latest
763 // commitment transaction. We should also still have the original PaymentClaimable event we
764 // never finished processing.
765 let events = nodes[3].node.get_and_clear_pending_events();
766 assert_eq!(events.len(), if persist_both_monitors { 4 } else { 3 });
767 if let Event::PaymentClaimable { amount_msat: 15_000_000, .. } = events[0] { } else { panic!(); }
768 if let Event::ChannelClosed { reason: ClosureReason::OutdatedChannelManager, .. } = events[1] { } else { panic!(); }
769 if persist_both_monitors {
770 if let Event::ChannelClosed { reason: ClosureReason::OutdatedChannelManager, .. } = events[2] { } else { panic!(); }
773 // On restart, we should also get a duplicate PaymentClaimed event as we persisted the
774 // ChannelManager prior to handling the original one.
775 if let Event::PaymentClaimed { payment_hash: our_payment_hash, amount_msat: 15_000_000, .. } =
776 events[if persist_both_monitors { 3 } else { 2 }]
778 assert_eq!(payment_hash, our_payment_hash);
781 assert_eq!(nodes[3].node.list_channels().len(), if persist_both_monitors { 0 } else { 1 });
782 if !persist_both_monitors {
783 // If one of the two channels is still live, reveal the payment preimage over it.
785 nodes[3].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: nodes[2].node.init_features(), remote_network_address: None }, true).unwrap();
786 let reestablish_1 = get_chan_reestablish_msgs!(nodes[3], nodes[2]);
787 nodes[2].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: nodes[3].node.init_features(), remote_network_address: None }, false).unwrap();
788 let reestablish_2 = get_chan_reestablish_msgs!(nodes[2], nodes[3]);
790 nodes[2].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish_1[0]);
791 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[3].node.get_our_node_id());
792 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
794 nodes[3].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &reestablish_2[0]);
796 // Once we call `get_and_clear_pending_msg_events` the holding cell is cleared and the HTLC
798 let ds_msgs = nodes[3].node.get_and_clear_pending_msg_events();
799 check_added_monitors!(nodes[3], 1);
800 assert_eq!(ds_msgs.len(), 2);
801 if let MessageSendEvent::SendChannelUpdate { .. } = ds_msgs[0] {} else { panic!(); }
803 let cs_updates = match ds_msgs[1] {
804 MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
805 nodes[2].node.handle_update_fulfill_htlc(&nodes[3].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
806 check_added_monitors!(nodes[2], 1);
807 let cs_updates = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
808 expect_payment_forwarded!(nodes[2], nodes[0], nodes[3], Some(1000), false, false);
809 commitment_signed_dance!(nodes[2], nodes[3], updates.commitment_signed, false, true);
815 nodes[0].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &cs_updates.update_fulfill_htlcs[0]);
816 commitment_signed_dance!(nodes[0], nodes[2], cs_updates.commitment_signed, false, true);
817 expect_payment_sent!(nodes[0], payment_preimage);
822 fn test_partial_claim_before_restart() {
823 do_test_partial_claim_before_restart(false);
824 do_test_partial_claim_before_restart(true);
827 fn do_forwarded_payment_no_manager_persistence(use_cs_commitment: bool, claim_htlc: bool, use_intercept: bool) {
828 if !use_cs_commitment { assert!(!claim_htlc); }
829 // If we go to forward a payment, and the ChannelMonitor persistence completes, but the
830 // ChannelManager does not, we shouldn't try to forward the payment again, nor should we fail
831 // it back until the ChannelMonitor decides the fate of the HTLC.
832 // This was never an issue, but it may be easy to regress here going forward.
833 let chanmon_cfgs = create_chanmon_cfgs(3);
834 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
835 let mut intercept_forwards_config = test_default_channel_config();
836 intercept_forwards_config.accept_intercept_htlcs = true;
837 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(intercept_forwards_config), None]);
840 let new_chain_monitor;
841 let nodes_1_deserialized;
843 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
845 let chan_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1).2;
846 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
848 let intercept_scid = nodes[1].node.get_intercept_scid();
850 let (mut route, payment_hash, payment_preimage, payment_secret) =
851 get_route_and_payment_hash!(nodes[0], nodes[2], 1_000_000);
853 route.paths[0][1].short_channel_id = intercept_scid;
855 let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
856 let htlc_expiry = nodes[0].best_block_info().1 + TEST_FINAL_CLTV;
857 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), payment_id).unwrap();
858 check_added_monitors!(nodes[0], 1);
860 let payment_event = SendEvent::from_node(&nodes[0]);
861 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
862 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
864 // Store the `ChannelManager` before handling the `PendingHTLCsForwardable`/`HTLCIntercepted`
865 // events, expecting either event (and the HTLC itself) to be missing on reload even though its
866 // present when we serialized.
867 let node_encoded = nodes[1].node.encode();
869 let mut intercept_id = None;
870 let mut expected_outbound_amount_msat = None;
872 let events = nodes[1].node.get_and_clear_pending_events();
873 assert_eq!(events.len(), 1);
875 Event::HTLCIntercepted { intercept_id: ev_id, expected_outbound_amount_msat: ev_amt, .. } => {
876 intercept_id = Some(ev_id);
877 expected_outbound_amount_msat = Some(ev_amt);
881 nodes[1].node.forward_intercepted_htlc(intercept_id.unwrap(), &chan_id_2,
882 nodes[2].node.get_our_node_id(), expected_outbound_amount_msat.unwrap()).unwrap();
885 expect_pending_htlcs_forwardable!(nodes[1]);
887 let payment_event = SendEvent::from_node(&nodes[1]);
888 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
889 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
890 check_added_monitors!(nodes[2], 1);
893 get_monitor!(nodes[2], chan_id_2).provide_payment_preimage(&payment_hash, &payment_preimage,
894 &nodes[2].tx_broadcaster, &LowerBoundedFeeEstimator(nodes[2].fee_estimator), &nodes[2].logger);
896 assert!(nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
898 let _ = nodes[2].node.get_and_clear_pending_msg_events();
900 nodes[2].node.force_close_broadcasting_latest_txn(&chan_id_2, &nodes[1].node.get_our_node_id()).unwrap();
901 let cs_commitment_tx = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
902 assert_eq!(cs_commitment_tx.len(), if claim_htlc { 2 } else { 1 });
904 check_added_monitors!(nodes[2], 1);
905 check_closed_event!(nodes[2], 1, ClosureReason::HolderForceClosed);
906 check_closed_broadcast!(nodes[2], true);
908 let chan_0_monitor_serialized = get_monitor!(nodes[1], chan_id_1).encode();
909 let chan_1_monitor_serialized = get_monitor!(nodes[1], chan_id_2).encode();
910 reload_node!(nodes[1], node_encoded, &[&chan_0_monitor_serialized, &chan_1_monitor_serialized], persister, new_chain_monitor, nodes_1_deserialized);
912 // Note that this checks that this is the only event on nodes[1], implying the
913 // `HTLCIntercepted` event has been removed in the `use_intercept` case.
914 check_closed_event!(nodes[1], 1, ClosureReason::OutdatedChannelManager);
917 // Attempt to forward the HTLC back out over nodes[1]' still-open channel, ensuring we get
918 // a intercept-doesn't-exist error.
919 let forward_err = nodes[1].node.forward_intercepted_htlc(intercept_id.unwrap(), &chan_id_1,
920 nodes[0].node.get_our_node_id(), expected_outbound_amount_msat.unwrap()).unwrap_err();
921 assert_eq!(forward_err, APIError::APIMisuseError {
922 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.unwrap().0))
926 nodes[1].node.timer_tick_occurred();
927 let bs_commitment_tx = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
928 assert_eq!(bs_commitment_tx.len(), 1);
929 check_added_monitors!(nodes[1], 1);
931 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
932 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
934 if use_cs_commitment {
935 // If we confirm a commitment transaction that has the HTLC on-chain, nodes[1] should wait
936 // for an HTLC-spending transaction before it does anything with the HTLC upstream.
937 confirm_transaction(&nodes[1], &cs_commitment_tx[0]);
938 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
939 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
942 confirm_transaction(&nodes[1], &cs_commitment_tx[1]);
944 connect_blocks(&nodes[1], htlc_expiry - nodes[1].best_block_info().1);
945 let bs_htlc_timeout_tx = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
946 assert_eq!(bs_htlc_timeout_tx.len(), 1);
947 confirm_transaction(&nodes[1], &bs_htlc_timeout_tx[0]);
950 confirm_transaction(&nodes[1], &bs_commitment_tx[0]);
954 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], [HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_id_2 }]);
956 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, true);
958 check_added_monitors!(nodes[1], 1);
960 let events = nodes[1].node.get_and_clear_pending_msg_events();
961 assert_eq!(events.len(), 1);
963 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { update_fulfill_htlcs, update_fail_htlcs, commitment_signed, .. }, .. } => {
965 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
967 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
969 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
971 _ => panic!("Unexpected event"),
975 expect_payment_sent!(nodes[0], payment_preimage);
977 expect_payment_failed!(nodes[0], payment_hash, false);
982 fn forwarded_payment_no_manager_persistence() {
983 do_forwarded_payment_no_manager_persistence(true, true, false);
984 do_forwarded_payment_no_manager_persistence(true, false, false);
985 do_forwarded_payment_no_manager_persistence(false, false, false);
989 fn intercepted_payment_no_manager_persistence() {
990 do_forwarded_payment_no_manager_persistence(true, true, true);
991 do_forwarded_payment_no_manager_persistence(true, false, true);
992 do_forwarded_payment_no_manager_persistence(false, false, true);
996 fn removed_payment_no_manager_persistence() {
997 // If an HTLC is failed to us on a channel, and the ChannelMonitor persistence completes, but
998 // the corresponding ChannelManager persistence does not, we need to ensure that the HTLC is
999 // still failed back to the previous hop even though the ChannelMonitor now no longer is aware
1000 // of the HTLC. This was previously broken as no attempt was made to figure out which HTLCs
1001 // were left dangling when a channel was force-closed due to a stale ChannelManager.
1002 let chanmon_cfgs = create_chanmon_cfgs(3);
1003 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1004 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1007 let new_chain_monitor;
1008 let nodes_1_deserialized;
1010 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1012 let chan_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1013 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
1015 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
1017 let node_encoded = nodes[1].node.encode();
1019 nodes[2].node.fail_htlc_backwards(&payment_hash);
1020 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], [HTLCDestination::FailedPayment { payment_hash }]);
1021 check_added_monitors!(nodes[2], 1);
1022 let events = nodes[2].node.get_and_clear_pending_msg_events();
1023 assert_eq!(events.len(), 1);
1025 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. }, .. } => {
1026 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &update_fail_htlcs[0]);
1027 commitment_signed_dance!(nodes[1], nodes[2], commitment_signed, false);
1029 _ => panic!("Unexpected event"),
1032 let chan_0_monitor_serialized = get_monitor!(nodes[1], chan_id_1).encode();
1033 let chan_1_monitor_serialized = get_monitor!(nodes[1], chan_id_2).encode();
1034 reload_node!(nodes[1], node_encoded, &[&chan_0_monitor_serialized, &chan_1_monitor_serialized], persister, new_chain_monitor, nodes_1_deserialized);
1036 match nodes[1].node.pop_pending_event().unwrap() {
1037 Event::ChannelClosed { ref reason, .. } => {
1038 assert_eq!(*reason, ClosureReason::OutdatedChannelManager);
1040 _ => panic!("Unexpected event"),
1043 // Now that the ChannelManager has force-closed the channel which had the HTLC removed, it is
1044 // now forgotten everywhere. The ChannelManager should have, as a side-effect of reload,
1045 // learned that the HTLC is gone from the ChannelMonitor and added it to the to-fail-back set.
1046 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1047 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1049 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], [HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_id_2 }]);
1050 check_added_monitors!(nodes[1], 1);
1051 let events = nodes[1].node.get_and_clear_pending_msg_events();
1052 assert_eq!(events.len(), 1);
1054 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. }, .. } => {
1055 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
1056 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
1058 _ => panic!("Unexpected event"),
1061 expect_payment_failed!(nodes[0], payment_hash, false);