_ Git - rust-lightning/blob - fuzz/src/chanmon_consistency.rs

   1 //! Test that monitor update failures don't get our channel state out of sync.
   2 //! One of the biggest concern with the monitor update failure handling code is that messages
   3 //! resent after monitor updating is restored are delivered out-of-order, resulting in
   4 //! commitment_signed messages having "invalid signatures".
   5 //! To test this we stand up a network of three nodes and read bytes from the fuzz input to denote
   6 //! actions such as sending payments, handling events, or changing monitor update return values on
   7 //! a per-node basis. This should allow it to find any cases where the ordering of actions results
   8 //! in us getting out of sync with ourselves, and, assuming at least one of our recieve- or
   9 //! send-side handling is correct, other peers. We consider it a failure if any action results in a
  10 //! channel being force-closed.
  11
  12 use bitcoin::BitcoinHash;
  13 use bitcoin::blockdata::block::BlockHeader;
  14 use bitcoin::blockdata::transaction::{Transaction, TxOut};
  15 use bitcoin::blockdata::script::{Builder, Script};
  16 use bitcoin::blockdata::opcodes;
  17 use bitcoin::network::constants::Network;
  18
  19 use bitcoin_hashes::Hash as TraitImport;
  20 use bitcoin_hashes::hash160::Hash as Hash160;
  21 use bitcoin_hashes::sha256::Hash as Sha256;
  22 use bitcoin_hashes::sha256d::Hash as Sha256d;
  23
  24 use lightning::chain::chaininterface;
  25 use lightning::chain::transaction::OutPoint;
  26 use lightning::chain::chaininterface::{BroadcasterInterface,ConfirmationTarget,ChainListener,FeeEstimator,ChainWatchInterfaceUtil};
  27 use lightning::chain::keysinterface::{KeysInterface, InMemoryChannelKeys};
  28 use lightning::ln::channelmonitor;
  29 use lightning::ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, HTLCUpdate};
  30 use lightning::ln::channelmanager::{ChannelManager, PaymentHash, PaymentPreimage, ChannelManagerReadArgs};
  31 use lightning::ln::router::{Route, RouteHop};
  32 use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  33 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, ErrorAction, UpdateAddHTLC, Init};
  34 use lightning::util::enforcing_trait_impls::EnforcingChannelKeys;
  35 use lightning::util::events;
  36 use lightning::util::logger::Logger;
  37 use lightning::util::config::UserConfig;
  38 use lightning::util::events::{EventsProvider, MessageSendEventsProvider};
  39 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
  40
  41 use utils::test_logger;
  42
  43 use secp256k1::key::{PublicKey,SecretKey};
  44 use secp256k1::Secp256k1;
  45
  46 use std::mem;
  47 use std::cmp::Ordering;
  48 use std::collections::{HashSet, hash_map, HashMap};
  49 use std::sync::{Arc,Mutex};
  50 use std::sync::atomic;
  51 use std::io::Cursor;
  52
  53 struct FuzzEstimator {}
  54 impl FeeEstimator for FuzzEstimator {
  55         fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
  56                 253
  57         }
  58 }
  59
  60 pub struct TestBroadcaster {}
  61 impl BroadcasterInterface for TestBroadcaster {
  62         fn broadcast_transaction(&self, _tx: &Transaction) { }
  63 }
  64
  65 pub struct VecWriter(pub Vec<u8>);
  66 impl Writer for VecWriter {
  67         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
  68                 self.0.extend_from_slice(buf);
  69                 Ok(())
  70         }
  71         fn size_hint(&mut self, size: usize) {
  72                 self.0.reserve_exact(size);
  73         }
  74 }
  75
  76 static mut IN_RESTORE: bool = false;
  77 pub struct TestChannelMonitor {
  78         pub simple_monitor: Arc<channelmonitor::SimpleManyChannelMonitor<OutPoint>>,
  79         pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
  80         pub latest_good_update: Mutex<HashMap<OutPoint, Vec<u8>>>,
  81         pub latest_update_good: Mutex<HashMap<OutPoint, bool>>,
  82         pub latest_updates_good_at_last_ser: Mutex<HashMap<OutPoint, bool>>,
  83         pub should_update_manager: atomic::AtomicBool,
  84 }
  85 impl TestChannelMonitor {
  86         pub fn new(chain_monitor: Arc<dyn chaininterface::ChainWatchInterface>, broadcaster: Arc<dyn chaininterface::BroadcasterInterface>, logger: Arc<dyn Logger>, feeest: Arc<dyn chaininterface::FeeEstimator>) -> Self {
  87                 Self {
  88                         simple_monitor: channelmonitor::SimpleManyChannelMonitor::new(chain_monitor, broadcaster, logger, feeest),
  89                         update_ret: Mutex::new(Ok(())),
  90                         latest_good_update: Mutex::new(HashMap::new()),
  91                         latest_update_good: Mutex::new(HashMap::new()),
  92                         latest_updates_good_at_last_ser: Mutex::new(HashMap::new()),
  93                         should_update_manager: atomic::AtomicBool::new(false),
  94                 }
  95         }
  96 }
  97 impl channelmonitor::ManyChannelMonitor for TestChannelMonitor {
  98         fn add_update_monitor(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
  99                 let ret = self.update_ret.lock().unwrap().clone();
 100                 if let Ok(()) = ret {
 101                         let mut ser = VecWriter(Vec::new());
 102                         monitor.write_for_disk(&mut ser).unwrap();
 103                         self.latest_good_update.lock().unwrap().insert(funding_txo, ser.0);
 104                         match self.latest_update_good.lock().unwrap().entry(funding_txo) {
 105                                 hash_map::Entry::Vacant(e) => { e.insert(true); },
 106                                 hash_map::Entry::Occupied(mut e) => {
 107                                         if !e.get() && unsafe { IN_RESTORE } {
 108                                                 // Technically we can't consider an update to be "good" unless we're doing
 109                                                 // it in response to a test_restore_channel_monitor as the channel may
 110                                                 // still be waiting on such a call, so only set us to good if we're in the
 111                                                 // middle of a restore call.
 112                                                 e.insert(true);
 113                                         }
 114                                 },
 115                         }
 116                         self.should_update_manager.store(true, atomic::Ordering::Relaxed);
 117                 } else {
 118                         self.latest_update_good.lock().unwrap().insert(funding_txo, false);
 119                 }
 120                 assert!(self.simple_monitor.add_update_monitor(funding_txo, monitor).is_ok());
 121                 ret
 122         }
 123
 124         fn fetch_pending_htlc_updated(&self) -> Vec<HTLCUpdate> {
 125                 return self.simple_monitor.fetch_pending_htlc_updated();
 126         }
 127 }
 128
 129 struct KeyProvider {
 130         node_id: u8,
 131         session_id: atomic::AtomicU8,
 132         channel_id: atomic::AtomicU8,
 133 }
 134 impl KeysInterface for KeyProvider {
 135         type ChanKeySigner = EnforcingChannelKeys;
 136
 137         fn get_node_secret(&self) -> SecretKey {
 138                 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()
 139         }
 140
 141         fn get_destination_script(&self) -> Script {
 142                 let secp_ctx = Secp256k1::signing_only();
 143                 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();
 144                 let our_channel_monitor_claim_key_hash = Hash160::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
 145                 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
 146         }
 147
 148         fn get_shutdown_pubkey(&self) -> PublicKey {
 149                 let secp_ctx = Secp256k1::signing_only();
 150                 PublicKey::from_secret_key(&secp_ctx, &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())
 151         }
 152
 153         fn get_channel_keys(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingChannelKeys {
 154                 EnforcingChannelKeys::new(InMemoryChannelKeys {
 155                         funding_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, 4, self.node_id]).unwrap(),
 156                         revocation_base_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, 5, self.node_id]).unwrap(),
 157                         payment_base_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, 6, self.node_id]).unwrap(),
 158                         delayed_payment_base_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, 7, self.node_id]).unwrap(),
 159                         htlc_base_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, 8, self.node_id]).unwrap(),
 160                         commitment_seed: [0, 0, 0, 0, 0, 0, 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],
 161                         remote_channel_pubkeys: None,
 162                         channel_value_satoshis,
 163                 })
 164         }
 165
 166         fn get_onion_rand(&self) -> (SecretKey, [u8; 32]) {
 167                 let id = self.session_id.fetch_add(1, atomic::Ordering::Relaxed);
 168                 (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, id, 10, self.node_id]).unwrap(),
 169                 [0; 32])
 170         }
 171
 172         fn get_channel_id(&self) -> [u8; 32] {
 173                 let id = self.channel_id.fetch_add(1, atomic::Ordering::Relaxed);
 174                 [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, id, 11, self.node_id]
 175         }
 176 }
 177
 178 #[inline]
 179 pub fn do_test(data: &[u8]) {
 180         let fee_est = Arc::new(FuzzEstimator{});
 181         let broadcast = Arc::new(TestBroadcaster{});
 182
 183         macro_rules! make_node {
 184                 ($node_id: expr) => { {
 185                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string()));
 186                         let watch = Arc::new(ChainWatchInterfaceUtil::new(Network::Bitcoin, Arc::clone(&logger)));
 187                         let monitor = Arc::new(TestChannelMonitor::new(watch.clone(), broadcast.clone(), logger.clone(), fee_est.clone()));
 188
 189                         let keys_manager = Arc::new(KeyProvider { node_id: $node_id, session_id: atomic::AtomicU8::new(0), channel_id: atomic::AtomicU8::new(0) });
 190                         let mut config = UserConfig::default();
 191                         config.channel_options.fee_proportional_millionths = 0;
 192                         config.channel_options.announced_channel = true;
 193                         config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
 194                         (ChannelManager::new(Network::Bitcoin, fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, 0).unwrap(),
 195                         monitor)
 196                 } }
 197         }
 198
 199         macro_rules! reload_node {
 200                 ($ser: expr, $node_id: expr, $old_monitors: expr) => { {
 201                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string()));
 202                         let watch = Arc::new(ChainWatchInterfaceUtil::new(Network::Bitcoin, Arc::clone(&logger)));
 203                         let monitor = Arc::new(TestChannelMonitor::new(watch.clone(), broadcast.clone(), logger.clone(), fee_est.clone()));
 204
 205                         let keys_manager = Arc::new(KeyProvider { node_id: $node_id, session_id: atomic::AtomicU8::new(0), channel_id: atomic::AtomicU8::new(0) });
 206                         let mut config = UserConfig::default();
 207                         config.channel_options.fee_proportional_millionths = 0;
 208                         config.channel_options.announced_channel = true;
 209                         config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
 210
 211                         let mut monitors = HashMap::new();
 212                         let mut old_monitors = $old_monitors.latest_good_update.lock().unwrap();
 213                         for (outpoint, monitor_ser) in old_monitors.drain() {
 214                                 monitors.insert(outpoint, <(Sha256d, ChannelMonitor)>::read(&mut Cursor::new(&monitor_ser), Arc::clone(&logger)).expect("Failed to read monitor").1);
 215                                 monitor.latest_good_update.lock().unwrap().insert(outpoint, monitor_ser);
 216                         }
 217                         let mut monitor_refs = HashMap::new();
 218                         for (outpoint, monitor) in monitors.iter_mut() {
 219                                 monitor_refs.insert(*outpoint, monitor);
 220                         }
 221
 222                         let read_args = ChannelManagerReadArgs {
 223                                 keys_manager,
 224                                 fee_estimator: fee_est.clone(),
 225                                 monitor: monitor.clone(),
 226                                 tx_broadcaster: broadcast.clone(),
 227                                 logger,
 228                                 default_config: config,
 229                                 channel_monitors: &mut monitor_refs,
 230                         };
 231
 232                         let res = (<(Sha256d, ChannelManager<EnforcingChannelKeys>)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, monitor);
 233                         for (_, was_good) in $old_monitors.latest_updates_good_at_last_ser.lock().unwrap().iter() {
 234                                 if !was_good {
 235                                         // If the last time we updated a monitor we didn't successfully update (and we
 236                                         // have sense updated our serialized copy of the ChannelManager) we may
 237                                         // force-close the channel on our counterparty cause we know we're missing
 238                                         // something. Thus, we just return here since we can't continue to test.
 239                                         return;
 240                                 }
 241                         }
 242                         res
 243                 } }
 244         }
 245
 246         let mut channel_txn = Vec::new();
 247         macro_rules! make_channel {
 248                 ($source: expr, $dest: expr, $chan_id: expr) => { {
 249                         $source.create_channel($dest.get_our_node_id(), 10000000, 42, 0).unwrap();
 250                         let open_channel = {
 251                                 let events = $source.get_and_clear_pending_msg_events();
 252                                 assert_eq!(events.len(), 1);
 253                                 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
 254                                         msg.clone()
 255                                 } else { panic!("Wrong event type"); }
 256                         };
 257
 258                         $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::supported(), &open_channel);
 259                         let accept_channel = {
 260                                 let events = $dest.get_and_clear_pending_msg_events();
 261                                 assert_eq!(events.len(), 1);
 262                                 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
 263                                         msg.clone()
 264                                 } else { panic!("Wrong event type"); }
 265                         };
 266
 267                         $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::supported(), &accept_channel);
 268                         {
 269                                 let events = $source.get_and_clear_pending_events();
 270                                 assert_eq!(events.len(), 1);
 271                                 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
 272                                         let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
 273                                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
 274                                         }]};
 275                                         let funding_output = OutPoint::new(tx.txid(), 0);
 276                                         $source.funding_transaction_generated(&temporary_channel_id, funding_output);
 277                                         channel_txn.push(tx);
 278                                 } else { panic!("Wrong event type"); }
 279                         }
 280
 281                         let funding_created = {
 282                                 let events = $source.get_and_clear_pending_msg_events();
 283                                 assert_eq!(events.len(), 1);
 284                                 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
 285                                         msg.clone()
 286                                 } else { panic!("Wrong event type"); }
 287                         };
 288                         $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
 289
 290                         let funding_signed = {
 291                                 let events = $dest.get_and_clear_pending_msg_events();
 292                                 assert_eq!(events.len(), 1);
 293                                 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
 294                                         msg.clone()
 295                                 } else { panic!("Wrong event type"); }
 296                         };
 297                         $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
 298
 299                         {
 300                                 let events = $source.get_and_clear_pending_events();
 301                                 assert_eq!(events.len(), 1);
 302                                 if let events::Event::FundingBroadcastSafe { .. } = events[0] {
 303                                 } else { panic!("Wrong event type"); }
 304                         }
 305                 } }
 306         }
 307
 308         macro_rules! confirm_txn {
 309                 ($node: expr) => { {
 310                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 311                         let mut txn = Vec::with_capacity(channel_txn.len());
 312                         let mut posn = Vec::with_capacity(channel_txn.len());
 313                         for i in 0..channel_txn.len() {
 314                                 txn.push(&channel_txn[i]);
 315                                 posn.push(i as u32 + 1);
 316                         }
 317                         $node.block_connected(&header, 1, &txn, &posn);
 318                         for i in 2..100 {
 319                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 320                                 $node.block_connected(&header, i, &Vec::new(), &[0; 0]);
 321                         }
 322                 } }
 323         }
 324
 325         macro_rules! lock_fundings {
 326                 ($nodes: expr) => { {
 327                         let mut node_events = Vec::new();
 328                         for node in $nodes.iter() {
 329                                 node_events.push(node.get_and_clear_pending_msg_events());
 330                         }
 331                         for (idx, node_event) in node_events.iter().enumerate() {
 332                                 for event in node_event {
 333                                         if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
 334                                                 for node in $nodes.iter() {
 335                                                         if node.get_our_node_id() == *node_id {
 336                                                                 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
 337                                                         }
 338                                                 }
 339                                         } else { panic!("Wrong event type"); }
 340                                 }
 341                         }
 342
 343                         for node in $nodes.iter() {
 344                                 let events = node.get_and_clear_pending_msg_events();
 345                                 for event in events {
 346                                         if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
 347                                         } else { panic!("Wrong event type"); }
 348                                 }
 349                         }
 350                 } }
 351         }
 352
 353         // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
 354         // forwarding.
 355         let (mut node_a, mut monitor_a) = make_node!(0);
 356         let (mut node_b, mut monitor_b) = make_node!(1);
 357         let (mut node_c, mut monitor_c) = make_node!(2);
 358
 359         let mut nodes = [node_a, node_b, node_c];
 360
 361         make_channel!(nodes[0], nodes[1], 0);
 362         make_channel!(nodes[1], nodes[2], 1);
 363
 364         for node in nodes.iter() {
 365                 confirm_txn!(node);
 366         }
 367
 368         lock_fundings!(nodes);
 369
 370         let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
 371         let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
 372
 373         let mut payment_id = 0;
 374
 375         let mut chan_a_disconnected = false;
 376         let mut chan_b_disconnected = false;
 377         let mut ba_events = Vec::new();
 378         let mut bc_events = Vec::new();
 379
 380         let mut node_a_ser = VecWriter(Vec::new());
 381         nodes[0].write(&mut node_a_ser).unwrap();
 382         let mut node_b_ser = VecWriter(Vec::new());
 383         nodes[1].write(&mut node_b_ser).unwrap();
 384         let mut node_c_ser = VecWriter(Vec::new());
 385         nodes[2].write(&mut node_c_ser).unwrap();
 386
 387         macro_rules! test_return {
 388                 () => { {
 389                         assert_eq!(nodes[0].list_channels().len(), 1);
 390                         assert_eq!(nodes[1].list_channels().len(), 2);
 391                         assert_eq!(nodes[2].list_channels().len(), 1);
 392                         return;
 393                 } }
 394         }
 395
 396         let mut read_pos = 0;
 397         macro_rules! get_slice {
 398                 ($len: expr) => {
 399                         {
 400                                 let slice_len = $len as usize;
 401                                 if data.len() < read_pos + slice_len {
 402                                         test_return!();
 403                                 }
 404                                 read_pos += slice_len;
 405                                 &data[read_pos - slice_len..read_pos]
 406                         }
 407                 }
 408         }
 409
 410         loop {
 411                 macro_rules! send_payment {
 412                         ($source: expr, $dest: expr) => { {
 413                                 let payment_hash = Sha256::hash(&[payment_id; 1]);
 414                                 payment_id = payment_id.wrapping_add(1);
 415                                 if let Err(_) = $source.send_payment(Route {
 416                                         hops: vec![RouteHop {
 417                                                 pubkey: $dest.0.get_our_node_id(),
 418                                                 node_features: NodeFeatures::empty(),
 419                                                 short_channel_id: $dest.1,
 420                                                 channel_features: ChannelFeatures::empty(),
 421                                                 fee_msat: 5000000,
 422                                                 cltv_expiry_delta: 200,
 423                                         }],
 424                                 }, PaymentHash(payment_hash.into_inner())) {
 425                                         // Probably ran out of funds
 426                                         test_return!();
 427                                 }
 428                         } };
 429                         ($source: expr, $middle: expr, $dest: expr) => { {
 430                                 let payment_hash = Sha256::hash(&[payment_id; 1]);
 431                                 payment_id = payment_id.wrapping_add(1);
 432                                 if let Err(_) = $source.send_payment(Route {
 433                                         hops: vec![RouteHop {
 434                                                 pubkey: $middle.0.get_our_node_id(),
 435                                                 node_features: NodeFeatures::empty(),
 436                                                 short_channel_id: $middle.1,
 437                                                 channel_features: ChannelFeatures::empty(),
 438                                                 fee_msat: 50000,
 439                                                 cltv_expiry_delta: 100,
 440                                         },RouteHop {
 441                                                 pubkey: $dest.0.get_our_node_id(),
 442                                                 node_features: NodeFeatures::empty(),
 443                                                 short_channel_id: $dest.1,
 444                                                 channel_features: ChannelFeatures::empty(),
 445                                                 fee_msat: 5000000,
 446                                                 cltv_expiry_delta: 200,
 447                                         }],
 448                                 }, PaymentHash(payment_hash.into_inner())) {
 449                                         // Probably ran out of funds
 450                                         test_return!();
 451                                 }
 452                         } }
 453                 }
 454
 455                 macro_rules! process_msg_events {
 456                         ($node: expr, $corrupt_forward: expr) => { {
 457                                 let events = if $node == 1 {
 458                                         let mut new_events = Vec::new();
 459                                         mem::swap(&mut new_events, &mut ba_events);
 460                                         new_events.extend_from_slice(&bc_events[..]);
 461                                         bc_events.clear();
 462                                         new_events
 463                                 } else { Vec::new() };
 464                                 for event in events.iter().chain(nodes[$node].get_and_clear_pending_msg_events().iter()) {
 465                                         match event {
 466                                                 events::MessageSendEvent::UpdateHTLCs { ref node_id, updates: CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
 467                                                         for dest in nodes.iter() {
 468                                                                 if dest.get_our_node_id() == *node_id {
 469                                                                         assert!(update_fee.is_none());
 470                                                                         for update_add in update_add_htlcs {
 471                                                                                 if !$corrupt_forward {
 472                                                                                         dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &update_add);
 473                                                                                 } else {
 474                                                                                         // Corrupt the update_add_htlc message so that its HMAC
 475                                                                                         // check will fail and we generate a
 476                                                                                         // update_fail_malformed_htlc instead of an
 477                                                                                         // update_fail_htlc as we do when we reject a payment.
 478                                                                                         let mut msg_ser = update_add.encode();
 479                                                                                         msg_ser[1000] ^= 0xff;
 480                                                                                         let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
 481                                                                                         dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
 482                                                                                 }
 483                                                                         }
 484                                                                         for update_fulfill in update_fulfill_htlcs {
 485                                                                                 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), &update_fulfill);
 486                                                                         }
 487                                                                         for update_fail in update_fail_htlcs {
 488                                                                                 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), &update_fail);
 489                                                                         }
 490                                                                         for update_fail_malformed in update_fail_malformed_htlcs {
 491                                                                                 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), &update_fail_malformed);
 492                                                                         }
 493                                                                         dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
 494                                                                 }
 495                                                         }
 496                                                 },
 497                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 498                                                         for dest in nodes.iter() {
 499                                                                 if dest.get_our_node_id() == *node_id {
 500                                                                         dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
 501                                                                 }
 502                                                         }
 503                                                 },
 504                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
 505                                                         for dest in nodes.iter() {
 506                                                                 if dest.get_our_node_id() == *node_id {
 507                                                                         dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
 508                                                                 }
 509                                                         }
 510                                                 },
 511                                                 events::MessageSendEvent::SendFundingLocked { .. } => {
 512                                                         // Can be generated as a reestablish response
 513                                                 },
 514                                                 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
 515                                                         // Can be generated due to a payment forward being rejected due to a
 516                                                         // channel having previously failed a monitor update
 517                                                 },
 518                                                 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {
 519                                                         // Can be generated at any processing step to send back an error, disconnect
 520                                                         // peer or just ignore
 521                                                 },
 522                                                 _ => panic!("Unhandled message event"),
 523                                         }
 524                                 }
 525                         } }
 526                 }
 527
 528                 macro_rules! drain_msg_events_on_disconnect {
 529                         ($counterparty_id: expr) => { {
 530                                 if $counterparty_id == 0 {
 531                                         for event in nodes[0].get_and_clear_pending_msg_events() {
 532                                                 match event {
 533                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
 534                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
 535                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
 536                                                         events::MessageSendEvent::SendFundingLocked { .. } => {},
 537                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
 538                                                         events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
 539                                                         _ => panic!("Unhandled message event"),
 540                                                 }
 541                                         }
 542                                         ba_events.clear();
 543                                 } else {
 544                                         for event in nodes[2].get_and_clear_pending_msg_events() {
 545                                                 match event {
 546                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
 547                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
 548                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
 549                                                         events::MessageSendEvent::SendFundingLocked { .. } => {},
 550                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
 551                                                         events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
 552                                                         _ => panic!("Unhandled message event"),
 553                                                 }
 554                                         }
 555                                         bc_events.clear();
 556                                 }
 557                                 let mut events = nodes[1].get_and_clear_pending_msg_events();
 558                                 let drop_node_id = if $counterparty_id == 0 { nodes[0].get_our_node_id() } else { nodes[2].get_our_node_id() };
 559                                 let msg_sink = if $counterparty_id == 0 { &mut bc_events } else { &mut ba_events };
 560                                 for event in events.drain(..) {
 561                                         let push = match event {
 562                                                 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
 563                                                         if *node_id != drop_node_id { true } else { false }
 564                                                 },
 565                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
 566                                                         if *node_id != drop_node_id { true } else { false }
 567                                                 },
 568                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
 569                                                         if *node_id != drop_node_id { true } else { false }
 570                                                 },
 571                                                 events::MessageSendEvent::SendFundingLocked { .. } => false,
 572                                                 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => false,
 573                                                 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => false,
 574                                                 _ => panic!("Unhandled message event"),
 575                                         };
 576                                         if push { msg_sink.push(event); }
 577                                 }
 578                         } }
 579                 }
 580
 581                 macro_rules! process_events {
 582                         ($node: expr, $fail: expr) => { {
 583                                 // In case we get 256 payments we may have a hash collision, resulting in the
 584                                 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
 585                                 // deduplicate the calls here.
 586                                 let mut claim_set = HashSet::new();
 587                                 let mut events = nodes[$node].get_and_clear_pending_events();
 588                                 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
 589                                 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
 590                                 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
 591                                 // PaymentReceived event for the second HTLC in our pending_events (and breaking
 592                                 // our claim_set deduplication).
 593                                 events.sort_by(|a, b| {
 594                                         if let events::Event::PaymentReceived { .. } = a {
 595                                                 if let events::Event::PendingHTLCsForwardable { .. } = b {
 596                                                         Ordering::Less
 597                                                 } else { Ordering::Equal }
 598                                         } else if let events::Event::PendingHTLCsForwardable { .. } = a {
 599                                                 if let events::Event::PaymentReceived { .. } = b {
 600                                                         Ordering::Greater
 601                                                 } else { Ordering::Equal }
 602                                         } else { Ordering::Equal }
 603                                 });
 604                                 for event in events.drain(..) {
 605                                         match event {
 606                                                 events::Event::PaymentReceived { payment_hash, .. } => {
 607                                                         if claim_set.insert(payment_hash.0) {
 608                                                                 if $fail {
 609                                                                         assert!(nodes[$node].fail_htlc_backwards(&payment_hash));
 610                                                                 } else {
 611                                                                         assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0), 5_000_000));
 612                                                                 }
 613                                                         }
 614                                                 },
 615                                                 events::Event::PaymentSent { .. } => {},
 616                                                 events::Event::PaymentFailed { .. } => {},
 617                                                 events::Event::PendingHTLCsForwardable { .. } => {
 618                                                         nodes[$node].process_pending_htlc_forwards();
 619                                                 },
 620                                                 _ => panic!("Unhandled event"),
 621                                         }
 622                                 }
 623                         } }
 624                 }
 625
 626                 match get_slice!(1)[0] {
 627                         0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 628                         0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 629                         0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
 630                         0x03 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
 631                         0x04 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
 632                         0x05 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
 633                         0x06 => { unsafe { IN_RESTORE = true }; nodes[0].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
 634                         0x07 => { unsafe { IN_RESTORE = true }; nodes[1].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
 635                         0x08 => { unsafe { IN_RESTORE = true }; nodes[2].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
 636                         0x09 => send_payment!(nodes[0], (&nodes[1], chan_a)),
 637                         0x0a => send_payment!(nodes[1], (&nodes[0], chan_a)),
 638                         0x0b => send_payment!(nodes[1], (&nodes[2], chan_b)),
 639                         0x0c => send_payment!(nodes[2], (&nodes[1], chan_b)),
 640                         0x0d => send_payment!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b)),
 641                         0x0e => send_payment!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a)),
 642                         0x0f => {
 643                                 if !chan_a_disconnected {
 644                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
 645                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
 646                                         chan_a_disconnected = true;
 647                                         drain_msg_events_on_disconnect!(0);
 648                                 }
 649                         },
 650                         0x10 => {
 651                                 if !chan_b_disconnected {
 652                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
 653                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
 654                                         chan_b_disconnected = true;
 655                                         drain_msg_events_on_disconnect!(2);
 656                                 }
 657                         },
 658                         0x11 => {
 659                                 if chan_a_disconnected {
 660                                         nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
 661                                         nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
 662                                         chan_a_disconnected = false;
 663                                 }
 664                         },
 665                         0x12 => {
 666                                 if chan_b_disconnected {
 667                                         nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
 668                                         nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
 669                                         chan_b_disconnected = false;
 670                                 }
 671                         },
 672                         0x13 => process_msg_events!(0, true),
 673                         0x14 => process_msg_events!(0, false),
 674                         0x15 => process_events!(0, true),
 675                         0x16 => process_events!(0, false),
 676                         0x17 => process_msg_events!(1, true),
 677                         0x18 => process_msg_events!(1, false),
 678                         0x19 => process_events!(1, true),
 679                         0x1a => process_events!(1, false),
 680                         0x1b => process_msg_events!(2, true),
 681                         0x1c => process_msg_events!(2, false),
 682                         0x1d => process_events!(2, true),
 683                         0x1e => process_events!(2, false),
 684                         0x1f => {
 685                                 if !chan_a_disconnected {
 686                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
 687                                         chan_a_disconnected = true;
 688                                         drain_msg_events_on_disconnect!(0);
 689                                 }
 690                                 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a);
 691                                 node_a = Arc::new(new_node_a);
 692                                 nodes[0] = node_a.clone();
 693                                 monitor_a = new_monitor_a;
 694                         },
 695                         0x20 => {
 696                                 if !chan_a_disconnected {
 697                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
 698                                         chan_a_disconnected = true;
 699                                         nodes[0].get_and_clear_pending_msg_events();
 700                                         ba_events.clear();
 701                                 }
 702                                 if !chan_b_disconnected {
 703                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
 704                                         chan_b_disconnected = true;
 705                                         nodes[2].get_and_clear_pending_msg_events();
 706                                         bc_events.clear();
 707                                 }
 708                                 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b);
 709                                 node_b = Arc::new(new_node_b);
 710                                 nodes[1] = node_b.clone();
 711                                 monitor_b = new_monitor_b;
 712                         },
 713                         0x21 => {
 714                                 if !chan_b_disconnected {
 715                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
 716                                         chan_b_disconnected = true;
 717                                         drain_msg_events_on_disconnect!(2);
 718                                 }
 719                                 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c);
 720                                 node_c = Arc::new(new_node_c);
 721                                 nodes[2] = node_c.clone();
 722                                 monitor_c = new_monitor_c;
 723                         },
 724                         _ => test_return!(),
 725                 }
 726
 727                 if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
 728                         node_a_ser.0.clear();
 729                         nodes[0].write(&mut node_a_ser).unwrap();
 730                         monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
 731                         *monitor_a.latest_updates_good_at_last_ser.lock().unwrap() = monitor_a.latest_update_good.lock().unwrap().clone();
 732                 }
 733                 if monitor_b.should_update_manager.load(atomic::Ordering::Relaxed) {
 734                         node_b_ser.0.clear();
 735                         nodes[1].write(&mut node_b_ser).unwrap();
 736                         monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
 737                         *monitor_b.latest_updates_good_at_last_ser.lock().unwrap() = monitor_b.latest_update_good.lock().unwrap().clone();
 738                 }
 739                 if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
 740                         node_c_ser.0.clear();
 741                         nodes[2].write(&mut node_c_ser).unwrap();
 742                         monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
 743                         *monitor_c.latest_updates_good_at_last_ser.lock().unwrap() = monitor_c.latest_update_good.lock().unwrap().clone();
 744                 }
 745         }
 746 }
 747
 748 #[no_mangle]
 749 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
 750         do_test(unsafe { std::slice::from_raw_parts(data, datalen) });
 751 }
 752
 753 #[cfg(test)]
 754 mod tests {
 755         #[test]
 756         fn duplicate_crash() {
 757                 super::do_test(&::hex::decode("00").unwrap());
 758         }
 759 }