06bcfa4b7c80003a435f13f2595b26f69b810371
[rust-lightning] / fuzz / src / chanmon_consistency.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 //! Test that monitor update failures don't get our channel state out of sync.
11 //! One of the biggest concern with the monitor update failure handling code is that messages
12 //! resent after monitor updating is restored are delivered out-of-order, resulting in
13 //! commitment_signed messages having "invalid signatures".
14 //! To test this we stand up a network of three nodes and read bytes from the fuzz input to denote
15 //! actions such as sending payments, handling events, or changing monitor update return values on
16 //! a per-node basis. This should allow it to find any cases where the ordering of actions results
17 //! in us getting out of sync with ourselves, and, assuming at least one of our recieve- or
18 //! send-side handling is correct, other peers. We consider it a failure if any action results in a
19 //! channel being force-closed.
20
21 use bitcoin::blockdata::block::BlockHeader;
22 use bitcoin::blockdata::transaction::{Transaction, TxOut};
23 use bitcoin::blockdata::script::{Builder, Script};
24 use bitcoin::blockdata::opcodes;
25 use bitcoin::network::constants::Network;
26
27 use bitcoin::hashes::Hash as TraitImport;
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hash_types::{BlockHash, WPubkeyHash};
30
31 use lightning::chain;
32 use lightning::chain::chainmonitor;
33 use lightning::chain::channelmonitor;
34 use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, MonitorEvent};
35 use lightning::chain::transaction::OutPoint;
36 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
37 use lightning::chain::keysinterface::{KeysInterface, InMemoryChannelKeys};
38 use lightning::ln::channelmanager::{ChannelManager, PaymentHash, PaymentPreimage, PaymentSecret, PaymentSendFailure, ChannelManagerReadArgs};
39 use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
40 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, ErrorAction, UpdateAddHTLC, Init};
41 use lightning::util::enforcing_trait_impls::EnforcingChannelKeys;
42 use lightning::util::errors::APIError;
43 use lightning::util::events;
44 use lightning::util::logger::Logger;
45 use lightning::util::config::UserConfig;
46 use lightning::util::events::{EventsProvider, MessageSendEventsProvider};
47 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
48 use lightning::routing::router::{Route, RouteHop};
49
50
51 use utils::test_logger;
52 use utils::test_persister::TestPersister;
53
54 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
55 use bitcoin::secp256k1::Secp256k1;
56
57 use std::mem;
58 use std::cmp::Ordering;
59 use std::collections::{HashSet, hash_map, HashMap};
60 use std::sync::{Arc,Mutex};
61 use std::sync::atomic;
62 use std::io::Cursor;
63
64 struct FuzzEstimator {}
65 impl FeeEstimator for FuzzEstimator {
66         fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
67                 253
68         }
69 }
70
71 pub struct TestBroadcaster {}
72 impl BroadcasterInterface for TestBroadcaster {
73         fn broadcast_transaction(&self, _tx: &Transaction) { }
74 }
75
76 pub struct VecWriter(pub Vec<u8>);
77 impl Writer for VecWriter {
78         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
79                 self.0.extend_from_slice(buf);
80                 Ok(())
81         }
82         fn size_hint(&mut self, size: usize) {
83                 self.0.reserve_exact(size);
84         }
85 }
86
87 struct TestChainMonitor {
88         pub logger: Arc<dyn Logger>,
89         pub chain_monitor: Arc<chainmonitor::ChainMonitor<EnforcingChannelKeys, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
90         pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
91         // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
92         // logic will automatically force-close our channels for us (as we don't have an up-to-date
93         // monitor implying we are not able to punish misbehaving counterparties). Because this test
94         // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
95         // fully-serialized monitor state here, as well as the corresponding update_id.
96         pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
97         pub should_update_manager: atomic::AtomicBool,
98 }
99 impl TestChainMonitor {
100         pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>) -> Self {
101                 Self {
102                         chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, persister)),
103                         logger,
104                         update_ret: Mutex::new(Ok(())),
105                         latest_monitors: Mutex::new(HashMap::new()),
106                         should_update_manager: atomic::AtomicBool::new(false),
107                 }
108         }
109 }
110 impl chain::Watch for TestChainMonitor {
111         type Keys = EnforcingChannelKeys;
112
113         fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingChannelKeys>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
114                 let mut ser = VecWriter(Vec::new());
115                 monitor.write(&mut ser).unwrap();
116                 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
117                         panic!("Already had monitor pre-watch_channel");
118                 }
119                 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
120                 assert!(self.chain_monitor.watch_channel(funding_txo, monitor).is_ok());
121                 self.update_ret.lock().unwrap().clone()
122         }
123
124         fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
125                 let mut map_lock = self.latest_monitors.lock().unwrap();
126                 let mut map_entry = match map_lock.entry(funding_txo) {
127                         hash_map::Entry::Occupied(entry) => entry,
128                         hash_map::Entry::Vacant(_) => panic!("Didn't have monitor on update call"),
129                 };
130                 let mut deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::
131                         read(&mut Cursor::new(&map_entry.get().1)).unwrap().1;
132                 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
133                 let mut ser = VecWriter(Vec::new());
134                 deserialized_monitor.write(&mut ser).unwrap();
135                 map_entry.insert((update.update_id, ser.0));
136                 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
137                 self.update_ret.lock().unwrap().clone()
138         }
139
140         fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
141                 return self.chain_monitor.release_pending_monitor_events();
142         }
143 }
144
145 struct KeyProvider {
146         node_id: u8,
147         rand_bytes_id: atomic::AtomicU8,
148 }
149 impl KeysInterface for KeyProvider {
150         type ChanKeySigner = EnforcingChannelKeys;
151
152         fn get_node_secret(&self) -> SecretKey {
153                 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, self.node_id]).unwrap()
154         }
155
156         fn get_destination_script(&self) -> Script {
157                 let secp_ctx = Secp256k1::signing_only();
158                 let channel_monitor_claim_key = SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, self.node_id]).unwrap();
159                 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
160                 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
161         }
162
163         fn get_shutdown_pubkey(&self) -> PublicKey {
164                 let secp_ctx = Secp256k1::signing_only();
165                 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, self.node_id]).unwrap())
166         }
167
168         fn get_channel_keys(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingChannelKeys {
169                 let secp_ctx = Secp256k1::signing_only();
170                 EnforcingChannelKeys::new(InMemoryChannelKeys::new(
171                         &secp_ctx,
172                         SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, self.node_id]).unwrap(),
173                         SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, self.node_id]).unwrap(),
174                         SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, self.node_id]).unwrap(),
175                         SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, self.node_id]).unwrap(),
176                         SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 8, self.node_id]).unwrap(),
177                         [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 9, self.node_id],
178                         channel_value_satoshis,
179                         (0, 0),
180                 ))
181         }
182
183         fn get_secure_random_bytes(&self) -> [u8; 32] {
184                 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
185                 [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, id, 11, self.node_id]
186         }
187
188         fn read_chan_signer(&self, data: &[u8]) -> Result<EnforcingChannelKeys, DecodeError> {
189                 EnforcingChannelKeys::read(&mut std::io::Cursor::new(data))
190         }
191 }
192
193 #[inline]
194 fn check_api_err(api_err: APIError) {
195         match api_err {
196                 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
197                 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
198                 APIError::RouteError { .. } => panic!("Our routes should work"),
199                 APIError::ChannelUnavailable { err } => {
200                         // Test the error against a list of errors we can hit, and reject
201                         // all others. If you hit this panic, the list of acceptable errors
202                         // is probably just stale and you should add new messages here.
203                         match err.as_str() {
204                                 "Peer for first hop currently disconnected/pending monitor update!" => {},
205                                 _ if err.starts_with("Cannot push more than their max accepted HTLCs ") => {},
206                                 _ if err.starts_with("Cannot send value that would put us over the max HTLC value in flight our peer will accept ") => {},
207                                 _ if err.starts_with("Cannot send value that would put our balance under counterparty-announced channel reserve value") => {},
208                                 _ if err.starts_with("Cannot send value that would overdraw remaining funds.") => {},
209                                 _ if err.starts_with("Cannot send value that would not leave enough to pay for fees.") => {},
210                                 _ => panic!(err),
211                         }
212                 },
213                 APIError::MonitorUpdateFailed => {
214                         // We can (obviously) temp-fail a monitor update
215                 },
216         }
217 }
218 #[inline]
219 fn check_payment_err(send_err: PaymentSendFailure) {
220         match send_err {
221                 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err),
222                 PaymentSendFailure::PathParameterError(per_path_results) => {
223                         for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
224                 },
225                 PaymentSendFailure::AllFailedRetrySafe(per_path_results) => {
226                         for api_err in per_path_results { check_api_err(api_err); }
227                 },
228                 PaymentSendFailure::PartialFailure(per_path_results) => {
229                         for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
230                 },
231         }
232 }
233
234 type ChanMan = ChannelManager<EnforcingChannelKeys, Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>;
235
236 #[inline]
237 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
238         let payment_hash = Sha256::hash(&[*payment_id; 1]);
239         *payment_id = payment_id.wrapping_add(1);
240         if let Err(err) = source.send_payment(&Route {
241                 paths: vec![vec![RouteHop {
242                         pubkey: dest.get_our_node_id(),
243                         node_features: NodeFeatures::empty(),
244                         short_channel_id: dest_chan_id,
245                         channel_features: ChannelFeatures::empty(),
246                         fee_msat: amt,
247                         cltv_expiry_delta: 200,
248                 }]],
249         }, PaymentHash(payment_hash.into_inner()), &None) {
250                 check_payment_err(err);
251                 false
252         } else { true }
253 }
254 #[inline]
255 fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
256         let payment_hash = Sha256::hash(&[*payment_id; 1]);
257         *payment_id = payment_id.wrapping_add(1);
258         if let Err(err) = source.send_payment(&Route {
259                 paths: vec![vec![RouteHop {
260                         pubkey: middle.get_our_node_id(),
261                         node_features: NodeFeatures::empty(),
262                         short_channel_id: middle_chan_id,
263                         channel_features: ChannelFeatures::empty(),
264                         fee_msat: 50000,
265                         cltv_expiry_delta: 100,
266                 },RouteHop {
267                         pubkey: dest.get_our_node_id(),
268                         node_features: NodeFeatures::empty(),
269                         short_channel_id: dest_chan_id,
270                         channel_features: ChannelFeatures::empty(),
271                         fee_msat: amt,
272                         cltv_expiry_delta: 200,
273                 }]],
274         }, PaymentHash(payment_hash.into_inner()), &None) {
275                 check_payment_err(err);
276                 false
277         } else { true }
278 }
279
280 #[inline]
281 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
282         let fee_est = Arc::new(FuzzEstimator{});
283         let broadcast = Arc::new(TestBroadcaster{});
284
285         macro_rules! make_node {
286                 ($node_id: expr) => { {
287                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
288                         let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{})));
289
290                         let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU8::new(0) });
291                         let mut config = UserConfig::default();
292                         config.channel_options.fee_proportional_millionths = 0;
293                         config.channel_options.announced_channel = true;
294                         config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
295                         (ChannelManager::new(Network::Bitcoin, fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, 0),
296                         monitor)
297                 } }
298         }
299
300         macro_rules! reload_node {
301                 ($ser: expr, $node_id: expr, $old_monitors: expr) => { {
302                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
303                         let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{})));
304
305                         let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU8::new(0) });
306                         let mut config = UserConfig::default();
307                         config.channel_options.fee_proportional_millionths = 0;
308                         config.channel_options.announced_channel = true;
309                         config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
310
311                         let mut monitors = HashMap::new();
312                         let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
313                         for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
314                                 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut Cursor::new(&monitor_ser)).expect("Failed to read monitor").1);
315                                 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
316                         }
317                         let mut monitor_refs = HashMap::new();
318                         for (outpoint, monitor) in monitors.iter_mut() {
319                                 monitor_refs.insert(*outpoint, monitor);
320                         }
321
322                         let read_args = ChannelManagerReadArgs {
323                                 keys_manager,
324                                 fee_estimator: fee_est.clone(),
325                                 chain_monitor: chain_monitor.clone(),
326                                 tx_broadcaster: broadcast.clone(),
327                                 logger,
328                                 default_config: config,
329                                 channel_monitors: monitor_refs,
330                         };
331
332                         (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor)
333                 } }
334         }
335
336         let mut channel_txn = Vec::new();
337         macro_rules! make_channel {
338                 ($source: expr, $dest: expr, $chan_id: expr) => { {
339                         $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
340                         let open_channel = {
341                                 let events = $source.get_and_clear_pending_msg_events();
342                                 assert_eq!(events.len(), 1);
343                                 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
344                                         msg.clone()
345                                 } else { panic!("Wrong event type"); }
346                         };
347
348                         $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::known(), &open_channel);
349                         let accept_channel = {
350                                 let events = $dest.get_and_clear_pending_msg_events();
351                                 assert_eq!(events.len(), 1);
352                                 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
353                                         msg.clone()
354                                 } else { panic!("Wrong event type"); }
355                         };
356
357                         $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::known(), &accept_channel);
358                         let funding_output;
359                         {
360                                 let events = $source.get_and_clear_pending_events();
361                                 assert_eq!(events.len(), 1);
362                                 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
363                                         let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
364                                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
365                                         }]};
366                                         funding_output = OutPoint { txid: tx.txid(), index: 0 };
367                                         $source.funding_transaction_generated(&temporary_channel_id, funding_output);
368                                         channel_txn.push(tx);
369                                 } else { panic!("Wrong event type"); }
370                         }
371
372                         let funding_created = {
373                                 let events = $source.get_and_clear_pending_msg_events();
374                                 assert_eq!(events.len(), 1);
375                                 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
376                                         msg.clone()
377                                 } else { panic!("Wrong event type"); }
378                         };
379                         $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
380
381                         let funding_signed = {
382                                 let events = $dest.get_and_clear_pending_msg_events();
383                                 assert_eq!(events.len(), 1);
384                                 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
385                                         msg.clone()
386                                 } else { panic!("Wrong event type"); }
387                         };
388                         $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
389
390                         {
391                                 let events = $source.get_and_clear_pending_events();
392                                 assert_eq!(events.len(), 1);
393                                 if let events::Event::FundingBroadcastSafe { .. } = events[0] {
394                                 } else { panic!("Wrong event type"); }
395                         }
396                         funding_output
397                 } }
398         }
399
400         macro_rules! confirm_txn {
401                 ($node: expr) => { {
402                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
403                         let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
404                         $node.block_connected(&header, &txdata, 1);
405                         for i in 2..100 {
406                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
407                                 $node.block_connected(&header, &[], i);
408                         }
409                 } }
410         }
411
412         macro_rules! lock_fundings {
413                 ($nodes: expr) => { {
414                         let mut node_events = Vec::new();
415                         for node in $nodes.iter() {
416                                 node_events.push(node.get_and_clear_pending_msg_events());
417                         }
418                         for (idx, node_event) in node_events.iter().enumerate() {
419                                 for event in node_event {
420                                         if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
421                                                 for node in $nodes.iter() {
422                                                         if node.get_our_node_id() == *node_id {
423                                                                 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
424                                                         }
425                                                 }
426                                         } else { panic!("Wrong event type"); }
427                                 }
428                         }
429
430                         for node in $nodes.iter() {
431                                 let events = node.get_and_clear_pending_msg_events();
432                                 for event in events {
433                                         if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
434                                         } else { panic!("Wrong event type"); }
435                                 }
436                         }
437                 } }
438         }
439
440         // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
441         // forwarding.
442         let (node_a, mut monitor_a) = make_node!(0);
443         let (node_b, mut monitor_b) = make_node!(1);
444         let (node_c, mut monitor_c) = make_node!(2);
445
446         let mut nodes = [node_a, node_b, node_c];
447
448         let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
449         let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
450
451         for node in nodes.iter() {
452                 confirm_txn!(node);
453         }
454
455         lock_fundings!(nodes);
456
457         let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
458         let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
459
460         let mut payment_id: u8 = 0;
461
462         let mut chan_a_disconnected = false;
463         let mut chan_b_disconnected = false;
464         let mut ba_events = Vec::new();
465         let mut bc_events = Vec::new();
466
467         let mut node_a_ser = VecWriter(Vec::new());
468         nodes[0].write(&mut node_a_ser).unwrap();
469         let mut node_b_ser = VecWriter(Vec::new());
470         nodes[1].write(&mut node_b_ser).unwrap();
471         let mut node_c_ser = VecWriter(Vec::new());
472         nodes[2].write(&mut node_c_ser).unwrap();
473
474         macro_rules! test_return {
475                 () => { {
476                         assert_eq!(nodes[0].list_channels().len(), 1);
477                         assert_eq!(nodes[1].list_channels().len(), 2);
478                         assert_eq!(nodes[2].list_channels().len(), 1);
479                         return;
480                 } }
481         }
482
483         let mut read_pos = 0;
484         macro_rules! get_slice {
485                 ($len: expr) => {
486                         {
487                                 let slice_len = $len as usize;
488                                 if data.len() < read_pos + slice_len {
489                                         test_return!();
490                                 }
491                                 read_pos += slice_len;
492                                 &data[read_pos - slice_len..read_pos]
493                         }
494                 }
495         }
496
497         loop {
498                 macro_rules! send_payment_with_secret {
499                         ($source: expr, $middle: expr, $dest: expr) => { {
500                                 let payment_hash = Sha256::hash(&[payment_id; 1]);
501                                 payment_id = payment_id.wrapping_add(1);
502                                 let payment_secret = Sha256::hash(&[payment_id; 1]);
503                                 payment_id = payment_id.wrapping_add(1);
504                                 if let Err(err) = $source.send_payment(&Route {
505                                         paths: vec![vec![RouteHop {
506                                                 pubkey: $middle.0.get_our_node_id(),
507                                                 node_features: NodeFeatures::empty(),
508                                                 short_channel_id: $middle.1,
509                                                 channel_features: ChannelFeatures::empty(),
510                                                 fee_msat: 50_000,
511                                                 cltv_expiry_delta: 100,
512                                         },RouteHop {
513                                                 pubkey: $dest.0.get_our_node_id(),
514                                                 node_features: NodeFeatures::empty(),
515                                                 short_channel_id: $dest.1,
516                                                 channel_features: ChannelFeatures::empty(),
517                                                 fee_msat: 10_000_000,
518                                                 cltv_expiry_delta: 200,
519                                         }],vec![RouteHop {
520                                                 pubkey: $middle.0.get_our_node_id(),
521                                                 node_features: NodeFeatures::empty(),
522                                                 short_channel_id: $middle.1,
523                                                 channel_features: ChannelFeatures::empty(),
524                                                 fee_msat: 50_000,
525                                                 cltv_expiry_delta: 100,
526                                         },RouteHop {
527                                                 pubkey: $dest.0.get_our_node_id(),
528                                                 node_features: NodeFeatures::empty(),
529                                                 short_channel_id: $dest.1,
530                                                 channel_features: ChannelFeatures::empty(),
531                                                 fee_msat: 10_000_000,
532                                                 cltv_expiry_delta: 200,
533                                         }]],
534                                 }, PaymentHash(payment_hash.into_inner()), &Some(PaymentSecret(payment_secret.into_inner()))) {
535                                         check_payment_err(err);
536                                 }
537                         } }
538                 }
539
540                 macro_rules! process_msg_events {
541                         ($node: expr, $corrupt_forward: expr) => { {
542                                 let events = if $node == 1 {
543                                         let mut new_events = Vec::new();
544                                         mem::swap(&mut new_events, &mut ba_events);
545                                         new_events.extend_from_slice(&bc_events[..]);
546                                         bc_events.clear();
547                                         new_events
548                                 } else { Vec::new() };
549                                 let mut had_events = false;
550                                 for event in events.iter().chain(nodes[$node].get_and_clear_pending_msg_events().iter()) {
551                                         had_events = true;
552                                         match event {
553                                                 events::MessageSendEvent::UpdateHTLCs { ref node_id, updates: CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
554                                                         for dest in nodes.iter() {
555                                                                 if dest.get_our_node_id() == *node_id {
556                                                                         assert!(update_fee.is_none());
557                                                                         for update_add in update_add_htlcs {
558                                                                                 if !$corrupt_forward {
559                                                                                         dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &update_add);
560                                                                                 } else {
561                                                                                         // Corrupt the update_add_htlc message so that its HMAC
562                                                                                         // check will fail and we generate a
563                                                                                         // update_fail_malformed_htlc instead of an
564                                                                                         // update_fail_htlc as we do when we reject a payment.
565                                                                                         let mut msg_ser = update_add.encode();
566                                                                                         msg_ser[1000] ^= 0xff;
567                                                                                         let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
568                                                                                         dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
569                                                                                 }
570                                                                         }
571                                                                         for update_fulfill in update_fulfill_htlcs {
572                                                                                 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), &update_fulfill);
573                                                                         }
574                                                                         for update_fail in update_fail_htlcs {
575                                                                                 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), &update_fail);
576                                                                         }
577                                                                         for update_fail_malformed in update_fail_malformed_htlcs {
578                                                                                 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), &update_fail_malformed);
579                                                                         }
580                                                                         dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
581                                                                 }
582                                                         }
583                                                 },
584                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
585                                                         for dest in nodes.iter() {
586                                                                 if dest.get_our_node_id() == *node_id {
587                                                                         dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
588                                                                 }
589                                                         }
590                                                 },
591                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
592                                                         for dest in nodes.iter() {
593                                                                 if dest.get_our_node_id() == *node_id {
594                                                                         dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
595                                                                 }
596                                                         }
597                                                 },
598                                                 events::MessageSendEvent::SendFundingLocked { .. } => {
599                                                         // Can be generated as a reestablish response
600                                                 },
601                                                 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
602                                                         // Can be generated due to a payment forward being rejected due to a
603                                                         // channel having previously failed a monitor update
604                                                 },
605                                                 _ => panic!("Unhandled message event"),
606                                         }
607                                 }
608                                 had_events
609                         } }
610                 }
611
612                 macro_rules! drain_msg_events_on_disconnect {
613                         ($counterparty_id: expr) => { {
614                                 if $counterparty_id == 0 {
615                                         for event in nodes[0].get_and_clear_pending_msg_events() {
616                                                 match event {
617                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
618                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
619                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
620                                                         events::MessageSendEvent::SendFundingLocked { .. } => {},
621                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
622                                                         events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
623                                                         _ => panic!("Unhandled message event"),
624                                                 }
625                                         }
626                                         ba_events.clear();
627                                 } else {
628                                         for event in nodes[2].get_and_clear_pending_msg_events() {
629                                                 match event {
630                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
631                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
632                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
633                                                         events::MessageSendEvent::SendFundingLocked { .. } => {},
634                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
635                                                         events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
636                                                         _ => panic!("Unhandled message event"),
637                                                 }
638                                         }
639                                         bc_events.clear();
640                                 }
641                                 let mut events = nodes[1].get_and_clear_pending_msg_events();
642                                 let drop_node_id = if $counterparty_id == 0 { nodes[0].get_our_node_id() } else { nodes[2].get_our_node_id() };
643                                 let msg_sink = if $counterparty_id == 0 { &mut bc_events } else { &mut ba_events };
644                                 for event in events.drain(..) {
645                                         let push = match event {
646                                                 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
647                                                         if *node_id != drop_node_id { true } else { false }
648                                                 },
649                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
650                                                         if *node_id != drop_node_id { true } else { false }
651                                                 },
652                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
653                                                         if *node_id != drop_node_id { true } else { false }
654                                                 },
655                                                 events::MessageSendEvent::SendFundingLocked { .. } => false,
656                                                 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => false,
657                                                 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => false,
658                                                 _ => panic!("Unhandled message event"),
659                                         };
660                                         if push { msg_sink.push(event); }
661                                 }
662                         } }
663                 }
664
665                 macro_rules! process_events {
666                         ($node: expr, $fail: expr) => { {
667                                 // In case we get 256 payments we may have a hash collision, resulting in the
668                                 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
669                                 // deduplicate the calls here.
670                                 let mut claim_set = HashSet::new();
671                                 let mut events = nodes[$node].get_and_clear_pending_events();
672                                 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
673                                 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
674                                 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
675                                 // PaymentReceived event for the second HTLC in our pending_events (and breaking
676                                 // our claim_set deduplication).
677                                 events.sort_by(|a, b| {
678                                         if let events::Event::PaymentReceived { .. } = a {
679                                                 if let events::Event::PendingHTLCsForwardable { .. } = b {
680                                                         Ordering::Less
681                                                 } else { Ordering::Equal }
682                                         } else if let events::Event::PendingHTLCsForwardable { .. } = a {
683                                                 if let events::Event::PaymentReceived { .. } = b {
684                                                         Ordering::Greater
685                                                 } else { Ordering::Equal }
686                                         } else { Ordering::Equal }
687                                 });
688                                 let had_events = !events.is_empty();
689                                 for event in events.drain(..) {
690                                         match event {
691                                                 events::Event::PaymentReceived { payment_hash, payment_secret, amt } => {
692                                                         if claim_set.insert(payment_hash.0) {
693                                                                 if $fail {
694                                                                         assert!(nodes[$node].fail_htlc_backwards(&payment_hash, &payment_secret));
695                                                                 } else {
696                                                                         assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0), &payment_secret, amt));
697                                                                 }
698                                                         }
699                                                 },
700                                                 events::Event::PaymentSent { .. } => {},
701                                                 events::Event::PaymentFailed { .. } => {},
702                                                 events::Event::PendingHTLCsForwardable { .. } => {
703                                                         nodes[$node].process_pending_htlc_forwards();
704                                                 },
705                                                 _ => panic!("Unhandled event"),
706                                         }
707                                 }
708                                 had_events
709                         } }
710                 }
711
712                 match get_slice!(1)[0] {
713                         // In general, we keep related message groups close together in binary form, allowing
714                         // bit-twiddling mutations to have similar effects. This is probably overkill, but no
715                         // harm in doing so.
716
717                         0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
718                         0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
719                         0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
720                         0x04 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
721                         0x05 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
722                         0x06 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
723
724                         0x08 => {
725                                 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
726                                         nodes[0].channel_monitor_updated(&chan_1_funding, *id);
727                                 }
728                         },
729                         0x09 => {
730                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
731                                         nodes[1].channel_monitor_updated(&chan_1_funding, *id);
732                                 }
733                         },
734                         0x0a => {
735                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
736                                         nodes[1].channel_monitor_updated(&chan_2_funding, *id);
737                                 }
738                         },
739                         0x0b => {
740                                 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
741                                         nodes[2].channel_monitor_updated(&chan_2_funding, *id);
742                                 }
743                         },
744
745                         0x0c => {
746                                 if !chan_a_disconnected {
747                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
748                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
749                                         chan_a_disconnected = true;
750                                         drain_msg_events_on_disconnect!(0);
751                                 }
752                         },
753                         0x0d => {
754                                 if !chan_b_disconnected {
755                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
756                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
757                                         chan_b_disconnected = true;
758                                         drain_msg_events_on_disconnect!(2);
759                                 }
760                         },
761                         0x0e => {
762                                 if chan_a_disconnected {
763                                         nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
764                                         nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
765                                         chan_a_disconnected = false;
766                                 }
767                         },
768                         0x0f => {
769                                 if chan_b_disconnected {
770                                         nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
771                                         nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
772                                         chan_b_disconnected = false;
773                                 }
774                         },
775
776                         0x10 => { process_msg_events!(0, true); },
777                         0x11 => { process_msg_events!(0, false); },
778                         0x12 => { process_events!(0, true); },
779                         0x13 => { process_events!(0, false); },
780                         0x14 => { process_msg_events!(1, true); },
781                         0x15 => { process_msg_events!(1, false); },
782                         0x16 => { process_events!(1, true); },
783                         0x17 => { process_events!(1, false); },
784                         0x18 => { process_msg_events!(2, true); },
785                         0x19 => { process_msg_events!(2, false); },
786                         0x1a => { process_events!(2, true); },
787                         0x1b => { process_events!(2, false); },
788
789                         0x1c => {
790                                 if !chan_a_disconnected {
791                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
792                                         chan_a_disconnected = true;
793                                         drain_msg_events_on_disconnect!(0);
794                                 }
795                                 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a);
796                                 nodes[0] = new_node_a;
797                                 monitor_a = new_monitor_a;
798                         },
799                         0x1d => {
800                                 if !chan_a_disconnected {
801                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
802                                         chan_a_disconnected = true;
803                                         nodes[0].get_and_clear_pending_msg_events();
804                                         ba_events.clear();
805                                 }
806                                 if !chan_b_disconnected {
807                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
808                                         chan_b_disconnected = true;
809                                         nodes[2].get_and_clear_pending_msg_events();
810                                         bc_events.clear();
811                                 }
812                                 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b);
813                                 nodes[1] = new_node_b;
814                                 monitor_b = new_monitor_b;
815                         },
816                         0x1e => {
817                                 if !chan_b_disconnected {
818                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
819                                         chan_b_disconnected = true;
820                                         drain_msg_events_on_disconnect!(2);
821                                 }
822                                 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c);
823                                 nodes[2] = new_node_c;
824                                 monitor_c = new_monitor_c;
825                         },
826
827                         // 1/10th the channel size:
828                         0x20 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id); },
829                         0x21 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id); },
830                         0x22 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id); },
831                         0x23 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id); },
832                         0x24 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id); },
833                         0x25 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id); },
834
835                         0x26 => { send_payment_with_secret!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b)); },
836                         0x27 => { send_payment_with_secret!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a)); },
837
838                         0x28 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id); },
839                         0x29 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id); },
840                         0x2a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id); },
841                         0x2b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id); },
842                         0x2c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id); },
843                         0x2d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id); },
844
845                         0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id); },
846                         0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id); },
847                         0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id); },
848                         0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id); },
849                         0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id); },
850                         0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id); },
851
852                         0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id); },
853                         0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id); },
854                         0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id); },
855                         0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id); },
856                         0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id); },
857                         0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id); },
858
859                         0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id); },
860                         0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id); },
861                         0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id); },
862                         0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id); },
863                         0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id); },
864                         0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id); },
865
866                         0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id); },
867                         0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id); },
868                         0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id); },
869                         0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id); },
870                         0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id); },
871                         0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id); },
872
873                         0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id); },
874                         0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id); },
875                         0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id); },
876                         0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id); },
877                         0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id); },
878                         0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id); },
879
880                         0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id); },
881                         0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id); },
882                         0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id); },
883                         0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id); },
884                         0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
885                         0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },
886
887                         0xff => {
888                                 // Test that no channel is in a stuck state where neither party can send funds even
889                                 // after we resolve all pending events.
890                                 // First make sure there are no pending monitor updates, resetting the error state
891                                 // and calling channel_monitor_updated for each monitor.
892                                 *monitor_a.update_ret.lock().unwrap() = Ok(());
893                                 *monitor_b.update_ret.lock().unwrap() = Ok(());
894                                 *monitor_c.update_ret.lock().unwrap() = Ok(());
895
896                                 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
897                                         nodes[0].channel_monitor_updated(&chan_1_funding, *id);
898                                 }
899                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
900                                         nodes[1].channel_monitor_updated(&chan_1_funding, *id);
901                                 }
902                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
903                                         nodes[1].channel_monitor_updated(&chan_2_funding, *id);
904                                 }
905                                 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
906                                         nodes[2].channel_monitor_updated(&chan_2_funding, *id);
907                                 }
908
909                                 // Next, make sure peers are all connected to each other
910                                 if chan_a_disconnected {
911                                         nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
912                                         nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
913                                         chan_a_disconnected = false;
914                                 }
915                                 if chan_b_disconnected {
916                                         nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
917                                         nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
918                                         chan_b_disconnected = false;
919                                 }
920
921                                 for i in 0..std::usize::MAX {
922                                         if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
923                                         // Then, make sure any current forwards make their way to their destination
924                                         if process_msg_events!(0, false) { continue; }
925                                         if process_msg_events!(1, false) { continue; }
926                                         if process_msg_events!(2, false) { continue; }
927                                         // ...making sure any pending PendingHTLCsForwardable events are handled and
928                                         // payments claimed.
929                                         if process_events!(0, false) { continue; }
930                                         if process_events!(1, false) { continue; }
931                                         if process_events!(2, false) { continue; }
932                                         break;
933                                 }
934
935                                 // Finally, make sure that at least one end of each channel can make a substantial payment.
936                                 assert!(
937                                         send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id) ||
938                                         send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id));
939                                 assert!(
940                                         send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
941                                         send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));
942                         },
943                         _ => test_return!(),
944                 }
945
946                 node_a_ser.0.clear();
947                 nodes[0].write(&mut node_a_ser).unwrap();
948                 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
949                 node_b_ser.0.clear();
950                 nodes[1].write(&mut node_b_ser).unwrap();
951                 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
952                 node_c_ser.0.clear();
953                 nodes[2].write(&mut node_c_ser).unwrap();
954                 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
955         }
956 }
957
958 pub fn chanmon_consistency_test<Out: test_logger::Output>(data: &[u8], out: Out) {
959         do_test(data, out);
960 }
961
962 #[no_mangle]
963 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
964         do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});
965 }