Merge pull request #858 from jkczyz/2021-03-electrum-interface
[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::constants::genesis_block;
23 use bitcoin::blockdata::transaction::{Transaction, TxOut};
24 use bitcoin::blockdata::script::{Builder, Script};
25 use bitcoin::blockdata::opcodes;
26 use bitcoin::network::constants::Network;
27
28 use bitcoin::hashes::Hash as TraitImport;
29 use bitcoin::hashes::sha256::Hash as Sha256;
30 use bitcoin::hash_types::{BlockHash, WPubkeyHash};
31
32 use lightning::chain;
33 use lightning::chain::chainmonitor;
34 use lightning::chain::channelmonitor;
35 use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, MonitorEvent};
36 use lightning::chain::transaction::OutPoint;
37 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
38 use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
39 use lightning::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentSecret, PaymentSendFailure, ChannelManagerReadArgs};
40 use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
41 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, ErrorAction, UpdateAddHTLC, Init};
42 use lightning::util::enforcing_trait_impls::{EnforcingSigner, INITIAL_REVOKED_COMMITMENT_NUMBER};
43 use lightning::util::errors::APIError;
44 use lightning::util::events;
45 use lightning::util::logger::Logger;
46 use lightning::util::config::UserConfig;
47 use lightning::util::events::{EventsProvider, MessageSendEventsProvider};
48 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
49 use lightning::util::test_utils::OnlyReadsKeysInterface;
50 use lightning::routing::router::{Route, RouteHop};
51
52
53 use utils::test_logger;
54 use utils::test_persister::TestPersister;
55
56 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
57 use bitcoin::secp256k1::Secp256k1;
58
59 use std::mem;
60 use std::cmp::Ordering;
61 use std::collections::{HashSet, hash_map, HashMap};
62 use std::sync::{Arc,Mutex};
63 use std::sync::atomic;
64 use std::io::Cursor;
65
66 struct FuzzEstimator {}
67 impl FeeEstimator for FuzzEstimator {
68         fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
69                 253
70         }
71 }
72
73 pub struct TestBroadcaster {}
74 impl BroadcasterInterface for TestBroadcaster {
75         fn broadcast_transaction(&self, _tx: &Transaction) { }
76 }
77
78 pub struct VecWriter(pub Vec<u8>);
79 impl Writer for VecWriter {
80         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
81                 self.0.extend_from_slice(buf);
82                 Ok(())
83         }
84         fn size_hint(&mut self, size: usize) {
85                 self.0.reserve_exact(size);
86         }
87 }
88
89 struct TestChainMonitor {
90         pub logger: Arc<dyn Logger>,
91         pub chain_monitor: Arc<chainmonitor::ChainMonitor<EnforcingSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
92         pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
93         // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
94         // logic will automatically force-close our channels for us (as we don't have an up-to-date
95         // monitor implying we are not able to punish misbehaving counterparties). Because this test
96         // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
97         // fully-serialized monitor state here, as well as the corresponding update_id.
98         pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
99         pub should_update_manager: atomic::AtomicBool,
100 }
101 impl TestChainMonitor {
102         pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>) -> Self {
103                 Self {
104                         chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, persister)),
105                         logger,
106                         update_ret: Mutex::new(Ok(())),
107                         latest_monitors: Mutex::new(HashMap::new()),
108                         should_update_manager: atomic::AtomicBool::new(false),
109                 }
110         }
111 }
112 impl chain::Watch<EnforcingSigner> for TestChainMonitor {
113         fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
114                 let mut ser = VecWriter(Vec::new());
115                 monitor.write(&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 deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
131                         read(&mut Cursor::new(&map_entry.get().1), &OnlyReadsKeysInterface {}).unwrap().1;
132                 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
133                 let mut ser = VecWriter(Vec::new());
134                 deserialized_monitor.write(&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         revoked_commitments: Mutex<HashMap<[u8;32], Arc<Mutex<u64>>>>,
149 }
150 impl KeysInterface for KeyProvider {
151         type Signer = EnforcingSigner;
152
153         fn get_node_secret(&self) -> SecretKey {
154                 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()
155         }
156
157         fn get_destination_script(&self) -> Script {
158                 let secp_ctx = Secp256k1::signing_only();
159                 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();
160                 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
161                 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
162         }
163
164         fn get_shutdown_pubkey(&self) -> PublicKey {
165                 let secp_ctx = Secp256k1::signing_only();
166                 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())
167         }
168
169         fn get_channel_signer(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner {
170                 let secp_ctx = Secp256k1::signing_only();
171                 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
172                 let keys = InMemorySigner::new(
173                         &secp_ctx,
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, 4, 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, 5, 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, 6, self.node_id]).unwrap(),
177                         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(),
178                         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(),
179                         [id, 0, 0, 0, 0, 0, 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],
180                         channel_value_satoshis,
181                         [0; 32],
182                 );
183                 let revoked_commitment = self.make_revoked_commitment_cell(keys.commitment_seed);
184                 EnforcingSigner::new_with_revoked(keys, revoked_commitment, false)
185         }
186
187         fn get_secure_random_bytes(&self) -> [u8; 32] {
188                 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
189                 [0, 0, 0, 0, 0, 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]
190         }
191
192         fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, DecodeError> {
193                 let mut reader = std::io::Cursor::new(buffer);
194
195                 let inner: InMemorySigner = Readable::read(&mut reader)?;
196                 let revoked_commitment = self.make_revoked_commitment_cell(inner.commitment_seed);
197
198                 let last_commitment_number = Readable::read(&mut reader)?;
199
200                 Ok(EnforcingSigner {
201                         inner,
202                         last_commitment_number: Arc::new(Mutex::new(last_commitment_number)),
203                         revoked_commitment,
204                         disable_revocation_policy_check: false,
205                 })
206         }
207 }
208
209 impl KeyProvider {
210         fn make_revoked_commitment_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<u64>> {
211                 let mut revoked_commitments = self.revoked_commitments.lock().unwrap();
212                 if !revoked_commitments.contains_key(&commitment_seed) {
213                         revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(INITIAL_REVOKED_COMMITMENT_NUMBER)));
214                 }
215                 let cell = revoked_commitments.get(&commitment_seed).unwrap();
216                 Arc::clone(cell)
217         }
218 }
219
220 #[inline]
221 fn check_api_err(api_err: APIError) {
222         match api_err {
223                 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
224                 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
225                 APIError::RouteError { .. } => panic!("Our routes should work"),
226                 APIError::ChannelUnavailable { err } => {
227                         // Test the error against a list of errors we can hit, and reject
228                         // all others. If you hit this panic, the list of acceptable errors
229                         // is probably just stale and you should add new messages here.
230                         match err.as_str() {
231                                 "Peer for first hop currently disconnected/pending monitor update!" => {},
232                                 _ if err.starts_with("Cannot push more than their max accepted HTLCs ") => {},
233                                 _ if err.starts_with("Cannot send value that would put us over the max HTLC value in flight our peer will accept ") => {},
234                                 _ if err.starts_with("Cannot send value that would put our balance under counterparty-announced channel reserve value") => {},
235                                 _ if err.starts_with("Cannot send value that would overdraw remaining funds.") => {},
236                                 _ if err.starts_with("Cannot send value that would not leave enough to pay for fees.") => {},
237                                 _ => panic!("{}", err),
238                         }
239                 },
240                 APIError::MonitorUpdateFailed => {
241                         // We can (obviously) temp-fail a monitor update
242                 },
243         }
244 }
245 #[inline]
246 fn check_payment_err(send_err: PaymentSendFailure) {
247         match send_err {
248                 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err),
249                 PaymentSendFailure::PathParameterError(per_path_results) => {
250                         for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
251                 },
252                 PaymentSendFailure::AllFailedRetrySafe(per_path_results) => {
253                         for api_err in per_path_results { check_api_err(api_err); }
254                 },
255                 PaymentSendFailure::PartialFailure(per_path_results) => {
256                         for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
257                 },
258         }
259 }
260
261 type ChanMan = ChannelManager<EnforcingSigner, Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>;
262
263 #[inline]
264 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
265         let payment_hash = Sha256::hash(&[*payment_id; 1]);
266         *payment_id = payment_id.wrapping_add(1);
267         if let Err(err) = source.send_payment(&Route {
268                 paths: vec![vec![RouteHop {
269                         pubkey: dest.get_our_node_id(),
270                         node_features: NodeFeatures::empty(),
271                         short_channel_id: dest_chan_id,
272                         channel_features: ChannelFeatures::empty(),
273                         fee_msat: amt,
274                         cltv_expiry_delta: 200,
275                 }]],
276         }, PaymentHash(payment_hash.into_inner()), &None) {
277                 check_payment_err(err);
278                 false
279         } else { true }
280 }
281 #[inline]
282 fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
283         let payment_hash = Sha256::hash(&[*payment_id; 1]);
284         *payment_id = payment_id.wrapping_add(1);
285         if let Err(err) = source.send_payment(&Route {
286                 paths: vec![vec![RouteHop {
287                         pubkey: middle.get_our_node_id(),
288                         node_features: NodeFeatures::empty(),
289                         short_channel_id: middle_chan_id,
290                         channel_features: ChannelFeatures::empty(),
291                         fee_msat: 50000,
292                         cltv_expiry_delta: 100,
293                 },RouteHop {
294                         pubkey: dest.get_our_node_id(),
295                         node_features: NodeFeatures::empty(),
296                         short_channel_id: dest_chan_id,
297                         channel_features: ChannelFeatures::empty(),
298                         fee_msat: amt,
299                         cltv_expiry_delta: 200,
300                 }]],
301         }, PaymentHash(payment_hash.into_inner()), &None) {
302                 check_payment_err(err);
303                 false
304         } else { true }
305 }
306
307 #[inline]
308 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
309         let fee_est = Arc::new(FuzzEstimator{});
310         let broadcast = Arc::new(TestBroadcaster{});
311
312         macro_rules! make_node {
313                 ($node_id: expr) => { {
314                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
315                         let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{})));
316
317                         let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU8::new(0), revoked_commitments: Mutex::new(HashMap::new()) });
318                         let mut config = UserConfig::default();
319                         config.channel_options.fee_proportional_millionths = 0;
320                         config.channel_options.announced_channel = true;
321                         config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
322                         let network = Network::Bitcoin;
323                         let params = ChainParameters {
324                                 network,
325                                 best_block: BestBlock::from_genesis(network),
326                         };
327                         (ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
328                         monitor, keys_manager)
329                 } }
330         }
331
332         macro_rules! reload_node {
333                 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr) => { {
334                     let keys_manager = Arc::clone(& $keys_manager);
335                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
336                         let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{})));
337
338                         let mut config = UserConfig::default();
339                         config.channel_options.fee_proportional_millionths = 0;
340                         config.channel_options.announced_channel = true;
341                         config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
342
343                         let mut monitors = HashMap::new();
344                         let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
345                         for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
346                                 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut Cursor::new(&monitor_ser), &OnlyReadsKeysInterface {}).expect("Failed to read monitor").1);
347                                 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
348                         }
349                         let mut monitor_refs = HashMap::new();
350                         for (outpoint, monitor) in monitors.iter_mut() {
351                                 monitor_refs.insert(*outpoint, monitor);
352                         }
353
354                         let read_args = ChannelManagerReadArgs {
355                                 keys_manager,
356                                 fee_estimator: fee_est.clone(),
357                                 chain_monitor: chain_monitor.clone(),
358                                 tx_broadcaster: broadcast.clone(),
359                                 logger,
360                                 default_config: config,
361                                 channel_monitors: monitor_refs,
362                         };
363
364                         (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor)
365                 } }
366         }
367
368         let mut channel_txn = Vec::new();
369         macro_rules! make_channel {
370                 ($source: expr, $dest: expr, $chan_id: expr) => { {
371                         $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
372                         let open_channel = {
373                                 let events = $source.get_and_clear_pending_msg_events();
374                                 assert_eq!(events.len(), 1);
375                                 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
376                                         msg.clone()
377                                 } else { panic!("Wrong event type"); }
378                         };
379
380                         $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::known(), &open_channel);
381                         let accept_channel = {
382                                 let events = $dest.get_and_clear_pending_msg_events();
383                                 assert_eq!(events.len(), 1);
384                                 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
385                                         msg.clone()
386                                 } else { panic!("Wrong event type"); }
387                         };
388
389                         $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::known(), &accept_channel);
390                         let funding_output;
391                         {
392                                 let events = $source.get_and_clear_pending_events();
393                                 assert_eq!(events.len(), 1);
394                                 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
395                                         let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
396                                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
397                                         }]};
398                                         funding_output = OutPoint { txid: tx.txid(), index: 0 };
399                                         $source.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
400                                         channel_txn.push(tx);
401                                 } else { panic!("Wrong event type"); }
402                         }
403
404                         let funding_created = {
405                                 let events = $source.get_and_clear_pending_msg_events();
406                                 assert_eq!(events.len(), 1);
407                                 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
408                                         msg.clone()
409                                 } else { panic!("Wrong event type"); }
410                         };
411                         $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
412
413                         let funding_signed = {
414                                 let events = $dest.get_and_clear_pending_msg_events();
415                                 assert_eq!(events.len(), 1);
416                                 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
417                                         msg.clone()
418                                 } else { panic!("Wrong event type"); }
419                         };
420                         $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
421
422                         funding_output
423                 } }
424         }
425
426         macro_rules! confirm_txn {
427                 ($node: expr) => { {
428                         let chain_hash = genesis_block(Network::Bitcoin).block_hash();
429                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: chain_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
430                         let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
431                         $node.transactions_confirmed(&header, 1, &txdata);
432                         for _ in 2..100 {
433                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
434                         }
435                         $node.update_best_block(&header, 99);
436                 } }
437         }
438
439         macro_rules! lock_fundings {
440                 ($nodes: expr) => { {
441                         let mut node_events = Vec::new();
442                         for node in $nodes.iter() {
443                                 node_events.push(node.get_and_clear_pending_msg_events());
444                         }
445                         for (idx, node_event) in node_events.iter().enumerate() {
446                                 for event in node_event {
447                                         if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
448                                                 for node in $nodes.iter() {
449                                                         if node.get_our_node_id() == *node_id {
450                                                                 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
451                                                         }
452                                                 }
453                                         } else { panic!("Wrong event type"); }
454                                 }
455                         }
456
457                         for node in $nodes.iter() {
458                                 let events = node.get_and_clear_pending_msg_events();
459                                 for event in events {
460                                         if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
461                                         } else { panic!("Wrong event type"); }
462                                 }
463                         }
464                 } }
465         }
466
467         // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
468         // forwarding.
469         let (node_a, mut monitor_a, keys_manager_a) = make_node!(0);
470         let (node_b, mut monitor_b, keys_manager_b) = make_node!(1);
471         let (node_c, mut monitor_c, keys_manager_c) = make_node!(2);
472
473         let mut nodes = [node_a, node_b, node_c];
474
475         let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
476         let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
477
478         for node in nodes.iter() {
479                 confirm_txn!(node);
480         }
481
482         lock_fundings!(nodes);
483
484         let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
485         let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
486
487         let mut payment_id: u8 = 0;
488
489         let mut chan_a_disconnected = false;
490         let mut chan_b_disconnected = false;
491         let mut ba_events = Vec::new();
492         let mut bc_events = Vec::new();
493
494         let mut node_a_ser = VecWriter(Vec::new());
495         nodes[0].write(&mut node_a_ser).unwrap();
496         let mut node_b_ser = VecWriter(Vec::new());
497         nodes[1].write(&mut node_b_ser).unwrap();
498         let mut node_c_ser = VecWriter(Vec::new());
499         nodes[2].write(&mut node_c_ser).unwrap();
500
501         macro_rules! test_return {
502                 () => { {
503                         assert_eq!(nodes[0].list_channels().len(), 1);
504                         assert_eq!(nodes[1].list_channels().len(), 2);
505                         assert_eq!(nodes[2].list_channels().len(), 1);
506                         return;
507                 } }
508         }
509
510         let mut read_pos = 0;
511         macro_rules! get_slice {
512                 ($len: expr) => {
513                         {
514                                 let slice_len = $len as usize;
515                                 if data.len() < read_pos + slice_len {
516                                         test_return!();
517                                 }
518                                 read_pos += slice_len;
519                                 &data[read_pos - slice_len..read_pos]
520                         }
521                 }
522         }
523
524         loop {
525                 macro_rules! send_payment_with_secret {
526                         ($source: expr, $middle: expr, $dest: expr) => { {
527                                 let payment_hash = Sha256::hash(&[payment_id; 1]);
528                                 payment_id = payment_id.wrapping_add(1);
529                                 let payment_secret = Sha256::hash(&[payment_id; 1]);
530                                 payment_id = payment_id.wrapping_add(1);
531                                 if let Err(err) = $source.send_payment(&Route {
532                                         paths: vec![vec![RouteHop {
533                                                 pubkey: $middle.0.get_our_node_id(),
534                                                 node_features: NodeFeatures::empty(),
535                                                 short_channel_id: $middle.1,
536                                                 channel_features: ChannelFeatures::empty(),
537                                                 fee_msat: 50_000,
538                                                 cltv_expiry_delta: 100,
539                                         },RouteHop {
540                                                 pubkey: $dest.0.get_our_node_id(),
541                                                 node_features: NodeFeatures::empty(),
542                                                 short_channel_id: $dest.1,
543                                                 channel_features: ChannelFeatures::empty(),
544                                                 fee_msat: 10_000_000,
545                                                 cltv_expiry_delta: 200,
546                                         }],vec![RouteHop {
547                                                 pubkey: $middle.0.get_our_node_id(),
548                                                 node_features: NodeFeatures::empty(),
549                                                 short_channel_id: $middle.1,
550                                                 channel_features: ChannelFeatures::empty(),
551                                                 fee_msat: 50_000,
552                                                 cltv_expiry_delta: 100,
553                                         },RouteHop {
554                                                 pubkey: $dest.0.get_our_node_id(),
555                                                 node_features: NodeFeatures::empty(),
556                                                 short_channel_id: $dest.1,
557                                                 channel_features: ChannelFeatures::empty(),
558                                                 fee_msat: 10_000_000,
559                                                 cltv_expiry_delta: 200,
560                                         }]],
561                                 }, PaymentHash(payment_hash.into_inner()), &Some(PaymentSecret(payment_secret.into_inner()))) {
562                                         check_payment_err(err);
563                                 }
564                         } }
565                 }
566
567                 macro_rules! process_msg_events {
568                         ($node: expr, $corrupt_forward: expr) => { {
569                                 let events = if $node == 1 {
570                                         let mut new_events = Vec::new();
571                                         mem::swap(&mut new_events, &mut ba_events);
572                                         new_events.extend_from_slice(&bc_events[..]);
573                                         bc_events.clear();
574                                         new_events
575                                 } else { Vec::new() };
576                                 let mut had_events = false;
577                                 for event in events.iter().chain(nodes[$node].get_and_clear_pending_msg_events().iter()) {
578                                         had_events = true;
579                                         match event {
580                                                 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 } } => {
581                                                         for dest in nodes.iter() {
582                                                                 if dest.get_our_node_id() == *node_id {
583                                                                         assert!(update_fee.is_none());
584                                                                         for update_add in update_add_htlcs {
585                                                                                 if !$corrupt_forward {
586                                                                                         dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &update_add);
587                                                                                 } else {
588                                                                                         // Corrupt the update_add_htlc message so that its HMAC
589                                                                                         // check will fail and we generate a
590                                                                                         // update_fail_malformed_htlc instead of an
591                                                                                         // update_fail_htlc as we do when we reject a payment.
592                                                                                         let mut msg_ser = update_add.encode();
593                                                                                         msg_ser[1000] ^= 0xff;
594                                                                                         let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
595                                                                                         dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
596                                                                                 }
597                                                                         }
598                                                                         for update_fulfill in update_fulfill_htlcs {
599                                                                                 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), &update_fulfill);
600                                                                         }
601                                                                         for update_fail in update_fail_htlcs {
602                                                                                 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), &update_fail);
603                                                                         }
604                                                                         for update_fail_malformed in update_fail_malformed_htlcs {
605                                                                                 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), &update_fail_malformed);
606                                                                         }
607                                                                         dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
608                                                                 }
609                                                         }
610                                                 },
611                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
612                                                         for dest in nodes.iter() {
613                                                                 if dest.get_our_node_id() == *node_id {
614                                                                         dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
615                                                                 }
616                                                         }
617                                                 },
618                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
619                                                         for dest in nodes.iter() {
620                                                                 if dest.get_our_node_id() == *node_id {
621                                                                         dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
622                                                                 }
623                                                         }
624                                                 },
625                                                 events::MessageSendEvent::SendFundingLocked { .. } => {
626                                                         // Can be generated as a reestablish response
627                                                 },
628                                                 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
629                                                         // Can be generated due to a payment forward being rejected due to a
630                                                         // channel having previously failed a monitor update
631                                                 },
632                                                 _ => panic!("Unhandled message event"),
633                                         }
634                                 }
635                                 had_events
636                         } }
637                 }
638
639                 macro_rules! drain_msg_events_on_disconnect {
640                         ($counterparty_id: expr) => { {
641                                 if $counterparty_id == 0 {
642                                         for event in nodes[0].get_and_clear_pending_msg_events() {
643                                                 match event {
644                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
645                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
646                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
647                                                         events::MessageSendEvent::SendFundingLocked { .. } => {},
648                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
649                                                         events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
650                                                         _ => panic!("Unhandled message event"),
651                                                 }
652                                         }
653                                         ba_events.clear();
654                                 } else {
655                                         for event in nodes[2].get_and_clear_pending_msg_events() {
656                                                 match event {
657                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
658                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
659                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
660                                                         events::MessageSendEvent::SendFundingLocked { .. } => {},
661                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
662                                                         events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
663                                                         _ => panic!("Unhandled message event"),
664                                                 }
665                                         }
666                                         bc_events.clear();
667                                 }
668                                 let mut events = nodes[1].get_and_clear_pending_msg_events();
669                                 let drop_node_id = if $counterparty_id == 0 { nodes[0].get_our_node_id() } else { nodes[2].get_our_node_id() };
670                                 let msg_sink = if $counterparty_id == 0 { &mut bc_events } else { &mut ba_events };
671                                 for event in events.drain(..) {
672                                         let push = match event {
673                                                 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
674                                                         if *node_id != drop_node_id { true } else { false }
675                                                 },
676                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
677                                                         if *node_id != drop_node_id { true } else { false }
678                                                 },
679                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
680                                                         if *node_id != drop_node_id { true } else { false }
681                                                 },
682                                                 events::MessageSendEvent::SendFundingLocked { .. } => false,
683                                                 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => false,
684                                                 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => false,
685                                                 _ => panic!("Unhandled message event"),
686                                         };
687                                         if push { msg_sink.push(event); }
688                                 }
689                         } }
690                 }
691
692                 macro_rules! process_events {
693                         ($node: expr, $fail: expr) => { {
694                                 // In case we get 256 payments we may have a hash collision, resulting in the
695                                 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
696                                 // deduplicate the calls here.
697                                 let mut claim_set = HashSet::new();
698                                 let mut events = nodes[$node].get_and_clear_pending_events();
699                                 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
700                                 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
701                                 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
702                                 // PaymentReceived event for the second HTLC in our pending_events (and breaking
703                                 // our claim_set deduplication).
704                                 events.sort_by(|a, b| {
705                                         if let events::Event::PaymentReceived { .. } = a {
706                                                 if let events::Event::PendingHTLCsForwardable { .. } = b {
707                                                         Ordering::Less
708                                                 } else { Ordering::Equal }
709                                         } else if let events::Event::PendingHTLCsForwardable { .. } = a {
710                                                 if let events::Event::PaymentReceived { .. } = b {
711                                                         Ordering::Greater
712                                                 } else { Ordering::Equal }
713                                         } else { Ordering::Equal }
714                                 });
715                                 let had_events = !events.is_empty();
716                                 for event in events.drain(..) {
717                                         match event {
718                                                 events::Event::PaymentReceived { payment_hash, payment_secret, amt } => {
719                                                         if claim_set.insert(payment_hash.0) {
720                                                                 if $fail {
721                                                                         assert!(nodes[$node].fail_htlc_backwards(&payment_hash, &payment_secret));
722                                                                 } else {
723                                                                         assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0), &payment_secret, amt));
724                                                                 }
725                                                         }
726                                                 },
727                                                 events::Event::PaymentSent { .. } => {},
728                                                 events::Event::PaymentFailed { .. } => {},
729                                                 events::Event::PendingHTLCsForwardable { .. } => {
730                                                         nodes[$node].process_pending_htlc_forwards();
731                                                 },
732                                                 _ => panic!("Unhandled event"),
733                                         }
734                                 }
735                                 had_events
736                         } }
737                 }
738
739                 match get_slice!(1)[0] {
740                         // In general, we keep related message groups close together in binary form, allowing
741                         // bit-twiddling mutations to have similar effects. This is probably overkill, but no
742                         // harm in doing so.
743
744                         0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
745                         0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
746                         0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
747                         0x04 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
748                         0x05 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
749                         0x06 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
750
751                         0x08 => {
752                                 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
753                                         nodes[0].channel_monitor_updated(&chan_1_funding, *id);
754                                 }
755                         },
756                         0x09 => {
757                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
758                                         nodes[1].channel_monitor_updated(&chan_1_funding, *id);
759                                 }
760                         },
761                         0x0a => {
762                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
763                                         nodes[1].channel_monitor_updated(&chan_2_funding, *id);
764                                 }
765                         },
766                         0x0b => {
767                                 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
768                                         nodes[2].channel_monitor_updated(&chan_2_funding, *id);
769                                 }
770                         },
771
772                         0x0c => {
773                                 if !chan_a_disconnected {
774                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
775                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
776                                         chan_a_disconnected = true;
777                                         drain_msg_events_on_disconnect!(0);
778                                 }
779                         },
780                         0x0d => {
781                                 if !chan_b_disconnected {
782                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
783                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
784                                         chan_b_disconnected = true;
785                                         drain_msg_events_on_disconnect!(2);
786                                 }
787                         },
788                         0x0e => {
789                                 if chan_a_disconnected {
790                                         nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
791                                         nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
792                                         chan_a_disconnected = false;
793                                 }
794                         },
795                         0x0f => {
796                                 if chan_b_disconnected {
797                                         nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
798                                         nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
799                                         chan_b_disconnected = false;
800                                 }
801                         },
802
803                         0x10 => { process_msg_events!(0, true); },
804                         0x11 => { process_msg_events!(0, false); },
805                         0x12 => { process_events!(0, true); },
806                         0x13 => { process_events!(0, false); },
807                         0x14 => { process_msg_events!(1, true); },
808                         0x15 => { process_msg_events!(1, false); },
809                         0x16 => { process_events!(1, true); },
810                         0x17 => { process_events!(1, false); },
811                         0x18 => { process_msg_events!(2, true); },
812                         0x19 => { process_msg_events!(2, false); },
813                         0x1a => { process_events!(2, true); },
814                         0x1b => { process_events!(2, false); },
815
816                         0x1c => {
817                                 if !chan_a_disconnected {
818                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
819                                         chan_a_disconnected = true;
820                                         drain_msg_events_on_disconnect!(0);
821                                 }
822                                 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a);
823                                 nodes[0] = new_node_a;
824                                 monitor_a = new_monitor_a;
825                         },
826                         0x1d => {
827                                 if !chan_a_disconnected {
828                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
829                                         chan_a_disconnected = true;
830                                         nodes[0].get_and_clear_pending_msg_events();
831                                         ba_events.clear();
832                                 }
833                                 if !chan_b_disconnected {
834                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
835                                         chan_b_disconnected = true;
836                                         nodes[2].get_and_clear_pending_msg_events();
837                                         bc_events.clear();
838                                 }
839                                 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b);
840                                 nodes[1] = new_node_b;
841                                 monitor_b = new_monitor_b;
842                         },
843                         0x1e => {
844                                 if !chan_b_disconnected {
845                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
846                                         chan_b_disconnected = true;
847                                         drain_msg_events_on_disconnect!(2);
848                                 }
849                                 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c);
850                                 nodes[2] = new_node_c;
851                                 monitor_c = new_monitor_c;
852                         },
853
854                         // 1/10th the channel size:
855                         0x20 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id); },
856                         0x21 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id); },
857                         0x22 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id); },
858                         0x23 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id); },
859                         0x24 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id); },
860                         0x25 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id); },
861
862                         0x26 => { send_payment_with_secret!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b)); },
863                         0x27 => { send_payment_with_secret!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a)); },
864
865                         0x28 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id); },
866                         0x29 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id); },
867                         0x2a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id); },
868                         0x2b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id); },
869                         0x2c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id); },
870                         0x2d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id); },
871
872                         0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id); },
873                         0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id); },
874                         0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id); },
875                         0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id); },
876                         0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id); },
877                         0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id); },
878
879                         0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id); },
880                         0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id); },
881                         0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id); },
882                         0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id); },
883                         0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id); },
884                         0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id); },
885
886                         0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id); },
887                         0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id); },
888                         0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id); },
889                         0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id); },
890                         0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id); },
891                         0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id); },
892
893                         0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id); },
894                         0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id); },
895                         0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id); },
896                         0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id); },
897                         0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id); },
898                         0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id); },
899
900                         0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id); },
901                         0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id); },
902                         0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id); },
903                         0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id); },
904                         0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id); },
905                         0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id); },
906
907                         0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id); },
908                         0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id); },
909                         0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id); },
910                         0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id); },
911                         0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
912                         0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },
913
914                         0xff => {
915                                 // Test that no channel is in a stuck state where neither party can send funds even
916                                 // after we resolve all pending events.
917                                 // First make sure there are no pending monitor updates, resetting the error state
918                                 // and calling channel_monitor_updated for each monitor.
919                                 *monitor_a.update_ret.lock().unwrap() = Ok(());
920                                 *monitor_b.update_ret.lock().unwrap() = Ok(());
921                                 *monitor_c.update_ret.lock().unwrap() = Ok(());
922
923                                 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
924                                         nodes[0].channel_monitor_updated(&chan_1_funding, *id);
925                                 }
926                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
927                                         nodes[1].channel_monitor_updated(&chan_1_funding, *id);
928                                 }
929                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
930                                         nodes[1].channel_monitor_updated(&chan_2_funding, *id);
931                                 }
932                                 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
933                                         nodes[2].channel_monitor_updated(&chan_2_funding, *id);
934                                 }
935
936                                 // Next, make sure peers are all connected to each other
937                                 if chan_a_disconnected {
938                                         nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
939                                         nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
940                                         chan_a_disconnected = false;
941                                 }
942                                 if chan_b_disconnected {
943                                         nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
944                                         nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
945                                         chan_b_disconnected = false;
946                                 }
947
948                                 for i in 0..std::usize::MAX {
949                                         if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
950                                         // Then, make sure any current forwards make their way to their destination
951                                         if process_msg_events!(0, false) { continue; }
952                                         if process_msg_events!(1, false) { continue; }
953                                         if process_msg_events!(2, false) { continue; }
954                                         // ...making sure any pending PendingHTLCsForwardable events are handled and
955                                         // payments claimed.
956                                         if process_events!(0, false) { continue; }
957                                         if process_events!(1, false) { continue; }
958                                         if process_events!(2, false) { continue; }
959                                         break;
960                                 }
961
962                                 // Finally, make sure that at least one end of each channel can make a substantial payment.
963                                 assert!(
964                                         send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id) ||
965                                         send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id));
966                                 assert!(
967                                         send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
968                                         send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));
969                         },
970                         _ => test_return!(),
971                 }
972
973                 node_a_ser.0.clear();
974                 nodes[0].write(&mut node_a_ser).unwrap();
975                 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
976                 node_b_ser.0.clear();
977                 nodes[1].write(&mut node_b_ser).unwrap();
978                 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
979                 node_c_ser.0.clear();
980                 nodes[2].write(&mut node_c_ser).unwrap();
981                 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
982         }
983 }
984
985 pub fn chanmon_consistency_test<Out: test_logger::Output>(data: &[u8], out: Out) {
986         do_test(data, out);
987 }
988
989 #[no_mangle]
990 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
991         do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});
992 }