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