1 // This file is Copyright its original authors, visible in version control
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
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.
21 use bitcoin::TxMerkleNode;
22 use bitcoin::blockdata::block::BlockHeader;
23 use bitcoin::blockdata::constants::genesis_block;
24 use bitcoin::blockdata::transaction::{Transaction, TxOut};
25 use bitcoin::blockdata::script::{Builder, Script};
26 use bitcoin::blockdata::opcodes;
27 use bitcoin::blockdata::locktime::PackedLockTime;
28 use bitcoin::network::constants::Network;
30 use bitcoin::hashes::Hash as TraitImport;
31 use bitcoin::hashes::sha256::Hash as Sha256;
32 use bitcoin::hash_types::{BlockHash, WPubkeyHash};
35 use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, chainmonitor, channelmonitor, Confirm, Watch};
36 use lightning::chain::channelmonitor::{ChannelMonitor, MonitorEvent};
37 use lightning::chain::transaction::OutPoint;
38 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
39 use lightning::chain::keysinterface::{KeyMaterial, KeysInterface, InMemorySigner, Recipient};
40 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
41 use lightning::ln::channelmanager::{self, ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs, PaymentId};
42 use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
43 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
44 use lightning::ln::script::ShutdownScript;
45 use lightning::util::enforcing_trait_impls::{EnforcingSigner, EnforcementState};
46 use lightning::util::errors::APIError;
47 use lightning::util::events;
48 use lightning::util::logger::Logger;
49 use lightning::util::config::UserConfig;
50 use lightning::util::events::MessageSendEventsProvider;
51 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
52 use lightning::routing::router::{Route, RouteHop};
54 use crate::utils::test_logger::{self, Output};
55 use crate::utils::test_persister::TestPersister;
57 use bitcoin::secp256k1::{PublicKey, SecretKey, Scalar};
58 use bitcoin::secp256k1::ecdh::SharedSecret;
59 use bitcoin::secp256k1::ecdsa::RecoverableSignature;
60 use bitcoin::secp256k1::Secp256k1;
63 use std::cmp::{self, Ordering};
64 use std::collections::{HashSet, hash_map, HashMap};
65 use std::sync::{Arc,Mutex};
66 use std::sync::atomic;
68 use bitcoin::bech32::u5;
70 const MAX_FEE: u32 = 10_000;
71 struct FuzzEstimator {
72 ret_val: atomic::AtomicU32,
74 impl FeeEstimator for FuzzEstimator {
75 fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
76 // We force-close channels if our counterparty sends us a feerate which is a small multiple
77 // of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
78 // always return a HighPriority feerate here which is >= the maximum Normal feerate and a
79 // Background feerate which is <= the minimum Normal feerate.
81 ConfirmationTarget::HighPriority => MAX_FEE,
82 ConfirmationTarget::Background => 253,
83 ConfirmationTarget::Normal => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
88 pub struct TestBroadcaster {}
89 impl BroadcasterInterface for TestBroadcaster {
90 fn broadcast_transaction(&self, _tx: &Transaction) { }
93 pub struct VecWriter(pub Vec<u8>);
94 impl Writer for VecWriter {
95 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
96 self.0.extend_from_slice(buf);
101 struct TestChainMonitor {
102 pub logger: Arc<dyn Logger>,
103 pub keys: Arc<KeyProvider>,
104 pub persister: Arc<TestPersister>,
105 pub chain_monitor: Arc<chainmonitor::ChainMonitor<EnforcingSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
106 // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
107 // logic will automatically force-close our channels for us (as we don't have an up-to-date
108 // monitor implying we are not able to punish misbehaving counterparties). Because this test
109 // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
110 // fully-serialized monitor state here, as well as the corresponding update_id.
111 pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
112 pub should_update_manager: atomic::AtomicBool,
114 impl TestChainMonitor {
115 pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>, keys: Arc<KeyProvider>) -> Self {
117 chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, Arc::clone(&persister))),
121 latest_monitors: Mutex::new(HashMap::new()),
122 should_update_manager: atomic::AtomicBool::new(false),
126 impl chain::Watch<EnforcingSigner> for TestChainMonitor {
127 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> chain::ChannelMonitorUpdateStatus {
128 let mut ser = VecWriter(Vec::new());
129 monitor.write(&mut ser).unwrap();
130 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
131 panic!("Already had monitor pre-watch_channel");
133 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
134 self.chain_monitor.watch_channel(funding_txo, monitor)
137 fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
138 let mut map_lock = self.latest_monitors.lock().unwrap();
139 let mut map_entry = match map_lock.entry(funding_txo) {
140 hash_map::Entry::Occupied(entry) => entry,
141 hash_map::Entry::Vacant(_) => panic!("Didn't have monitor on update call"),
143 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
144 read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
145 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
146 let mut ser = VecWriter(Vec::new());
147 deserialized_monitor.write(&mut ser).unwrap();
148 map_entry.insert((update.update_id, ser.0));
149 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
150 self.chain_monitor.update_channel(funding_txo, update)
153 fn release_pending_monitor_events(&self) -> Vec<(OutPoint, Vec<MonitorEvent>, Option<PublicKey>)> {
154 return self.chain_monitor.release_pending_monitor_events();
160 rand_bytes_id: atomic::AtomicU32,
161 enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
163 impl KeysInterface for KeyProvider {
164 type Signer = EnforcingSigner;
166 fn get_node_secret(&self, _recipient: Recipient) -> Result<SecretKey, ()> {
167 Ok(SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, self.node_id]).unwrap())
170 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
171 let mut node_secret = self.get_node_secret(recipient)?;
172 if let Some(tweak) = tweak {
173 node_secret = node_secret.mul_tweak(tweak).unwrap();
175 Ok(SharedSecret::new(other_key, &node_secret))
178 fn get_inbound_payment_key_material(&self) -> KeyMaterial {
179 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_id])
182 fn get_destination_script(&self) -> Script {
183 let secp_ctx = Secp256k1::signing_only();
184 let channel_monitor_claim_key = SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, self.node_id]).unwrap();
185 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
186 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
189 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
190 let secp_ctx = Secp256k1::signing_only();
191 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_id]).unwrap();
192 let pubkey_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &secret_key).serialize());
193 ShutdownScript::new_p2wpkh(&pubkey_hash)
196 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] {
197 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed) as u8;
201 fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> Self::Signer {
202 let secp_ctx = Secp256k1::signing_only();
203 let id = channel_keys_id[0];
204 let keys = InMemorySigner::new(
206 self.get_node_secret(Recipient::Node).unwrap(),
207 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, self.node_id]).unwrap(),
208 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, self.node_id]).unwrap(),
209 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, self.node_id]).unwrap(),
210 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, self.node_id]).unwrap(),
211 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 8, self.node_id]).unwrap(),
212 [id, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 9, self.node_id],
213 channel_value_satoshis,
216 let revoked_commitment = self.make_enforcement_state_cell(keys.commitment_seed);
217 EnforcingSigner::new_with_revoked(keys, revoked_commitment, false)
220 fn get_secure_random_bytes(&self) -> [u8; 32] {
221 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
222 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_id];
223 res[30-4..30].copy_from_slice(&id.to_le_bytes());
227 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, DecodeError> {
228 let mut reader = std::io::Cursor::new(buffer);
230 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self.get_node_secret(Recipient::Node).unwrap())?;
231 let state = self.make_enforcement_state_cell(inner.commitment_seed);
236 disable_revocation_policy_check: false,
240 fn sign_invoice(&self, _hrp_bytes: &[u8], _invoice_data: &[u5], _recipient: Recipient) -> Result<RecoverableSignature, ()> {
246 fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
247 let mut revoked_commitments = self.enforcement_states.lock().unwrap();
248 if !revoked_commitments.contains_key(&commitment_seed) {
249 revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(EnforcementState::new())));
251 let cell = revoked_commitments.get(&commitment_seed).unwrap();
257 fn check_api_err(api_err: APIError) {
259 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
260 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
261 APIError::InvalidRoute { .. } => panic!("Our routes should work"),
262 APIError::ChannelUnavailable { err } => {
263 // Test the error against a list of errors we can hit, and reject
264 // all others. If you hit this panic, the list of acceptable errors
265 // is probably just stale and you should add new messages here.
267 "Peer for first hop currently disconnected/pending monitor update!" => {},
268 _ if err.starts_with("Cannot push more than their max accepted HTLCs ") => {},
269 _ if err.starts_with("Cannot send value that would put us over the max HTLC value in flight our peer will accept ") => {},
270 _ if err.starts_with("Cannot send value that would put our balance under counterparty-announced channel reserve value") => {},
271 _ if err.starts_with("Cannot send value that would put counterparty balance under holder-announced channel reserve value") => {},
272 _ if err.starts_with("Cannot send value that would overdraw remaining funds.") => {},
273 _ if err.starts_with("Cannot send value that would not leave enough to pay for fees.") => {},
274 _ if err.starts_with("Cannot send value that would put our exposure to dust HTLCs at") => {},
275 _ => panic!("{}", err),
278 APIError::MonitorUpdateInProgress => {
279 // We can (obviously) temp-fail a monitor update
281 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
285 fn check_payment_err(send_err: PaymentSendFailure) {
287 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err),
288 PaymentSendFailure::PathParameterError(per_path_results) => {
289 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
291 PaymentSendFailure::AllFailedResendSafe(per_path_results) => {
292 for api_err in per_path_results { check_api_err(api_err); }
294 PaymentSendFailure::PartialFailure { results, .. } => {
295 for res in results { if let Err(api_err) = res { check_api_err(api_err); } }
297 PaymentSendFailure::DuplicatePayment => panic!(),
301 type ChanMan = ChannelManager<Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>;
304 fn get_payment_secret_hash(dest: &ChanMan, payment_id: &mut u8) -> Option<(PaymentSecret, PaymentHash)> {
305 let mut payment_hash;
307 payment_hash = PaymentHash(Sha256::hash(&[*payment_id; 1]).into_inner());
308 if let Ok(payment_secret) = dest.create_inbound_payment_for_hash(payment_hash, None, 3600) {
309 return Some((payment_secret, payment_hash));
311 *payment_id = payment_id.wrapping_add(1);
317 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8, payment_idx: &mut u64) -> bool {
318 let (payment_secret, payment_hash) =
319 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
320 let mut payment_id = [0; 32];
321 payment_id[0..8].copy_from_slice(&payment_idx.to_ne_bytes());
323 if let Err(err) = source.send_payment(&Route {
324 paths: vec![vec![RouteHop {
325 pubkey: dest.get_our_node_id(),
326 node_features: channelmanager::provided_node_features(),
327 short_channel_id: dest_chan_id,
328 channel_features: channelmanager::provided_channel_features(),
330 cltv_expiry_delta: 200,
332 payment_params: None,
333 }, payment_hash, &Some(payment_secret), PaymentId(payment_id)) {
334 check_payment_err(err);
339 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 {
340 let (payment_secret, payment_hash) =
341 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
342 let mut payment_id = [0; 32];
343 payment_id[0..8].copy_from_slice(&payment_idx.to_ne_bytes());
345 if let Err(err) = source.send_payment(&Route {
346 paths: vec![vec![RouteHop {
347 pubkey: middle.get_our_node_id(),
348 node_features: channelmanager::provided_node_features(),
349 short_channel_id: middle_chan_id,
350 channel_features: channelmanager::provided_channel_features(),
352 cltv_expiry_delta: 100,
354 pubkey: dest.get_our_node_id(),
355 node_features: channelmanager::provided_node_features(),
356 short_channel_id: dest_chan_id,
357 channel_features: channelmanager::provided_channel_features(),
359 cltv_expiry_delta: 200,
361 payment_params: None,
362 }, payment_hash, &Some(payment_secret), PaymentId(payment_id)) {
363 check_payment_err(err);
369 pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
370 let out = SearchingOutput::new(underlying_out);
371 let broadcast = Arc::new(TestBroadcaster{});
373 macro_rules! make_node {
374 ($node_id: expr, $fee_estimator: expr) => { {
375 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
376 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
377 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
378 Arc::new(TestPersister {
379 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
380 }), Arc::clone(&keys_manager)));
382 let mut config = UserConfig::default();
383 config.channel_config.forwarding_fee_proportional_millionths = 0;
384 config.channel_handshake_config.announced_channel = true;
385 let network = Network::Bitcoin;
386 let params = ChainParameters {
388 best_block: BestBlock::from_genesis(network),
390 (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
391 monitor, keys_manager)
395 macro_rules! reload_node {
396 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
397 let keys_manager = Arc::clone(& $keys_manager);
398 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
399 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
400 Arc::new(TestPersister {
401 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
402 }), Arc::clone(& $keys_manager)));
404 let mut config = UserConfig::default();
405 config.channel_config.forwarding_fee_proportional_millionths = 0;
406 config.channel_handshake_config.announced_channel = true;
408 let mut monitors = HashMap::new();
409 let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
410 for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
411 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut Cursor::new(&monitor_ser), &*$keys_manager).expect("Failed to read monitor").1);
412 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
414 let mut monitor_refs = HashMap::new();
415 for (outpoint, monitor) in monitors.iter_mut() {
416 monitor_refs.insert(*outpoint, monitor);
419 let read_args = ChannelManagerReadArgs {
421 fee_estimator: $fee_estimator.clone(),
422 chain_monitor: chain_monitor.clone(),
423 tx_broadcaster: broadcast.clone(),
425 default_config: config,
426 channel_monitors: monitor_refs,
429 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
430 for (funding_txo, mon) in monitors.drain() {
431 assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
432 ChannelMonitorUpdateStatus::Completed);
438 let mut channel_txn = Vec::new();
439 macro_rules! make_channel {
440 ($source: expr, $dest: expr, $chan_id: expr) => { {
441 $source.peer_connected(&$dest.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
442 $dest.peer_connected(&$source.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
444 $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
446 let events = $source.get_and_clear_pending_msg_events();
447 assert_eq!(events.len(), 1);
448 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
450 } else { panic!("Wrong event type"); }
453 $dest.handle_open_channel(&$source.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
454 let accept_channel = {
455 let events = $dest.get_and_clear_pending_msg_events();
456 assert_eq!(events.len(), 1);
457 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
459 } else { panic!("Wrong event type"); }
462 $source.handle_accept_channel(&$dest.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
465 let events = $source.get_and_clear_pending_events();
466 assert_eq!(events.len(), 1);
467 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
468 let tx = Transaction { version: $chan_id, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
469 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
471 funding_output = OutPoint { txid: tx.txid(), index: 0 };
472 $source.funding_transaction_generated(&temporary_channel_id, &$dest.get_our_node_id(), tx.clone()).unwrap();
473 channel_txn.push(tx);
474 } else { panic!("Wrong event type"); }
477 let funding_created = {
478 let events = $source.get_and_clear_pending_msg_events();
479 assert_eq!(events.len(), 1);
480 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
482 } else { panic!("Wrong event type"); }
484 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
486 let funding_signed = {
487 let events = $dest.get_and_clear_pending_msg_events();
488 assert_eq!(events.len(), 1);
489 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
491 } else { panic!("Wrong event type"); }
493 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
499 macro_rules! confirm_txn {
501 let chain_hash = genesis_block(Network::Bitcoin).block_hash();
502 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: chain_hash, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
503 let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
504 $node.transactions_confirmed(&header, &txdata, 1);
506 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
508 $node.best_block_updated(&header, 99);
512 macro_rules! lock_fundings {
513 ($nodes: expr) => { {
514 let mut node_events = Vec::new();
515 for node in $nodes.iter() {
516 node_events.push(node.get_and_clear_pending_msg_events());
518 for (idx, node_event) in node_events.iter().enumerate() {
519 for event in node_event {
520 if let events::MessageSendEvent::SendChannelReady { ref node_id, ref msg } = event {
521 for node in $nodes.iter() {
522 if node.get_our_node_id() == *node_id {
523 node.handle_channel_ready(&$nodes[idx].get_our_node_id(), msg);
526 } else { panic!("Wrong event type"); }
530 for node in $nodes.iter() {
531 let events = node.get_and_clear_pending_msg_events();
532 for event in events {
533 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
534 } else { panic!("Wrong event type"); }
540 let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
541 let mut last_htlc_clear_fee_a = 253;
542 let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
543 let mut last_htlc_clear_fee_b = 253;
544 let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
545 let mut last_htlc_clear_fee_c = 253;
547 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
549 let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
550 let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
551 let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);
553 let mut nodes = [node_a, node_b, node_c];
555 let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
556 let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
558 for node in nodes.iter() {
562 lock_fundings!(nodes);
564 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
565 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
567 let mut payment_id: u8 = 0;
568 let mut payment_idx: u64 = 0;
570 let mut chan_a_disconnected = false;
571 let mut chan_b_disconnected = false;
572 let mut ab_events = Vec::new();
573 let mut ba_events = Vec::new();
574 let mut bc_events = Vec::new();
575 let mut cb_events = Vec::new();
577 let mut node_a_ser = VecWriter(Vec::new());
578 nodes[0].write(&mut node_a_ser).unwrap();
579 let mut node_b_ser = VecWriter(Vec::new());
580 nodes[1].write(&mut node_b_ser).unwrap();
581 let mut node_c_ser = VecWriter(Vec::new());
582 nodes[2].write(&mut node_c_ser).unwrap();
584 macro_rules! test_return {
586 assert_eq!(nodes[0].list_channels().len(), 1);
587 assert_eq!(nodes[1].list_channels().len(), 2);
588 assert_eq!(nodes[2].list_channels().len(), 1);
593 let mut read_pos = 0;
594 macro_rules! get_slice {
597 let slice_len = $len as usize;
598 if data.len() < read_pos + slice_len {
601 read_pos += slice_len;
602 &data[read_pos - slice_len..read_pos]
608 // Push any events from Node B onto ba_events and bc_events
609 macro_rules! push_excess_b_events {
610 ($excess_events: expr, $expect_drop_node: expr) => { {
611 let a_id = nodes[0].get_our_node_id();
612 let expect_drop_node: Option<usize> = $expect_drop_node;
613 let expect_drop_id = if let Some(id) = expect_drop_node { Some(nodes[id].get_our_node_id()) } else { None };
614 for event in $excess_events {
615 let push_a = match event {
616 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
617 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
620 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
621 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
624 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
625 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
628 events::MessageSendEvent::SendChannelReady { .. } => continue,
629 events::MessageSendEvent::SendAnnouncementSignatures { .. } => continue,
630 events::MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
631 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
632 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
635 _ => panic!("Unhandled message event {:?}", event),
637 if push_a { ba_events.push(event); } else { bc_events.push(event); }
642 // While delivering messages, we select across three possible message selection processes
643 // to ensure we get as much coverage as possible. See the individual enum variants for more
646 enum ProcessMessages {
647 /// Deliver all available messages, including fetching any new messages from
648 /// `get_and_clear_pending_msg_events()` (which may have side effects).
650 /// Call `get_and_clear_pending_msg_events()` first, and then deliver up to one
651 /// message (which may already be queued).
653 /// Deliver up to one already-queued message. This avoids any potential side-effects
654 /// of `get_and_clear_pending_msg_events()` (eg freeing the HTLC holding cell), which
655 /// provides potentially more coverage.
659 macro_rules! process_msg_events {
660 ($node: expr, $corrupt_forward: expr, $limit_events: expr) => { {
661 let mut events = if $node == 1 {
662 let mut new_events = Vec::new();
663 mem::swap(&mut new_events, &mut ba_events);
664 new_events.extend_from_slice(&bc_events[..]);
667 } else if $node == 0 {
668 let mut new_events = Vec::new();
669 mem::swap(&mut new_events, &mut ab_events);
672 let mut new_events = Vec::new();
673 mem::swap(&mut new_events, &mut cb_events);
676 let mut new_events = Vec::new();
677 if $limit_events != ProcessMessages::OnePendingMessage {
678 new_events = nodes[$node].get_and_clear_pending_msg_events();
680 let mut had_events = false;
681 let mut events_iter = events.drain(..).chain(new_events.drain(..));
682 let mut extra_ev = None;
683 for event in &mut events_iter {
686 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
687 for (idx, dest) in nodes.iter().enumerate() {
688 if dest.get_our_node_id() == node_id {
689 for update_add in update_add_htlcs.iter() {
690 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
691 if !$corrupt_forward {
692 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
694 // Corrupt the update_add_htlc message so that its HMAC
695 // check will fail and we generate a
696 // update_fail_malformed_htlc instead of an
697 // update_fail_htlc as we do when we reject a payment.
698 let mut msg_ser = update_add.encode();
699 msg_ser[1000] ^= 0xff;
700 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
701 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
704 for update_fulfill in update_fulfill_htlcs.iter() {
705 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
706 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
708 for update_fail in update_fail_htlcs.iter() {
709 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
710 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
712 for update_fail_malformed in update_fail_malformed_htlcs.iter() {
713 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
714 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
716 if let Some(msg) = update_fee {
717 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
718 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
720 let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
721 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
722 if $limit_events != ProcessMessages::AllMessages && processed_change {
723 // If we only want to process some messages, don't deliver the CS until later.
724 extra_ev = Some(events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate {
725 update_add_htlcs: Vec::new(),
726 update_fail_htlcs: Vec::new(),
727 update_fulfill_htlcs: Vec::new(),
728 update_fail_malformed_htlcs: Vec::new(),
734 out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
735 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
740 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
741 for (idx, dest) in nodes.iter().enumerate() {
742 if dest.get_our_node_id() == *node_id {
743 out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
744 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
748 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
749 for (idx, dest) in nodes.iter().enumerate() {
750 if dest.get_our_node_id() == *node_id {
751 out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
752 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
756 events::MessageSendEvent::SendChannelReady { .. } => {
757 // Can be generated as a reestablish response
759 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {
760 // Can be generated as a reestablish response
762 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
763 // When we reconnect we will resend a channel_update to make sure our
764 // counterparty has the latest parameters for receiving payments
765 // through us. We do, however, check that the message does not include
766 // the "disabled" bit, as we should never ever have a channel which is
767 // disabled when we send such an update (or it may indicate channel
768 // force-close which we should detect as an error).
769 assert_eq!(msg.contents.flags & 2, 0);
771 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
774 panic!("Unhandled message event {:?}", event)
777 if $limit_events != ProcessMessages::AllMessages {
782 push_excess_b_events!(extra_ev.into_iter().chain(events_iter), None);
783 } else if $node == 0 {
784 if let Some(ev) = extra_ev { ab_events.push(ev); }
785 for event in events_iter { ab_events.push(event); }
787 if let Some(ev) = extra_ev { cb_events.push(ev); }
788 for event in events_iter { cb_events.push(event); }
794 macro_rules! drain_msg_events_on_disconnect {
795 ($counterparty_id: expr) => { {
796 if $counterparty_id == 0 {
797 for event in nodes[0].get_and_clear_pending_msg_events() {
799 events::MessageSendEvent::UpdateHTLCs { .. } => {},
800 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
801 events::MessageSendEvent::SendChannelReestablish { .. } => {},
802 events::MessageSendEvent::SendChannelReady { .. } => {},
803 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
804 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
805 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
807 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
810 panic!("Unhandled message event")
814 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(0));
818 for event in nodes[2].get_and_clear_pending_msg_events() {
820 events::MessageSendEvent::UpdateHTLCs { .. } => {},
821 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
822 events::MessageSendEvent::SendChannelReestablish { .. } => {},
823 events::MessageSendEvent::SendChannelReady { .. } => {},
824 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
825 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
826 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
828 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
831 panic!("Unhandled message event")
835 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(2));
842 macro_rules! process_events {
843 ($node: expr, $fail: expr) => { {
844 // In case we get 256 payments we may have a hash collision, resulting in the
845 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
846 // deduplicate the calls here.
847 let mut claim_set = HashSet::new();
848 let mut events = nodes[$node].get_and_clear_pending_events();
849 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
850 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
851 // PaymentClaimable, claiming/failing two HTLCs, but leaving a just-generated
852 // PaymentClaimable event for the second HTLC in our pending_events (and breaking
853 // our claim_set deduplication).
854 events.sort_by(|a, b| {
855 if let events::Event::PaymentClaimable { .. } = a {
856 if let events::Event::PendingHTLCsForwardable { .. } = b {
858 } else { Ordering::Equal }
859 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
860 if let events::Event::PaymentClaimable { .. } = b {
862 } else { Ordering::Equal }
863 } else { Ordering::Equal }
865 let had_events = !events.is_empty();
866 for event in events.drain(..) {
868 events::Event::PaymentClaimable { payment_hash, .. } => {
869 if claim_set.insert(payment_hash.0) {
871 nodes[$node].fail_htlc_backwards(&payment_hash);
873 nodes[$node].claim_funds(PaymentPreimage(payment_hash.0));
877 events::Event::PaymentSent { .. } => {},
878 events::Event::PaymentClaimed { .. } => {},
879 events::Event::PaymentPathSuccessful { .. } => {},
880 events::Event::PaymentPathFailed { .. } => {},
881 events::Event::ProbeSuccessful { .. } | events::Event::ProbeFailed { .. } => {
882 // Even though we don't explicitly send probes, because probes are
883 // detected based on hashing the payment hash+preimage, its rather
884 // trivial for the fuzzer to build payments that accidentally end up
885 // looking like probes.
887 events::Event::PaymentForwarded { .. } if $node == 1 => {},
888 events::Event::ChannelReady { .. } => {},
889 events::Event::PendingHTLCsForwardable { .. } => {
890 nodes[$node].process_pending_htlc_forwards();
892 events::Event::HTLCHandlingFailed { .. } => {},
893 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
896 panic!("Unhandled event")
904 let v = get_slice!(1)[0];
905 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
907 // In general, we keep related message groups close together in binary form, allowing
908 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
911 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
912 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
913 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
914 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
915 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
916 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
919 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
920 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
921 nodes[0].process_monitor_events();
925 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
926 monitor_b.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
927 nodes[1].process_monitor_events();
931 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
932 monitor_b.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
933 nodes[1].process_monitor_events();
937 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
938 monitor_c.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
939 nodes[2].process_monitor_events();
944 if !chan_a_disconnected {
945 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
946 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
947 chan_a_disconnected = true;
948 drain_msg_events_on_disconnect!(0);
952 if !chan_b_disconnected {
953 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
954 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
955 chan_b_disconnected = true;
956 drain_msg_events_on_disconnect!(2);
960 if chan_a_disconnected {
961 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
962 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
963 chan_a_disconnected = false;
967 if chan_b_disconnected {
968 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
969 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
970 chan_b_disconnected = false;
974 0x10 => { process_msg_events!(0, true, ProcessMessages::AllMessages); },
975 0x11 => { process_msg_events!(0, false, ProcessMessages::AllMessages); },
976 0x12 => { process_msg_events!(0, true, ProcessMessages::OneMessage); },
977 0x13 => { process_msg_events!(0, false, ProcessMessages::OneMessage); },
978 0x14 => { process_msg_events!(0, true, ProcessMessages::OnePendingMessage); },
979 0x15 => { process_msg_events!(0, false, ProcessMessages::OnePendingMessage); },
981 0x16 => { process_events!(0, true); },
982 0x17 => { process_events!(0, false); },
984 0x18 => { process_msg_events!(1, true, ProcessMessages::AllMessages); },
985 0x19 => { process_msg_events!(1, false, ProcessMessages::AllMessages); },
986 0x1a => { process_msg_events!(1, true, ProcessMessages::OneMessage); },
987 0x1b => { process_msg_events!(1, false, ProcessMessages::OneMessage); },
988 0x1c => { process_msg_events!(1, true, ProcessMessages::OnePendingMessage); },
989 0x1d => { process_msg_events!(1, false, ProcessMessages::OnePendingMessage); },
991 0x1e => { process_events!(1, true); },
992 0x1f => { process_events!(1, false); },
994 0x20 => { process_msg_events!(2, true, ProcessMessages::AllMessages); },
995 0x21 => { process_msg_events!(2, false, ProcessMessages::AllMessages); },
996 0x22 => { process_msg_events!(2, true, ProcessMessages::OneMessage); },
997 0x23 => { process_msg_events!(2, false, ProcessMessages::OneMessage); },
998 0x24 => { process_msg_events!(2, true, ProcessMessages::OnePendingMessage); },
999 0x25 => { process_msg_events!(2, false, ProcessMessages::OnePendingMessage); },
1001 0x26 => { process_events!(2, true); },
1002 0x27 => { process_events!(2, false); },
1005 if !chan_a_disconnected {
1006 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
1007 chan_a_disconnected = true;
1008 drain_msg_events_on_disconnect!(0);
1010 if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
1011 node_a_ser.0.clear();
1012 nodes[0].write(&mut node_a_ser).unwrap();
1014 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
1015 nodes[0] = new_node_a;
1016 monitor_a = new_monitor_a;
1019 if !chan_a_disconnected {
1020 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
1021 chan_a_disconnected = true;
1022 nodes[0].get_and_clear_pending_msg_events();
1026 if !chan_b_disconnected {
1027 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
1028 chan_b_disconnected = true;
1029 nodes[2].get_and_clear_pending_msg_events();
1033 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
1034 nodes[1] = new_node_b;
1035 monitor_b = new_monitor_b;
1038 if !chan_b_disconnected {
1039 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
1040 chan_b_disconnected = true;
1041 drain_msg_events_on_disconnect!(2);
1043 if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
1044 node_c_ser.0.clear();
1045 nodes[2].write(&mut node_c_ser).unwrap();
1047 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
1048 nodes[2] = new_node_c;
1049 monitor_c = new_monitor_c;
1052 // 1/10th the channel size:
1053 0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1054 0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1055 0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1056 0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1057 0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1058 0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1060 0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1061 0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1062 0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1063 0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1064 0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1065 0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1067 0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1068 0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1069 0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1070 0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1071 0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1072 0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1074 0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1075 0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1076 0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1077 0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1078 0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1079 0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1081 0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1082 0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1083 0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1084 0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1085 0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1086 0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1088 0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id, &mut payment_idx); },
1089 0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id, &mut payment_idx); },
1090 0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id, &mut payment_idx); },
1091 0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id, &mut payment_idx); },
1092 0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id, &mut payment_idx); },
1093 0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id, &mut payment_idx); },
1095 0x60 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id, &mut payment_idx); },
1096 0x61 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id, &mut payment_idx); },
1097 0x62 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id, &mut payment_idx); },
1098 0x63 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id, &mut payment_idx); },
1099 0x64 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id, &mut payment_idx); },
1100 0x65 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id, &mut payment_idx); },
1102 0x68 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id, &mut payment_idx); },
1103 0x69 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id, &mut payment_idx); },
1104 0x6a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id, &mut payment_idx); },
1105 0x6b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id, &mut payment_idx); },
1106 0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id, &mut payment_idx); },
1107 0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id, &mut payment_idx); },
1110 let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1111 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1112 fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
1114 nodes[0].maybe_update_chan_fees();
1116 0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },
1119 let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1120 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1121 fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
1123 nodes[1].maybe_update_chan_fees();
1125 0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },
1128 let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1129 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1130 fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
1132 nodes[2].maybe_update_chan_fees();
1134 0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },
1137 // Test that no channel is in a stuck state where neither party can send funds even
1138 // after we resolve all pending events.
1139 // First make sure there are no pending monitor updates, resetting the error state
1140 // and calling force_channel_monitor_updated for each monitor.
1141 *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1142 *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1143 *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1145 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1146 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1147 nodes[0].process_monitor_events();
1149 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1150 monitor_b.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1151 nodes[1].process_monitor_events();
1153 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1154 monitor_b.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1155 nodes[1].process_monitor_events();
1157 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1158 monitor_c.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1159 nodes[2].process_monitor_events();
1162 // Next, make sure peers are all connected to each other
1163 if chan_a_disconnected {
1164 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1165 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1166 chan_a_disconnected = false;
1168 if chan_b_disconnected {
1169 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1170 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
1171 chan_b_disconnected = false;
1174 for i in 0..std::usize::MAX {
1175 if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
1176 // Then, make sure any current forwards make their way to their destination
1177 if process_msg_events!(0, false, ProcessMessages::AllMessages) { continue; }
1178 if process_msg_events!(1, false, ProcessMessages::AllMessages) { continue; }
1179 if process_msg_events!(2, false, ProcessMessages::AllMessages) { continue; }
1180 // ...making sure any pending PendingHTLCsForwardable events are handled and
1181 // payments claimed.
1182 if process_events!(0, false) { continue; }
1183 if process_events!(1, false) { continue; }
1184 if process_events!(2, false) { continue; }
1188 // Finally, make sure that at least one end of each channel can make a substantial payment
1190 send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id, &mut payment_idx) ||
1191 send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx));
1193 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx) ||
1194 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id, &mut payment_idx));
1196 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
1197 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
1198 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
1200 _ => test_return!(),
1203 node_a_ser.0.clear();
1204 nodes[0].write(&mut node_a_ser).unwrap();
1205 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
1206 node_b_ser.0.clear();
1207 nodes[1].write(&mut node_b_ser).unwrap();
1208 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
1209 node_c_ser.0.clear();
1210 nodes[2].write(&mut node_c_ser).unwrap();
1211 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
1215 /// We actually have different behavior based on if a certain log string has been seen, so we have
1216 /// to do a bit more tracking.
1218 struct SearchingOutput<O: Output> {
1220 may_fail: Arc<atomic::AtomicBool>,
1222 impl<O: Output> Output for SearchingOutput<O> {
1223 fn locked_write(&self, data: &[u8]) {
1224 // We hit a design limitation of LN state machine (see CONCURRENT_INBOUND_HTLC_FEE_BUFFER)
1225 if std::str::from_utf8(data).unwrap().contains("Outbound update_fee HTLC buffer overflow - counterparty should force-close this channel") {
1226 self.may_fail.store(true, atomic::Ordering::Release);
1228 self.output.locked_write(data)
1231 impl<O: Output> SearchingOutput<O> {
1232 pub fn new(output: O) -> Self {
1233 Self { output, may_fail: Arc::new(atomic::AtomicBool::new(false)) }
1237 pub fn chanmon_consistency_test<Out: Output>(data: &[u8], out: Out) {
1242 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
1243 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});