Use hashbrown replacements for std equivalents
[rust-lightning] / lightning / src / ln / chanmon_update_fail_tests.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
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
8 // licenses.
9
10 //! Functional tests which test the correct handling of ChannelMonitorUpdateErr returns from
11 //! monitor updates.
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.
14
15 use bitcoin::blockdata::block::{Block, BlockHeader};
16 use bitcoin::blockdata::constants::genesis_block;
17 use bitcoin::hash_types::BlockHash;
18 use bitcoin::network::constants::Network;
19 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr};
20 use chain::transaction::OutPoint;
21 use chain::Listen;
22 use chain::Watch;
23 use ln::{PaymentPreimage, PaymentHash};
24 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
25 use ln::features::{InitFeatures, InvoiceFeatures};
26 use ln::msgs;
27 use ln::msgs::{ChannelMessageHandler, ErrorAction, RoutingMessageHandler};
28 use routing::router::get_route;
29 use util::config::UserConfig;
30 use util::enforcing_trait_impls::EnforcingSigner;
31 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
32 use util::errors::APIError;
33 use util::ser::{ReadableArgs, Writeable};
34 use util::test_utils::TestBroadcaster;
35
36 use bitcoin::hashes::sha256::Hash as Sha256;
37 use bitcoin::hashes::Hash;
38
39 use ln::functional_test_utils::*;
40
41 use util::test_utils;
42
43 use prelude::*;
44 use std::sync::{Arc, Mutex};
45
46 // If persister_fail is true, we have the persister return a PermanentFailure
47 // instead of the higher-level ChainMonitor.
48 fn do_test_simple_monitor_permanent_update_fail(persister_fail: bool) {
49         // Test that we handle a simple permanent monitor update failure
50         let mut chanmon_cfgs = create_chanmon_cfgs(2);
51         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
52         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
53         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
54         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
55         let logger = test_utils::TestLogger::new();
56
57         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(&nodes[1]);
58
59         match persister_fail {
60                 true => chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::PermanentFailure)),
61                 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::PermanentFailure))
62         }
63         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
64         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
65         unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable {..}, {});
66         check_added_monitors!(nodes[0], 2);
67
68         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
69         assert_eq!(events_1.len(), 2);
70         match events_1[0] {
71                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
72                 _ => panic!("Unexpected event"),
73         };
74         match events_1[1] {
75                 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
76                 _ => panic!("Unexpected event"),
77         };
78
79         // TODO: Once we hit the chain with the failure transaction we should check that we get a
80         // PaymentFailed event
81
82         assert_eq!(nodes[0].node.list_channels().len(), 0);
83 }
84
85 #[test]
86 fn test_monitor_and_persister_update_fail() {
87         // Test that if both updating the `ChannelMonitor` and persisting the updated
88         // `ChannelMonitor` fail, then the failure from updating the `ChannelMonitor`
89         // one that gets returned.
90         let chanmon_cfgs = create_chanmon_cfgs(2);
91         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
92         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
93         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
94
95         // Create some initial channel
96         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
97         let outpoint = OutPoint { txid: chan.3.txid(), index: 0 };
98
99         // Rebalance the network to generate htlc in the two directions
100         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
101
102         // Route an HTLC from node 0 to node 1 (but don't settle)
103         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
104
105         // Make a copy of the ChainMonitor so we can capture the error it returns on a
106         // bogus update. Note that if instead we updated the nodes[0]'s ChainMonitor
107         // directly, the node would fail to be `Drop`'d at the end because its
108         // ChannelManager and ChainMonitor would be out of sync.
109         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
110         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
111         let persister = test_utils::TestPersister::new();
112         let tx_broadcaster = TestBroadcaster {
113                 txn_broadcasted: Mutex::new(Vec::new()),
114                 // Because we will connect a block at height 200 below, we need the TestBroadcaster to know
115                 // that we are at height 200 so that it doesn't think we're violating the time lock
116                 // requirements of transactions broadcasted at that point.
117                 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 200); 200])),
118         };
119         let chain_mon = {
120                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
121                 let monitor = monitors.get(&outpoint).unwrap();
122                 let mut w = test_utils::TestVecWriter(Vec::new());
123                 monitor.write(&mut w).unwrap();
124                 let new_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
125                         &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
126                 assert!(new_monitor == *monitor);
127                 let chain_mon = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
128                 assert!(chain_mon.watch_channel(outpoint, new_monitor).is_ok());
129                 chain_mon
130         };
131         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
132         chain_mon.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
133
134         // Set the persister's return value to be a TemporaryFailure.
135         persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
136
137         // Try to update ChannelMonitor
138         assert!(nodes[1].node.claim_funds(preimage));
139         check_added_monitors!(nodes[1], 1);
140         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
141         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
142         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
143         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2) {
144                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
145                         // Check that even though the persister is returning a TemporaryFailure,
146                         // because the update is bogus, ultimately the error that's returned
147                         // should be a PermanentFailure.
148                         if let Err(ChannelMonitorUpdateErr::PermanentFailure) = chain_mon.chain_monitor.update_channel(outpoint, update.clone()) {} else { panic!("Expected monitor error to be permanent"); }
149                         logger.assert_log_contains("lightning::chain::chainmonitor".to_string(), "Failed to persist channel monitor update: TemporaryFailure".to_string(), 1);
150                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
151                 } else { assert!(false); }
152         } else { assert!(false); };
153
154         check_added_monitors!(nodes[0], 1);
155         let events = nodes[0].node.get_and_clear_pending_events();
156         assert_eq!(events.len(), 1);
157 }
158
159 #[test]
160 fn test_simple_monitor_permanent_update_fail() {
161         do_test_simple_monitor_permanent_update_fail(false);
162
163         // Test behavior when the persister returns a PermanentFailure.
164         do_test_simple_monitor_permanent_update_fail(true);
165 }
166
167 // If persister_fail is true, we have the persister return a TemporaryFailure instead of the
168 // higher-level ChainMonitor.
169 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool, persister_fail: bool) {
170         // Test that we can recover from a simple temporary monitor update failure optionally with
171         // a disconnect in between
172         let mut chanmon_cfgs = create_chanmon_cfgs(2);
173         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
174         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
175         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
176         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
177         let logger = test_utils::TestLogger::new();
178
179         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(&nodes[1]);
180
181         match persister_fail {
182                 true => chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure)),
183                 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure))
184         }
185
186         {
187                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
188                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
189                 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), false, APIError::MonitorUpdateFailed, {});
190                 check_added_monitors!(nodes[0], 1);
191         }
192
193         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
194         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
195         assert_eq!(nodes[0].node.list_channels().len(), 1);
196
197         if disconnect {
198                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
199                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
200                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
201         }
202
203         match persister_fail {
204                 true => chanmon_cfgs[0].persister.set_update_ret(Ok(())),
205                 false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()))
206         }
207         let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
208         nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
209         check_added_monitors!(nodes[0], 0);
210
211         let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
212         assert_eq!(events_2.len(), 1);
213         let payment_event = SendEvent::from_event(events_2.pop().unwrap());
214         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
215         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
216         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
217
218         expect_pending_htlcs_forwardable!(nodes[1]);
219
220         let events_3 = nodes[1].node.get_and_clear_pending_events();
221         assert_eq!(events_3.len(), 1);
222         match events_3[0] {
223                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
224                         assert_eq!(payment_hash_1, *payment_hash);
225                         assert!(payment_preimage.is_none());
226                         assert_eq!(payment_secret_1, *payment_secret);
227                         assert_eq!(amt, 1000000);
228                 },
229                 _ => panic!("Unexpected event"),
230         }
231
232         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
233
234         // Now set it to failed again...
235         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
236         {
237                 match persister_fail {
238                         true => chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure)),
239                         false => *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure))
240                 }
241                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
242                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
243                 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)), false, APIError::MonitorUpdateFailed, {});
244                 check_added_monitors!(nodes[0], 1);
245         }
246
247         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
248         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
249         assert_eq!(nodes[0].node.list_channels().len(), 1);
250
251         if disconnect {
252                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
253                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
254                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
255         }
256
257         // ...and make sure we can force-close a frozen channel
258         nodes[0].node.force_close_channel(&channel_id).unwrap();
259         check_added_monitors!(nodes[0], 1);
260         check_closed_broadcast!(nodes[0], true);
261
262         // TODO: Once we hit the chain with the failure transaction we should check that we get a
263         // PaymentFailed event
264
265         assert_eq!(nodes[0].node.list_channels().len(), 0);
266 }
267
268 #[test]
269 fn test_simple_monitor_temporary_update_fail() {
270         do_test_simple_monitor_temporary_update_fail(false, false);
271         do_test_simple_monitor_temporary_update_fail(true, false);
272
273         // Test behavior when the persister returns a TemporaryFailure.
274         do_test_simple_monitor_temporary_update_fail(false, true);
275         do_test_simple_monitor_temporary_update_fail(true, true);
276 }
277
278 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
279         let disconnect_flags = 8 | 16;
280
281         // Test that we can recover from a temporary monitor update failure with some in-flight
282         // HTLCs going on at the same time potentially with some disconnection thrown in.
283         // * First we route a payment, then get a temporary monitor update failure when trying to
284         //   route a second payment. We then claim the first payment.
285         // * If disconnect_count is set, we will disconnect at this point (which is likely as
286         //   TemporaryFailure likely indicates net disconnect which resulted in failing to update
287         //   the ChannelMonitor on a watchtower).
288         // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
289         //   immediately, otherwise we wait disconnect and deliver them via the reconnect
290         //   channel_reestablish processing (ie disconnect_count & 16 makes no sense if
291         //   disconnect_count & !disconnect_flags is 0).
292         // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
293         //   through message sending, potentially disconnect/reconnecting multiple times based on
294         //   disconnect_count, to get the update_fulfill_htlc through.
295         // * We then walk through more message exchanges to get the original update_add_htlc
296         //   through, swapping message ordering based on disconnect_count & 8 and optionally
297         //   disconnect/reconnecting based on disconnect_count.
298         let chanmon_cfgs = create_chanmon_cfgs(2);
299         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
300         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
301         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
302         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
303         let logger = test_utils::TestLogger::new();
304
305         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
306
307         // Now try to send a second payment which will fail to send
308         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
309         {
310                 *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
311                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
312                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
313                 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)), false, APIError::MonitorUpdateFailed, {});
314                 check_added_monitors!(nodes[0], 1);
315         }
316
317         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
318         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
319         assert_eq!(nodes[0].node.list_channels().len(), 1);
320
321         // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
322         // but nodes[0] won't respond since it is frozen.
323         assert!(nodes[1].node.claim_funds(payment_preimage_1));
324         check_added_monitors!(nodes[1], 1);
325         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
326         assert_eq!(events_2.len(), 1);
327         let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
328                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
329                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
330                         assert!(update_add_htlcs.is_empty());
331                         assert_eq!(update_fulfill_htlcs.len(), 1);
332                         assert!(update_fail_htlcs.is_empty());
333                         assert!(update_fail_malformed_htlcs.is_empty());
334                         assert!(update_fee.is_none());
335
336                         if (disconnect_count & 16) == 0 {
337                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
338                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
339                                 assert_eq!(events_3.len(), 1);
340                                 match events_3[0] {
341                                         Event::PaymentSent { ref payment_preimage } => {
342                                                 assert_eq!(*payment_preimage, payment_preimage_1);
343                                         },
344                                         _ => panic!("Unexpected event"),
345                                 }
346
347                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
348                                 check_added_monitors!(nodes[0], 1);
349                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
350                                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
351                         }
352
353                         (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
354                 },
355                 _ => panic!("Unexpected event"),
356         };
357
358         if disconnect_count & !disconnect_flags > 0 {
359                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
360                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
361         }
362
363         // Now fix monitor updating...
364         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
365         let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
366         nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
367         check_added_monitors!(nodes[0], 0);
368
369         macro_rules! disconnect_reconnect_peers { () => { {
370                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
371                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
372
373                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
374                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
375                 assert_eq!(reestablish_1.len(), 1);
376                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
377                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
378                 assert_eq!(reestablish_2.len(), 1);
379
380                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
381                 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
382                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
383                 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
384
385                 assert!(as_resp.0.is_none());
386                 assert!(bs_resp.0.is_none());
387
388                 (reestablish_1, reestablish_2, as_resp, bs_resp)
389         } } }
390
391         let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
392                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
393                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
394
395                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
396                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
397                 assert_eq!(reestablish_1.len(), 1);
398                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
399                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
400                 assert_eq!(reestablish_2.len(), 1);
401
402                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
403                 check_added_monitors!(nodes[0], 0);
404                 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
405                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
406                 check_added_monitors!(nodes[1], 0);
407                 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
408
409                 assert!(as_resp.0.is_none());
410                 assert!(bs_resp.0.is_none());
411
412                 assert!(bs_resp.1.is_none());
413                 if (disconnect_count & 16) == 0 {
414                         assert!(bs_resp.2.is_none());
415
416                         assert!(as_resp.1.is_some());
417                         assert!(as_resp.2.is_some());
418                         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
419                 } else {
420                         assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
421                         assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
422                         assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
423                         assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
424                         assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
425                         assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
426
427                         assert!(as_resp.1.is_none());
428
429                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]);
430                         let events_3 = nodes[0].node.get_and_clear_pending_events();
431                         assert_eq!(events_3.len(), 1);
432                         match events_3[0] {
433                                 Event::PaymentSent { ref payment_preimage } => {
434                                         assert_eq!(*payment_preimage, payment_preimage_1);
435                                 },
436                                 _ => panic!("Unexpected event"),
437                         }
438
439                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed);
440                         let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
441                         // No commitment_signed so get_event_msg's assert(len == 1) passes
442                         check_added_monitors!(nodes[0], 1);
443
444                         as_resp.1 = Some(as_resp_raa);
445                         bs_resp.2 = None;
446                 }
447
448                 if disconnect_count & !disconnect_flags > 1 {
449                         let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
450
451                         if (disconnect_count & 16) == 0 {
452                                 assert!(reestablish_1 == second_reestablish_1);
453                                 assert!(reestablish_2 == second_reestablish_2);
454                         }
455                         assert!(as_resp == second_as_resp);
456                         assert!(bs_resp == second_bs_resp);
457                 }
458
459                 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
460         } else {
461                 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
462                 assert_eq!(events_4.len(), 2);
463                 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
464                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
465                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
466                                 msg.clone()
467                         },
468                         _ => panic!("Unexpected event"),
469                 })
470         };
471
472         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
473
474         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
475         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
476         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
477         // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
478         check_added_monitors!(nodes[1], 1);
479
480         if disconnect_count & !disconnect_flags > 2 {
481                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
482
483                 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
484                 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
485
486                 assert!(as_resp.2.is_none());
487                 assert!(bs_resp.2.is_none());
488         }
489
490         let as_commitment_update;
491         let bs_second_commitment_update;
492
493         macro_rules! handle_bs_raa { () => {
494                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
495                 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
496                 assert!(as_commitment_update.update_add_htlcs.is_empty());
497                 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
498                 assert!(as_commitment_update.update_fail_htlcs.is_empty());
499                 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
500                 assert!(as_commitment_update.update_fee.is_none());
501                 check_added_monitors!(nodes[0], 1);
502         } }
503
504         macro_rules! handle_initial_raa { () => {
505                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack);
506                 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
507                 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
508                 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
509                 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
510                 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
511                 assert!(bs_second_commitment_update.update_fee.is_none());
512                 check_added_monitors!(nodes[1], 1);
513         } }
514
515         if (disconnect_count & 8) == 0 {
516                 handle_bs_raa!();
517
518                 if disconnect_count & !disconnect_flags > 3 {
519                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
520
521                         assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
522                         assert!(bs_resp.1.is_none());
523
524                         assert!(as_resp.2.unwrap() == as_commitment_update);
525                         assert!(bs_resp.2.is_none());
526
527                         assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
528                 }
529
530                 handle_initial_raa!();
531
532                 if disconnect_count & !disconnect_flags > 4 {
533                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
534
535                         assert!(as_resp.1.is_none());
536                         assert!(bs_resp.1.is_none());
537
538                         assert!(as_resp.2.unwrap() == as_commitment_update);
539                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
540                 }
541         } else {
542                 handle_initial_raa!();
543
544                 if disconnect_count & !disconnect_flags > 3 {
545                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
546
547                         assert!(as_resp.1.is_none());
548                         assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
549
550                         assert!(as_resp.2.is_none());
551                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
552
553                         assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
554                 }
555
556                 handle_bs_raa!();
557
558                 if disconnect_count & !disconnect_flags > 4 {
559                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
560
561                         assert!(as_resp.1.is_none());
562                         assert!(bs_resp.1.is_none());
563
564                         assert!(as_resp.2.unwrap() == as_commitment_update);
565                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
566                 }
567         }
568
569         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed);
570         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
571         // No commitment_signed so get_event_msg's assert(len == 1) passes
572         check_added_monitors!(nodes[0], 1);
573
574         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed);
575         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
576         // No commitment_signed so get_event_msg's assert(len == 1) passes
577         check_added_monitors!(nodes[1], 1);
578
579         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
580         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
581         check_added_monitors!(nodes[1], 1);
582
583         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
584         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
585         check_added_monitors!(nodes[0], 1);
586
587         expect_pending_htlcs_forwardable!(nodes[1]);
588
589         let events_5 = nodes[1].node.get_and_clear_pending_events();
590         assert_eq!(events_5.len(), 1);
591         match events_5[0] {
592                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
593                         assert_eq!(payment_hash_2, *payment_hash);
594                         assert!(payment_preimage.is_none());
595                         assert_eq!(payment_secret_2, *payment_secret);
596                         assert_eq!(amt, 1000000);
597                 },
598                 _ => panic!("Unexpected event"),
599         }
600
601         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
602 }
603
604 #[test]
605 fn test_monitor_temporary_update_fail_a() {
606         do_test_monitor_temporary_update_fail(0);
607         do_test_monitor_temporary_update_fail(1);
608         do_test_monitor_temporary_update_fail(2);
609         do_test_monitor_temporary_update_fail(3);
610         do_test_monitor_temporary_update_fail(4);
611         do_test_monitor_temporary_update_fail(5);
612 }
613
614 #[test]
615 fn test_monitor_temporary_update_fail_b() {
616         do_test_monitor_temporary_update_fail(2 | 8);
617         do_test_monitor_temporary_update_fail(3 | 8);
618         do_test_monitor_temporary_update_fail(4 | 8);
619         do_test_monitor_temporary_update_fail(5 | 8);
620 }
621
622 #[test]
623 fn test_monitor_temporary_update_fail_c() {
624         do_test_monitor_temporary_update_fail(1 | 16);
625         do_test_monitor_temporary_update_fail(2 | 16);
626         do_test_monitor_temporary_update_fail(3 | 16);
627         do_test_monitor_temporary_update_fail(2 | 8 | 16);
628         do_test_monitor_temporary_update_fail(3 | 8 | 16);
629 }
630
631 #[test]
632 fn test_monitor_update_fail_cs() {
633         // Tests handling of a monitor update failure when processing an incoming commitment_signed
634         let chanmon_cfgs = create_chanmon_cfgs(2);
635         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
636         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
637         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
638         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
639         let logger = test_utils::TestLogger::new();
640
641         let (payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
642         {
643                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
644                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
645                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
646                 check_added_monitors!(nodes[0], 1);
647         }
648
649         let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
650         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
651
652         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
653         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg);
654         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
655         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
656         check_added_monitors!(nodes[1], 1);
657         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
658
659         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
660         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
661         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
662         check_added_monitors!(nodes[1], 0);
663         let responses = nodes[1].node.get_and_clear_pending_msg_events();
664         assert_eq!(responses.len(), 2);
665
666         match responses[0] {
667                 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
668                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
669                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg);
670                         check_added_monitors!(nodes[0], 1);
671                 },
672                 _ => panic!("Unexpected event"),
673         }
674         match responses[1] {
675                 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
676                         assert!(updates.update_add_htlcs.is_empty());
677                         assert!(updates.update_fulfill_htlcs.is_empty());
678                         assert!(updates.update_fail_htlcs.is_empty());
679                         assert!(updates.update_fail_malformed_htlcs.is_empty());
680                         assert!(updates.update_fee.is_none());
681                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
682
683                         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
684                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
685                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
686                         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
687                         check_added_monitors!(nodes[0], 1);
688                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
689                 },
690                 _ => panic!("Unexpected event"),
691         }
692
693         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
694         let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
695         nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
696         check_added_monitors!(nodes[0], 0);
697
698         let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
699         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa);
700         check_added_monitors!(nodes[1], 1);
701
702         expect_pending_htlcs_forwardable!(nodes[1]);
703
704         let events = nodes[1].node.get_and_clear_pending_events();
705         assert_eq!(events.len(), 1);
706         match events[0] {
707                 Event::PaymentReceived { payment_hash, payment_preimage, payment_secret, amt, user_payment_id: _ } => {
708                         assert_eq!(payment_hash, our_payment_hash);
709                         assert!(payment_preimage.is_none());
710                         assert_eq!(our_payment_secret, payment_secret);
711                         assert_eq!(amt, 1000000);
712                 },
713                 _ => panic!("Unexpected event"),
714         };
715
716         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
717 }
718
719 #[test]
720 fn test_monitor_update_fail_no_rebroadcast() {
721         // Tests handling of a monitor update failure when no message rebroadcasting on
722         // channel_monitor_updated() is required. Backported from chanmon_fail_consistency
723         // fuzz tests.
724         let chanmon_cfgs = create_chanmon_cfgs(2);
725         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
726         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
727         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
728         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
729         let logger = test_utils::TestLogger::new();
730
731         let (payment_preimage_1, our_payment_hash, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
732         {
733                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
734                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
735                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(payment_secret_1)).unwrap();
736                 check_added_monitors!(nodes[0], 1);
737         }
738
739         let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
740         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
741         let bs_raa = commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true, false, true);
742
743         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
744         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_raa);
745         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
746         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
747         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
748         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
749         check_added_monitors!(nodes[1], 1);
750
751         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
752         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
753         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
754         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
755         check_added_monitors!(nodes[1], 0);
756         expect_pending_htlcs_forwardable!(nodes[1]);
757
758         let events = nodes[1].node.get_and_clear_pending_events();
759         assert_eq!(events.len(), 1);
760         match events[0] {
761                 Event::PaymentReceived { payment_hash, .. } => {
762                         assert_eq!(payment_hash, our_payment_hash);
763                 },
764                 _ => panic!("Unexpected event"),
765         }
766
767         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
768 }
769
770 #[test]
771 fn test_monitor_update_raa_while_paused() {
772         // Tests handling of an RAA while monitor updating has already been marked failed.
773         // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
774         let chanmon_cfgs = create_chanmon_cfgs(2);
775         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
776         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
777         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
778         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
779         let logger = test_utils::TestLogger::new();
780
781         send_payment(&nodes[0], &[&nodes[1]], 5000000);
782         let (payment_preimage_1, our_payment_hash_1, our_payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
783         {
784                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
785                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
786                 nodes[0].node.send_payment(&route, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
787                 check_added_monitors!(nodes[0], 1);
788         }
789         let send_event_1 = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
790
791         let (payment_preimage_2, our_payment_hash_2, our_payment_secret_2) = get_payment_preimage_hash!(nodes[0]);
792         {
793                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
794                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
795                 nodes[1].node.send_payment(&route, our_payment_hash_2, &Some(our_payment_secret_2)).unwrap();
796                 check_added_monitors!(nodes[1], 1);
797         }
798         let send_event_2 = SendEvent::from_event(nodes[1].node.get_and_clear_pending_msg_events().remove(0));
799
800         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event_1.msgs[0]);
801         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event_1.commitment_msg);
802         check_added_monitors!(nodes[1], 1);
803         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
804
805         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
806         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_2.msgs[0]);
807         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_2.commitment_msg);
808         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
809         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
810         check_added_monitors!(nodes[0], 1);
811
812         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
813         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
814         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented responses to RAA".to_string(), 1);
815         check_added_monitors!(nodes[0], 1);
816
817         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
818         let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
819         nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
820         check_added_monitors!(nodes[0], 0);
821
822         let as_update_raa = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
823         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_update_raa.0);
824         check_added_monitors!(nodes[1], 1);
825         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
826
827         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update_raa.1);
828         check_added_monitors!(nodes[1], 1);
829         let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
830
831         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
832         check_added_monitors!(nodes[0], 1);
833         let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
834
835         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
836         check_added_monitors!(nodes[0], 1);
837         expect_pending_htlcs_forwardable!(nodes[0]);
838         expect_payment_received!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
839
840         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
841         check_added_monitors!(nodes[1], 1);
842         expect_pending_htlcs_forwardable!(nodes[1]);
843         expect_payment_received!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
844
845         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
846         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
847 }
848
849 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
850         // Tests handling of a monitor update failure when processing an incoming RAA
851         let chanmon_cfgs = create_chanmon_cfgs(3);
852         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
853         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
854         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
855         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
856         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
857         let logger = test_utils::TestLogger::new();
858
859         // Rebalance a bit so that we can send backwards from 2 to 1.
860         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
861
862         // Route a first payment that we'll fail backwards
863         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
864
865         // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
866         assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1));
867         expect_pending_htlcs_forwardable!(nodes[2]);
868         check_added_monitors!(nodes[2], 1);
869
870         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
871         assert!(updates.update_add_htlcs.is_empty());
872         assert!(updates.update_fulfill_htlcs.is_empty());
873         assert_eq!(updates.update_fail_htlcs.len(), 1);
874         assert!(updates.update_fail_malformed_htlcs.is_empty());
875         assert!(updates.update_fee.is_none());
876         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
877
878         let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
879         check_added_monitors!(nodes[0], 0);
880
881         // While the second channel is AwaitingRAA, forward a second payment to get it into the
882         // holding cell.
883         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
884         {
885                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
886                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
887                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
888                 check_added_monitors!(nodes[0], 1);
889         }
890
891         let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
892         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
893         commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
894
895         expect_pending_htlcs_forwardable!(nodes[1]);
896         check_added_monitors!(nodes[1], 0);
897         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
898
899         // Now fail monitor updating.
900         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
901         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
902         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
903         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
904         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
905         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
906         check_added_monitors!(nodes[1], 1);
907
908         // Attempt to forward a third payment but fail due to the second channel being unavailable
909         // for forwarding.
910         let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[2]);
911         {
912                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
913                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
914                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
915                 check_added_monitors!(nodes[0], 1);
916         }
917
918         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(())); // We succeed in updating the monitor for the first channel
919         send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
920         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
921         commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
922         check_added_monitors!(nodes[1], 0);
923
924         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
925         assert_eq!(events_2.len(), 1);
926         match events_2.remove(0) {
927                 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
928                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
929                         assert!(updates.update_fulfill_htlcs.is_empty());
930                         assert_eq!(updates.update_fail_htlcs.len(), 1);
931                         assert!(updates.update_fail_malformed_htlcs.is_empty());
932                         assert!(updates.update_add_htlcs.is_empty());
933                         assert!(updates.update_fee.is_none());
934
935                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
936                         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false, true);
937
938                         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
939                         assert_eq!(msg_events.len(), 1);
940                         match msg_events[0] {
941                                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
942                                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
943                                         assert_eq!(msg.contents.flags & 2, 2); // temp disabled
944                                 },
945                                 _ => panic!("Unexpected event"),
946                         }
947
948                         let events = nodes[0].node.get_and_clear_pending_events();
949                         assert_eq!(events.len(), 1);
950                         if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events[0] {
951                                 assert_eq!(payment_hash, payment_hash_3);
952                                 assert!(!rejected_by_dest);
953                         } else { panic!("Unexpected event!"); }
954                 },
955                 _ => panic!("Unexpected event type!"),
956         };
957
958         let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
959                 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
960                 let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
961                 let net_graph_msg_handler = &nodes[2].net_graph_msg_handler;
962                 let route = get_route(&nodes[2].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
963                 nodes[2].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
964                 check_added_monitors!(nodes[2], 1);
965
966                 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
967                 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]);
968                 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg);
969                 check_added_monitors!(nodes[1], 1);
970                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
971                 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
972                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
973                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
974                 (Some(payment_preimage_4), Some(payment_hash_4))
975         } else { (None, None) };
976
977         // Restore monitor updating, ensuring we immediately get a fail-back update and a
978         // update_add update.
979         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
980         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2.2).unwrap().clone();
981         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
982         check_added_monitors!(nodes[1], 0);
983         expect_pending_htlcs_forwardable!(nodes[1]);
984         check_added_monitors!(nodes[1], 1);
985
986         let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
987         if test_ignore_second_cs {
988                 assert_eq!(events_3.len(), 3);
989         } else {
990                 assert_eq!(events_3.len(), 2);
991         }
992
993         // Note that the ordering of the events for different nodes is non-prescriptive, though the
994         // ordering of the two events that both go to nodes[2] have to stay in the same order.
995         let messages_a = match events_3.pop().unwrap() {
996                 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
997                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
998                         assert!(updates.update_fulfill_htlcs.is_empty());
999                         assert_eq!(updates.update_fail_htlcs.len(), 1);
1000                         assert!(updates.update_fail_malformed_htlcs.is_empty());
1001                         assert!(updates.update_add_htlcs.is_empty());
1002                         assert!(updates.update_fee.is_none());
1003                         (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
1004                 },
1005                 _ => panic!("Unexpected event type!"),
1006         };
1007         let raa = if test_ignore_second_cs {
1008                 match events_3.remove(1) {
1009                         MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
1010                                 assert_eq!(node_id, nodes[2].node.get_our_node_id());
1011                                 Some(msg.clone())
1012                         },
1013                         _ => panic!("Unexpected event"),
1014                 }
1015         } else { None };
1016         let send_event_b = SendEvent::from_event(events_3.remove(0));
1017         assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
1018
1019         // Now deliver the new messages...
1020
1021         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0);
1022         commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
1023         let events_4 = nodes[0].node.get_and_clear_pending_events();
1024         assert_eq!(events_4.len(), 1);
1025         if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events_4[0] {
1026                 assert_eq!(payment_hash, payment_hash_1);
1027                 assert!(rejected_by_dest);
1028         } else { panic!("Unexpected event!"); }
1029
1030         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]);
1031         if test_ignore_second_cs {
1032                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg);
1033                 check_added_monitors!(nodes[2], 1);
1034                 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1035                 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap());
1036                 check_added_monitors!(nodes[2], 1);
1037                 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1038                 assert!(bs_cs.update_add_htlcs.is_empty());
1039                 assert!(bs_cs.update_fail_htlcs.is_empty());
1040                 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
1041                 assert!(bs_cs.update_fulfill_htlcs.is_empty());
1042                 assert!(bs_cs.update_fee.is_none());
1043
1044                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1045                 check_added_monitors!(nodes[1], 1);
1046                 let as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1047                 assert!(as_cs.update_add_htlcs.is_empty());
1048                 assert!(as_cs.update_fail_htlcs.is_empty());
1049                 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
1050                 assert!(as_cs.update_fulfill_htlcs.is_empty());
1051                 assert!(as_cs.update_fee.is_none());
1052
1053                 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed);
1054                 check_added_monitors!(nodes[1], 1);
1055                 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1056
1057                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed);
1058                 check_added_monitors!(nodes[2], 1);
1059                 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1060
1061                 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1062                 check_added_monitors!(nodes[2], 1);
1063                 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
1064
1065                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa);
1066                 check_added_monitors!(nodes[1], 1);
1067                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1068         } else {
1069                 commitment_signed_dance!(nodes[2], nodes[1], send_event_b.commitment_msg, false);
1070         }
1071
1072         expect_pending_htlcs_forwardable!(nodes[2]);
1073
1074         let events_6 = nodes[2].node.get_and_clear_pending_events();
1075         assert_eq!(events_6.len(), 1);
1076         match events_6[0] {
1077                 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1078                 _ => panic!("Unexpected event"),
1079         };
1080
1081         if test_ignore_second_cs {
1082                 expect_pending_htlcs_forwardable!(nodes[1]);
1083                 check_added_monitors!(nodes[1], 1);
1084
1085                 send_event = SendEvent::from_node(&nodes[1]);
1086                 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
1087                 assert_eq!(send_event.msgs.len(), 1);
1088                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
1089                 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
1090
1091                 expect_pending_htlcs_forwardable!(nodes[0]);
1092
1093                 let events_9 = nodes[0].node.get_and_clear_pending_events();
1094                 assert_eq!(events_9.len(), 1);
1095                 match events_9[0] {
1096                         Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1097                         _ => panic!("Unexpected event"),
1098                 };
1099                 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
1100         }
1101
1102         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
1103 }
1104
1105 #[test]
1106 fn test_monitor_update_fail_raa() {
1107         do_test_monitor_update_fail_raa(false);
1108         do_test_monitor_update_fail_raa(true);
1109 }
1110
1111 #[test]
1112 fn test_monitor_update_fail_reestablish() {
1113         // Simple test for message retransmission after monitor update failure on
1114         // channel_reestablish generating a monitor update (which comes from freeing holding cell
1115         // HTLCs).
1116         let chanmon_cfgs = create_chanmon_cfgs(3);
1117         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1118         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1119         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1120         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1121         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1122
1123         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1124
1125         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1126         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1127
1128         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1129         check_added_monitors!(nodes[2], 1);
1130         let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1131         assert!(updates.update_add_htlcs.is_empty());
1132         assert!(updates.update_fail_htlcs.is_empty());
1133         assert!(updates.update_fail_malformed_htlcs.is_empty());
1134         assert!(updates.update_fee.is_none());
1135         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1136         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1137         check_added_monitors!(nodes[1], 1);
1138         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1139         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1140
1141         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1142         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1143         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1144
1145         let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1146         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1147
1148         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1149
1150         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1151         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1152         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1153         check_added_monitors!(nodes[1], 1);
1154
1155         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1156         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1157
1158         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1159         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1160
1161         assert!(as_reestablish == get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id()));
1162         assert!(bs_reestablish == get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()));
1163
1164         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
1165
1166         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
1167         check_added_monitors!(nodes[1], 0);
1168         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1169
1170         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1171         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1172         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1173         check_added_monitors!(nodes[1], 0);
1174
1175         updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1176         assert!(updates.update_add_htlcs.is_empty());
1177         assert!(updates.update_fail_htlcs.is_empty());
1178         assert!(updates.update_fail_malformed_htlcs.is_empty());
1179         assert!(updates.update_fee.is_none());
1180         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1181         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1182         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1183
1184         let events = nodes[0].node.get_and_clear_pending_events();
1185         assert_eq!(events.len(), 1);
1186         match events[0] {
1187                 Event::PaymentSent { payment_preimage, .. } => assert_eq!(payment_preimage, our_payment_preimage),
1188                 _ => panic!("Unexpected event"),
1189         }
1190 }
1191
1192 #[test]
1193 fn raa_no_response_awaiting_raa_state() {
1194         // This is a rather convoluted test which ensures that if handling of an RAA does not happen
1195         // due to a previous monitor update failure, we still set AwaitingRemoteRevoke on the channel
1196         // in question (assuming it intends to respond with a CS after monitor updating is restored).
1197         // Backported from chanmon_fail_consistency fuzz tests as this used to be broken.
1198         let chanmon_cfgs = create_chanmon_cfgs(2);
1199         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1200         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1201         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1202         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1203         let logger = test_utils::TestLogger::new();
1204
1205         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
1206         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1207         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1208
1209         // Queue up two payments - one will be delivered right away, one immediately goes into the
1210         // holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
1211         // immediately after a CS. By setting failing the monitor update failure from the CS (which
1212         // requires only an RAA response due to AwaitingRAA) we can deliver the RAA and require the CS
1213         // generation during RAA while in monitor-update-failed state.
1214         {
1215                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1216                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1217                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1218                 check_added_monitors!(nodes[0], 1);
1219                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1220                 check_added_monitors!(nodes[0], 0);
1221         }
1222
1223         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1224         assert_eq!(events.len(), 1);
1225         let payment_event = SendEvent::from_event(events.pop().unwrap());
1226         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1227         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1228         check_added_monitors!(nodes[1], 1);
1229
1230         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1231         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1232         check_added_monitors!(nodes[0], 1);
1233         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1234         assert_eq!(events.len(), 1);
1235         let payment_event = SendEvent::from_event(events.pop().unwrap());
1236
1237         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1238         check_added_monitors!(nodes[0], 1);
1239         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1240
1241         // Now we have a CS queued up which adds a new HTLC (which will need a RAA/CS response from
1242         // nodes[1]) followed by an RAA. Fail the monitor updating prior to the CS, deliver the RAA,
1243         // then restore channel monitor updates.
1244         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1245         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1246         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1247         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1248         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1249         check_added_monitors!(nodes[1], 1);
1250
1251         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1252         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1253         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented responses to RAA".to_string(), 1);
1254         check_added_monitors!(nodes[1], 1);
1255
1256         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1257         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1258         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1259         // nodes[1] should be AwaitingRAA here!
1260         check_added_monitors!(nodes[1], 0);
1261         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1262         expect_pending_htlcs_forwardable!(nodes[1]);
1263         expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1264
1265         // We send a third payment here, which is somewhat of a redundant test, but the
1266         // chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
1267         // commitment transaction states) whereas here we can explicitly check for it.
1268         {
1269                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1270                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1271                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1272                 check_added_monitors!(nodes[0], 0);
1273                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1274         }
1275         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1276         check_added_monitors!(nodes[0], 1);
1277         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1278         assert_eq!(events.len(), 1);
1279         let payment_event = SendEvent::from_event(events.pop().unwrap());
1280
1281         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1282         check_added_monitors!(nodes[0], 1);
1283         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1284
1285         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1286         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1287         check_added_monitors!(nodes[1], 1);
1288         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1289
1290         // Finally deliver the RAA to nodes[1] which results in a CS response to the last update
1291         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1292         check_added_monitors!(nodes[1], 1);
1293         expect_pending_htlcs_forwardable!(nodes[1]);
1294         expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1295         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1296
1297         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1298         check_added_monitors!(nodes[0], 1);
1299
1300         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed);
1301         check_added_monitors!(nodes[0], 1);
1302         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1303
1304         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1305         check_added_monitors!(nodes[1], 1);
1306         expect_pending_htlcs_forwardable!(nodes[1]);
1307         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1308
1309         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1310         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1311         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1312 }
1313
1314 #[test]
1315 fn claim_while_disconnected_monitor_update_fail() {
1316         // Test for claiming a payment while disconnected and then having the resulting
1317         // channel-update-generated monitor update fail. This kind of thing isn't a particularly
1318         // contrived case for nodes with network instability.
1319         // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1320         // code introduced a regression in this test (specifically, this caught a removal of the
1321         // channel_reestablish handling ensuring the order was sensical given the messages used).
1322         let chanmon_cfgs = create_chanmon_cfgs(2);
1323         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1324         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1325         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1326         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1327         let logger = test_utils::TestLogger::new();
1328
1329         // Forward a payment for B to claim
1330         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1331
1332         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1333         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1334
1335         assert!(nodes[1].node.claim_funds(payment_preimage_1));
1336         check_added_monitors!(nodes[1], 1);
1337
1338         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1339         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1340
1341         let as_reconnect = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1342         let bs_reconnect = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1343
1344         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1345         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1346
1347         // Now deliver a's reestablish, freeing the claim from the holding cell, but fail the monitor
1348         // update.
1349         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1350
1351         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1352         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1353         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1354         check_added_monitors!(nodes[1], 1);
1355         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1356
1357         // Send a second payment from A to B, resulting in a commitment update that gets swallowed with
1358         // the monitor still failed
1359         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1360         {
1361                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1362                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1363                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1364                 check_added_monitors!(nodes[0], 1);
1365         }
1366
1367         let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1368         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
1369         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.commitment_signed);
1370         check_added_monitors!(nodes[1], 1);
1371         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1372         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1373         // Note that nodes[1] not updating monitor here is OK - it wont take action on the new HTLC
1374         // until we've channel_monitor_update'd and updated for the new commitment transaction.
1375
1376         // Now un-fail the monitor, which will result in B sending its original commitment update,
1377         // receiving the commitment update from A, and the resulting commitment dances.
1378         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1379         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1380         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1381         check_added_monitors!(nodes[1], 0);
1382
1383         let bs_msgs = nodes[1].node.get_and_clear_pending_msg_events();
1384         assert_eq!(bs_msgs.len(), 2);
1385
1386         match bs_msgs[0] {
1387                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1388                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1389                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1390                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1391                         check_added_monitors!(nodes[0], 1);
1392
1393                         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1394                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1395                         check_added_monitors!(nodes[1], 1);
1396                 },
1397                 _ => panic!("Unexpected event"),
1398         }
1399
1400         match bs_msgs[1] {
1401                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1402                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
1403                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), msg);
1404                         check_added_monitors!(nodes[0], 1);
1405                 },
1406                 _ => panic!("Unexpected event"),
1407         }
1408
1409         let as_commitment = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1410
1411         let bs_commitment = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1412         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment.commitment_signed);
1413         check_added_monitors!(nodes[0], 1);
1414         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1415
1416         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment.commitment_signed);
1417         check_added_monitors!(nodes[1], 1);
1418         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1419         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1420         check_added_monitors!(nodes[1], 1);
1421
1422         expect_pending_htlcs_forwardable!(nodes[1]);
1423         expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1424
1425         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1426         check_added_monitors!(nodes[0], 1);
1427
1428         let events = nodes[0].node.get_and_clear_pending_events();
1429         assert_eq!(events.len(), 1);
1430         match events[0] {
1431                 Event::PaymentSent { ref payment_preimage } => {
1432                         assert_eq!(*payment_preimage, payment_preimage_1);
1433                 },
1434                 _ => panic!("Unexpected event"),
1435         }
1436
1437         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1438 }
1439
1440 #[test]
1441 fn monitor_failed_no_reestablish_response() {
1442         // Test for receiving a channel_reestablish after a monitor update failure resulted in no
1443         // response to a commitment_signed.
1444         // Backported from chanmon_fail_consistency fuzz tests as it caught a long-standing
1445         // debug_assert!() failure in channel_reestablish handling.
1446         let chanmon_cfgs = create_chanmon_cfgs(2);
1447         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1448         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1449         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1450         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1451         let logger = test_utils::TestLogger::new();
1452
1453         // Route the payment and deliver the initial commitment_signed (with a monitor update failure
1454         // on receipt).
1455         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
1456         {
1457                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1458                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1459                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1460                 check_added_monitors!(nodes[0], 1);
1461         }
1462
1463         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1464         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1465         assert_eq!(events.len(), 1);
1466         let payment_event = SendEvent::from_event(events.pop().unwrap());
1467         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1468         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1469         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1470         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1471         check_added_monitors!(nodes[1], 1);
1472
1473         // Now disconnect and immediately reconnect, delivering the channel_reestablish while nodes[1]
1474         // is still failing to update monitors.
1475         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1476         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1477
1478         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1479         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1480
1481         let as_reconnect = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1482         let bs_reconnect = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1483
1484         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reconnect);
1485         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reconnect);
1486
1487         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1488         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1489         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1490         check_added_monitors!(nodes[1], 0);
1491         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1492
1493         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1494         check_added_monitors!(nodes[0], 1);
1495         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1496         check_added_monitors!(nodes[0], 1);
1497
1498         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1499         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1500         check_added_monitors!(nodes[1], 1);
1501
1502         expect_pending_htlcs_forwardable!(nodes[1]);
1503         expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1504
1505         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1506 }
1507
1508 #[test]
1509 fn first_message_on_recv_ordering() {
1510         // Test that if the initial generator of a monitor-update-frozen state doesn't generate
1511         // messages, we're willing to flip the order of response messages if neccessary in resposne to
1512         // a commitment_signed which needs to send an RAA first.
1513         // At a high level, our goal is to fail monitor updating in response to an RAA which needs no
1514         // response and then handle a CS while in the failed state, requiring an RAA followed by a CS
1515         // response. To do this, we start routing two payments, with the final RAA for the first being
1516         // delivered while B is in AwaitingRAA, hence when we deliver the CS for the second B will
1517         // have no pending response but will want to send a RAA/CS (with the updates for the second
1518         // payment applied).
1519         // Backported from chanmon_fail_consistency fuzz tests as it caught a bug here.
1520         let chanmon_cfgs = create_chanmon_cfgs(2);
1521         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1522         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1523         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1524         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1525         let logger = test_utils::TestLogger::new();
1526
1527         // Route the first payment outbound, holding the last RAA for B until we are set up so that we
1528         // can deliver it and fail the monitor update.
1529         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
1530         {
1531                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1532                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1533                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
1534                 check_added_monitors!(nodes[0], 1);
1535         }
1536
1537         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1538         assert_eq!(events.len(), 1);
1539         let payment_event = SendEvent::from_event(events.pop().unwrap());
1540         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1541         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1542         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1543         check_added_monitors!(nodes[1], 1);
1544         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1545
1546         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1547         check_added_monitors!(nodes[0], 1);
1548         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1549         check_added_monitors!(nodes[0], 1);
1550
1551         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1552
1553         // Route the second payment, generating an update_add_htlc/commitment_signed
1554         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1555         {
1556                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1557                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1558                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1559                 check_added_monitors!(nodes[0], 1);
1560         }
1561         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1562         assert_eq!(events.len(), 1);
1563         let payment_event = SendEvent::from_event(events.pop().unwrap());
1564         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1565
1566         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1567
1568         // Deliver the final RAA for the first payment, which does not require a response. RAAs
1569         // generally require a commitment_signed, so the fact that we're expecting an opposite response
1570         // to the next message also tests resetting the delivery order.
1571         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1572         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1573         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1574         check_added_monitors!(nodes[1], 1);
1575
1576         // Now deliver the update_add_htlc/commitment_signed for the second payment, which does need an
1577         // RAA/CS response, which should be generated when we call channel_monitor_update (with the
1578         // appropriate HTLC acceptance).
1579         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1580         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
1581         check_added_monitors!(nodes[1], 1);
1582         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1583         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Previous monitor update failure prevented generation of RAA".to_string(), 1);
1584
1585         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1586         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1587         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1588         check_added_monitors!(nodes[1], 0);
1589
1590         expect_pending_htlcs_forwardable!(nodes[1]);
1591         expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1592
1593         let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1594         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
1595         check_added_monitors!(nodes[0], 1);
1596         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_responses.1);
1597         check_added_monitors!(nodes[0], 1);
1598
1599         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1600         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1601         check_added_monitors!(nodes[1], 1);
1602
1603         expect_pending_htlcs_forwardable!(nodes[1]);
1604         expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1605
1606         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
1607         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1608 }
1609
1610 #[test]
1611 fn test_monitor_update_fail_claim() {
1612         // Basic test for monitor update failures when processing claim_funds calls.
1613         // We set up a simple 3-node network, sending a payment from A to B and failing B's monitor
1614         // update to claim the payment. We then send a payment C->B->A, making the forward of this
1615         // payment from B to A fail due to the paused channel. Finally, we restore the channel monitor
1616         // updating and claim the payment on B.
1617         let chanmon_cfgs = create_chanmon_cfgs(3);
1618         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1619         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1620         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1621         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1622         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1623         let logger = test_utils::TestLogger::new();
1624
1625         // Rebalance a bit so that we can send backwards from 3 to 2.
1626         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1627
1628         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1629
1630         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1631         assert!(nodes[1].node.claim_funds(payment_preimage_1));
1632         check_added_monitors!(nodes[1], 1);
1633
1634         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[0]);
1635         {
1636                 let net_graph_msg_handler = &nodes[2].net_graph_msg_handler;
1637                 let route = get_route(&nodes[2].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1638                 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1639                 check_added_monitors!(nodes[2], 1);
1640         }
1641
1642         // Successfully update the monitor on the 1<->2 channel, but the 0<->1 channel should still be
1643         // paused, so forward shouldn't succeed until we call channel_monitor_updated().
1644         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1645
1646         let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1647         assert_eq!(events.len(), 1);
1648         let payment_event = SendEvent::from_event(events.pop().unwrap());
1649         nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1650         let events = nodes[1].node.get_and_clear_pending_msg_events();
1651         assert_eq!(events.len(), 0);
1652         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1653         commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false, true);
1654
1655         let bs_fail_update = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1656         nodes[2].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_update.update_fail_htlcs[0]);
1657         commitment_signed_dance!(nodes[2], nodes[1], bs_fail_update.commitment_signed, false, true);
1658
1659         let msg_events = nodes[2].node.get_and_clear_pending_msg_events();
1660         assert_eq!(msg_events.len(), 1);
1661         match msg_events[0] {
1662                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1663                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
1664                         assert_eq!(msg.contents.flags & 2, 2); // temp disabled
1665                 },
1666                 _ => panic!("Unexpected event"),
1667         }
1668
1669         let events = nodes[2].node.get_and_clear_pending_events();
1670         assert_eq!(events.len(), 1);
1671         if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events[0] {
1672                 assert_eq!(payment_hash, payment_hash_2);
1673                 assert!(!rejected_by_dest);
1674         } else { panic!("Unexpected event!"); }
1675
1676         // Now restore monitor updating on the 0<->1 channel and claim the funds on B.
1677         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1678         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1679         check_added_monitors!(nodes[1], 0);
1680
1681         let bs_fulfill_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1682         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_fulfill_update.update_fulfill_htlcs[0]);
1683         commitment_signed_dance!(nodes[0], nodes[1], bs_fulfill_update.commitment_signed, false);
1684
1685         let events = nodes[0].node.get_and_clear_pending_events();
1686         assert_eq!(events.len(), 1);
1687         if let Event::PaymentSent { payment_preimage, .. } = events[0] {
1688                 assert_eq!(payment_preimage, payment_preimage_1);
1689         } else { panic!("Unexpected event!"); }
1690 }
1691
1692 #[test]
1693 fn test_monitor_update_on_pending_forwards() {
1694         // Basic test for monitor update failures when processing pending HTLC fail/add forwards.
1695         // We do this with a simple 3-node network, sending a payment from A to C and one from C to A.
1696         // The payment from A to C will be failed by C and pending a back-fail to A, while the payment
1697         // from C to A will be pending a forward to A.
1698         let chanmon_cfgs = create_chanmon_cfgs(3);
1699         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1700         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1701         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1702         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1703         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1704         let logger = test_utils::TestLogger::new();
1705
1706         // Rebalance a bit so that we can send backwards from 3 to 1.
1707         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
1708
1709         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1710         assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1));
1711         expect_pending_htlcs_forwardable!(nodes[2]);
1712         check_added_monitors!(nodes[2], 1);
1713
1714         let cs_fail_update = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1715         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail_update.update_fail_htlcs[0]);
1716         commitment_signed_dance!(nodes[1], nodes[2], cs_fail_update.commitment_signed, true, true);
1717         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1718
1719         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[0]);
1720         {
1721                 let net_graph_msg_handler = &nodes[2].net_graph_msg_handler;
1722                 let route = get_route(&nodes[2].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1723                 nodes[2].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1724                 check_added_monitors!(nodes[2], 1);
1725         }
1726
1727         let mut events = nodes[2].node.get_and_clear_pending_msg_events();
1728         assert_eq!(events.len(), 1);
1729         let payment_event = SendEvent::from_event(events.pop().unwrap());
1730         nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
1731         commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
1732
1733         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1734         expect_pending_htlcs_forwardable!(nodes[1]);
1735         check_added_monitors!(nodes[1], 1);
1736         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1737         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1738
1739         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1740         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_1.2).unwrap().clone();
1741         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1742         check_added_monitors!(nodes[1], 0);
1743
1744         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1745         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
1746         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_add_htlcs[0]);
1747         commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
1748
1749         let events = nodes[0].node.get_and_clear_pending_events();
1750         assert_eq!(events.len(), 2);
1751         if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events[0] {
1752                 assert_eq!(payment_hash, payment_hash_1);
1753                 assert!(rejected_by_dest);
1754         } else { panic!("Unexpected event!"); }
1755         match events[1] {
1756                 Event::PendingHTLCsForwardable { .. } => { },
1757                 _ => panic!("Unexpected event"),
1758         };
1759         nodes[0].node.process_pending_htlc_forwards();
1760         expect_payment_received!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1761
1762         claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
1763 }
1764
1765 #[test]
1766 fn monitor_update_claim_fail_no_response() {
1767         // Test for claim_funds resulting in both a monitor update failure and no message response (due
1768         // to channel being AwaitingRAA).
1769         // Backported from chanmon_fail_consistency fuzz tests as an unmerged version of the handling
1770         // code was broken.
1771         let chanmon_cfgs = create_chanmon_cfgs(2);
1772         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1773         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1774         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1775         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
1776         let logger = test_utils::TestLogger::new();
1777
1778         // Forward a payment for B to claim
1779         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
1780
1781         // Now start forwarding a second payment, skipping the last RAA so B is in AwaitingRAA
1782         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1783         {
1784                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1785                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
1786                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1787                 check_added_monitors!(nodes[0], 1);
1788         }
1789
1790         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1791         assert_eq!(events.len(), 1);
1792         let payment_event = SendEvent::from_event(events.pop().unwrap());
1793         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1794         let as_raa = commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true, false, true);
1795
1796         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1797         assert!(nodes[1].node.claim_funds(payment_preimage_1));
1798         check_added_monitors!(nodes[1], 1);
1799         let events = nodes[1].node.get_and_clear_pending_msg_events();
1800         assert_eq!(events.len(), 0);
1801         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Temporary failure claiming HTLC, treating as success: Failed to update ChannelMonitor".to_string(), 1);
1802
1803         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1804         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1805         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1806         check_added_monitors!(nodes[1], 0);
1807         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1808
1809         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1810         check_added_monitors!(nodes[1], 1);
1811         expect_pending_htlcs_forwardable!(nodes[1]);
1812         expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1813
1814         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1815         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
1816         commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false);
1817
1818         let events = nodes[0].node.get_and_clear_pending_events();
1819         assert_eq!(events.len(), 1);
1820         match events[0] {
1821                 Event::PaymentSent { ref payment_preimage } => {
1822                         assert_eq!(*payment_preimage, payment_preimage_1);
1823                 },
1824                 _ => panic!("Unexpected event"),
1825         }
1826
1827         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
1828 }
1829
1830 // confirm_a_first and restore_b_before_conf are wholly unrelated to earlier bools and
1831 // restore_b_before_conf has no meaning if !confirm_a_first
1832 fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf: bool) {
1833         // Test that if the monitor update generated by funding_transaction_generated fails we continue
1834         // the channel setup happily after the update is restored.
1835         let chanmon_cfgs = create_chanmon_cfgs(2);
1836         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1837         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1838         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1839
1840         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
1841         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()));
1842         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()));
1843
1844         let (temporary_channel_id, funding_tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 43);
1845
1846         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_tx.clone()).unwrap();
1847         check_added_monitors!(nodes[0], 0);
1848
1849         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1850         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1851         let channel_id = OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
1852         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
1853         check_added_monitors!(nodes[1], 1);
1854
1855         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1856         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()));
1857         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1858         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Failed to update ChannelMonitor".to_string(), 1);
1859         check_added_monitors!(nodes[0], 1);
1860         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1861         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1862         let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1863         nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
1864         check_added_monitors!(nodes[0], 0);
1865
1866         let events = nodes[0].node.get_and_clear_pending_events();
1867         assert_eq!(events.len(), 0);
1868         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1869         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0].txid(), funding_output.txid);
1870
1871         if confirm_a_first {
1872                 confirm_transaction(&nodes[0], &funding_tx);
1873                 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()));
1874         } else {
1875                 assert!(!restore_b_before_conf);
1876                 confirm_transaction(&nodes[1], &funding_tx);
1877                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1878         }
1879
1880         // Make sure nodes[1] isn't stupid enough to re-send the FundingLocked on reconnect
1881         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1882         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1883         reconnect_nodes(&nodes[0], &nodes[1], (false, confirm_a_first), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
1884         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1885         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1886
1887         if !restore_b_before_conf {
1888                 confirm_transaction(&nodes[1], &funding_tx);
1889                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1890                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1891         }
1892
1893         *nodes[1].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1894         let (outpoint, latest_update) = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&channel_id).unwrap().clone();
1895         nodes[1].node.channel_monitor_updated(&outpoint, latest_update);
1896         check_added_monitors!(nodes[1], 0);
1897
1898         let (channel_id, (announcement, as_update, bs_update)) = if !confirm_a_first {
1899                 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()));
1900
1901                 confirm_transaction(&nodes[0], &funding_tx);
1902                 let (funding_locked, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
1903                 (channel_id, create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked))
1904         } else {
1905                 if restore_b_before_conf {
1906                         confirm_transaction(&nodes[1], &funding_tx);
1907                 }
1908                 let (funding_locked, channel_id) = create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
1909                 (channel_id, create_chan_between_nodes_with_value_b(&nodes[1], &nodes[0], &funding_locked))
1910         };
1911         for node in nodes.iter() {
1912                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
1913                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1914                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1915         }
1916
1917         send_payment(&nodes[0], &[&nodes[1]], 8000000);
1918         close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);
1919 }
1920
1921 #[test]
1922 fn during_funding_monitor_fail() {
1923         do_during_funding_monitor_fail(true, true);
1924         do_during_funding_monitor_fail(true, false);
1925         do_during_funding_monitor_fail(false, false);
1926 }
1927
1928 #[test]
1929 fn test_path_paused_mpp() {
1930         // Simple test of sending a multi-part payment where one path is currently blocked awaiting
1931         // monitor update
1932         let chanmon_cfgs = create_chanmon_cfgs(4);
1933         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1934         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1935         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1936
1937         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1938         let (chan_2_ann, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
1939         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1940         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
1941         let logger = test_utils::TestLogger::new();
1942
1943         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
1944         let mut route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
1945
1946         // Set us up to take multiple routes, one 0 -> 1 -> 3 and one 0 -> 2 -> 3:
1947         let path = route.paths[0].clone();
1948         route.paths.push(path);
1949         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
1950         route.paths[0][0].short_channel_id = chan_1_id;
1951         route.paths[0][1].short_channel_id = chan_3_id;
1952         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
1953         route.paths[1][0].short_channel_id = chan_2_ann.contents.short_channel_id;
1954         route.paths[1][1].short_channel_id = chan_4_id;
1955
1956         // Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
1957         // (for the path 0 -> 2 -> 3) fails.
1958         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1959         *nodes[0].chain_monitor.next_update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
1960
1961         // Now check that we get the right return value, indicating that the first path succeeded but
1962         // the second got a MonitorUpdateFailed err. This implies PaymentSendFailure::PartialFailure as
1963         // some paths succeeded, preventing retry.
1964         if let Err(PaymentSendFailure::PartialFailure(results)) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)) {
1965                 assert_eq!(results.len(), 2);
1966                 if let Ok(()) = results[0] {} else { panic!(); }
1967                 if let Err(APIError::MonitorUpdateFailed) = results[1] {} else { panic!(); }
1968         } else { panic!(); }
1969         check_added_monitors!(nodes[0], 2);
1970         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Ok(()));
1971
1972         // Pass the first HTLC of the payment along to nodes[3].
1973         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1974         assert_eq!(events.len(), 1);
1975         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 0, payment_hash.clone(), payment_secret, events.pop().unwrap(), false);
1976
1977         // And check that, after we successfully update the monitor for chan_2 we can pass the second
1978         // HTLC along to nodes[3] and claim the whole payment back to nodes[0].
1979         let (outpoint, latest_update) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_2_id).unwrap().clone();
1980         nodes[0].node.channel_monitor_updated(&outpoint, latest_update);
1981         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1982         assert_eq!(events.len(), 1);
1983         pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash.clone(), payment_secret, events.pop().unwrap(), true);
1984
1985         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
1986 }
1987
1988 fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
1989         // Tests that, when we serialize a channel with AddHTLC entries in the holding cell, we
1990         // properly free them on reconnect. We previously failed such HTLCs upon serialization, but
1991         // that behavior was both somewhat unexpected and also broken (there was a debug assertion
1992         // which failed in such a case).
1993         let chanmon_cfgs = create_chanmon_cfgs(2);
1994         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1995         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1996         let persister: test_utils::TestPersister;
1997         let new_chain_monitor: test_utils::TestChainMonitor;
1998         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
1999         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2000
2001         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;
2002         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(&nodes[1]);
2003         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(&nodes[1]);
2004
2005         // Do a really complicated dance to get an HTLC into the holding cell, with MonitorUpdateFailed
2006         // set but AwaitingRemoteRevoke unset. When this test was written, any attempts to send an HTLC
2007         // while MonitorUpdateFailed is set are immediately failed-backwards. Thus, the only way to get
2008         // an AddHTLC into the holding cell is to add it while AwaitingRemoteRevoke is set but
2009         // MonitorUpdateFailed is unset, and then swap the flags.
2010         //
2011         // We do this by:
2012         //  a) routing a payment from node B to node A,
2013         //  b) sending a payment from node A to node B without delivering any of the generated messages,
2014         //     putting node A in AwaitingRemoteRevoke,
2015         //  c) sending a second payment from node A to node B, which is immediately placed in the
2016         //     holding cell,
2017         //  d) claiming the first payment from B, allowing us to fail the monitor update which occurs
2018         //     when we try to persist the payment preimage,
2019         //  e) delivering A's commitment_signed from (b) and the resulting B revoke_and_ack message,
2020         //     clearing AwaitingRemoteRevoke on node A.
2021         //
2022         // Note that because, at the end, MonitorUpdateFailed is still set, the HTLC generated in (c)
2023         // will not be freed from the holding cell.
2024         let (payment_preimage_0, _, _) = route_payment(&nodes[1], &[&nodes[0]], 100000);
2025
2026         let route = {
2027                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2028                 get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, nodes[0].logger).unwrap()
2029         };
2030
2031         nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
2032         check_added_monitors!(nodes[0], 1);
2033         let send = SendEvent::from_node(&nodes[0]);
2034         assert_eq!(send.msgs.len(), 1);
2035
2036         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
2037         check_added_monitors!(nodes[0], 0);
2038
2039         *nodes[0].chain_monitor.update_ret.lock().unwrap() = Some(Err(ChannelMonitorUpdateErr::TemporaryFailure));
2040         assert!(nodes[0].node.claim_funds(payment_preimage_0));
2041         check_added_monitors!(nodes[0], 1);
2042
2043         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send.msgs[0]);
2044         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send.commitment_msg);
2045         check_added_monitors!(nodes[1], 1);
2046
2047         let (raa, cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2048
2049         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
2050         check_added_monitors!(nodes[0], 1);
2051
2052         if disconnect {
2053                 // Optionally reload nodes[0] entirely through a serialization roundtrip, otherwise just
2054                 // disconnect the peers. Note that the fuzzer originally found this issue because
2055                 // deserializing a ChannelManager in this state causes an assertion failure.
2056                 if reload_a {
2057                         let nodes_0_serialized = nodes[0].node.encode();
2058                         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
2059                         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
2060
2061                         persister = test_utils::TestPersister::new();
2062                         let keys_manager = &chanmon_cfgs[0].keys_manager;
2063                         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);
2064                         nodes[0].chain_monitor = &new_chain_monitor;
2065                         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
2066                         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
2067                                 &mut chan_0_monitor_read, keys_manager).unwrap();
2068                         assert!(chan_0_monitor_read.is_empty());
2069
2070                         let mut nodes_0_read = &nodes_0_serialized[..];
2071                         let config = UserConfig::default();
2072                         nodes_0_deserialized = {
2073                                 let mut channel_monitors = HashMap::new();
2074                                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
2075                                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
2076                                         default_config: config,
2077                                         keys_manager,
2078                                         fee_estimator: node_cfgs[0].fee_estimator,
2079                                         chain_monitor: nodes[0].chain_monitor,
2080                                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
2081                                         logger: nodes[0].logger,
2082                                         channel_monitors,
2083                                 }).unwrap().1
2084                         };
2085                         nodes[0].node = &nodes_0_deserialized;
2086                         assert!(nodes_0_read.is_empty());
2087
2088                         nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0.clone(), chan_0_monitor).unwrap();
2089                         check_added_monitors!(nodes[0], 1);
2090                 } else {
2091                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2092                 }
2093                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2094
2095                 // Now reconnect the two
2096                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2097                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
2098                 assert_eq!(reestablish_1.len(), 1);
2099                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2100                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
2101                 assert_eq!(reestablish_2.len(), 1);
2102
2103                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
2104                 let resp_1 = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
2105                 check_added_monitors!(nodes[1], 0);
2106
2107                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
2108                 let resp_0 = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
2109
2110                 assert!(resp_0.0.is_none());
2111                 assert!(resp_0.1.is_none());
2112                 assert!(resp_0.2.is_none());
2113                 assert!(resp_1.0.is_none());
2114                 assert!(resp_1.1.is_none());
2115
2116                 // Check that the freshly-generated cs is equal to the original (which we will deliver in a
2117                 // moment).
2118                 if let Some(pending_cs) = resp_1.2 {
2119                         assert!(pending_cs.update_add_htlcs.is_empty());
2120                         assert!(pending_cs.update_fail_htlcs.is_empty());
2121                         assert!(pending_cs.update_fulfill_htlcs.is_empty());
2122                         assert_eq!(pending_cs.commitment_signed, cs);
2123                 } else { panic!(); }
2124
2125                 // There should be no monitor updates as we are still pending awaiting a failed one.
2126                 check_added_monitors!(nodes[0], 0);
2127                 check_added_monitors!(nodes[1], 0);
2128         }
2129
2130         // If we finish updating the monitor, we should free the holding cell right away (this did
2131         // not occur prior to #756).
2132         *nodes[0].chain_monitor.update_ret.lock().unwrap() = None;
2133         let (funding_txo, mon_id) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
2134         nodes[0].node.channel_monitor_updated(&funding_txo, mon_id);
2135
2136         // New outbound messages should be generated immediately upon a call to
2137         // get_and_clear_pending_msg_events (but not before).
2138         check_added_monitors!(nodes[0], 0);
2139         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2140         check_added_monitors!(nodes[0], 1);
2141         assert_eq!(events.len(), 1);
2142
2143         // Deliver the pending in-flight CS
2144         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &cs);
2145         check_added_monitors!(nodes[0], 1);
2146
2147         let commitment_msg = match events.pop().unwrap() {
2148                 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
2149                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
2150                         assert!(updates.update_fail_htlcs.is_empty());
2151                         assert!(updates.update_fail_malformed_htlcs.is_empty());
2152                         assert!(updates.update_fee.is_none());
2153                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2154                         nodes[1].node.handle_update_fulfill_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
2155                         expect_payment_sent!(nodes[1], payment_preimage_0);
2156                         assert_eq!(updates.update_add_htlcs.len(), 1);
2157                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
2158                         updates.commitment_signed
2159                 },
2160                 _ => panic!("Unexpected event type!"),
2161         };
2162
2163         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_msg);
2164         check_added_monitors!(nodes[1], 1);
2165
2166         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2167         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2168         expect_pending_htlcs_forwardable!(nodes[1]);
2169         expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2170         check_added_monitors!(nodes[1], 1);
2171
2172         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
2173
2174         expect_pending_htlcs_forwardable!(nodes[1]);
2175         expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2176
2177         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
2178         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2179 }
2180 #[test]
2181 fn channel_holding_cell_serialize() {
2182         do_channel_holding_cell_serialize(true, true);
2183         do_channel_holding_cell_serialize(true, false);
2184         do_channel_holding_cell_serialize(false, true); // last arg doesn't matter
2185 }