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