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::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;
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};
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::util::enforcing_trait_impls::{EnforcingSigner, EnforcementState};
48 use lightning::util::errors::APIError;
49 use lightning::util::logger::Logger;
50 use lightning::util::config::UserConfig;
51 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
52 use lightning::routing::router::{InFlightHtlcs, Path, Route, RouteHop, RouteParameters, Router};
54 use crate::utils::test_logger::{self, Output};
55 use crate::utils::test_persister::TestPersister;
57 use bitcoin::secp256k1::{Message, PublicKey, SecretKey, Scalar, Secp256k1};
58 use bitcoin::secp256k1::ecdh::SharedSecret;
59 use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
62 use std::cmp::{self, Ordering};
63 use hashbrown::{HashSet, hash_map, HashMap};
64 use std::sync::{Arc,Mutex};
65 use std::sync::atomic;
67 use bitcoin::bech32::u5;
69 const MAX_FEE: u32 = 10_000;
70 struct FuzzEstimator {
71 ret_val: atomic::AtomicU32,
73 impl FeeEstimator for FuzzEstimator {
74 fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
75 // We force-close channels if our counterparty sends us a feerate which is a small multiple
76 // of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
77 // always return a HighPriority feerate here which is >= the maximum Normal feerate and a
78 // Background feerate which is <= the minimum Normal feerate.
80 ConfirmationTarget::HighPriority => MAX_FEE,
81 ConfirmationTarget::Background => 253,
82 ConfirmationTarget::Normal => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
89 impl Router for FuzzRouter {
91 &self, _payer: &PublicKey, _params: &RouteParameters, _first_hops: Option<&[&ChannelDetails]>,
92 _inflight_htlcs: &InFlightHtlcs
93 ) -> Result<Route, msgs::LightningError> {
94 Err(msgs::LightningError {
95 err: String::from("Not implemented"),
96 action: msgs::ErrorAction::IgnoreError
101 pub struct TestBroadcaster {}
102 impl BroadcasterInterface for TestBroadcaster {
103 fn broadcast_transactions(&self, _txs: &[&Transaction]) { }
106 pub struct VecWriter(pub Vec<u8>);
107 impl Writer for VecWriter {
108 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
109 self.0.extend_from_slice(buf);
114 struct TestChainMonitor {
115 pub logger: Arc<dyn Logger>,
116 pub keys: Arc<KeyProvider>,
117 pub persister: Arc<TestPersister>,
118 pub chain_monitor: Arc<chainmonitor::ChainMonitor<EnforcingSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
119 // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
120 // logic will automatically force-close our channels for us (as we don't have an up-to-date
121 // monitor implying we are not able to punish misbehaving counterparties). Because this test
122 // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
123 // fully-serialized monitor state here, as well as the corresponding update_id.
124 pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
125 pub should_update_manager: atomic::AtomicBool,
127 impl TestChainMonitor {
128 pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>, keys: Arc<KeyProvider>) -> Self {
130 chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, Arc::clone(&persister))),
134 latest_monitors: Mutex::new(HashMap::new()),
135 should_update_manager: atomic::AtomicBool::new(false),
139 impl chain::Watch<EnforcingSigner> for TestChainMonitor {
140 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> chain::ChannelMonitorUpdateStatus {
141 let mut ser = VecWriter(Vec::new());
142 monitor.write(&mut ser).unwrap();
143 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
144 panic!("Already had monitor pre-watch_channel");
146 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
147 self.chain_monitor.watch_channel(funding_txo, monitor)
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"),
156 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
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.should_update_manager.store(true, atomic::Ordering::Relaxed);
163 self.chain_monitor.update_channel(funding_txo, update)
166 fn release_pending_monitor_events(&self) -> Vec<(OutPoint, Vec<MonitorEvent>, Option<PublicKey>)> {
167 return self.chain_monitor.release_pending_monitor_events();
172 node_secret: SecretKey,
173 rand_bytes_id: atomic::AtomicU32,
174 enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
177 impl EntropySource for KeyProvider {
178 fn get_secure_random_bytes(&self) -> [u8; 32] {
179 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
180 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]];
181 res[30-4..30].copy_from_slice(&id.to_le_bytes());
186 impl NodeSigner for KeyProvider {
187 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
188 let node_secret = match recipient {
189 Recipient::Node => Ok(&self.node_secret),
190 Recipient::PhantomNode => Err(())
192 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
195 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
196 let mut node_secret = match recipient {
197 Recipient::Node => Ok(self.node_secret.clone()),
198 Recipient::PhantomNode => Err(())
200 if let Some(tweak) = tweak {
201 node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
203 Ok(SharedSecret::new(other_key, &node_secret))
206 fn get_inbound_payment_key_material(&self) -> KeyMaterial {
207 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]])
210 fn sign_invoice(&self, _hrp_bytes: &[u8], _invoice_data: &[u5], _recipient: Recipient) -> Result<RecoverableSignature, ()> {
214 fn sign_gossip_message(&self, msg: lightning::ln::msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
215 let msg_hash = Message::from_slice(&Sha256dHash::hash(&msg.encode()[..])[..]).map_err(|_| ())?;
216 let secp_ctx = Secp256k1::signing_only();
217 Ok(secp_ctx.sign_ecdsa(&msg_hash, &self.node_secret))
221 impl SignerProvider for KeyProvider {
222 type Signer = EnforcingSigner;
224 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] {
225 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed) as u8;
229 fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> Self::Signer {
230 let secp_ctx = Secp256k1::signing_only();
231 let id = channel_keys_id[0];
232 let keys = InMemorySigner::new(
234 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(),
235 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(),
236 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(),
237 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(),
238 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(),
239 [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]],
240 channel_value_satoshis,
244 let revoked_commitment = self.make_enforcement_state_cell(keys.commitment_seed);
245 EnforcingSigner::new_with_revoked(keys, revoked_commitment, false)
248 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, DecodeError> {
249 let mut reader = std::io::Cursor::new(buffer);
251 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
252 let state = self.make_enforcement_state_cell(inner.commitment_seed);
257 disable_revocation_policy_check: false,
261 fn get_destination_script(&self) -> Result<Script, ()> {
262 let secp_ctx = Secp256k1::signing_only();
263 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();
264 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
265 Ok(Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script())
268 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
269 let secp_ctx = Secp256k1::signing_only();
270 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();
271 let pubkey_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &secret_key).serialize());
272 Ok(ShutdownScript::new_p2wpkh(&pubkey_hash))
277 fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
278 let mut revoked_commitments = self.enforcement_states.lock().unwrap();
279 if !revoked_commitments.contains_key(&commitment_seed) {
280 revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(EnforcementState::new())));
282 let cell = revoked_commitments.get(&commitment_seed).unwrap();
288 fn check_api_err(api_err: APIError) {
290 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
291 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
292 APIError::InvalidRoute { .. } => panic!("Our routes should work"),
293 APIError::ChannelUnavailable { err } => {
294 // Test the error against a list of errors we can hit, and reject
295 // all others. If you hit this panic, the list of acceptable errors
296 // is probably just stale and you should add new messages here.
298 "Peer for first hop currently disconnected" => {},
299 _ if err.starts_with("Cannot push more than their max accepted HTLCs ") => {},
300 _ if err.starts_with("Cannot send value that would put us over the max HTLC value in flight our peer will accept ") => {},
301 _ if err.starts_with("Cannot send value that would put our balance under counterparty-announced channel reserve value") => {},
302 _ if err.starts_with("Cannot send value that would put counterparty balance under holder-announced channel reserve value") => {},
303 _ if err.starts_with("Cannot send value that would overdraw remaining funds.") => {},
304 _ if err.starts_with("Cannot send value that would not leave enough to pay for fees.") => {},
305 _ if err.starts_with("Cannot send value that would put our exposure to dust HTLCs at") => {},
306 _ => panic!("{}", err),
309 APIError::MonitorUpdateInProgress => {
310 // We can (obviously) temp-fail a monitor update
312 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
316 fn check_payment_err(send_err: PaymentSendFailure) {
318 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err),
319 PaymentSendFailure::PathParameterError(per_path_results) => {
320 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
322 PaymentSendFailure::AllFailedResendSafe(per_path_results) => {
323 for api_err in per_path_results { check_api_err(api_err); }
325 PaymentSendFailure::PartialFailure { results, .. } => {
326 for res in results { if let Err(api_err) = res { check_api_err(api_err); } }
328 PaymentSendFailure::DuplicatePayment => panic!(),
332 type ChanMan<'a> = ChannelManager<Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<KeyProvider>, Arc<KeyProvider>, Arc<FuzzEstimator>, &'a FuzzRouter, Arc<dyn Logger>>;
335 fn get_payment_secret_hash(dest: &ChanMan, payment_id: &mut u8) -> Option<(PaymentSecret, PaymentHash)> {
336 let mut payment_hash;
338 payment_hash = PaymentHash(Sha256::hash(&[*payment_id; 1]).into_inner());
339 if let Ok(payment_secret) = dest.create_inbound_payment_for_hash(payment_hash, None, 3600, None) {
340 return Some((payment_secret, payment_hash));
342 *payment_id = payment_id.wrapping_add(1);
348 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8, payment_idx: &mut u64) -> bool {
349 let (payment_secret, payment_hash) =
350 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
351 let mut payment_id = [0; 32];
352 payment_id[0..8].copy_from_slice(&payment_idx.to_ne_bytes());
354 if let Err(err) = source.send_payment_with_route(&Route {
355 paths: vec![Path { hops: vec![RouteHop {
356 pubkey: dest.get_our_node_id(),
357 node_features: dest.node_features(),
358 short_channel_id: dest_chan_id,
359 channel_features: dest.channel_features(),
361 cltv_expiry_delta: 200,
362 }], blinded_tail: None }],
363 payment_params: None,
364 }, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
365 check_payment_err(err);
370 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 {
371 let (payment_secret, payment_hash) =
372 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
373 let mut payment_id = [0; 32];
374 payment_id[0..8].copy_from_slice(&payment_idx.to_ne_bytes());
376 if let Err(err) = source.send_payment_with_route(&Route {
377 paths: vec![Path { hops: vec![RouteHop {
378 pubkey: middle.get_our_node_id(),
379 node_features: middle.node_features(),
380 short_channel_id: middle_chan_id,
381 channel_features: middle.channel_features(),
383 cltv_expiry_delta: 100,
385 pubkey: dest.get_our_node_id(),
386 node_features: dest.node_features(),
387 short_channel_id: dest_chan_id,
388 channel_features: dest.channel_features(),
390 cltv_expiry_delta: 200,
391 }], blinded_tail: None }],
392 payment_params: None,
393 }, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
394 check_payment_err(err);
400 pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
401 let out = SearchingOutput::new(underlying_out);
402 let broadcast = Arc::new(TestBroadcaster{});
403 let router = FuzzRouter {};
405 macro_rules! make_node {
406 ($node_id: expr, $fee_estimator: expr) => { {
407 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
408 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();
409 let keys_manager = Arc::new(KeyProvider { node_secret, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
410 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
411 Arc::new(TestPersister {
412 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
413 }), Arc::clone(&keys_manager)));
415 let mut config = UserConfig::default();
416 config.channel_config.forwarding_fee_proportional_millionths = 0;
417 config.channel_handshake_config.announced_channel = true;
418 let network = Network::Bitcoin;
419 let params = ChainParameters {
421 best_block: BestBlock::from_network(network),
423 (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), &router, Arc::clone(&logger), keys_manager.clone(), keys_manager.clone(), keys_manager.clone(), config, params),
424 monitor, keys_manager)
428 macro_rules! reload_node {
429 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
430 let keys_manager = Arc::clone(& $keys_manager);
431 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
432 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
433 Arc::new(TestPersister {
434 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
435 }), Arc::clone(& $keys_manager)));
437 let mut config = UserConfig::default();
438 config.channel_config.forwarding_fee_proportional_millionths = 0;
439 config.channel_handshake_config.announced_channel = true;
441 let mut monitors = HashMap::new();
442 let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
443 for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
444 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut Cursor::new(&monitor_ser), (&*$keys_manager, &*$keys_manager)).expect("Failed to read monitor").1);
445 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
447 let mut monitor_refs = HashMap::new();
448 for (outpoint, monitor) in monitors.iter_mut() {
449 monitor_refs.insert(*outpoint, monitor);
452 let read_args = ChannelManagerReadArgs {
453 entropy_source: keys_manager.clone(),
454 node_signer: keys_manager.clone(),
455 signer_provider: keys_manager.clone(),
456 fee_estimator: $fee_estimator.clone(),
457 chain_monitor: chain_monitor.clone(),
458 tx_broadcaster: broadcast.clone(),
461 default_config: config,
462 channel_monitors: monitor_refs,
465 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
466 for (funding_txo, mon) in monitors.drain() {
467 assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
468 ChannelMonitorUpdateStatus::Completed);
474 let mut channel_txn = Vec::new();
475 macro_rules! make_channel {
476 ($source: expr, $dest: expr, $chan_id: expr) => { {
477 $source.peer_connected(&$dest.get_our_node_id(), &Init {
478 features: $dest.init_features(), networks: None, remote_network_address: None
480 $dest.peer_connected(&$source.get_our_node_id(), &Init {
481 features: $source.init_features(), networks: None, remote_network_address: None
484 $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
486 let events = $source.get_and_clear_pending_msg_events();
487 assert_eq!(events.len(), 1);
488 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
490 } else { panic!("Wrong event type"); }
493 $dest.handle_open_channel(&$source.get_our_node_id(), &open_channel);
494 let accept_channel = {
495 let events = $dest.get_and_clear_pending_msg_events();
496 assert_eq!(events.len(), 1);
497 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
499 } else { panic!("Wrong event type"); }
502 $source.handle_accept_channel(&$dest.get_our_node_id(), &accept_channel);
505 let events = $source.get_and_clear_pending_events();
506 assert_eq!(events.len(), 1);
507 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
508 let tx = Transaction { version: $chan_id, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
509 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
511 funding_output = OutPoint { txid: tx.txid(), index: 0 };
512 $source.funding_transaction_generated(&temporary_channel_id, &$dest.get_our_node_id(), tx.clone()).unwrap();
513 channel_txn.push(tx);
514 } else { panic!("Wrong event type"); }
517 let funding_created = {
518 let events = $source.get_and_clear_pending_msg_events();
519 assert_eq!(events.len(), 1);
520 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
522 } else { panic!("Wrong event type"); }
524 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
526 let funding_signed = {
527 let events = $dest.get_and_clear_pending_msg_events();
528 assert_eq!(events.len(), 1);
529 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
531 } else { panic!("Wrong event type"); }
533 let events = $dest.get_and_clear_pending_events();
534 assert_eq!(events.len(), 1);
535 if let events::Event::ChannelPending{ ref counterparty_node_id, .. } = events[0] {
536 assert_eq!(counterparty_node_id, &$source.get_our_node_id());
537 } else { panic!("Wrong event type"); }
539 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
540 let events = $source.get_and_clear_pending_events();
541 assert_eq!(events.len(), 1);
542 if let events::Event::ChannelPending{ ref counterparty_node_id, .. } = events[0] {
543 assert_eq!(counterparty_node_id, &$dest.get_our_node_id());
544 } else { panic!("Wrong event type"); }
550 macro_rules! confirm_txn {
552 let chain_hash = genesis_block(Network::Bitcoin).block_hash();
553 let mut header = create_dummy_header(chain_hash, 42);
554 let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
555 $node.transactions_confirmed(&header, &txdata, 1);
557 header = create_dummy_header(header.block_hash(), 42);
559 $node.best_block_updated(&header, 99);
563 macro_rules! lock_fundings {
564 ($nodes: expr) => { {
565 let mut node_events = Vec::new();
566 for node in $nodes.iter() {
567 node_events.push(node.get_and_clear_pending_msg_events());
569 for (idx, node_event) in node_events.iter().enumerate() {
570 for event in node_event {
571 if let events::MessageSendEvent::SendChannelReady { ref node_id, ref msg } = event {
572 for node in $nodes.iter() {
573 if node.get_our_node_id() == *node_id {
574 node.handle_channel_ready(&$nodes[idx].get_our_node_id(), msg);
577 } else { panic!("Wrong event type"); }
581 for node in $nodes.iter() {
582 let events = node.get_and_clear_pending_msg_events();
583 for event in events {
584 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
585 } else { panic!("Wrong event type"); }
591 let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
592 let mut last_htlc_clear_fee_a = 253;
593 let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
594 let mut last_htlc_clear_fee_b = 253;
595 let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
596 let mut last_htlc_clear_fee_c = 253;
598 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
600 let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
601 let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
602 let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);
604 let mut nodes = [node_a, node_b, node_c];
606 let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
607 let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
609 for node in nodes.iter() {
613 lock_fundings!(nodes);
615 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
616 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
618 let mut payment_id: u8 = 0;
619 let mut payment_idx: u64 = 0;
621 let mut chan_a_disconnected = false;
622 let mut chan_b_disconnected = false;
623 let mut ab_events = Vec::new();
624 let mut ba_events = Vec::new();
625 let mut bc_events = Vec::new();
626 let mut cb_events = Vec::new();
628 let mut node_a_ser = VecWriter(Vec::new());
629 nodes[0].write(&mut node_a_ser).unwrap();
630 let mut node_b_ser = VecWriter(Vec::new());
631 nodes[1].write(&mut node_b_ser).unwrap();
632 let mut node_c_ser = VecWriter(Vec::new());
633 nodes[2].write(&mut node_c_ser).unwrap();
635 macro_rules! test_return {
637 assert_eq!(nodes[0].list_channels().len(), 1);
638 assert_eq!(nodes[1].list_channels().len(), 2);
639 assert_eq!(nodes[2].list_channels().len(), 1);
644 let mut read_pos = 0;
645 macro_rules! get_slice {
648 let slice_len = $len as usize;
649 if data.len() < read_pos + slice_len {
652 read_pos += slice_len;
653 &data[read_pos - slice_len..read_pos]
659 // Push any events from Node B onto ba_events and bc_events
660 macro_rules! push_excess_b_events {
661 ($excess_events: expr, $expect_drop_node: expr) => { {
662 let a_id = nodes[0].get_our_node_id();
663 let expect_drop_node: Option<usize> = $expect_drop_node;
664 let expect_drop_id = if let Some(id) = expect_drop_node { Some(nodes[id].get_our_node_id()) } else { None };
665 for event in $excess_events {
666 let push_a = match event {
667 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
668 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
671 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
672 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
675 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
676 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
679 events::MessageSendEvent::SendChannelReady { .. } => continue,
680 events::MessageSendEvent::SendAnnouncementSignatures { .. } => continue,
681 events::MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
682 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
683 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
686 _ => panic!("Unhandled message event {:?}", event),
688 if push_a { ba_events.push(event); } else { bc_events.push(event); }
693 // While delivering messages, we select across three possible message selection processes
694 // to ensure we get as much coverage as possible. See the individual enum variants for more
697 enum ProcessMessages {
698 /// Deliver all available messages, including fetching any new messages from
699 /// `get_and_clear_pending_msg_events()` (which may have side effects).
701 /// Call `get_and_clear_pending_msg_events()` first, and then deliver up to one
702 /// message (which may already be queued).
704 /// Deliver up to one already-queued message. This avoids any potential side-effects
705 /// of `get_and_clear_pending_msg_events()` (eg freeing the HTLC holding cell), which
706 /// provides potentially more coverage.
710 macro_rules! process_msg_events {
711 ($node: expr, $corrupt_forward: expr, $limit_events: expr) => { {
712 let mut events = if $node == 1 {
713 let mut new_events = Vec::new();
714 mem::swap(&mut new_events, &mut ba_events);
715 new_events.extend_from_slice(&bc_events[..]);
718 } else if $node == 0 {
719 let mut new_events = Vec::new();
720 mem::swap(&mut new_events, &mut ab_events);
723 let mut new_events = Vec::new();
724 mem::swap(&mut new_events, &mut cb_events);
727 let mut new_events = Vec::new();
728 if $limit_events != ProcessMessages::OnePendingMessage {
729 new_events = nodes[$node].get_and_clear_pending_msg_events();
731 let mut had_events = false;
732 let mut events_iter = events.drain(..).chain(new_events.drain(..));
733 let mut extra_ev = None;
734 for event in &mut events_iter {
737 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
738 for (idx, dest) in nodes.iter().enumerate() {
739 if dest.get_our_node_id() == node_id {
740 for update_add in update_add_htlcs.iter() {
741 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
742 if !$corrupt_forward {
743 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
745 // Corrupt the update_add_htlc message so that its HMAC
746 // check will fail and we generate a
747 // update_fail_malformed_htlc instead of an
748 // update_fail_htlc as we do when we reject a payment.
749 let mut msg_ser = update_add.encode();
750 msg_ser[1000] ^= 0xff;
751 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
752 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
755 for update_fulfill in update_fulfill_htlcs.iter() {
756 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
757 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
759 for update_fail in update_fail_htlcs.iter() {
760 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
761 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
763 for update_fail_malformed in update_fail_malformed_htlcs.iter() {
764 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
765 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
767 if let Some(msg) = update_fee {
768 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
769 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
771 let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
772 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
773 if $limit_events != ProcessMessages::AllMessages && processed_change {
774 // If we only want to process some messages, don't deliver the CS until later.
775 extra_ev = Some(events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate {
776 update_add_htlcs: Vec::new(),
777 update_fail_htlcs: Vec::new(),
778 update_fulfill_htlcs: Vec::new(),
779 update_fail_malformed_htlcs: Vec::new(),
785 out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
786 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
791 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
792 for (idx, dest) in nodes.iter().enumerate() {
793 if dest.get_our_node_id() == *node_id {
794 out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
795 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
799 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
800 for (idx, dest) in nodes.iter().enumerate() {
801 if dest.get_our_node_id() == *node_id {
802 out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
803 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
807 events::MessageSendEvent::SendChannelReady { .. } => {
808 // Can be generated as a reestablish response
810 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {
811 // Can be generated as a reestablish response
813 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
814 // When we reconnect we will resend a channel_update to make sure our
815 // counterparty has the latest parameters for receiving payments
816 // through us. We do, however, check that the message does not include
817 // the "disabled" bit, as we should never ever have a channel which is
818 // disabled when we send such an update (or it may indicate channel
819 // force-close which we should detect as an error).
820 assert_eq!(msg.contents.flags & 2, 0);
822 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
825 panic!("Unhandled message event {:?}", event)
828 if $limit_events != ProcessMessages::AllMessages {
833 push_excess_b_events!(extra_ev.into_iter().chain(events_iter), None);
834 } else if $node == 0 {
835 if let Some(ev) = extra_ev { ab_events.push(ev); }
836 for event in events_iter { ab_events.push(event); }
838 if let Some(ev) = extra_ev { cb_events.push(ev); }
839 for event in events_iter { cb_events.push(event); }
845 macro_rules! drain_msg_events_on_disconnect {
846 ($counterparty_id: expr) => { {
847 if $counterparty_id == 0 {
848 for event in nodes[0].get_and_clear_pending_msg_events() {
850 events::MessageSendEvent::UpdateHTLCs { .. } => {},
851 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
852 events::MessageSendEvent::SendChannelReestablish { .. } => {},
853 events::MessageSendEvent::SendChannelReady { .. } => {},
854 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
855 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
856 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
858 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
861 panic!("Unhandled message event")
865 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(0));
869 for event in nodes[2].get_and_clear_pending_msg_events() {
871 events::MessageSendEvent::UpdateHTLCs { .. } => {},
872 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
873 events::MessageSendEvent::SendChannelReestablish { .. } => {},
874 events::MessageSendEvent::SendChannelReady { .. } => {},
875 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
876 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
877 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
879 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
882 panic!("Unhandled message event")
886 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(2));
893 macro_rules! process_events {
894 ($node: expr, $fail: expr) => { {
895 // In case we get 256 payments we may have a hash collision, resulting in the
896 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
897 // deduplicate the calls here.
898 let mut claim_set = HashSet::new();
899 let mut events = nodes[$node].get_and_clear_pending_events();
900 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
901 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
902 // PaymentClaimable, claiming/failing two HTLCs, but leaving a just-generated
903 // PaymentClaimable event for the second HTLC in our pending_events (and breaking
904 // our claim_set deduplication).
905 events.sort_by(|a, b| {
906 if let events::Event::PaymentClaimable { .. } = a {
907 if let events::Event::PendingHTLCsForwardable { .. } = b {
909 } else { Ordering::Equal }
910 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
911 if let events::Event::PaymentClaimable { .. } = b {
913 } else { Ordering::Equal }
914 } else { Ordering::Equal }
916 let had_events = !events.is_empty();
917 for event in events.drain(..) {
919 events::Event::PaymentClaimable { payment_hash, .. } => {
920 if claim_set.insert(payment_hash.0) {
922 nodes[$node].fail_htlc_backwards(&payment_hash);
924 nodes[$node].claim_funds(PaymentPreimage(payment_hash.0));
928 events::Event::PaymentSent { .. } => {},
929 events::Event::PaymentClaimed { .. } => {},
930 events::Event::PaymentPathSuccessful { .. } => {},
931 events::Event::PaymentPathFailed { .. } => {},
932 events::Event::PaymentFailed { .. } => {},
933 events::Event::ProbeSuccessful { .. } | events::Event::ProbeFailed { .. } => {
934 // Even though we don't explicitly send probes, because probes are
935 // detected based on hashing the payment hash+preimage, its rather
936 // trivial for the fuzzer to build payments that accidentally end up
937 // looking like probes.
939 events::Event::PaymentForwarded { .. } if $node == 1 => {},
940 events::Event::ChannelReady { .. } => {},
941 events::Event::PendingHTLCsForwardable { .. } => {
942 nodes[$node].process_pending_htlc_forwards();
944 events::Event::HTLCHandlingFailed { .. } => {},
945 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
948 panic!("Unhandled event")
956 let v = get_slice!(1)[0];
957 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
959 // In general, we keep related message groups close together in binary form, allowing
960 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
963 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
964 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
965 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
966 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
967 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
968 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
971 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
972 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
973 nodes[0].process_monitor_events();
977 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
978 monitor_b.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
979 nodes[1].process_monitor_events();
983 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
984 monitor_b.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
985 nodes[1].process_monitor_events();
989 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
990 monitor_c.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
991 nodes[2].process_monitor_events();
996 if !chan_a_disconnected {
997 nodes[0].peer_disconnected(&nodes[1].get_our_node_id());
998 nodes[1].peer_disconnected(&nodes[0].get_our_node_id());
999 chan_a_disconnected = true;
1000 drain_msg_events_on_disconnect!(0);
1004 if !chan_b_disconnected {
1005 nodes[1].peer_disconnected(&nodes[2].get_our_node_id());
1006 nodes[2].peer_disconnected(&nodes[1].get_our_node_id());
1007 chan_b_disconnected = true;
1008 drain_msg_events_on_disconnect!(2);
1012 if chan_a_disconnected {
1013 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init {
1014 features: nodes[1].init_features(), networks: None, remote_network_address: None
1016 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init {
1017 features: nodes[0].init_features(), networks: None, remote_network_address: None
1019 chan_a_disconnected = false;
1023 if chan_b_disconnected {
1024 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init {
1025 features: nodes[2].init_features(), networks: None, remote_network_address: None
1027 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init {
1028 features: nodes[1].init_features(), networks: None, remote_network_address: None
1030 chan_b_disconnected = false;
1034 0x10 => { process_msg_events!(0, true, ProcessMessages::AllMessages); },
1035 0x11 => { process_msg_events!(0, false, ProcessMessages::AllMessages); },
1036 0x12 => { process_msg_events!(0, true, ProcessMessages::OneMessage); },
1037 0x13 => { process_msg_events!(0, false, ProcessMessages::OneMessage); },
1038 0x14 => { process_msg_events!(0, true, ProcessMessages::OnePendingMessage); },
1039 0x15 => { process_msg_events!(0, false, ProcessMessages::OnePendingMessage); },
1041 0x16 => { process_events!(0, true); },
1042 0x17 => { process_events!(0, false); },
1044 0x18 => { process_msg_events!(1, true, ProcessMessages::AllMessages); },
1045 0x19 => { process_msg_events!(1, false, ProcessMessages::AllMessages); },
1046 0x1a => { process_msg_events!(1, true, ProcessMessages::OneMessage); },
1047 0x1b => { process_msg_events!(1, false, ProcessMessages::OneMessage); },
1048 0x1c => { process_msg_events!(1, true, ProcessMessages::OnePendingMessage); },
1049 0x1d => { process_msg_events!(1, false, ProcessMessages::OnePendingMessage); },
1051 0x1e => { process_events!(1, true); },
1052 0x1f => { process_events!(1, false); },
1054 0x20 => { process_msg_events!(2, true, ProcessMessages::AllMessages); },
1055 0x21 => { process_msg_events!(2, false, ProcessMessages::AllMessages); },
1056 0x22 => { process_msg_events!(2, true, ProcessMessages::OneMessage); },
1057 0x23 => { process_msg_events!(2, false, ProcessMessages::OneMessage); },
1058 0x24 => { process_msg_events!(2, true, ProcessMessages::OnePendingMessage); },
1059 0x25 => { process_msg_events!(2, false, ProcessMessages::OnePendingMessage); },
1061 0x26 => { process_events!(2, true); },
1062 0x27 => { process_events!(2, false); },
1065 if !chan_a_disconnected {
1066 nodes[1].peer_disconnected(&nodes[0].get_our_node_id());
1067 chan_a_disconnected = true;
1068 drain_msg_events_on_disconnect!(0);
1070 if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
1071 node_a_ser.0.clear();
1072 nodes[0].write(&mut node_a_ser).unwrap();
1074 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
1075 nodes[0] = new_node_a;
1076 monitor_a = new_monitor_a;
1079 if !chan_a_disconnected {
1080 nodes[0].peer_disconnected(&nodes[1].get_our_node_id());
1081 chan_a_disconnected = true;
1082 nodes[0].get_and_clear_pending_msg_events();
1086 if !chan_b_disconnected {
1087 nodes[2].peer_disconnected(&nodes[1].get_our_node_id());
1088 chan_b_disconnected = true;
1089 nodes[2].get_and_clear_pending_msg_events();
1093 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
1094 nodes[1] = new_node_b;
1095 monitor_b = new_monitor_b;
1098 if !chan_b_disconnected {
1099 nodes[1].peer_disconnected(&nodes[2].get_our_node_id());
1100 chan_b_disconnected = true;
1101 drain_msg_events_on_disconnect!(2);
1103 if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
1104 node_c_ser.0.clear();
1105 nodes[2].write(&mut node_c_ser).unwrap();
1107 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
1108 nodes[2] = new_node_c;
1109 monitor_c = new_monitor_c;
1112 // 1/10th the channel size:
1113 0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1114 0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1115 0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1116 0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1117 0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1118 0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1120 0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1121 0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1122 0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1123 0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1124 0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1125 0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1127 0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1128 0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1129 0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1130 0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1131 0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1132 0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1134 0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1135 0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1136 0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1137 0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1138 0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1139 0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1141 0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1142 0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1143 0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1144 0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1145 0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1146 0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1148 0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id, &mut payment_idx); },
1149 0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id, &mut payment_idx); },
1150 0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id, &mut payment_idx); },
1151 0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id, &mut payment_idx); },
1152 0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id, &mut payment_idx); },
1153 0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id, &mut payment_idx); },
1155 0x60 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id, &mut payment_idx); },
1156 0x61 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id, &mut payment_idx); },
1157 0x62 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id, &mut payment_idx); },
1158 0x63 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id, &mut payment_idx); },
1159 0x64 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id, &mut payment_idx); },
1160 0x65 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id, &mut payment_idx); },
1162 0x68 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id, &mut payment_idx); },
1163 0x69 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id, &mut payment_idx); },
1164 0x6a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id, &mut payment_idx); },
1165 0x6b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id, &mut payment_idx); },
1166 0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id, &mut payment_idx); },
1167 0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id, &mut payment_idx); },
1170 let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1171 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1172 fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
1174 nodes[0].maybe_update_chan_fees();
1176 0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },
1179 let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1180 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1181 fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
1183 nodes[1].maybe_update_chan_fees();
1185 0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },
1188 let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1189 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1190 fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
1192 nodes[2].maybe_update_chan_fees();
1194 0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },
1197 // Test that no channel is in a stuck state where neither party can send funds even
1198 // after we resolve all pending events.
1199 // First make sure there are no pending monitor updates, resetting the error state
1200 // and calling force_channel_monitor_updated for each monitor.
1201 *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1202 *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1203 *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1205 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1206 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1207 nodes[0].process_monitor_events();
1209 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1210 monitor_b.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1211 nodes[1].process_monitor_events();
1213 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1214 monitor_b.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1215 nodes[1].process_monitor_events();
1217 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1218 monitor_c.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1219 nodes[2].process_monitor_events();
1222 // Next, make sure peers are all connected to each other
1223 if chan_a_disconnected {
1224 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init {
1225 features: nodes[1].init_features(), networks: None, remote_network_address: None
1227 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init {
1228 features: nodes[0].init_features(), networks: None, remote_network_address: None
1230 chan_a_disconnected = false;
1232 if chan_b_disconnected {
1233 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init {
1234 features: nodes[2].init_features(), networks: None, remote_network_address: None
1236 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init {
1237 features: nodes[1].init_features(), networks: None, remote_network_address: None
1239 chan_b_disconnected = false;
1242 for i in 0..std::usize::MAX {
1243 if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
1244 // Then, make sure any current forwards make their way to their destination
1245 if process_msg_events!(0, false, ProcessMessages::AllMessages) { continue; }
1246 if process_msg_events!(1, false, ProcessMessages::AllMessages) { continue; }
1247 if process_msg_events!(2, false, ProcessMessages::AllMessages) { continue; }
1248 // ...making sure any pending PendingHTLCsForwardable events are handled and
1249 // payments claimed.
1250 if process_events!(0, false) { continue; }
1251 if process_events!(1, false) { continue; }
1252 if process_events!(2, false) { continue; }
1256 // Finally, make sure that at least one end of each channel can make a substantial payment
1258 send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id, &mut payment_idx) ||
1259 send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx));
1261 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx) ||
1262 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id, &mut payment_idx));
1264 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
1265 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
1266 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
1268 _ => test_return!(),
1271 node_a_ser.0.clear();
1272 nodes[0].write(&mut node_a_ser).unwrap();
1273 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
1274 node_b_ser.0.clear();
1275 nodes[1].write(&mut node_b_ser).unwrap();
1276 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
1277 node_c_ser.0.clear();
1278 nodes[2].write(&mut node_c_ser).unwrap();
1279 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
1283 /// We actually have different behavior based on if a certain log string has been seen, so we have
1284 /// to do a bit more tracking.
1286 struct SearchingOutput<O: Output> {
1288 may_fail: Arc<atomic::AtomicBool>,
1290 impl<O: Output> Output for SearchingOutput<O> {
1291 fn locked_write(&self, data: &[u8]) {
1292 // We hit a design limitation of LN state machine (see CONCURRENT_INBOUND_HTLC_FEE_BUFFER)
1293 if std::str::from_utf8(data).unwrap().contains("Outbound update_fee HTLC buffer overflow - counterparty should force-close this channel") {
1294 self.may_fail.store(true, atomic::Ordering::Release);
1296 self.output.locked_write(data)
1299 impl<O: Output> SearchingOutput<O> {
1300 pub fn new(output: O) -> Self {
1301 Self { output, may_fail: Arc::new(atomic::AtomicBool::new(false)) }
1305 pub fn chanmon_consistency_test<Out: Output>(data: &[u8], out: Out) {
1310 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
1311 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});