_ 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, chainmonitor, channelmonitor, Confirm, Watch};
  34 use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, MonitorEvent};
  35 use lightning::chain::transaction::OutPoint;
  36 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
  37 use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
  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
  54 use utils::test_logger;
  55 use utils::test_persister::TestPersister;
  56
  57 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  58 use bitcoin::secp256k1::recovery::RecoverableSignature;
  59 use bitcoin::secp256k1::Secp256k1;
  60
  61 use std::mem;
  62 use std::cmp::{self, Ordering};
  63 use std::collections::{HashSet, hash_map, HashMap};
  64 use std::sync::{Arc,Mutex};
  65 use std::sync::atomic;
  66 use std::io::Cursor;
  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         fn size_hint(&mut self, size: usize) {
  98                 self.0.reserve_exact(size);
  99         }
 100 }
 101
 102 struct TestChainMonitor {
 103         pub logger: Arc<dyn Logger>,
 104         pub keys: Arc<KeyProvider>,
 105         pub chain_monitor: Arc<chainmonitor::ChainMonitor<EnforcingSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
 106         pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
 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, persister)),
 119                         logger,
 120                         keys,
 121                         update_ret: Mutex::new(Ok(())),
 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<(), channelmonitor::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                 assert!(self.chain_monitor.watch_channel(funding_txo, monitor).is_ok());
 136                 self.update_ret.lock().unwrap().clone()
 137         }
 138
 139         fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
 140                 let mut map_lock = self.latest_monitors.lock().unwrap();
 141                 let mut map_entry = match map_lock.entry(funding_txo) {
 142                         hash_map::Entry::Occupied(entry) => entry,
 143                         hash_map::Entry::Vacant(_) => panic!("Didn't have monitor on update call"),
 144                 };
 145                 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
 146                         read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
 147                 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
 148                 let mut ser = VecWriter(Vec::new());
 149                 deserialized_monitor.write(&mut ser).unwrap();
 150                 map_entry.insert((update.update_id, ser.0));
 151                 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
 152                 assert!(self.chain_monitor.update_channel(funding_txo, update).is_ok());
 153                 self.update_ret.lock().unwrap().clone()
 154         }
 155
 156         fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
 157                 return self.chain_monitor.release_pending_monitor_events();
 158         }
 159 }
 160
 161 struct KeyProvider {
 162         node_id: u8,
 163         rand_bytes_id: atomic::AtomicU32,
 164         enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
 165 }
 166 impl KeysInterface for KeyProvider {
 167         type Signer = EnforcingSigner;
 168
 169         fn get_node_secret(&self) -> SecretKey {
 170                 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()
 171         }
 172
 173         fn get_destination_script(&self) -> Script {
 174                 let secp_ctx = Secp256k1::signing_only();
 175                 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();
 176                 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
 177                 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
 178         }
 179
 180         fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
 181                 let secp_ctx = Secp256k1::signing_only();
 182                 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();
 183                 let pubkey_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &secret_key).serialize());
 184                 ShutdownScript::new_p2wpkh(&pubkey_hash)
 185         }
 186
 187         fn get_channel_signer(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner {
 188                 let secp_ctx = Secp256k1::signing_only();
 189                 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
 190                 let keys = InMemorySigner::new(
 191                         &secp_ctx,
 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 = Readable::read(&mut reader)?;
 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, _invoice_preimage: Vec<u8>) -> 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(per_path_results) => {
 280                         for res in per_path_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, 0) {
 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_hash, &Some(payment_secret)) {
 314                 check_payment_err(err);
 315                 false
 316         } else { true }
 317 }
 318 #[inline]
 319 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 {
 320         let (payment_secret, payment_hash) =
 321                 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
 322         if let Err(err) = source.send_payment(&Route {
 323                 paths: vec![vec![RouteHop {
 324                         pubkey: middle.get_our_node_id(),
 325                         node_features: NodeFeatures::known(),
 326                         short_channel_id: middle_chan_id,
 327                         channel_features: ChannelFeatures::known(),
 328                         fee_msat: 50000,
 329                         cltv_expiry_delta: 100,
 330                 },RouteHop {
 331                         pubkey: dest.get_our_node_id(),
 332                         node_features: NodeFeatures::known(),
 333                         short_channel_id: dest_chan_id,
 334                         channel_features: ChannelFeatures::known(),
 335                         fee_msat: amt,
 336                         cltv_expiry_delta: 200,
 337                 }]],
 338         }, payment_hash, &Some(payment_secret)) {
 339                 check_payment_err(err);
 340                 false
 341         } else { true }
 342 }
 343
 344 #[inline]
 345 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 346         let broadcast = Arc::new(TestBroadcaster{});
 347
 348         macro_rules! make_node {
 349                 ($node_id: expr, $fee_estimator: expr) => { {
 350                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 351                         let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
 352                         let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));
 353
 354                         let mut config = UserConfig::default();
 355                         config.channel_options.forwarding_fee_proportional_millionths = 0;
 356                         config.channel_options.announced_channel = true;
 357                         let network = Network::Bitcoin;
 358                         let params = ChainParameters {
 359                                 network,
 360                                 best_block: BestBlock::from_genesis(network),
 361                         };
 362                         (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 363                         monitor, keys_manager)
 364                 } }
 365         }
 366
 367         macro_rules! reload_node {
 368                 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
 369                     let keys_manager = Arc::clone(& $keys_manager);
 370                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 371                         let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));
 372
 373                         let mut config = UserConfig::default();
 374                         config.channel_options.forwarding_fee_proportional_millionths = 0;
 375                         config.channel_options.announced_channel = true;
 376
 377                         let mut monitors = HashMap::new();
 378                         let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
 379                         for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
 380                                 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut Cursor::new(&monitor_ser), &*$keys_manager).expect("Failed to read monitor").1);
 381                                 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
 382                         }
 383                         let mut monitor_refs = HashMap::new();
 384                         for (outpoint, monitor) in monitors.iter_mut() {
 385                                 monitor_refs.insert(*outpoint, monitor);
 386                         }
 387
 388                         let read_args = ChannelManagerReadArgs {
 389                                 keys_manager,
 390                                 fee_estimator: $fee_estimator.clone(),
 391                                 chain_monitor: chain_monitor.clone(),
 392                                 tx_broadcaster: broadcast.clone(),
 393                                 logger,
 394                                 default_config: config,
 395                                 channel_monitors: monitor_refs,
 396                         };
 397
 398                         let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
 399                         for (funding_txo, mon) in monitors.drain() {
 400                                 assert!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon).is_ok());
 401                         }
 402                         res
 403                 } }
 404         }
 405
 406         let mut channel_txn = Vec::new();
 407         macro_rules! make_channel {
 408                 ($source: expr, $dest: expr, $chan_id: expr) => { {
 409                         $source.peer_connected(&$dest.get_our_node_id(), &Init { features: InitFeatures::known() });
 410                         $dest.peer_connected(&$source.get_our_node_id(), &Init { features: InitFeatures::known() });
 411
 412                         $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
 413                         let open_channel = {
 414                                 let events = $source.get_and_clear_pending_msg_events();
 415                                 assert_eq!(events.len(), 1);
 416                                 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
 417                                         msg.clone()
 418                                 } else { panic!("Wrong event type"); }
 419                         };
 420
 421                         $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::known(), &open_channel);
 422                         let accept_channel = {
 423                                 let events = $dest.get_and_clear_pending_msg_events();
 424                                 assert_eq!(events.len(), 1);
 425                                 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
 426                                         msg.clone()
 427                                 } else { panic!("Wrong event type"); }
 428                         };
 429
 430                         $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::known(), &accept_channel);
 431                         let funding_output;
 432                         {
 433                                 let events = $source.get_and_clear_pending_events();
 434                                 assert_eq!(events.len(), 1);
 435                                 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
 436                                         let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
 437                                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
 438                                         }]};
 439                                         funding_output = OutPoint { txid: tx.txid(), index: 0 };
 440                                         $source.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 441                                         channel_txn.push(tx);
 442                                 } else { panic!("Wrong event type"); }
 443                         }
 444
 445                         let funding_created = {
 446                                 let events = $source.get_and_clear_pending_msg_events();
 447                                 assert_eq!(events.len(), 1);
 448                                 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
 449                                         msg.clone()
 450                                 } else { panic!("Wrong event type"); }
 451                         };
 452                         $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
 453
 454                         let funding_signed = {
 455                                 let events = $dest.get_and_clear_pending_msg_events();
 456                                 assert_eq!(events.len(), 1);
 457                                 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
 458                                         msg.clone()
 459                                 } else { panic!("Wrong event type"); }
 460                         };
 461                         $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
 462
 463                         funding_output
 464                 } }
 465         }
 466
 467         macro_rules! confirm_txn {
 468                 ($node: expr) => { {
 469                         let chain_hash = genesis_block(Network::Bitcoin).block_hash();
 470                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: chain_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 471                         let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
 472                         $node.transactions_confirmed(&header, &txdata, 1);
 473                         for _ in 2..100 {
 474                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 475                         }
 476                         $node.best_block_updated(&header, 99);
 477                 } }
 478         }
 479
 480         macro_rules! lock_fundings {
 481                 ($nodes: expr) => { {
 482                         let mut node_events = Vec::new();
 483                         for node in $nodes.iter() {
 484                                 node_events.push(node.get_and_clear_pending_msg_events());
 485                         }
 486                         for (idx, node_event) in node_events.iter().enumerate() {
 487                                 for event in node_event {
 488                                         if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
 489                                                 for node in $nodes.iter() {
 490                                                         if node.get_our_node_id() == *node_id {
 491                                                                 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
 492                                                         }
 493                                                 }
 494                                         } else { panic!("Wrong event type"); }
 495                                 }
 496                         }
 497
 498                         for node in $nodes.iter() {
 499                                 let events = node.get_and_clear_pending_msg_events();
 500                                 for event in events {
 501                                         if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
 502                                         } else { panic!("Wrong event type"); }
 503                                 }
 504                         }
 505                 } }
 506         }
 507
 508         let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
 509         let mut last_htlc_clear_fee_a =  253;
 510         let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
 511         let mut last_htlc_clear_fee_b =  253;
 512         let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
 513         let mut last_htlc_clear_fee_c =  253;
 514
 515         // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
 516         // forwarding.
 517         let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
 518         let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
 519         let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);
 520
 521         let mut nodes = [node_a, node_b, node_c];
 522
 523         let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
 524         let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
 525
 526         for node in nodes.iter() {
 527                 confirm_txn!(node);
 528         }
 529
 530         lock_fundings!(nodes);
 531
 532         let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
 533         let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
 534
 535         let mut payment_id: u8 = 0;
 536
 537         let mut chan_a_disconnected = false;
 538         let mut chan_b_disconnected = false;
 539         let mut ab_events = Vec::new();
 540         let mut ba_events = Vec::new();
 541         let mut bc_events = Vec::new();
 542         let mut cb_events = Vec::new();
 543
 544         let mut node_a_ser = VecWriter(Vec::new());
 545         nodes[0].write(&mut node_a_ser).unwrap();
 546         let mut node_b_ser = VecWriter(Vec::new());
 547         nodes[1].write(&mut node_b_ser).unwrap();
 548         let mut node_c_ser = VecWriter(Vec::new());
 549         nodes[2].write(&mut node_c_ser).unwrap();
 550
 551         macro_rules! test_return {
 552                 () => { {
 553                         assert_eq!(nodes[0].list_channels().len(), 1);
 554                         assert_eq!(nodes[1].list_channels().len(), 2);
 555                         assert_eq!(nodes[2].list_channels().len(), 1);
 556                         return;
 557                 } }
 558         }
 559
 560         let mut read_pos = 0;
 561         macro_rules! get_slice {
 562                 ($len: expr) => {
 563                         {
 564                                 let slice_len = $len as usize;
 565                                 if data.len() < read_pos + slice_len {
 566                                         test_return!();
 567                                 }
 568                                 read_pos += slice_len;
 569                                 &data[read_pos - slice_len..read_pos]
 570                         }
 571                 }
 572         }
 573
 574         loop {
 575                 // Push any events from Node B onto ba_events and bc_events
 576                 macro_rules! push_excess_b_events {
 577                         ($excess_events: expr, $expect_drop_node: expr) => { {
 578                                 let a_id = nodes[0].get_our_node_id();
 579                                 let expect_drop_node: Option<usize> = $expect_drop_node;
 580                                 let expect_drop_id = if let Some(id) = expect_drop_node { Some(nodes[id].get_our_node_id()) } else { None };
 581                                 for event in $excess_events {
 582                                         let push_a = match event {
 583                                                 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
 584                                                         if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
 585                                                         *node_id == a_id
 586                                                 },
 587                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
 588                                                         if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
 589                                                         *node_id == a_id
 590                                                 },
 591                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
 592                                                         if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
 593                                                         *node_id == a_id
 594                                                 },
 595                                                 events::MessageSendEvent::SendFundingLocked { .. } => continue,
 596                                                 events::MessageSendEvent::SendAnnouncementSignatures { .. } => continue,
 597                                                 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => continue,
 598                                                 events::MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
 599                                                         assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
 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                                                 _ => panic!("Unhandled message event {:?}", event),
 604                                         };
 605                                         if push_a { ba_events.push(event); } else { bc_events.push(event); }
 606                                 }
 607                         } }
 608                 }
 609
 610                 // While delivering messages, we select across three possible message selection processes
 611                 // to ensure we get as much coverage as possible. See the individual enum variants for more
 612                 // details.
 613                 #[derive(PartialEq)]
 614                 enum ProcessMessages {
 615                         /// Deliver all available messages, including fetching any new messages from
 616                         /// `get_and_clear_pending_msg_events()` (which may have side effects).
 617                         AllMessages,
 618                         /// Call `get_and_clear_pending_msg_events()` first, and then deliver up to one
 619                         /// message (which may already be queued).
 620                         OneMessage,
 621                         /// Deliver up to one already-queued message. This avoids any potential side-effects
 622                         /// of `get_and_clear_pending_msg_events()` (eg freeing the HTLC holding cell), which
 623                         /// provides potentially more coverage.
 624                         OnePendingMessage,
 625                 }
 626
 627                 macro_rules! process_msg_events {
 628                         ($node: expr, $corrupt_forward: expr, $limit_events: expr) => { {
 629                                 let mut events = if $node == 1 {
 630                                         let mut new_events = Vec::new();
 631                                         mem::swap(&mut new_events, &mut ba_events);
 632                                         new_events.extend_from_slice(&bc_events[..]);
 633                                         bc_events.clear();
 634                                         new_events
 635                                 } else if $node == 0 {
 636                                         let mut new_events = Vec::new();
 637                                         mem::swap(&mut new_events, &mut ab_events);
 638                                         new_events
 639                                 } else {
 640                                         let mut new_events = Vec::new();
 641                                         mem::swap(&mut new_events, &mut cb_events);
 642                                         new_events
 643                                 };
 644                                 let mut new_events = Vec::new();
 645                                 if $limit_events != ProcessMessages::OnePendingMessage {
 646                                         new_events = nodes[$node].get_and_clear_pending_msg_events();
 647                                 }
 648                                 let mut had_events = false;
 649                                 let mut events_iter = events.drain(..).chain(new_events.drain(..));
 650                                 let mut extra_ev = None;
 651                                 for event in &mut events_iter {
 652                                         had_events = true;
 653                                         match event {
 654                                                 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
 655                                                         for (idx, dest) in nodes.iter().enumerate() {
 656                                                                 if dest.get_our_node_id() == node_id {
 657                                                                         for update_add in update_add_htlcs.iter() {
 658                                                                                 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
 659                                                                                 if !$corrupt_forward {
 660                                                                                         dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
 661                                                                                 } else {
 662                                                                                         // Corrupt the update_add_htlc message so that its HMAC
 663                                                                                         // check will fail and we generate a
 664                                                                                         // update_fail_malformed_htlc instead of an
 665                                                                                         // update_fail_htlc as we do when we reject a payment.
 666                                                                                         let mut msg_ser = update_add.encode();
 667                                                                                         msg_ser[1000] ^= 0xff;
 668                                                                                         let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
 669                                                                                         dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
 670                                                                                 }
 671                                                                         }
 672                                                                         for update_fulfill in update_fulfill_htlcs.iter() {
 673                                                                                 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
 674                                                                                 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
 675                                                                         }
 676                                                                         for update_fail in update_fail_htlcs.iter() {
 677                                                                                 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
 678                                                                                 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
 679                                                                         }
 680                                                                         for update_fail_malformed in update_fail_malformed_htlcs.iter() {
 681                                                                                 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
 682                                                                                 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
 683                                                                         }
 684                                                                         if let Some(msg) = update_fee {
 685                                                                                 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
 686                                                                                 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
 687                                                                         }
 688                                                                         let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
 689                                                                                 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
 690                                                                         if $limit_events != ProcessMessages::AllMessages && processed_change {
 691                                                                                 // If we only want to process some messages, don't deliver the CS until later.
 692                                                                                 extra_ev = Some(events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate {
 693                                                                                         update_add_htlcs: Vec::new(),
 694                                                                                         update_fail_htlcs: Vec::new(),
 695                                                                                         update_fulfill_htlcs: Vec::new(),
 696                                                                                         update_fail_malformed_htlcs: Vec::new(),
 697                                                                                         update_fee: None,
 698                                                                                         commitment_signed
 699                                                                                 } });
 700                                                                                 break;
 701                                                                         }
 702                                                                         out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
 703                                                                         dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
 704                                                                         break;
 705                                                                 }
 706                                                         }
 707                                                 },
 708                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 709                                                         for (idx, dest) in nodes.iter().enumerate() {
 710                                                                 if dest.get_our_node_id() == *node_id {
 711                                                                         out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
 712                                                                         dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
 713                                                                 }
 714                                                         }
 715                                                 },
 716                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
 717                                                         for (idx, dest) in nodes.iter().enumerate() {
 718                                                                 if dest.get_our_node_id() == *node_id {
 719                                                                         out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
 720                                                                         dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
 721                                                                 }
 722                                                         }
 723                                                 },
 724                                                 events::MessageSendEvent::SendFundingLocked { .. } => {
 725                                                         // Can be generated as a reestablish response
 726                                                 },
 727                                                 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {
 728                                                         // Can be generated as a reestablish response
 729                                                 },
 730                                                 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
 731                                                         // Can be generated due to a payment forward being rejected due to a
 732                                                         // channel having previously failed a monitor update
 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                                                 _ => panic!("Unhandled message event {:?}", event),
 744                                         }
 745                                         if $limit_events != ProcessMessages::AllMessages {
 746                                                 break;
 747                                         }
 748                                 }
 749                                 if $node == 1 {
 750                                         push_excess_b_events!(extra_ev.into_iter().chain(events_iter), None);
 751                                 } else if $node == 0 {
 752                                         if let Some(ev) = extra_ev { ab_events.push(ev); }
 753                                         for event in events_iter { ab_events.push(event); }
 754                                 } else {
 755                                         if let Some(ev) = extra_ev { cb_events.push(ev); }
 756                                         for event in events_iter { cb_events.push(event); }
 757                                 }
 758                                 had_events
 759                         } }
 760                 }
 761
 762                 macro_rules! drain_msg_events_on_disconnect {
 763                         ($counterparty_id: expr) => { {
 764                                 if $counterparty_id == 0 {
 765                                         for event in nodes[0].get_and_clear_pending_msg_events() {
 766                                                 match event {
 767                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
 768                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
 769                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
 770                                                         events::MessageSendEvent::SendFundingLocked { .. } => {},
 771                                                         events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
 772                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
 773                                                         events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
 774                                                                 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
 775                                                         },
 776                                                         _ => panic!("Unhandled message event"),
 777                                                 }
 778                                         }
 779                                         push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(0));
 780                                         ab_events.clear();
 781                                         ba_events.clear();
 782                                 } else {
 783                                         for event in nodes[2].get_and_clear_pending_msg_events() {
 784                                                 match event {
 785                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
 786                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
 787                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
 788                                                         events::MessageSendEvent::SendFundingLocked { .. } => {},
 789                                                         events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
 790                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
 791                                                         events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
 792                                                                 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
 793                                                         },
 794                                                         _ => panic!("Unhandled message event"),
 795                                                 }
 796                                         }
 797                                         push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(2));
 798                                         bc_events.clear();
 799                                         cb_events.clear();
 800                                 }
 801                         } }
 802                 }
 803
 804                 macro_rules! process_events {
 805                         ($node: expr, $fail: expr) => { {
 806                                 // In case we get 256 payments we may have a hash collision, resulting in the
 807                                 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
 808                                 // deduplicate the calls here.
 809                                 let mut claim_set = HashSet::new();
 810                                 let mut events = nodes[$node].get_and_clear_pending_events();
 811                                 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
 812                                 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
 813                                 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
 814                                 // PaymentReceived event for the second HTLC in our pending_events (and breaking
 815                                 // our claim_set deduplication).
 816                                 events.sort_by(|a, b| {
 817                                         if let events::Event::PaymentReceived { .. } = a {
 818                                                 if let events::Event::PendingHTLCsForwardable { .. } = b {
 819                                                         Ordering::Less
 820                                                 } else { Ordering::Equal }
 821                                         } else if let events::Event::PendingHTLCsForwardable { .. } = a {
 822                                                 if let events::Event::PaymentReceived { .. } = b {
 823                                                         Ordering::Greater
 824                                                 } else { Ordering::Equal }
 825                                         } else { Ordering::Equal }
 826                                 });
 827                                 let had_events = !events.is_empty();
 828                                 for event in events.drain(..) {
 829                                         match event {
 830                                                 events::Event::PaymentReceived { payment_hash, .. } => {
 831                                                         if claim_set.insert(payment_hash.0) {
 832                                                                 if $fail {
 833                                                                         assert!(nodes[$node].fail_htlc_backwards(&payment_hash));
 834                                                                 } else {
 835                                                                         assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0)));
 836                                                                 }
 837                                                         }
 838                                                 },
 839                                                 events::Event::PaymentSent { .. } => {},
 840                                                 events::Event::PaymentFailed { .. } => {},
 841                                                 events::Event::PaymentForwarded { .. } if $node == 1 => {},
 842                                                 events::Event::PendingHTLCsForwardable { .. } => {
 843                                                         nodes[$node].process_pending_htlc_forwards();
 844                                                 },
 845                                                 _ => panic!("Unhandled event"),
 846                                         }
 847                                 }
 848                                 had_events
 849                         } }
 850                 }
 851
 852                 let v = get_slice!(1)[0];
 853                 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
 854                 match v {
 855                         // In general, we keep related message groups close together in binary form, allowing
 856                         // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 857                         // harm in doing so.
 858
 859                         0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 860                         0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 861                         0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 862                         0x04 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
 863                         0x05 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
 864                         0x06 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
 865
 866                         0x08 => {
 867                                 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
 868                                         nodes[0].channel_monitor_updated(&chan_1_funding, *id);
 869                                 }
 870                         },
 871                         0x09 => {
 872                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
 873                                         nodes[1].channel_monitor_updated(&chan_1_funding, *id);
 874                                 }
 875                         },
 876                         0x0a => {
 877                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
 878                                         nodes[1].channel_monitor_updated(&chan_2_funding, *id);
 879                                 }
 880                         },
 881                         0x0b => {
 882                                 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
 883                                         nodes[2].channel_monitor_updated(&chan_2_funding, *id);
 884                                 }
 885                         },
 886
 887                         0x0c => {
 888                                 if !chan_a_disconnected {
 889                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
 890                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
 891                                         chan_a_disconnected = true;
 892                                         drain_msg_events_on_disconnect!(0);
 893                                 }
 894                         },
 895                         0x0d => {
 896                                 if !chan_b_disconnected {
 897                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
 898                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
 899                                         chan_b_disconnected = true;
 900                                         drain_msg_events_on_disconnect!(2);
 901                                 }
 902                         },
 903                         0x0e => {
 904                                 if chan_a_disconnected {
 905                                         nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
 906                                         nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::known() });
 907                                         chan_a_disconnected = false;
 908                                 }
 909                         },
 910                         0x0f => {
 911                                 if chan_b_disconnected {
 912                                         nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::known() });
 913                                         nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
 914                                         chan_b_disconnected = false;
 915                                 }
 916                         },
 917
 918                         0x10 => { process_msg_events!(0, true, ProcessMessages::AllMessages); },
 919                         0x11 => { process_msg_events!(0, false, ProcessMessages::AllMessages); },
 920                         0x12 => { process_msg_events!(0, true, ProcessMessages::OneMessage); },
 921                         0x13 => { process_msg_events!(0, false, ProcessMessages::OneMessage); },
 922                         0x14 => { process_msg_events!(0, true, ProcessMessages::OnePendingMessage); },
 923                         0x15 => { process_msg_events!(0, false, ProcessMessages::OnePendingMessage); },
 924
 925                         0x16 => { process_events!(0, true); },
 926                         0x17 => { process_events!(0, false); },
 927
 928                         0x18 => { process_msg_events!(1, true, ProcessMessages::AllMessages); },
 929                         0x19 => { process_msg_events!(1, false, ProcessMessages::AllMessages); },
 930                         0x1a => { process_msg_events!(1, true, ProcessMessages::OneMessage); },
 931                         0x1b => { process_msg_events!(1, false, ProcessMessages::OneMessage); },
 932                         0x1c => { process_msg_events!(1, true, ProcessMessages::OnePendingMessage); },
 933                         0x1d => { process_msg_events!(1, false, ProcessMessages::OnePendingMessage); },
 934
 935                         0x1e => { process_events!(1, true); },
 936                         0x1f => { process_events!(1, false); },
 937
 938                         0x20 => { process_msg_events!(2, true, ProcessMessages::AllMessages); },
 939                         0x21 => { process_msg_events!(2, false, ProcessMessages::AllMessages); },
 940                         0x22 => { process_msg_events!(2, true, ProcessMessages::OneMessage); },
 941                         0x23 => { process_msg_events!(2, false, ProcessMessages::OneMessage); },
 942                         0x24 => { process_msg_events!(2, true, ProcessMessages::OnePendingMessage); },
 943                         0x25 => { process_msg_events!(2, false, ProcessMessages::OnePendingMessage); },
 944
 945                         0x26 => { process_events!(2, true); },
 946                         0x27 => { process_events!(2, false); },
 947
 948                         0x2c => {
 949                                 if !chan_a_disconnected {
 950                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
 951                                         chan_a_disconnected = true;
 952                                         drain_msg_events_on_disconnect!(0);
 953                                 }
 954                                 if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
 955                                         node_a_ser.0.clear();
 956                                         nodes[0].write(&mut node_a_ser).unwrap();
 957                                 }
 958                                 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
 959                                 nodes[0] = new_node_a;
 960                                 monitor_a = new_monitor_a;
 961                         },
 962                         0x2d => {
 963                                 if !chan_a_disconnected {
 964                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
 965                                         chan_a_disconnected = true;
 966                                         nodes[0].get_and_clear_pending_msg_events();
 967                                         ab_events.clear();
 968                                         ba_events.clear();
 969                                 }
 970                                 if !chan_b_disconnected {
 971                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
 972                                         chan_b_disconnected = true;
 973                                         nodes[2].get_and_clear_pending_msg_events();
 974                                         bc_events.clear();
 975                                         cb_events.clear();
 976                                 }
 977                                 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
 978                                 nodes[1] = new_node_b;
 979                                 monitor_b = new_monitor_b;
 980                         },
 981                         0x2e => {
 982                                 if !chan_b_disconnected {
 983                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
 984                                         chan_b_disconnected = true;
 985                                         drain_msg_events_on_disconnect!(2);
 986                                 }
 987                                 if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
 988                                         node_c_ser.0.clear();
 989                                         nodes[2].write(&mut node_c_ser).unwrap();
 990                                 }
 991                                 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
 992                                 nodes[2] = new_node_c;
 993                                 monitor_c = new_monitor_c;
 994                         },
 995
 996                         // 1/10th the channel size:
 997                         0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id); },
 998                         0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id); },
 999                         0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id); },
1000                         0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id); },
1001                         0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id); },
1002                         0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id); },
1003
1004                         0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id); },
1005                         0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id); },
1006                         0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id); },
1007                         0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id); },
1008                         0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id); },
1009                         0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id); },
1010
1011                         0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id); },
1012                         0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id); },
1013                         0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id); },
1014                         0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id); },
1015                         0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id); },
1016                         0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id); },
1017
1018                         0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id); },
1019                         0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id); },
1020                         0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id); },
1021                         0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id); },
1022                         0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id); },
1023                         0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id); },
1024
1025                         0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id); },
1026                         0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id); },
1027                         0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id); },
1028                         0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id); },
1029                         0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id); },
1030                         0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id); },
1031
1032                         0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id); },
1033                         0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id); },
1034                         0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id); },
1035                         0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id); },
1036                         0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id); },
1037                         0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id); },
1038
1039                         0x60 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id); },
1040                         0x61 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id); },
1041                         0x62 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id); },
1042                         0x63 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id); },
1043                         0x64 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id); },
1044                         0x65 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id); },
1045
1046                         0x68 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id); },
1047                         0x69 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id); },
1048                         0x6a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id); },
1049                         0x6b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id); },
1050                         0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
1051                         0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },
1052
1053                         0x80 => {
1054                                 let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1055                                 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1056                                         fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
1057                                 }
1058                                 nodes[0].maybe_update_chan_fees();
1059                         },
1060                         0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },
1061
1062                         0x84 => {
1063                                 let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1064                                 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1065                                         fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
1066                                 }
1067                                 nodes[1].maybe_update_chan_fees();
1068                         },
1069                         0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },
1070
1071                         0x88 => {
1072                                 let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1073                                 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1074                                         fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
1075                                 }
1076                                 nodes[2].maybe_update_chan_fees();
1077                         },
1078                         0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },
1079
1080                         0xff => {
1081                                 // Test that no channel is in a stuck state where neither party can send funds even
1082                                 // after we resolve all pending events.
1083                                 // First make sure there are no pending monitor updates, resetting the error state
1084                                 // and calling channel_monitor_updated for each monitor.
1085                                 *monitor_a.update_ret.lock().unwrap() = Ok(());
1086                                 *monitor_b.update_ret.lock().unwrap() = Ok(());
1087                                 *monitor_c.update_ret.lock().unwrap() = Ok(());
1088
1089                                 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1090                                         nodes[0].channel_monitor_updated(&chan_1_funding, *id);
1091                                 }
1092                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1093                                         nodes[1].channel_monitor_updated(&chan_1_funding, *id);
1094                                 }
1095                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1096                                         nodes[1].channel_monitor_updated(&chan_2_funding, *id);
1097                                 }
1098                                 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1099                                         nodes[2].channel_monitor_updated(&chan_2_funding, *id);
1100                                 }
1101
1102                                 // Next, make sure peers are all connected to each other
1103                                 if chan_a_disconnected {
1104                                         nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
1105                                         nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::known() });
1106                                         chan_a_disconnected = false;
1107                                 }
1108                                 if chan_b_disconnected {
1109                                         nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::known() });
1110                                         nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
1111                                         chan_b_disconnected = false;
1112                                 }
1113
1114                                 for i in 0..std::usize::MAX {
1115                                         if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
1116                                         // Then, make sure any current forwards make their way to their destination
1117                                         if process_msg_events!(0, false, ProcessMessages::AllMessages) { continue; }
1118                                         if process_msg_events!(1, false, ProcessMessages::AllMessages) { continue; }
1119                                         if process_msg_events!(2, false, ProcessMessages::AllMessages) { continue; }
1120                                         // ...making sure any pending PendingHTLCsForwardable events are handled and
1121                                         // payments claimed.
1122                                         if process_events!(0, false) { continue; }
1123                                         if process_events!(1, false) { continue; }
1124                                         if process_events!(2, false) { continue; }
1125                                         break;
1126                                 }
1127
1128                                 // Finally, make sure that at least one end of each channel can make a substantial payment.
1129                                 assert!(
1130                                         send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id) ||
1131                                         send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id));
1132                                 assert!(
1133                                         send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
1134                                         send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));
1135
1136                                 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
1137                                 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
1138                                 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
1139                         },
1140                         _ => test_return!(),
1141                 }
1142
1143                 node_a_ser.0.clear();
1144                 nodes[0].write(&mut node_a_ser).unwrap();
1145                 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
1146                 node_b_ser.0.clear();
1147                 nodes[1].write(&mut node_b_ser).unwrap();
1148                 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
1149                 node_c_ser.0.clear();
1150                 nodes[2].write(&mut node_c_ser).unwrap();
1151                 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
1152         }
1153 }
1154
1155 pub fn chanmon_consistency_test<Out: test_logger::Output>(data: &[u8], out: Out) {
1156         do_test(data, out);
1157 }
1158
1159 #[no_mangle]
1160 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
1161         do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});
1162 }