]> git.bitcoin.ninja Git - rust-lightning/blob - fuzz/src/chanmon_consistency.rs
074224e562ecbe59aacc2c97b6c57283f14b0adc
[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::constants::genesis_block;
22 use bitcoin::blockdata::transaction::{Transaction, TxOut};
23 use bitcoin::blockdata::script::{Builder, Script};
24 use bitcoin::blockdata::opcodes;
25 use bitcoin::blockdata::locktime::PackedLockTime;
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::hashes::sha256d::Hash as Sha256dHash;
31 use bitcoin::hash_types::{BlockHash, WPubkeyHash};
32
33 use lightning::chain;
34 use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, chainmonitor, channelmonitor, Confirm, Watch};
35 use lightning::chain::channelmonitor::{ChannelMonitor, MonitorEvent};
36 use lightning::chain::transaction::OutPoint;
37 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
38 use lightning::sign::{KeyMaterial, InMemorySigner, Recipient, EntropySource, NodeSigner, SignerProvider};
39 use lightning::events;
40 use lightning::events::MessageSendEventsProvider;
41 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
42 use lightning::ln::channelmanager::{ChainParameters, ChannelDetails, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs, PaymentId, RecipientOnionFields};
43 use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
44 use lightning::ln::msgs::{self, CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
45 use lightning::ln::script::ShutdownScript;
46 use lightning::ln::functional_test_utils::*;
47 use lightning::offers::invoice::UnsignedBolt12Invoice;
48 use lightning::offers::invoice_request::UnsignedInvoiceRequest;
49 use lightning::util::test_channel_signer::{TestChannelSigner, EnforcementState};
50 use lightning::util::errors::APIError;
51 use lightning::util::logger::Logger;
52 use lightning::util::config::UserConfig;
53 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
54 use lightning::routing::router::{InFlightHtlcs, Path, Route, RouteHop, RouteParameters, Router};
55
56 use crate::utils::test_logger::{self, Output};
57 use crate::utils::test_persister::TestPersister;
58
59 use bitcoin::secp256k1::{Message, PublicKey, SecretKey, Scalar, Secp256k1};
60 use bitcoin::secp256k1::ecdh::SharedSecret;
61 use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
62 use bitcoin::secp256k1::schnorr;
63
64 use std::mem;
65 use std::cmp::{self, Ordering};
66 use hashbrown::{HashSet, hash_map, HashMap};
67 use std::sync::{Arc,Mutex};
68 use std::sync::atomic;
69 use std::io::Cursor;
70 use bitcoin::bech32::u5;
71
72 const MAX_FEE: u32 = 10_000;
73 struct FuzzEstimator {
74         ret_val: atomic::AtomicU32,
75 }
76 impl FeeEstimator for FuzzEstimator {
77         fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
78                 // We force-close channels if our counterparty sends us a feerate which is a small multiple
79                 // of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
80                 // always return a HighPriority feerate here which is >= the maximum Normal feerate and a
81                 // Background feerate which is <= the minimum Normal feerate.
82                 match conf_target {
83                         ConfirmationTarget::OnChainSweep => MAX_FEE,
84                         ConfirmationTarget::ChannelCloseMinimum|ConfirmationTarget::AnchorChannelFee|ConfirmationTarget::MinAllowedAnchorChannelRemoteFee|ConfirmationTarget::MinAllowedNonAnchorChannelRemoteFee => 253,
85                         ConfirmationTarget::NonAnchorChannelFee => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
86                 }
87         }
88 }
89
90 struct FuzzRouter {}
91
92 impl Router for FuzzRouter {
93         fn find_route(
94                 &self, _payer: &PublicKey, _params: &RouteParameters, _first_hops: Option<&[&ChannelDetails]>,
95                 _inflight_htlcs: InFlightHtlcs
96         ) -> Result<Route, msgs::LightningError> {
97                 Err(msgs::LightningError {
98                         err: String::from("Not implemented"),
99                         action: msgs::ErrorAction::IgnoreError
100                 })
101         }
102 }
103
104 pub struct TestBroadcaster {}
105 impl BroadcasterInterface for TestBroadcaster {
106         fn broadcast_transactions(&self, _txs: &[&Transaction]) { }
107 }
108
109 pub struct VecWriter(pub Vec<u8>);
110 impl Writer for VecWriter {
111         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
112                 self.0.extend_from_slice(buf);
113                 Ok(())
114         }
115 }
116
117 struct TestChainMonitor {
118         pub logger: Arc<dyn Logger>,
119         pub keys: Arc<KeyProvider>,
120         pub persister: Arc<TestPersister>,
121         pub chain_monitor: Arc<chainmonitor::ChainMonitor<TestChannelSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
122         // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
123         // logic will automatically force-close our channels for us (as we don't have an up-to-date
124         // monitor implying we are not able to punish misbehaving counterparties). Because this test
125         // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
126         // fully-serialized monitor state here, as well as the corresponding update_id.
127         pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
128 }
129 impl TestChainMonitor {
130         pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>, keys: Arc<KeyProvider>) -> Self {
131                 Self {
132                         chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, Arc::clone(&persister))),
133                         logger,
134                         keys,
135                         persister,
136                         latest_monitors: Mutex::new(HashMap::new()),
137                 }
138         }
139 }
140 impl chain::Watch<TestChannelSigner> for TestChainMonitor {
141         fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<TestChannelSigner>) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
142                 let mut ser = VecWriter(Vec::new());
143                 monitor.write(&mut ser).unwrap();
144                 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
145                         panic!("Already had monitor pre-watch_channel");
146                 }
147                 self.chain_monitor.watch_channel(funding_txo, monitor)
148         }
149
150         fn update_channel(&self, funding_txo: OutPoint, update: &channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
151                 let mut map_lock = self.latest_monitors.lock().unwrap();
152                 let mut map_entry = match map_lock.entry(funding_txo) {
153                         hash_map::Entry::Occupied(entry) => entry,
154                         hash_map::Entry::Vacant(_) => panic!("Didn't have monitor on update call"),
155                 };
156                 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::
157                         read(&mut Cursor::new(&map_entry.get().1), (&*self.keys, &*self.keys)).unwrap().1;
158                 deserialized_monitor.update_monitor(update, &&TestBroadcaster{}, &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
159                 let mut ser = VecWriter(Vec::new());
160                 deserialized_monitor.write(&mut ser).unwrap();
161                 map_entry.insert((update.update_id, ser.0));
162                 self.chain_monitor.update_channel(funding_txo, update)
163         }
164
165         fn release_pending_monitor_events(&self) -> Vec<(OutPoint, Vec<MonitorEvent>, Option<PublicKey>)> {
166                 return self.chain_monitor.release_pending_monitor_events();
167         }
168 }
169
170 struct KeyProvider {
171         node_secret: SecretKey,
172         rand_bytes_id: atomic::AtomicU32,
173         enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
174 }
175
176 impl EntropySource for KeyProvider {
177         fn get_secure_random_bytes(&self) -> [u8; 32] {
178                 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
179                 let mut res = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 11, self.node_secret[31]];
180                 res[30-4..30].copy_from_slice(&id.to_le_bytes());
181                 res
182         }
183 }
184
185 impl NodeSigner for KeyProvider {
186         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
187                 let node_secret = match recipient {
188                         Recipient::Node => Ok(&self.node_secret),
189                         Recipient::PhantomNode => Err(())
190                 }?;
191                 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
192         }
193
194         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
195                 let mut node_secret = match recipient {
196                         Recipient::Node => Ok(self.node_secret.clone()),
197                         Recipient::PhantomNode => Err(())
198                 }?;
199                 if let Some(tweak) = tweak {
200                         node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
201                 }
202                 Ok(SharedSecret::new(other_key, &node_secret))
203         }
204
205         fn get_inbound_payment_key_material(&self) -> KeyMaterial {
206                 KeyMaterial([0, 0, 0, 0, 0, 0, 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_secret[31]])
207         }
208
209         fn sign_invoice(&self, _hrp_bytes: &[u8], _invoice_data: &[u5], _recipient: Recipient) -> Result<RecoverableSignature, ()> {
210                 unreachable!()
211         }
212
213         fn sign_bolt12_invoice_request(
214                 &self, _invoice_request: &UnsignedInvoiceRequest
215         ) -> Result<schnorr::Signature, ()> {
216                 unreachable!()
217         }
218
219         fn sign_bolt12_invoice(
220                 &self, _invoice: &UnsignedBolt12Invoice,
221         ) -> Result<schnorr::Signature, ()> {
222                 unreachable!()
223         }
224
225         fn sign_gossip_message(&self, msg: lightning::ln::msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
226                 let msg_hash = Message::from_slice(&Sha256dHash::hash(&msg.encode()[..])[..]).map_err(|_| ())?;
227                 let secp_ctx = Secp256k1::signing_only();
228                 Ok(secp_ctx.sign_ecdsa(&msg_hash, &self.node_secret))
229         }
230 }
231
232 impl SignerProvider for KeyProvider {
233         type Signer = TestChannelSigner;
234
235         fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] {
236                 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed) as u8;
237                 [id; 32]
238         }
239
240         fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> Self::Signer {
241                 let secp_ctx = Secp256k1::signing_only();
242                 let id = channel_keys_id[0];
243                 let keys = InMemorySigner::new(
244                         &secp_ctx,
245                         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_secret[31]]).unwrap(),
246                         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_secret[31]]).unwrap(),
247                         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_secret[31]]).unwrap(),
248                         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_secret[31]]).unwrap(),
249                         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_secret[31]]).unwrap(),
250                         [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_secret[31]],
251                         channel_value_satoshis,
252                         channel_keys_id,
253                         channel_keys_id,
254                 );
255                 let revoked_commitment = self.make_enforcement_state_cell(keys.commitment_seed);
256                 TestChannelSigner::new_with_revoked(keys, revoked_commitment, false)
257         }
258
259         fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, DecodeError> {
260                 let mut reader = std::io::Cursor::new(buffer);
261
262                 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
263                 let state = self.make_enforcement_state_cell(inner.commitment_seed);
264
265                 Ok(TestChannelSigner {
266                         inner,
267                         state,
268                         disable_revocation_policy_check: false,
269                 })
270         }
271
272         fn get_destination_script(&self) -> Result<Script, ()> {
273                 let secp_ctx = Secp256k1::signing_only();
274                 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_secret[31]]).unwrap();
275                 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
276                 Ok(Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script())
277         }
278
279         fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
280                 let secp_ctx = Secp256k1::signing_only();
281                 let secret_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, 3, self.node_secret[31]]).unwrap();
282                 let pubkey_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &secret_key).serialize());
283                 Ok(ShutdownScript::new_p2wpkh(&pubkey_hash))
284         }
285 }
286
287 impl KeyProvider {
288         fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
289                 let mut revoked_commitments = self.enforcement_states.lock().unwrap();
290                 if !revoked_commitments.contains_key(&commitment_seed) {
291                         revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(EnforcementState::new())));
292                 }
293                 let cell = revoked_commitments.get(&commitment_seed).unwrap();
294                 Arc::clone(cell)
295         }
296 }
297
298 #[inline]
299 fn check_api_err(api_err: APIError, sendable_bounds_violated: bool) {
300         match api_err {
301                 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
302                 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
303                 APIError::InvalidRoute { .. } => panic!("Our routes should work"),
304                 APIError::ChannelUnavailable { err } => {
305                         // Test the error against a list of errors we can hit, and reject
306                         // all others. If you hit this panic, the list of acceptable errors
307                         // is probably just stale and you should add new messages here.
308                         match err.as_str() {
309                                 "Peer for first hop currently disconnected" => {},
310                                 _ if err.starts_with("Cannot send less than our next-HTLC minimum - ") => {},
311                                 _ if err.starts_with("Cannot send more than our next-HTLC maximum - ") => {},
312                                 _ => panic!("{}", err),
313                         }
314                         assert!(sendable_bounds_violated);
315                 },
316                 APIError::MonitorUpdateInProgress => {
317                         // We can (obviously) temp-fail a monitor update
318                 },
319                 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
320         }
321 }
322 #[inline]
323 fn check_payment_err(send_err: PaymentSendFailure, sendable_bounds_violated: bool) {
324         match send_err {
325                 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err, sendable_bounds_violated),
326                 PaymentSendFailure::PathParameterError(per_path_results) => {
327                         for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err, sendable_bounds_violated); } }
328                 },
329                 PaymentSendFailure::AllFailedResendSafe(per_path_results) => {
330                         for api_err in per_path_results { check_api_err(api_err, sendable_bounds_violated); }
331                 },
332                 PaymentSendFailure::PartialFailure { results, .. } => {
333                         for res in results { if let Err(api_err) = res { check_api_err(api_err, sendable_bounds_violated); } }
334                 },
335                 PaymentSendFailure::DuplicatePayment => panic!(),
336         }
337 }
338
339 type ChanMan<'a> = ChannelManager<Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<KeyProvider>, Arc<KeyProvider>, Arc<FuzzEstimator>, &'a FuzzRouter, Arc<dyn Logger>>;
340
341 #[inline]
342 fn get_payment_secret_hash(dest: &ChanMan, payment_id: &mut u8) -> Option<(PaymentSecret, PaymentHash)> {
343         let mut payment_hash;
344         for _ in 0..256 {
345                 payment_hash = PaymentHash(Sha256::hash(&[*payment_id; 1]).into_inner());
346                 if let Ok(payment_secret) = dest.create_inbound_payment_for_hash(payment_hash, None, 3600, None) {
347                         return Some((payment_secret, payment_hash));
348                 }
349                 *payment_id = payment_id.wrapping_add(1);
350         }
351         None
352 }
353
354 #[inline]
355 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8, payment_idx: &mut u64) -> bool {
356         let (payment_secret, payment_hash) =
357                 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
358         let mut payment_id = [0; 32];
359         payment_id[0..8].copy_from_slice(&payment_idx.to_ne_bytes());
360         *payment_idx += 1;
361         let (min_value_sendable, max_value_sendable) = source.list_usable_channels()
362                 .iter().find(|chan| chan.short_channel_id == Some(dest_chan_id))
363                 .map(|chan|
364                         (chan.next_outbound_htlc_minimum_msat, chan.next_outbound_htlc_limit_msat))
365                 .unwrap_or((0, 0));
366         if let Err(err) = source.send_payment_with_route(&Route {
367                 paths: vec![Path { hops: vec![RouteHop {
368                         pubkey: dest.get_our_node_id(),
369                         node_features: dest.node_features(),
370                         short_channel_id: dest_chan_id,
371                         channel_features: dest.channel_features(),
372                         fee_msat: amt,
373                         cltv_expiry_delta: 200,
374                         maybe_announced_channel: true,
375                 }], blinded_tail: None }],
376                 route_params: None,
377         }, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
378                 check_payment_err(err, amt > max_value_sendable || amt < min_value_sendable);
379                 false
380         } else {
381                 // Note that while the max is a strict upper-bound, we can occasionally send substantially
382                 // below the minimum, with some gap which is unusable immediately below the minimum. Thus,
383                 // we don't check against min_value_sendable here.
384                 assert!(amt <= max_value_sendable);
385                 true
386         }
387 }
388 #[inline]
389 fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8, payment_idx: &mut u64) -> bool {
390         let (payment_secret, payment_hash) =
391                 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
392         let mut payment_id = [0; 32];
393         payment_id[0..8].copy_from_slice(&payment_idx.to_ne_bytes());
394         *payment_idx += 1;
395         let (min_value_sendable, max_value_sendable) = source.list_usable_channels()
396                 .iter().find(|chan| chan.short_channel_id == Some(middle_chan_id))
397                 .map(|chan|
398                         (chan.next_outbound_htlc_minimum_msat, chan.next_outbound_htlc_limit_msat))
399                 .unwrap_or((0, 0));
400         let first_hop_fee = 50_000;
401         if let Err(err) = source.send_payment_with_route(&Route {
402                 paths: vec![Path { hops: vec![RouteHop {
403                         pubkey: middle.get_our_node_id(),
404                         node_features: middle.node_features(),
405                         short_channel_id: middle_chan_id,
406                         channel_features: middle.channel_features(),
407                         fee_msat: first_hop_fee,
408                         cltv_expiry_delta: 100,
409                         maybe_announced_channel: true,
410                 }, RouteHop {
411                         pubkey: dest.get_our_node_id(),
412                         node_features: dest.node_features(),
413                         short_channel_id: dest_chan_id,
414                         channel_features: dest.channel_features(),
415                         fee_msat: amt,
416                         cltv_expiry_delta: 200,
417                         maybe_announced_channel: true,
418                 }], blinded_tail: None }],
419                 route_params: None,
420         }, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
421                 let sent_amt = amt + first_hop_fee;
422                 check_payment_err(err, sent_amt < min_value_sendable || sent_amt > max_value_sendable);
423                 false
424         } else {
425                 // Note that while the max is a strict upper-bound, we can occasionally send substantially
426                 // below the minimum, with some gap which is unusable immediately below the minimum. Thus,
427                 // we don't check against min_value_sendable here.
428                 assert!(amt + first_hop_fee <= max_value_sendable);
429                 true
430         }
431 }
432
433 #[inline]
434 pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out, anchors: bool) {
435         let out = SearchingOutput::new(underlying_out);
436         let broadcast = Arc::new(TestBroadcaster{});
437         let router = FuzzRouter {};
438
439         macro_rules! make_node {
440                 ($node_id: expr, $fee_estimator: expr) => { {
441                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
442                         let node_secret = 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, $node_id]).unwrap();
443                         let keys_manager = Arc::new(KeyProvider { node_secret, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
444                         let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
445                                 Arc::new(TestPersister {
446                                         update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
447                                 }), Arc::clone(&keys_manager)));
448
449                         let mut config = UserConfig::default();
450                         config.channel_config.forwarding_fee_proportional_millionths = 0;
451                         config.channel_handshake_config.announced_channel = true;
452                         if anchors {
453                                 config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
454                                 config.manually_accept_inbound_channels = true;
455                         }
456                         let network = Network::Bitcoin;
457                         let best_block_timestamp = genesis_block(network).header.time;
458                         let params = ChainParameters {
459                                 network,
460                                 best_block: BestBlock::from_network(network),
461                         };
462                         (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), &router, Arc::clone(&logger), keys_manager.clone(), keys_manager.clone(), keys_manager.clone(), config, params, best_block_timestamp),
463                         monitor, keys_manager)
464                 } }
465         }
466
467         macro_rules! reload_node {
468                 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
469                     let keys_manager = Arc::clone(& $keys_manager);
470                         let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
471                         let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
472                                 Arc::new(TestPersister {
473                                         update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
474                                 }), Arc::clone(& $keys_manager)));
475
476                         let mut config = UserConfig::default();
477                         config.channel_config.forwarding_fee_proportional_millionths = 0;
478                         config.channel_handshake_config.announced_channel = true;
479                         if anchors {
480                                 config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
481                                 config.manually_accept_inbound_channels = true;
482                         }
483
484                         let mut monitors = HashMap::new();
485                         let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
486                         for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
487                                 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(&mut Cursor::new(&monitor_ser), (&*$keys_manager, &*$keys_manager)).expect("Failed to read monitor").1);
488                                 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
489                         }
490                         let mut monitor_refs = HashMap::new();
491                         for (outpoint, monitor) in monitors.iter_mut() {
492                                 monitor_refs.insert(*outpoint, monitor);
493                         }
494
495                         let read_args = ChannelManagerReadArgs {
496                                 entropy_source: keys_manager.clone(),
497                                 node_signer: keys_manager.clone(),
498                                 signer_provider: keys_manager.clone(),
499                                 fee_estimator: $fee_estimator.clone(),
500                                 chain_monitor: chain_monitor.clone(),
501                                 tx_broadcaster: broadcast.clone(),
502                                 router: &router,
503                                 logger,
504                                 default_config: config,
505                                 channel_monitors: monitor_refs,
506                         };
507
508                         let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
509                         for (funding_txo, mon) in monitors.drain() {
510                                 assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
511                                         Ok(ChannelMonitorUpdateStatus::Completed));
512                         }
513                         res
514                 } }
515         }
516
517         let mut channel_txn = Vec::new();
518         macro_rules! make_channel {
519                 ($source: expr, $dest: expr, $dest_keys_manager: expr, $chan_id: expr) => { {
520                         $source.peer_connected(&$dest.get_our_node_id(), &Init {
521                                 features: $dest.init_features(), networks: None, remote_network_address: None
522                         }, true).unwrap();
523                         $dest.peer_connected(&$source.get_our_node_id(), &Init {
524                                 features: $source.init_features(), networks: None, remote_network_address: None
525                         }, false).unwrap();
526
527                         $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
528                         let open_channel = {
529                                 let events = $source.get_and_clear_pending_msg_events();
530                                 assert_eq!(events.len(), 1);
531                                 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
532                                         msg.clone()
533                                 } else { panic!("Wrong event type"); }
534                         };
535
536                         $dest.handle_open_channel(&$source.get_our_node_id(), &open_channel);
537                         let accept_channel = {
538                                 if anchors {
539                                         let events = $dest.get_and_clear_pending_events();
540                                         assert_eq!(events.len(), 1);
541                                         if let events::Event::OpenChannelRequest {
542                                                 ref temporary_channel_id, ref counterparty_node_id, ..
543                                         } = events[0] {
544                                                 let mut random_bytes = [0u8; 16];
545                                                 random_bytes.copy_from_slice(&$dest_keys_manager.get_secure_random_bytes()[..16]);
546                                                 let user_channel_id = u128::from_be_bytes(random_bytes);
547                                                 $dest.accept_inbound_channel(
548                                                         temporary_channel_id,
549                                                         counterparty_node_id,
550                                                         user_channel_id,
551                                                 ).unwrap();
552                                         } else { panic!("Wrong event type"); }
553                                 }
554                                 let events = $dest.get_and_clear_pending_msg_events();
555                                 assert_eq!(events.len(), 1);
556                                 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
557                                         msg.clone()
558                                 } else { panic!("Wrong event type"); }
559                         };
560
561                         $source.handle_accept_channel(&$dest.get_our_node_id(), &accept_channel);
562                         let funding_output;
563                         {
564                                 let events = $source.get_and_clear_pending_events();
565                                 assert_eq!(events.len(), 1);
566                                 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
567                                         let tx = Transaction { version: $chan_id, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
568                                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
569                                         }]};
570                                         funding_output = OutPoint { txid: tx.txid(), index: 0 };
571                                         $source.funding_transaction_generated(&temporary_channel_id, &$dest.get_our_node_id(), tx.clone()).unwrap();
572                                         channel_txn.push(tx);
573                                 } else { panic!("Wrong event type"); }
574                         }
575
576                         let funding_created = {
577                                 let events = $source.get_and_clear_pending_msg_events();
578                                 assert_eq!(events.len(), 1);
579                                 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
580                                         msg.clone()
581                                 } else { panic!("Wrong event type"); }
582                         };
583                         $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
584
585                         let funding_signed = {
586                                 let events = $dest.get_and_clear_pending_msg_events();
587                                 assert_eq!(events.len(), 1);
588                                 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
589                                         msg.clone()
590                                 } else { panic!("Wrong event type"); }
591                         };
592                         let events = $dest.get_and_clear_pending_events();
593                         assert_eq!(events.len(), 1);
594                         if let events::Event::ChannelPending{ ref counterparty_node_id, .. } = events[0] {
595                                 assert_eq!(counterparty_node_id, &$source.get_our_node_id());
596                         } else { panic!("Wrong event type"); }
597
598                         $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
599                         let events = $source.get_and_clear_pending_events();
600                         assert_eq!(events.len(), 1);
601                         if let events::Event::ChannelPending{ ref counterparty_node_id, .. } = events[0] {
602                                 assert_eq!(counterparty_node_id, &$dest.get_our_node_id());
603                         } else { panic!("Wrong event type"); }
604
605                         funding_output
606                 } }
607         }
608
609         macro_rules! confirm_txn {
610                 ($node: expr) => { {
611                         let chain_hash = genesis_block(Network::Bitcoin).block_hash();
612                         let mut header = create_dummy_header(chain_hash, 42);
613                         let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
614                         $node.transactions_confirmed(&header, &txdata, 1);
615                         for _ in 2..100 {
616                                 header = create_dummy_header(header.block_hash(), 42);
617                         }
618                         $node.best_block_updated(&header, 99);
619                 } }
620         }
621
622         macro_rules! lock_fundings {
623                 ($nodes: expr) => { {
624                         let mut node_events = Vec::new();
625                         for node in $nodes.iter() {
626                                 node_events.push(node.get_and_clear_pending_msg_events());
627                         }
628                         for (idx, node_event) in node_events.iter().enumerate() {
629                                 for event in node_event {
630                                         if let events::MessageSendEvent::SendChannelReady { ref node_id, ref msg } = event {
631                                                 for node in $nodes.iter() {
632                                                         if node.get_our_node_id() == *node_id {
633                                                                 node.handle_channel_ready(&$nodes[idx].get_our_node_id(), msg);
634                                                         }
635                                                 }
636                                         } else { panic!("Wrong event type"); }
637                                 }
638                         }
639
640                         for node in $nodes.iter() {
641                                 let events = node.get_and_clear_pending_msg_events();
642                                 for event in events {
643                                         if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
644                                         } else { panic!("Wrong event type"); }
645                                 }
646                         }
647                 } }
648         }
649
650         let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
651         let mut last_htlc_clear_fee_a =  253;
652         let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
653         let mut last_htlc_clear_fee_b =  253;
654         let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
655         let mut last_htlc_clear_fee_c =  253;
656
657         // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
658         // forwarding.
659         let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
660         let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
661         let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);
662
663         let mut nodes = [node_a, node_b, node_c];
664
665         let chan_1_funding = make_channel!(nodes[0], nodes[1], keys_manager_b, 0);
666         let chan_2_funding = make_channel!(nodes[1], nodes[2], keys_manager_c, 1);
667
668         for node in nodes.iter() {
669                 confirm_txn!(node);
670         }
671
672         lock_fundings!(nodes);
673
674         let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
675         let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
676
677         let mut payment_id: u8 = 0;
678         let mut payment_idx: u64 = 0;
679
680         let mut chan_a_disconnected = false;
681         let mut chan_b_disconnected = false;
682         let mut ab_events = Vec::new();
683         let mut ba_events = Vec::new();
684         let mut bc_events = Vec::new();
685         let mut cb_events = Vec::new();
686
687         let mut node_a_ser = VecWriter(Vec::new());
688         nodes[0].write(&mut node_a_ser).unwrap();
689         let mut node_b_ser = VecWriter(Vec::new());
690         nodes[1].write(&mut node_b_ser).unwrap();
691         let mut node_c_ser = VecWriter(Vec::new());
692         nodes[2].write(&mut node_c_ser).unwrap();
693
694         macro_rules! test_return {
695                 () => { {
696                         assert_eq!(nodes[0].list_channels().len(), 1);
697                         assert_eq!(nodes[1].list_channels().len(), 2);
698                         assert_eq!(nodes[2].list_channels().len(), 1);
699                         return;
700                 } }
701         }
702
703         let mut read_pos = 0;
704         macro_rules! get_slice {
705                 ($len: expr) => {
706                         {
707                                 let slice_len = $len as usize;
708                                 if data.len() < read_pos + slice_len {
709                                         test_return!();
710                                 }
711                                 read_pos += slice_len;
712                                 &data[read_pos - slice_len..read_pos]
713                         }
714                 }
715         }
716
717         loop {
718                 // Push any events from Node B onto ba_events and bc_events
719                 macro_rules! push_excess_b_events {
720                         ($excess_events: expr, $expect_drop_node: expr) => { {
721                                 let a_id = nodes[0].get_our_node_id();
722                                 let expect_drop_node: Option<usize> = $expect_drop_node;
723                                 let expect_drop_id = if let Some(id) = expect_drop_node { Some(nodes[id].get_our_node_id()) } else { None };
724                                 for event in $excess_events {
725                                         let push_a = match event {
726                                                 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
727                                                         if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
728                                                         *node_id == a_id
729                                                 },
730                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
731                                                         if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
732                                                         *node_id == a_id
733                                                 },
734                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
735                                                         if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
736                                                         *node_id == a_id
737                                                 },
738                                                 events::MessageSendEvent::SendChannelReady { .. } => continue,
739                                                 events::MessageSendEvent::SendAnnouncementSignatures { .. } => continue,
740                                                 events::MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
741                                                         assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
742                                                         if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
743                                                         *node_id == a_id
744                                                 },
745                                                 _ => panic!("Unhandled message event {:?}", event),
746                                         };
747                                         if push_a { ba_events.push(event); } else { bc_events.push(event); }
748                                 }
749                         } }
750                 }
751
752                 // While delivering messages, we select across three possible message selection processes
753                 // to ensure we get as much coverage as possible. See the individual enum variants for more
754                 // details.
755                 #[derive(PartialEq)]
756                 enum ProcessMessages {
757                         /// Deliver all available messages, including fetching any new messages from
758                         /// `get_and_clear_pending_msg_events()` (which may have side effects).
759                         AllMessages,
760                         /// Call `get_and_clear_pending_msg_events()` first, and then deliver up to one
761                         /// message (which may already be queued).
762                         OneMessage,
763                         /// Deliver up to one already-queued message. This avoids any potential side-effects
764                         /// of `get_and_clear_pending_msg_events()` (eg freeing the HTLC holding cell), which
765                         /// provides potentially more coverage.
766                         OnePendingMessage,
767                 }
768
769                 macro_rules! process_msg_events {
770                         ($node: expr, $corrupt_forward: expr, $limit_events: expr) => { {
771                                 let mut events = if $node == 1 {
772                                         let mut new_events = Vec::new();
773                                         mem::swap(&mut new_events, &mut ba_events);
774                                         new_events.extend_from_slice(&bc_events[..]);
775                                         bc_events.clear();
776                                         new_events
777                                 } else if $node == 0 {
778                                         let mut new_events = Vec::new();
779                                         mem::swap(&mut new_events, &mut ab_events);
780                                         new_events
781                                 } else {
782                                         let mut new_events = Vec::new();
783                                         mem::swap(&mut new_events, &mut cb_events);
784                                         new_events
785                                 };
786                                 let mut new_events = Vec::new();
787                                 if $limit_events != ProcessMessages::OnePendingMessage {
788                                         new_events = nodes[$node].get_and_clear_pending_msg_events();
789                                 }
790                                 let mut had_events = false;
791                                 let mut events_iter = events.drain(..).chain(new_events.drain(..));
792                                 let mut extra_ev = None;
793                                 for event in &mut events_iter {
794                                         had_events = true;
795                                         match event {
796                                                 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
797                                                         for (idx, dest) in nodes.iter().enumerate() {
798                                                                 if dest.get_our_node_id() == node_id {
799                                                                         for update_add in update_add_htlcs.iter() {
800                                                                                 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
801                                                                                 if !$corrupt_forward {
802                                                                                         dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
803                                                                                 } else {
804                                                                                         // Corrupt the update_add_htlc message so that its HMAC
805                                                                                         // check will fail and we generate a
806                                                                                         // update_fail_malformed_htlc instead of an
807                                                                                         // update_fail_htlc as we do when we reject a payment.
808                                                                                         let mut msg_ser = update_add.encode();
809                                                                                         msg_ser[1000] ^= 0xff;
810                                                                                         let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
811                                                                                         dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
812                                                                                 }
813                                                                         }
814                                                                         for update_fulfill in update_fulfill_htlcs.iter() {
815                                                                                 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
816                                                                                 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
817                                                                         }
818                                                                         for update_fail in update_fail_htlcs.iter() {
819                                                                                 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
820                                                                                 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
821                                                                         }
822                                                                         for update_fail_malformed in update_fail_malformed_htlcs.iter() {
823                                                                                 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
824                                                                                 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
825                                                                         }
826                                                                         if let Some(msg) = update_fee {
827                                                                                 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
828                                                                                 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
829                                                                         }
830                                                                         let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
831                                                                                 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
832                                                                         if $limit_events != ProcessMessages::AllMessages && processed_change {
833                                                                                 // If we only want to process some messages, don't deliver the CS until later.
834                                                                                 extra_ev = Some(events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate {
835                                                                                         update_add_htlcs: Vec::new(),
836                                                                                         update_fail_htlcs: Vec::new(),
837                                                                                         update_fulfill_htlcs: Vec::new(),
838                                                                                         update_fail_malformed_htlcs: Vec::new(),
839                                                                                         update_fee: None,
840                                                                                         commitment_signed
841                                                                                 } });
842                                                                                 break;
843                                                                         }
844                                                                         out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
845                                                                         dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
846                                                                         break;
847                                                                 }
848                                                         }
849                                                 },
850                                                 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
851                                                         for (idx, dest) in nodes.iter().enumerate() {
852                                                                 if dest.get_our_node_id() == *node_id {
853                                                                         out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
854                                                                         dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
855                                                                 }
856                                                         }
857                                                 },
858                                                 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
859                                                         for (idx, dest) in nodes.iter().enumerate() {
860                                                                 if dest.get_our_node_id() == *node_id {
861                                                                         out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
862                                                                         dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
863                                                                 }
864                                                         }
865                                                 },
866                                                 events::MessageSendEvent::SendChannelReady { .. } => {
867                                                         // Can be generated as a reestablish response
868                                                 },
869                                                 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {
870                                                         // Can be generated as a reestablish response
871                                                 },
872                                                 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
873                                                         // When we reconnect we will resend a channel_update to make sure our
874                                                         // counterparty has the latest parameters for receiving payments
875                                                         // through us. We do, however, check that the message does not include
876                                                         // the "disabled" bit, as we should never ever have a channel which is
877                                                         // disabled when we send such an update (or it may indicate channel
878                                                         // force-close which we should detect as an error).
879                                                         assert_eq!(msg.contents.flags & 2, 0);
880                                                 },
881                                                 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
882                                                         return;
883                                                 } else {
884                                                         panic!("Unhandled message event {:?}", event)
885                                                 },
886                                         }
887                                         if $limit_events != ProcessMessages::AllMessages {
888                                                 break;
889                                         }
890                                 }
891                                 if $node == 1 {
892                                         push_excess_b_events!(extra_ev.into_iter().chain(events_iter), None);
893                                 } else if $node == 0 {
894                                         if let Some(ev) = extra_ev { ab_events.push(ev); }
895                                         for event in events_iter { ab_events.push(event); }
896                                 } else {
897                                         if let Some(ev) = extra_ev { cb_events.push(ev); }
898                                         for event in events_iter { cb_events.push(event); }
899                                 }
900                                 had_events
901                         } }
902                 }
903
904                 macro_rules! drain_msg_events_on_disconnect {
905                         ($counterparty_id: expr) => { {
906                                 if $counterparty_id == 0 {
907                                         for event in nodes[0].get_and_clear_pending_msg_events() {
908                                                 match event {
909                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
910                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
911                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
912                                                         events::MessageSendEvent::SendChannelReady { .. } => {},
913                                                         events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
914                                                         events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
915                                                                 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
916                                                         },
917                                                         _ => if out.may_fail.load(atomic::Ordering::Acquire) {
918                                                                 return;
919                                                         } else {
920                                                                 panic!("Unhandled message event")
921                                                         },
922                                                 }
923                                         }
924                                         push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(0));
925                                         ab_events.clear();
926                                         ba_events.clear();
927                                 } else {
928                                         for event in nodes[2].get_and_clear_pending_msg_events() {
929                                                 match event {
930                                                         events::MessageSendEvent::UpdateHTLCs { .. } => {},
931                                                         events::MessageSendEvent::SendRevokeAndACK { .. } => {},
932                                                         events::MessageSendEvent::SendChannelReestablish { .. } => {},
933                                                         events::MessageSendEvent::SendChannelReady { .. } => {},
934                                                         events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
935                                                         events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
936                                                                 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
937                                                         },
938                                                         _ => if out.may_fail.load(atomic::Ordering::Acquire) {
939                                                                 return;
940                                                         } else {
941                                                                 panic!("Unhandled message event")
942                                                         },
943                                                 }
944                                         }
945                                         push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(2));
946                                         bc_events.clear();
947                                         cb_events.clear();
948                                 }
949                         } }
950                 }
951
952                 macro_rules! process_events {
953                         ($node: expr, $fail: expr) => { {
954                                 // In case we get 256 payments we may have a hash collision, resulting in the
955                                 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
956                                 // deduplicate the calls here.
957                                 let mut claim_set = HashSet::new();
958                                 let mut events = nodes[$node].get_and_clear_pending_events();
959                                 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
960                                 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
961                                 // PaymentClaimable, claiming/failing two HTLCs, but leaving a just-generated
962                                 // PaymentClaimable event for the second HTLC in our pending_events (and breaking
963                                 // our claim_set deduplication).
964                                 events.sort_by(|a, b| {
965                                         if let events::Event::PaymentClaimable { .. } = a {
966                                                 if let events::Event::PendingHTLCsForwardable { .. } = b {
967                                                         Ordering::Less
968                                                 } else { Ordering::Equal }
969                                         } else if let events::Event::PendingHTLCsForwardable { .. } = a {
970                                                 if let events::Event::PaymentClaimable { .. } = b {
971                                                         Ordering::Greater
972                                                 } else { Ordering::Equal }
973                                         } else { Ordering::Equal }
974                                 });
975                                 let had_events = !events.is_empty();
976                                 for event in events.drain(..) {
977                                         match event {
978                                                 events::Event::PaymentClaimable { payment_hash, .. } => {
979                                                         if claim_set.insert(payment_hash.0) {
980                                                                 if $fail {
981                                                                         nodes[$node].fail_htlc_backwards(&payment_hash);
982                                                                 } else {
983                                                                         nodes[$node].claim_funds(PaymentPreimage(payment_hash.0));
984                                                                 }
985                                                         }
986                                                 },
987                                                 events::Event::PaymentSent { .. } => {},
988                                                 events::Event::PaymentClaimed { .. } => {},
989                                                 events::Event::PaymentPathSuccessful { .. } => {},
990                                                 events::Event::PaymentPathFailed { .. } => {},
991                                                 events::Event::PaymentFailed { .. } => {},
992                                                 events::Event::ProbeSuccessful { .. } | events::Event::ProbeFailed { .. } => {
993                                                         // Even though we don't explicitly send probes, because probes are
994                                                         // detected based on hashing the payment hash+preimage, its rather
995                                                         // trivial for the fuzzer to build payments that accidentally end up
996                                                         // looking like probes.
997                                                 },
998                                                 events::Event::PaymentForwarded { .. } if $node == 1 => {},
999                                                 events::Event::ChannelReady { .. } => {},
1000                                                 events::Event::PendingHTLCsForwardable { .. } => {
1001                                                         nodes[$node].process_pending_htlc_forwards();
1002                                                 },
1003                                                 events::Event::HTLCHandlingFailed { .. } => {},
1004                                                 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
1005                                                         return;
1006                                                 } else {
1007                                                         panic!("Unhandled event")
1008                                                 },
1009                                         }
1010                                 }
1011                                 had_events
1012                         } }
1013                 }
1014
1015                 let v = get_slice!(1)[0];
1016                 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
1017                 match v {
1018                         // In general, we keep related message groups close together in binary form, allowing
1019                         // bit-twiddling mutations to have similar effects. This is probably overkill, but no
1020                         // harm in doing so.
1021
1022                         0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
1023                         0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
1024                         0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
1025                         0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
1026                         0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
1027                         0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
1028
1029                         0x08 => {
1030                                 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1031                                         monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1032                                         nodes[0].process_monitor_events();
1033                                 }
1034                         },
1035                         0x09 => {
1036                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1037                                         monitor_b.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1038                                         nodes[1].process_monitor_events();
1039                                 }
1040                         },
1041                         0x0a => {
1042                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1043                                         monitor_b.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1044                                         nodes[1].process_monitor_events();
1045                                 }
1046                         },
1047                         0x0b => {
1048                                 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1049                                         monitor_c.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1050                                         nodes[2].process_monitor_events();
1051                                 }
1052                         },
1053
1054                         0x0c => {
1055                                 if !chan_a_disconnected {
1056                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id());
1057                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id());
1058                                         chan_a_disconnected = true;
1059                                         drain_msg_events_on_disconnect!(0);
1060                                 }
1061                         },
1062                         0x0d => {
1063                                 if !chan_b_disconnected {
1064                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id());
1065                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id());
1066                                         chan_b_disconnected = true;
1067                                         drain_msg_events_on_disconnect!(2);
1068                                 }
1069                         },
1070                         0x0e => {
1071                                 if chan_a_disconnected {
1072                                         nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init {
1073                                                 features: nodes[1].init_features(), networks: None, remote_network_address: None
1074                                         }, true).unwrap();
1075                                         nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init {
1076                                                 features: nodes[0].init_features(), networks: None, remote_network_address: None
1077                                         }, false).unwrap();
1078                                         chan_a_disconnected = false;
1079                                 }
1080                         },
1081                         0x0f => {
1082                                 if chan_b_disconnected {
1083                                         nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init {
1084                                                 features: nodes[2].init_features(), networks: None, remote_network_address: None
1085                                         }, true).unwrap();
1086                                         nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init {
1087                                                 features: nodes[1].init_features(), networks: None, remote_network_address: None
1088                                         }, false).unwrap();
1089                                         chan_b_disconnected = false;
1090                                 }
1091                         },
1092
1093                         0x10 => { process_msg_events!(0, true, ProcessMessages::AllMessages); },
1094                         0x11 => { process_msg_events!(0, false, ProcessMessages::AllMessages); },
1095                         0x12 => { process_msg_events!(0, true, ProcessMessages::OneMessage); },
1096                         0x13 => { process_msg_events!(0, false, ProcessMessages::OneMessage); },
1097                         0x14 => { process_msg_events!(0, true, ProcessMessages::OnePendingMessage); },
1098                         0x15 => { process_msg_events!(0, false, ProcessMessages::OnePendingMessage); },
1099
1100                         0x16 => { process_events!(0, true); },
1101                         0x17 => { process_events!(0, false); },
1102
1103                         0x18 => { process_msg_events!(1, true, ProcessMessages::AllMessages); },
1104                         0x19 => { process_msg_events!(1, false, ProcessMessages::AllMessages); },
1105                         0x1a => { process_msg_events!(1, true, ProcessMessages::OneMessage); },
1106                         0x1b => { process_msg_events!(1, false, ProcessMessages::OneMessage); },
1107                         0x1c => { process_msg_events!(1, true, ProcessMessages::OnePendingMessage); },
1108                         0x1d => { process_msg_events!(1, false, ProcessMessages::OnePendingMessage); },
1109
1110                         0x1e => { process_events!(1, true); },
1111                         0x1f => { process_events!(1, false); },
1112
1113                         0x20 => { process_msg_events!(2, true, ProcessMessages::AllMessages); },
1114                         0x21 => { process_msg_events!(2, false, ProcessMessages::AllMessages); },
1115                         0x22 => { process_msg_events!(2, true, ProcessMessages::OneMessage); },
1116                         0x23 => { process_msg_events!(2, false, ProcessMessages::OneMessage); },
1117                         0x24 => { process_msg_events!(2, true, ProcessMessages::OnePendingMessage); },
1118                         0x25 => { process_msg_events!(2, false, ProcessMessages::OnePendingMessage); },
1119
1120                         0x26 => { process_events!(2, true); },
1121                         0x27 => { process_events!(2, false); },
1122
1123                         0x2c => {
1124                                 if !chan_a_disconnected {
1125                                         nodes[1].peer_disconnected(&nodes[0].get_our_node_id());
1126                                         chan_a_disconnected = true;
1127                                         push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(0));
1128                                         ab_events.clear();
1129                                         ba_events.clear();
1130                                 }
1131                                 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
1132                                 nodes[0] = new_node_a;
1133                                 monitor_a = new_monitor_a;
1134                         },
1135                         0x2d => {
1136                                 if !chan_a_disconnected {
1137                                         nodes[0].peer_disconnected(&nodes[1].get_our_node_id());
1138                                         chan_a_disconnected = true;
1139                                         nodes[0].get_and_clear_pending_msg_events();
1140                                         ab_events.clear();
1141                                         ba_events.clear();
1142                                 }
1143                                 if !chan_b_disconnected {
1144                                         nodes[2].peer_disconnected(&nodes[1].get_our_node_id());
1145                                         chan_b_disconnected = true;
1146                                         nodes[2].get_and_clear_pending_msg_events();
1147                                         bc_events.clear();
1148                                         cb_events.clear();
1149                                 }
1150                                 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
1151                                 nodes[1] = new_node_b;
1152                                 monitor_b = new_monitor_b;
1153                         },
1154                         0x2e => {
1155                                 if !chan_b_disconnected {
1156                                         nodes[1].peer_disconnected(&nodes[2].get_our_node_id());
1157                                         chan_b_disconnected = true;
1158                                         push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(2));
1159                                         bc_events.clear();
1160                                         cb_events.clear();
1161                                 }
1162                                 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
1163                                 nodes[2] = new_node_c;
1164                                 monitor_c = new_monitor_c;
1165                         },
1166
1167                         // 1/10th the channel size:
1168                         0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1169                         0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1170                         0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1171                         0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1172                         0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1173                         0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1174
1175                         0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1176                         0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1177                         0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1178                         0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1179                         0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1180                         0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1181
1182                         0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1183                         0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1184                         0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1185                         0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1186                         0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1187                         0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1188
1189                         0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1190                         0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1191                         0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1192                         0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1193                         0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1194                         0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1195
1196                         0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1197                         0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1198                         0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1199                         0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1200                         0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1201                         0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1202
1203                         0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id, &mut payment_idx); },
1204                         0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id, &mut payment_idx); },
1205                         0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id, &mut payment_idx); },
1206                         0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id, &mut payment_idx); },
1207                         0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id, &mut payment_idx); },
1208                         0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id, &mut payment_idx); },
1209
1210                         0x60 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id, &mut payment_idx); },
1211                         0x61 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id, &mut payment_idx); },
1212                         0x62 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id, &mut payment_idx); },
1213                         0x63 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id, &mut payment_idx); },
1214                         0x64 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id, &mut payment_idx); },
1215                         0x65 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id, &mut payment_idx); },
1216
1217                         0x68 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id, &mut payment_idx); },
1218                         0x69 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id, &mut payment_idx); },
1219                         0x6a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id, &mut payment_idx); },
1220                         0x6b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id, &mut payment_idx); },
1221                         0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id, &mut payment_idx); },
1222                         0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id, &mut payment_idx); },
1223
1224                         0x80 => {
1225                                 let mut max_feerate = last_htlc_clear_fee_a;
1226                                 if !anchors {
1227                                         max_feerate *= FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1228                                 }
1229                                 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1230                                         fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
1231                                 }
1232                                 nodes[0].maybe_update_chan_fees();
1233                         },
1234                         0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },
1235
1236                         0x84 => {
1237                                 let mut max_feerate = last_htlc_clear_fee_b;
1238                                 if !anchors {
1239                                         max_feerate *= FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1240                                 }
1241                                 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1242                                         fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
1243                                 }
1244                                 nodes[1].maybe_update_chan_fees();
1245                         },
1246                         0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },
1247
1248                         0x88 => {
1249                                 let mut max_feerate = last_htlc_clear_fee_c;
1250                                 if !anchors {
1251                                         max_feerate *= FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1252                                 }
1253                                 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1254                                         fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
1255                                 }
1256                                 nodes[2].maybe_update_chan_fees();
1257                         },
1258                         0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },
1259
1260                         0xff => {
1261                                 // Test that no channel is in a stuck state where neither party can send funds even
1262                                 // after we resolve all pending events.
1263                                 // First make sure there are no pending monitor updates, resetting the error state
1264                                 // and calling force_channel_monitor_updated for each monitor.
1265                                 *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1266                                 *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1267                                 *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1268
1269                                 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1270                                         monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1271                                         nodes[0].process_monitor_events();
1272                                 }
1273                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1274                                         monitor_b.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1275                                         nodes[1].process_monitor_events();
1276                                 }
1277                                 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1278                                         monitor_b.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1279                                         nodes[1].process_monitor_events();
1280                                 }
1281                                 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1282                                         monitor_c.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1283                                         nodes[2].process_monitor_events();
1284                                 }
1285
1286                                 // Next, make sure peers are all connected to each other
1287                                 if chan_a_disconnected {
1288                                         nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init {
1289                                                 features: nodes[1].init_features(), networks: None, remote_network_address: None
1290                                         }, true).unwrap();
1291                                         nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init {
1292                                                 features: nodes[0].init_features(), networks: None, remote_network_address: None
1293                                         }, false).unwrap();
1294                                         chan_a_disconnected = false;
1295                                 }
1296                                 if chan_b_disconnected {
1297                                         nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init {
1298                                                 features: nodes[2].init_features(), networks: None, remote_network_address: None
1299                                         }, true).unwrap();
1300                                         nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init {
1301                                                 features: nodes[1].init_features(), networks: None, remote_network_address: None
1302                                         }, false).unwrap();
1303                                         chan_b_disconnected = false;
1304                                 }
1305
1306                                 for i in 0..std::usize::MAX {
1307                                         if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
1308                                         // Then, make sure any current forwards make their way to their destination
1309                                         if process_msg_events!(0, false, ProcessMessages::AllMessages) { continue; }
1310                                         if process_msg_events!(1, false, ProcessMessages::AllMessages) { continue; }
1311                                         if process_msg_events!(2, false, ProcessMessages::AllMessages) { continue; }
1312                                         // ...making sure any pending PendingHTLCsForwardable events are handled and
1313                                         // payments claimed.
1314                                         if process_events!(0, false) { continue; }
1315                                         if process_events!(1, false) { continue; }
1316                                         if process_events!(2, false) { continue; }
1317                                         break;
1318                                 }
1319
1320                                 // Finally, make sure that at least one end of each channel can make a substantial payment
1321                                 assert!(
1322                                         send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id, &mut payment_idx) ||
1323                                         send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx));
1324                                 assert!(
1325                                         send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx) ||
1326                                         send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id, &mut payment_idx));
1327
1328                                 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
1329                                 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
1330                                 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
1331                         },
1332                         _ => test_return!(),
1333                 }
1334
1335                 if nodes[0].get_and_clear_needs_persistence() == true {
1336                         node_a_ser.0.clear();
1337                         nodes[0].write(&mut node_a_ser).unwrap();
1338                 }
1339                 if nodes[1].get_and_clear_needs_persistence() == true {
1340                         node_b_ser.0.clear();
1341                         nodes[1].write(&mut node_b_ser).unwrap();
1342                 }
1343                 if nodes[2].get_and_clear_needs_persistence() == true {
1344                         node_c_ser.0.clear();
1345                         nodes[2].write(&mut node_c_ser).unwrap();
1346                 }
1347         }
1348 }
1349
1350 /// We actually have different behavior based on if a certain log string has been seen, so we have
1351 /// to do a bit more tracking.
1352 #[derive(Clone)]
1353 struct SearchingOutput<O: Output> {
1354         output: O,
1355         may_fail: Arc<atomic::AtomicBool>,
1356 }
1357 impl<O: Output> Output for SearchingOutput<O> {
1358         fn locked_write(&self, data: &[u8]) {
1359                 // We hit a design limitation of LN state machine (see CONCURRENT_INBOUND_HTLC_FEE_BUFFER)
1360                 if std::str::from_utf8(data).unwrap().contains("Outbound update_fee HTLC buffer overflow - counterparty should force-close this channel") {
1361                         self.may_fail.store(true, atomic::Ordering::Release);
1362                 }
1363                 self.output.locked_write(data)
1364         }
1365 }
1366 impl<O: Output> SearchingOutput<O> {
1367         pub fn new(output: O) -> Self {
1368                 Self { output, may_fail: Arc::new(atomic::AtomicBool::new(false)) }
1369         }
1370 }
1371
1372 pub fn chanmon_consistency_test<Out: Output>(data: &[u8], out: Out) {
1373         do_test(data, out.clone(), false);
1374         do_test(data, out, true);
1375 }
1376
1377 #[no_mangle]
1378 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
1379         do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{}, false);
1380         do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{}, true);
1381 }