git.bitcoin.ninja Git - rust-lightning/blob - fuzz/src/chanmon_consistency.rs

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