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