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