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