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