Bump workspace to rust edition 2018
[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::TxMerkleNode;
22 use bitcoin::blockdata::block::BlockHeader;
23 use bitcoin::blockdata::constants::genesis_block;
24 use bitcoin::blockdata::transaction::{Transaction, TxOut};
25 use bitcoin::blockdata::script::{Builder, Script};
26 use bitcoin::blockdata::opcodes;
27 use bitcoin::blockdata::locktime::PackedLockTime;
28 use bitcoin::network::constants::Network;
29
30 use bitcoin::hashes::Hash as TraitImport;
31 use bitcoin::hashes::sha256::Hash as Sha256;
32 use bitcoin::hash_types::{BlockHash, WPubkeyHash};
33
34 use lightning::chain;
35 use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, chainmonitor, channelmonitor, Confirm, Watch};
36 use lightning::chain::channelmonitor::{ChannelMonitor, MonitorEvent};
37 use lightning::chain::transaction::OutPoint;
38 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
39 use lightning::chain::keysinterface::{KeyMaterial, KeysInterface, InMemorySigner, Recipient};
40 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
41 use lightning::ln::channelmanager::{self, ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs};
42 use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
43 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
44 use lightning::ln::script::ShutdownScript;
45 use lightning::util::enforcing_trait_impls::{EnforcingSigner, EnforcementState};
46 use lightning::util::errors::APIError;
47 use lightning::util::events;
48 use lightning::util::logger::Logger;
49 use lightning::util::config::UserConfig;
50 use lightning::util::events::MessageSendEventsProvider;
51 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
52 use lightning::routing::router::{Route, RouteHop};
53
54 use crate::utils::test_logger::{self, Output};
55 use crate::utils::test_persister::TestPersister;
56
57 use bitcoin::secp256k1::{PublicKey, SecretKey, Scalar};
58 use bitcoin::secp256k1::ecdh::SharedSecret;
59 use bitcoin::secp256k1::ecdsa::RecoverableSignature;
60 use bitcoin::secp256k1::Secp256k1;
61
62 use std::mem;
63 use std::cmp::{self, Ordering};
64 use std::collections::{HashSet, hash_map, HashMap};
65 use std::sync::{Arc,Mutex};
66 use std::sync::atomic;
67 use std::io::Cursor;
68 use bitcoin::bech32::u5;
69
70 const MAX_FEE: u32 = 10_000;
71 struct FuzzEstimator {
72         ret_val: atomic::AtomicU32,
73 }
74 impl FeeEstimator for FuzzEstimator {
75         fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
76                 // We force-close channels if our counterparty sends us a feerate which is a small multiple
77                 // of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
78                 // always return a HighPriority feerate here which is >= the maximum Normal feerate and a
79                 // Background feerate which is <= the minimum Normal feerate.
80                 match conf_target {
81                         ConfirmationTarget::HighPriority => MAX_FEE,
82                         ConfirmationTarget::Background => 253,
83                         ConfirmationTarget::Normal => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
84                 }
85         }
86 }
87
88 pub struct TestBroadcaster {}
89 impl BroadcasterInterface for TestBroadcaster {
90         fn broadcast_transaction(&self, _tx: &Transaction) { }
91 }
92
93 pub struct VecWriter(pub Vec<u8>);
94 impl Writer for VecWriter {
95         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
96                 self.0.extend_from_slice(buf);
97                 Ok(())
98         }
99 }
100
101 struct TestChainMonitor {
102         pub logger: Arc<dyn Logger>,
103         pub keys: Arc<KeyProvider>,
104         pub persister: Arc<TestPersister>,
105         pub chain_monitor: Arc<chainmonitor::ChainMonitor<EnforcingSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
106         // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
107         // logic will automatically force-close our channels for us (as we don't have an up-to-date
108         // monitor implying we are not able to punish misbehaving counterparties). Because this test
109         // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
110         // fully-serialized monitor state here, as well as the corresponding update_id.
111         pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
112         pub should_update_manager: atomic::AtomicBool,
113 }
114 impl TestChainMonitor {
115         pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>, keys: Arc<KeyProvider>) -> Self {
116                 Self {
117                         chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, Arc::clone(&persister))),
118                         logger,
119                         keys,
120                         persister,
121                         latest_monitors: Mutex::new(HashMap::new()),
122                         should_update_manager: atomic::AtomicBool::new(false),
123                 }
124         }
125 }
126 impl chain::Watch<EnforcingSigner> for TestChainMonitor {
127         fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> chain::ChannelMonitorUpdateStatus {
128                 let mut ser = VecWriter(Vec::new());
129                 monitor.write(&mut ser).unwrap();
130                 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
131                         panic!("Already had monitor pre-watch_channel");
132                 }
133                 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
134                 self.chain_monitor.watch_channel(funding_txo, monitor)
135         }
136
137         fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
138                 let mut map_lock = self.latest_monitors.lock().unwrap();
139                 let mut map_entry = match map_lock.entry(funding_txo) {
140                         hash_map::Entry::Occupied(entry) => entry,
141                         hash_map::Entry::Vacant(_) => panic!("Didn't have monitor on update call"),
142                 };
143                 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
144                         read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
145                 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
146                 let mut ser = VecWriter(Vec::new());
147                 deserialized_monitor.write(&mut ser).unwrap();
148                 map_entry.insert((update.update_id, ser.0));
149                 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
150                 self.chain_monitor.update_channel(funding_txo, update)
151         }
152
153         fn release_pending_monitor_events(&self) -> Vec<(OutPoint, Vec<MonitorEvent>, Option<PublicKey>)> {
154                 return self.chain_monitor.release_pending_monitor_events();
155         }
156 }
157
158 struct KeyProvider {
159         node_id: u8,
160         rand_bytes_id: atomic::AtomicU32,
161         enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
162 }
163 impl KeysInterface for KeyProvider {
164         type Signer = EnforcingSigner;
165
166         fn get_node_secret(&self, _recipient: Recipient) -> Result<SecretKey, ()> {
167                 Ok(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())
168         }
169
170         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
171                 let mut node_secret = self.get_node_secret(recipient)?;
172                 if let Some(tweak) = tweak {
173                         node_secret = node_secret.mul_tweak(tweak).unwrap();
174                 }
175                 Ok(SharedSecret::new(other_key, &node_secret))
176         }
177
178         fn get_inbound_payment_key_material(&self) -> KeyMaterial {
179                 KeyMaterial([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])
180         }
181
182         fn get_destination_script(&self) -> Script {
183                 let secp_ctx = Secp256k1::signing_only();
184                 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();
185                 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
186                 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
187         }
188
189         fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
190                 let secp_ctx = Secp256k1::signing_only();
191                 let secret_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, 3, self.node_id]).unwrap();
192                 let pubkey_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &secret_key).serialize());
193                 ShutdownScript::new_p2wpkh(&pubkey_hash)
194         }
195
196         fn get_channel_signer(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner {
197                 let secp_ctx = Secp256k1::signing_only();
198                 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
199                 let keys = InMemorySigner::new(
200                         &secp_ctx,
201                         self.get_node_secret(Recipient::Node).unwrap(),
202                         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(),
203                         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(),
204                         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(),
205                         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(),
206                         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(),
207                         [id as u8, 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],
208                         channel_value_satoshis,
209                         [0; 32],
210                 );
211                 let revoked_commitment = self.make_enforcement_state_cell(keys.commitment_seed);
212                 EnforcingSigner::new_with_revoked(keys, revoked_commitment, false)
213         }
214
215         fn get_secure_random_bytes(&self) -> [u8; 32] {
216                 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
217                 let mut res = [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, 11, self.node_id];
218                 res[30-4..30].copy_from_slice(&id.to_le_bytes());
219                 res
220         }
221
222         fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, DecodeError> {
223                 let mut reader = std::io::Cursor::new(buffer);
224
225                 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self.get_node_secret(Recipient::Node).unwrap())?;
226                 let state = self.make_enforcement_state_cell(inner.commitment_seed);
227
228                 Ok(EnforcingSigner {
229                         inner,
230                         state,
231                         disable_revocation_policy_check: false,
232                 })
233         }
234
235         fn sign_invoice(&self, _hrp_bytes: &[u8], _invoice_data: &[u5], _recipient: Recipient) -> Result<RecoverableSignature, ()> {
236                 unreachable!()
237         }
238 }
239
240 impl KeyProvider {
241         fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
242                 let mut revoked_commitments = self.enforcement_states.lock().unwrap();
243                 if !revoked_commitments.contains_key(&commitment_seed) {
244                         revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(EnforcementState::new())));
245                 }
246                 let cell = revoked_commitments.get(&commitment_seed).unwrap();
247                 Arc::clone(cell)
248         }
249 }
250
251 #[inline]
252 fn check_api_err(api_err: APIError) {
253         match api_err {
254                 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
255                 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
256                 APIError::RouteError { .. } => panic!("Our routes should work"),
257                 APIError::ChannelUnavailable { err } => {
258                         // Test the error against a list of errors we can hit, and reject
259                         // all others. If you hit this panic, the list of acceptable errors
260                         // is probably just stale and you should add new messages here.
261                         match err.as_str() {
262                                 "Peer for first hop currently disconnected/pending monitor update!" => {},
263                                 _ if err.starts_with("Cannot push more than their max accepted HTLCs ") => {},
264                                 _ if err.starts_with("Cannot send value that would put us over the max HTLC value in flight our peer will accept ") => {},
265                                 _ if err.starts_with("Cannot send value that would put our balance under counterparty-announced channel reserve value") => {},
266                                 _ if err.starts_with("Cannot send value that would put counterparty balance under holder-announced channel reserve value") => {},
267                                 _ if err.starts_with("Cannot send value that would overdraw remaining funds.") => {},
268                                 _ if err.starts_with("Cannot send value that would not leave enough to pay for fees.") => {},
269                                 _ if err.starts_with("Cannot send value that would put our exposure to dust HTLCs at") => {},
270                                 _ => panic!("{}", err),
271                         }
272                 },
273                 APIError::MonitorUpdateInProgress => {
274                         // We can (obviously) temp-fail a monitor update
275                 },
276                 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
277         }
278 }
279 #[inline]
280 fn check_payment_err(send_err: PaymentSendFailure) {
281         match send_err {
282                 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err),
283                 PaymentSendFailure::PathParameterError(per_path_results) => {
284                         for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
285                 },
286                 PaymentSendFailure::AllFailedRetrySafe(per_path_results) => {
287                         for api_err in per_path_results { check_api_err(api_err); }
288                 },
289                 PaymentSendFailure::PartialFailure { results, .. } => {
290                         for res in results { if let Err(api_err) = res { check_api_err(api_err); } }
291                 },
292         }
293 }
294
295 type ChanMan = ChannelManager<EnforcingSigner, Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>;
296
297 #[inline]
298 fn get_payment_secret_hash(dest: &ChanMan, payment_id: &mut u8) -> Option<(PaymentSecret, PaymentHash)> {
299         let mut payment_hash;
300         for _ in 0..256 {
301                 payment_hash = PaymentHash(Sha256::hash(&[*payment_id; 1]).into_inner());
302                 if let Ok(payment_secret) = dest.create_inbound_payment_for_hash(payment_hash, None, 3600) {
303                         return Some((payment_secret, payment_hash));
304                 }
305                 *payment_id = payment_id.wrapping_add(1);
306         }
307         None
308 }
309
310 #[inline]
311 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
312         let (payment_secret, payment_hash) =
313                 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
314         if let Err(err) = source.send_payment(&Route {
315                 paths: vec![vec![RouteHop {
316                         pubkey: dest.get_our_node_id(),
317                         node_features: channelmanager::provided_node_features(),
318                         short_channel_id: dest_chan_id,
319                         channel_features: channelmanager::provided_channel_features(),
320                         fee_msat: amt,
321                         cltv_expiry_delta: 200,
322                 }]],
323                 payment_params: None,
324         }, payment_hash, &Some(payment_secret)) {
325                 check_payment_err(err);
326                 false
327         } else { true }
328 }
329 #[inline]
330 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 {
331         let (payment_secret, payment_hash) =
332                 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
333         if let Err(err) = source.send_payment(&Route {
334                 paths: vec![vec![RouteHop {
335                         pubkey: middle.get_our_node_id(),
336                         node_features: channelmanager::provided_node_features(),
337                         short_channel_id: middle_chan_id,
338                         channel_features: channelmanager::provided_channel_features(),
339                         fee_msat: 50000,
340                         cltv_expiry_delta: 100,
341                 },RouteHop {
342                         pubkey: dest.get_our_node_id(),
343                         node_features: channelmanager::provided_node_features(),
344                         short_channel_id: dest_chan_id,
345                         channel_features: channelmanager::provided_channel_features(),
346                         fee_msat: amt,
347                         cltv_expiry_delta: 200,
348                 }]],
349                 payment_params: None,
350         }, payment_hash, &Some(payment_secret)) {
351                 check_payment_err(err);
352                 false
353         } else { true }
354 }
355
356 #[inline]
357 pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
358         let out = SearchingOutput::new(underlying_out);
359         let broadcast = Arc::new(TestBroadcaster{});
360
361         macro_rules! make_node {
362                 ($node_id: expr, $fee_estimator: expr) => { {
363                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
364                         let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
365                         let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
366                                 Arc::new(TestPersister {
367                                         update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
368                                 }), Arc::clone(&keys_manager)));
369
370                         let mut config = UserConfig::default();
371                         config.channel_config.forwarding_fee_proportional_millionths = 0;
372                         config.channel_handshake_config.announced_channel = true;
373                         let network = Network::Bitcoin;
374                         let params = ChainParameters {
375                                 network,
376                                 best_block: BestBlock::from_genesis(network),
377                         };
378                         (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
379                         monitor, keys_manager)
380                 } }
381         }
382
383         macro_rules! reload_node {
384                 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
385                     let keys_manager = Arc::clone(& $keys_manager);
386                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
387                         let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
388                                 Arc::new(TestPersister {
389                                         update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
390                                 }), Arc::clone(& $keys_manager)));
391
392                         let mut config = UserConfig::default();
393                         config.channel_config.forwarding_fee_proportional_millionths = 0;
394                         config.channel_handshake_config.announced_channel = true;
395
396                         let mut monitors = HashMap::new();
397                         let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
398                         for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
399                                 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut Cursor::new(&monitor_ser), &*$keys_manager).expect("Failed to read monitor").1);
400                                 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
401                         }
402                         let mut monitor_refs = HashMap::new();
403                         for (outpoint, monitor) in monitors.iter_mut() {
404                                 monitor_refs.insert(*outpoint, monitor);
405                         }
406
407                         let read_args = ChannelManagerReadArgs {
408                                 keys_manager,
409                                 fee_estimator: $fee_estimator.clone(),
410                                 chain_monitor: chain_monitor.clone(),
411                                 tx_broadcaster: broadcast.clone(),
412                                 logger,
413                                 default_config: config,
414                                 channel_monitors: monitor_refs,
415                         };
416
417                         let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
418                         for (funding_txo, mon) in monitors.drain() {
419                                 assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
420                                         ChannelMonitorUpdateStatus::Completed);
421                         }
422                         res
423                 } }
424         }
425
426         let mut channel_txn = Vec::new();
427         macro_rules! make_channel {
428                 ($source: expr, $dest: expr, $chan_id: expr) => { {
429                         $source.peer_connected(&$dest.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
430                         $dest.peer_connected(&$source.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
431
432                         $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
433                         let open_channel = {
434                                 let events = $source.get_and_clear_pending_msg_events();
435                                 assert_eq!(events.len(), 1);
436                                 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
437                                         msg.clone()
438                                 } else { panic!("Wrong event type"); }
439                         };
440
441                         $dest.handle_open_channel(&$source.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
442                         let accept_channel = {
443                                 let events = $dest.get_and_clear_pending_msg_events();
444                                 assert_eq!(events.len(), 1);
445                                 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
446                                         msg.clone()
447                                 } else { panic!("Wrong event type"); }
448                         };
449
450                         $source.handle_accept_channel(&$dest.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
451                         let funding_output;
452                         {
453                                 let events = $source.get_and_clear_pending_events();
454                                 assert_eq!(events.len(), 1);
455                                 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
456                                         let tx = Transaction { version: $chan_id, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
457                                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
458                                         }]};
459                                         funding_output = OutPoint { txid: tx.txid(), index: 0 };
460                                         $source.funding_transaction_generated(&temporary_channel_id, &$dest.get_our_node_id(), tx.clone()).unwrap();
461                                         channel_txn.push(tx);
462                                 } else { panic!("Wrong event type"); }
463                         }
464
465                         let funding_created = {
466                                 let events = $source.get_and_clear_pending_msg_events();
467                                 assert_eq!(events.len(), 1);
468                                 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
469                                         msg.clone()
470                                 } else { panic!("Wrong event type"); }
471                         };
472                         $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
473
474                         let funding_signed = {
475                                 let events = $dest.get_and_clear_pending_msg_events();
476                                 assert_eq!(events.len(), 1);
477                                 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
478                                         msg.clone()
479                                 } else { panic!("Wrong event type"); }
480                         };
481                         $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
482
483                         funding_output
484                 } }
485         }
486
487         macro_rules! confirm_txn {
488                 ($node: expr) => { {
489                         let chain_hash = genesis_block(Network::Bitcoin).block_hash();
490                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: chain_hash, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
491                         let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
492                         $node.transactions_confirmed(&header, &txdata, 1);
493                         for _ in 2..100 {
494                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
495                         }
496                         $node.best_block_updated(&header, 99);
497                 } }
498         }
499
500         macro_rules! lock_fundings {
501                 ($nodes: expr) => { {
502                         let mut node_events = Vec::new();
503                         for node in $nodes.iter() {
504                                 node_events.push(node.get_and_clear_pending_msg_events());
505                         }
506                         for (idx, node_event) in node_events.iter().enumerate() {
507                                 for event in node_event {
508                                         if let events::MessageSendEvent::SendChannelReady { ref node_id, ref msg } = event {
509                                                 for node in $nodes.iter() {
510                                                         if node.get_our_node_id() == *node_id {
511                                                                 node.handle_channel_ready(&$nodes[idx].get_our_node_id(), msg);
512                                                         }
513                                                 }
514                                         } else { panic!("Wrong event type"); }
515                                 }
516                         }
517
518                         for node in $nodes.iter() {
519                                 let events = node.get_and_clear_pending_msg_events();
520                                 for event in events {
521                                         if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
522                                         } else { panic!("Wrong event type"); }
523                                 }
524                         }
525                 } }
526         }
527
528         let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
529         let mut last_htlc_clear_fee_a =  253;
530         let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
531         let mut last_htlc_clear_fee_b =  253;
532         let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
533         let mut last_htlc_clear_fee_c =  253;
534
535         // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
536         // forwarding.
537         let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
538         let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
539         let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);
540
541         let mut nodes = [node_a, node_b, node_c];
542
543         let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
544         let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
545
546         for node in nodes.iter() {
547                 confirm_txn!(node);
548         }
549
550         lock_fundings!(nodes);
551
552         let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
553         let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
554
555         let mut payment_id: u8 = 0;
556
557         let mut chan_a_disconnected = false;
558         let mut chan_b_disconnected = false;
559         let mut ab_events = Vec::new();
560         let mut ba_events = Vec::new();
561         let mut bc_events = Vec::new();
562         let mut cb_events = Vec::new();
563
564         let mut node_a_ser = VecWriter(Vec::new());
565         nodes[0].write(&mut node_a_ser).unwrap();
566         let mut node_b_ser = VecWriter(Vec::new());
567         nodes[1].write(&mut node_b_ser).unwrap();
568         let mut node_c_ser = VecWriter(Vec::new());
569         nodes[2].write(&mut node_c_ser).unwrap();
570
571         macro_rules! test_return {
572                 () => { {
573                         assert_eq!(nodes[0].list_channels().len(), 1);
574                         assert_eq!(nodes[1].list_channels().len(), 2);
575                         assert_eq!(nodes[2].list_channels().len(), 1);
576                         return;
577                 } }
578         }
579
580         let mut read_pos = 0;
581         macro_rules! get_slice {
582                 ($len: expr) => {
583                         {
584                                 let slice_len = $len as usize;
585                                 if data.len() < read_pos + slice_len {
586                                         test_return!();
587                                 }
588                                 read_pos += slice_len;
589                                 &data[read_pos - slice_len..read_pos]
590                         }
591                 }
592         }
593
594         loop {
595                 // Push any events from Node B onto ba_events and bc_events
596                 macro_rules! push_excess_b_events {
597                         ($excess_events: expr, $expect_drop_node: expr) => { {
598                                 let a_id = nodes[0].get_our_node_id();
599                                 let expect_drop_node: Option<usize> = $expect_drop_node;
600                                 let expect_drop_id = if let Some(id) = expect_drop_node { Some(nodes[id].get_our_node_id()) } else { None };
601                                 for event in $excess_events {
602                                         let push_a = match event {
603                                                 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
604                                                         if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
605                                                         *node_id == a_id
606                                                 },
607                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
608                                                         if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
609                                                         *node_id == a_id
610                                                 },
611                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
612                                                         if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
613                                                         *node_id == a_id
614                                                 },
615                                                 events::MessageSendEvent::SendChannelReady { .. } => continue,
616                                                 events::MessageSendEvent::SendAnnouncementSignatures { .. } => continue,
617                                                 events::MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
618                                                         assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
619                                                         if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
620                                                         *node_id == a_id
621                                                 },
622                                                 _ => panic!("Unhandled message event {:?}", event),
623                                         };
624                                         if push_a { ba_events.push(event); } else { bc_events.push(event); }
625                                 }
626                         } }
627                 }
628
629                 // While delivering messages, we select across three possible message selection processes
630                 // to ensure we get as much coverage as possible. See the individual enum variants for more
631                 // details.
632                 #[derive(PartialEq)]
633                 enum ProcessMessages {
634                         /// Deliver all available messages, including fetching any new messages from
635                         /// `get_and_clear_pending_msg_events()` (which may have side effects).
636                         AllMessages,
637                         /// Call `get_and_clear_pending_msg_events()` first, and then deliver up to one
638                         /// message (which may already be queued).
639                         OneMessage,
640                         /// Deliver up to one already-queued message. This avoids any potential side-effects
641                         /// of `get_and_clear_pending_msg_events()` (eg freeing the HTLC holding cell), which
642                         /// provides potentially more coverage.
643                         OnePendingMessage,
644                 }
645
646                 macro_rules! process_msg_events {
647                         ($node: expr, $corrupt_forward: expr, $limit_events: expr) => { {
648                                 let mut events = if $node == 1 {
649                                         let mut new_events = Vec::new();
650                                         mem::swap(&mut new_events, &mut ba_events);
651                                         new_events.extend_from_slice(&bc_events[..]);
652                                         bc_events.clear();
653                                         new_events
654                                 } else if $node == 0 {
655                                         let mut new_events = Vec::new();
656                                         mem::swap(&mut new_events, &mut ab_events);
657                                         new_events
658                                 } else {
659                                         let mut new_events = Vec::new();
660                                         mem::swap(&mut new_events, &mut cb_events);
661                                         new_events
662                                 };
663                                 let mut new_events = Vec::new();
664                                 if $limit_events != ProcessMessages::OnePendingMessage {
665                                         new_events = nodes[$node].get_and_clear_pending_msg_events();
666                                 }
667                                 let mut had_events = false;
668                                 let mut events_iter = events.drain(..).chain(new_events.drain(..));
669                                 let mut extra_ev = None;
670                                 for event in &mut events_iter {
671                                         had_events = true;
672                                         match event {
673                                                 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
674                                                         for (idx, dest) in nodes.iter().enumerate() {
675                                                                 if dest.get_our_node_id() == node_id {
676                                                                         for update_add in update_add_htlcs.iter() {
677                                                                                 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
678                                                                                 if !$corrupt_forward {
679                                                                                         dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
680                                                                                 } else {
681                                                                                         // Corrupt the update_add_htlc message so that its HMAC
682                                                                                         // check will fail and we generate a
683                                                                                         // update_fail_malformed_htlc instead of an
684                                                                                         // update_fail_htlc as we do when we reject a payment.
685                                                                                         let mut msg_ser = update_add.encode();
686                                                                                         msg_ser[1000] ^= 0xff;
687                                                                                         let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
688                                                                                         dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
689                                                                                 }
690                                                                         }
691                                                                         for update_fulfill in update_fulfill_htlcs.iter() {
692                                                                                 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
693                                                                                 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
694                                                                         }
695                                                                         for update_fail in update_fail_htlcs.iter() {
696                                                                                 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
697                                                                                 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
698                                                                         }
699                                                                         for update_fail_malformed in update_fail_malformed_htlcs.iter() {
700                                                                                 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
701                                                                                 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
702                                                                         }
703                                                                         if let Some(msg) = update_fee {
704                                                                                 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
705                                                                                 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
706                                                                         }
707                                                                         let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
708                                                                                 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
709                                                                         if $limit_events != ProcessMessages::AllMessages && processed_change {
710                                                                                 // If we only want to process some messages, don't deliver the CS until later.
711                                                                                 extra_ev = Some(events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate {
712                                                                                         update_add_htlcs: Vec::new(),
713                                                                                         update_fail_htlcs: Vec::new(),
714                                                                                         update_fulfill_htlcs: Vec::new(),
715                                                                                         update_fail_malformed_htlcs: Vec::new(),
716                                                                                         update_fee: None,
717                                                                                         commitment_signed
718                                                                                 } });
719                                                                                 break;
720                                                                         }
721                                                                         out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
722                                                                         dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
723                                                                         break;
724                                                                 }
725                                                         }
726                                                 },
727                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
728                                                         for (idx, dest) in nodes.iter().enumerate() {
729                                                                 if dest.get_our_node_id() == *node_id {
730                                                                         out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
731                                                                         dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
732                                                                 }
733                                                         }
734                                                 },
735                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
736                                                         for (idx, dest) in nodes.iter().enumerate() {
737                                                                 if dest.get_our_node_id() == *node_id {
738                                                                         out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
739                                                                         dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
740                                                                 }
741                                                         }
742                                                 },
743                                                 events::MessageSendEvent::SendChannelReady { .. } => {
744                                                         // Can be generated as a reestablish response
745                                                 },
746                                                 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {
747                                                         // Can be generated as a reestablish response
748                                                 },
749                                                 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
750                                                         // When we reconnect we will resend a channel_update to make sure our
751                                                         // counterparty has the latest parameters for receiving payments
752                                                         // through us. We do, however, check that the message does not include
753                                                         // the "disabled" bit, as we should never ever have a channel which is
754                                                         // disabled when we send such an update (or it may indicate channel
755                                                         // force-close which we should detect as an error).
756                                                         assert_eq!(msg.contents.flags & 2, 0);
757                                                 },
758                                                 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
759                                                         return;
760                                                 } else {
761                                                         panic!("Unhandled message event {:?}", event)
762                                                 },
763                                         }
764                                         if $limit_events != ProcessMessages::AllMessages {
765                                                 break;
766                                         }
767                                 }
768                                 if $node == 1 {
769                                         push_excess_b_events!(extra_ev.into_iter().chain(events_iter), None);
770                                 } else if $node == 0 {
771                                         if let Some(ev) = extra_ev { ab_events.push(ev); }
772                                         for event in events_iter { ab_events.push(event); }
773                                 } else {
774                                         if let Some(ev) = extra_ev { cb_events.push(ev); }
775                                         for event in events_iter { cb_events.push(event); }
776                                 }
777                                 had_events
778                         } }
779                 }
780
781                 macro_rules! drain_msg_events_on_disconnect {
782                         ($counterparty_id: expr) => { {
783                                 if $counterparty_id == 0 {
784                                         for event in nodes[0].get_and_clear_pending_msg_events() {
785                                                 match event {
786                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
787                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
788                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
789                                                         events::MessageSendEvent::SendChannelReady { .. } => {},
790                                                         events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
791                                                         events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
792                                                                 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
793                                                         },
794                                                         _ => if out.may_fail.load(atomic::Ordering::Acquire) {
795                                                                 return;
796                                                         } else {
797                                                                 panic!("Unhandled message event")
798                                                         },
799                                                 }
800                                         }
801                                         push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(0));
802                                         ab_events.clear();
803                                         ba_events.clear();
804                                 } else {
805                                         for event in nodes[2].get_and_clear_pending_msg_events() {
806                                                 match event {
807                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
808                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
809                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
810                                                         events::MessageSendEvent::SendChannelReady { .. } => {},
811                                                         events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
812                                                         events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
813                                                                 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
814                                                         },
815                                                         _ => if out.may_fail.load(atomic::Ordering::Acquire) {
816                                                                 return;
817                                                         } else {
818                                                                 panic!("Unhandled message event")
819                                                         },
820                                                 }
821                                         }
822                                         push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(2));
823                                         bc_events.clear();
824                                         cb_events.clear();
825                                 }
826                         } }
827                 }
828
829                 macro_rules! process_events {
830                         ($node: expr, $fail: expr) => { {
831                                 // In case we get 256 payments we may have a hash collision, resulting in the
832                                 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
833                                 // deduplicate the calls here.
834                                 let mut claim_set = HashSet::new();
835                                 let mut events = nodes[$node].get_and_clear_pending_events();
836                                 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
837                                 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
838                                 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
839                                 // PaymentReceived event for the second HTLC in our pending_events (and breaking
840                                 // our claim_set deduplication).
841                                 events.sort_by(|a, b| {
842                                         if let events::Event::PaymentReceived { .. } = a {
843                                                 if let events::Event::PendingHTLCsForwardable { .. } = b {
844                                                         Ordering::Less
845                                                 } else { Ordering::Equal }
846                                         } else if let events::Event::PendingHTLCsForwardable { .. } = a {
847                                                 if let events::Event::PaymentReceived { .. } = b {
848                                                         Ordering::Greater
849                                                 } else { Ordering::Equal }
850                                         } else { Ordering::Equal }
851                                 });
852                                 let had_events = !events.is_empty();
853                                 for event in events.drain(..) {
854                                         match event {
855                                                 events::Event::PaymentReceived { payment_hash, .. } => {
856                                                         if claim_set.insert(payment_hash.0) {
857                                                                 if $fail {
858                                                                         nodes[$node].fail_htlc_backwards(&payment_hash);
859                                                                 } else {
860                                                                         nodes[$node].claim_funds(PaymentPreimage(payment_hash.0));
861                                                                 }
862                                                         }
863                                                 },
864                                                 events::Event::PaymentSent { .. } => {},
865                                                 events::Event::PaymentClaimed { .. } => {},
866                                                 events::Event::PaymentPathSuccessful { .. } => {},
867                                                 events::Event::PaymentPathFailed { .. } => {},
868                                                 events::Event::ProbeSuccessful { .. } | events::Event::ProbeFailed { .. } => {
869                                                         // Even though we don't explicitly send probes, because probes are
870                                                         // detected based on hashing the payment hash+preimage, its rather
871                                                         // trivial for the fuzzer to build payments that accidentally end up
872                                                         // looking like probes.
873                                                 },
874                                                 events::Event::PaymentForwarded { .. } if $node == 1 => {},
875                                                 events::Event::PendingHTLCsForwardable { .. } => {
876                                                         nodes[$node].process_pending_htlc_forwards();
877                                                 },
878                                                 events::Event::HTLCHandlingFailed { .. } => {},
879                                                 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
880                                                         return;
881                                                 } else {
882                                                         panic!("Unhandled event")
883                                                 },
884                                         }
885                                 }
886                                 had_events
887                         } }
888                 }
889
890                 let v = get_slice!(1)[0];
891                 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
892                 match v {
893                         // In general, we keep related message groups close together in binary form, allowing
894                         // bit-twiddling mutations to have similar effects. This is probably overkill, but no
895                         // harm in doing so.
896
897                         0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
898                         0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
899                         0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
900                         0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
901                         0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
902                         0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
903
904                         0x08 => {
905                                 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
906                                         monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
907                                         nodes[0].process_monitor_events();
908                                 }
909                         },
910                         0x09 => {
911                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
912                                         monitor_b.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
913                                         nodes[1].process_monitor_events();
914                                 }
915                         },
916                         0x0a => {
917                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
918                                         monitor_b.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
919                                         nodes[1].process_monitor_events();
920                                 }
921                         },
922                         0x0b => {
923                                 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
924                                         monitor_c.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
925                                         nodes[2].process_monitor_events();
926                                 }
927                         },
928
929                         0x0c => {
930                                 if !chan_a_disconnected {
931                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
932                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
933                                         chan_a_disconnected = true;
934                                         drain_msg_events_on_disconnect!(0);
935                                 }
936                         },
937                         0x0d => {
938                                 if !chan_b_disconnected {
939                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
940                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
941                                         chan_b_disconnected = true;
942                                         drain_msg_events_on_disconnect!(2);
943                                 }
944                         },
945                         0x0e => {
946                                 if chan_a_disconnected {
947                                         nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
948                                         nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
949                                         chan_a_disconnected = false;
950                                 }
951                         },
952                         0x0f => {
953                                 if chan_b_disconnected {
954                                         nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
955                                         nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
956                                         chan_b_disconnected = false;
957                                 }
958                         },
959
960                         0x10 => { process_msg_events!(0, true, ProcessMessages::AllMessages); },
961                         0x11 => { process_msg_events!(0, false, ProcessMessages::AllMessages); },
962                         0x12 => { process_msg_events!(0, true, ProcessMessages::OneMessage); },
963                         0x13 => { process_msg_events!(0, false, ProcessMessages::OneMessage); },
964                         0x14 => { process_msg_events!(0, true, ProcessMessages::OnePendingMessage); },
965                         0x15 => { process_msg_events!(0, false, ProcessMessages::OnePendingMessage); },
966
967                         0x16 => { process_events!(0, true); },
968                         0x17 => { process_events!(0, false); },
969
970                         0x18 => { process_msg_events!(1, true, ProcessMessages::AllMessages); },
971                         0x19 => { process_msg_events!(1, false, ProcessMessages::AllMessages); },
972                         0x1a => { process_msg_events!(1, true, ProcessMessages::OneMessage); },
973                         0x1b => { process_msg_events!(1, false, ProcessMessages::OneMessage); },
974                         0x1c => { process_msg_events!(1, true, ProcessMessages::OnePendingMessage); },
975                         0x1d => { process_msg_events!(1, false, ProcessMessages::OnePendingMessage); },
976
977                         0x1e => { process_events!(1, true); },
978                         0x1f => { process_events!(1, false); },
979
980                         0x20 => { process_msg_events!(2, true, ProcessMessages::AllMessages); },
981                         0x21 => { process_msg_events!(2, false, ProcessMessages::AllMessages); },
982                         0x22 => { process_msg_events!(2, true, ProcessMessages::OneMessage); },
983                         0x23 => { process_msg_events!(2, false, ProcessMessages::OneMessage); },
984                         0x24 => { process_msg_events!(2, true, ProcessMessages::OnePendingMessage); },
985                         0x25 => { process_msg_events!(2, false, ProcessMessages::OnePendingMessage); },
986
987                         0x26 => { process_events!(2, true); },
988                         0x27 => { process_events!(2, false); },
989
990                         0x2c => {
991                                 if !chan_a_disconnected {
992                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
993                                         chan_a_disconnected = true;
994                                         drain_msg_events_on_disconnect!(0);
995                                 }
996                                 if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
997                                         node_a_ser.0.clear();
998                                         nodes[0].write(&mut node_a_ser).unwrap();
999                                 }
1000                                 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
1001                                 nodes[0] = new_node_a;
1002                                 monitor_a = new_monitor_a;
1003                         },
1004                         0x2d => {
1005                                 if !chan_a_disconnected {
1006                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
1007                                         chan_a_disconnected = true;
1008                                         nodes[0].get_and_clear_pending_msg_events();
1009                                         ab_events.clear();
1010                                         ba_events.clear();
1011                                 }
1012                                 if !chan_b_disconnected {
1013                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
1014                                         chan_b_disconnected = true;
1015                                         nodes[2].get_and_clear_pending_msg_events();
1016                                         bc_events.clear();
1017                                         cb_events.clear();
1018                                 }
1019                                 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
1020                                 nodes[1] = new_node_b;
1021                                 monitor_b = new_monitor_b;
1022                         },
1023                         0x2e => {
1024                                 if !chan_b_disconnected {
1025                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
1026                                         chan_b_disconnected = true;
1027                                         drain_msg_events_on_disconnect!(2);
1028                                 }
1029                                 if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
1030                                         node_c_ser.0.clear();
1031                                         nodes[2].write(&mut node_c_ser).unwrap();
1032                                 }
1033                                 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
1034                                 nodes[2] = new_node_c;
1035                                 monitor_c = new_monitor_c;
1036                         },
1037
1038                         // 1/10th the channel size:
1039                         0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id); },
1040                         0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id); },
1041                         0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id); },
1042                         0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id); },
1043                         0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id); },
1044                         0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id); },
1045
1046                         0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id); },
1047                         0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id); },
1048                         0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id); },
1049                         0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id); },
1050                         0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id); },
1051                         0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id); },
1052
1053                         0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id); },
1054                         0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id); },
1055                         0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id); },
1056                         0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id); },
1057                         0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id); },
1058                         0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id); },
1059
1060                         0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id); },
1061                         0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id); },
1062                         0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id); },
1063                         0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id); },
1064                         0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id); },
1065                         0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id); },
1066
1067                         0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id); },
1068                         0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id); },
1069                         0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id); },
1070                         0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id); },
1071                         0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id); },
1072                         0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id); },
1073
1074                         0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id); },
1075                         0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id); },
1076                         0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id); },
1077                         0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id); },
1078                         0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id); },
1079                         0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id); },
1080
1081                         0x60 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id); },
1082                         0x61 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id); },
1083                         0x62 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id); },
1084                         0x63 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id); },
1085                         0x64 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id); },
1086                         0x65 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id); },
1087
1088                         0x68 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id); },
1089                         0x69 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id); },
1090                         0x6a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id); },
1091                         0x6b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id); },
1092                         0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
1093                         0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },
1094
1095                         0x80 => {
1096                                 let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1097                                 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1098                                         fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
1099                                 }
1100                                 nodes[0].maybe_update_chan_fees();
1101                         },
1102                         0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },
1103
1104                         0x84 => {
1105                                 let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1106                                 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1107                                         fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
1108                                 }
1109                                 nodes[1].maybe_update_chan_fees();
1110                         },
1111                         0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },
1112
1113                         0x88 => {
1114                                 let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1115                                 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1116                                         fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
1117                                 }
1118                                 nodes[2].maybe_update_chan_fees();
1119                         },
1120                         0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },
1121
1122                         0xff => {
1123                                 // Test that no channel is in a stuck state where neither party can send funds even
1124                                 // after we resolve all pending events.
1125                                 // First make sure there are no pending monitor updates, resetting the error state
1126                                 // and calling force_channel_monitor_updated for each monitor.
1127                                 *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1128                                 *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1129                                 *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1130
1131                                 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1132                                         monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1133                                         nodes[0].process_monitor_events();
1134                                 }
1135                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1136                                         monitor_b.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1137                                         nodes[1].process_monitor_events();
1138                                 }
1139                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1140                                         monitor_b.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1141                                         nodes[1].process_monitor_events();
1142                                 }
1143                                 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1144                                         monitor_c.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1145                                         nodes[2].process_monitor_events();
1146                                 }
1147
1148                                 // Next, make sure peers are all connected to each other
1149                                 if chan_a_disconnected {
1150                                         nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1151                                         nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1152                                         chan_a_disconnected = false;
1153                                 }
1154                                 if chan_b_disconnected {
1155                                         nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1156                                         nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1157                                         chan_b_disconnected = false;
1158                                 }
1159
1160                                 for i in 0..std::usize::MAX {
1161                                         if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
1162                                         // Then, make sure any current forwards make their way to their destination
1163                                         if process_msg_events!(0, false, ProcessMessages::AllMessages) { continue; }
1164                                         if process_msg_events!(1, false, ProcessMessages::AllMessages) { continue; }
1165                                         if process_msg_events!(2, false, ProcessMessages::AllMessages) { continue; }
1166                                         // ...making sure any pending PendingHTLCsForwardable events are handled and
1167                                         // payments claimed.
1168                                         if process_events!(0, false) { continue; }
1169                                         if process_events!(1, false) { continue; }
1170                                         if process_events!(2, false) { continue; }
1171                                         break;
1172                                 }
1173
1174                                 // Finally, make sure that at least one end of each channel can make a substantial payment
1175                                 assert!(
1176                                         send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id) ||
1177                                         send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id));
1178                                 assert!(
1179                                         send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
1180                                         send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));
1181
1182                                 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
1183                                 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
1184                                 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
1185                         },
1186                         _ => test_return!(),
1187                 }
1188
1189                 node_a_ser.0.clear();
1190                 nodes[0].write(&mut node_a_ser).unwrap();
1191                 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
1192                 node_b_ser.0.clear();
1193                 nodes[1].write(&mut node_b_ser).unwrap();
1194                 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
1195                 node_c_ser.0.clear();
1196                 nodes[2].write(&mut node_c_ser).unwrap();
1197                 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
1198         }
1199 }
1200
1201 /// We actually have different behavior based on if a certain log string has been seen, so we have
1202 /// to do a bit more tracking.
1203 #[derive(Clone)]
1204 struct SearchingOutput<O: Output> {
1205         output: O,
1206         may_fail: Arc<atomic::AtomicBool>,
1207 }
1208 impl<O: Output> Output for SearchingOutput<O> {
1209         fn locked_write(&self, data: &[u8]) {
1210                 // We hit a design limitation of LN state machine (see CONCURRENT_INBOUND_HTLC_FEE_BUFFER)
1211                 if std::str::from_utf8(data).unwrap().contains("Outbound update_fee HTLC buffer overflow - counterparty should force-close this channel") {
1212                         self.may_fail.store(true, atomic::Ordering::Release);
1213                 }
1214                 self.output.locked_write(data)
1215         }
1216 }
1217 impl<O: Output> SearchingOutput<O> {
1218         pub fn new(output: O) -> Self {
1219                 Self { output, may_fail: Arc::new(atomic::AtomicBool::new(false)) }
1220         }
1221 }
1222
1223 pub fn chanmon_consistency_test<Out: Output>(data: &[u8], out: Out) {
1224         do_test(data, out);
1225 }
1226
1227 #[no_mangle]
1228 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
1229         do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});
1230 }