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::offers::invoice::UnsignedBolt12Invoice;
48 use lightning::offers::invoice_request::UnsignedInvoiceRequest;
49 use lightning::util::test_channel_signer::{TestChannelSigner, EnforcementState};
50 use lightning::util::errors::APIError;
51 use lightning::util::logger::Logger;
52 use lightning::util::config::UserConfig;
53 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
54 use lightning::routing::router::{InFlightHtlcs, Path, Route, RouteHop, RouteParameters, Router};
56 use crate::utils::test_logger::{self, Output};
57 use crate::utils::test_persister::TestPersister;
59 use bitcoin::secp256k1::{Message, PublicKey, SecretKey, Scalar, Secp256k1};
60 use bitcoin::secp256k1::ecdh::SharedSecret;
61 use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
62 use bitcoin::secp256k1::schnorr;
65 use std::cmp::{self, Ordering};
66 use hashbrown::{HashSet, hash_map, HashMap};
67 use std::sync::{Arc,Mutex};
68 use std::sync::atomic;
70 use bitcoin::bech32::u5;
72 const MAX_FEE: u32 = 10_000;
73 struct FuzzEstimator {
74 ret_val: atomic::AtomicU32,
76 impl FeeEstimator for FuzzEstimator {
77 fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
78 // We force-close channels if our counterparty sends us a feerate which is a small multiple
79 // of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
80 // always return a HighPriority feerate here which is >= the maximum Normal feerate and a
81 // Background feerate which is <= the minimum Normal feerate.
83 ConfirmationTarget::HighPriority => MAX_FEE,
84 ConfirmationTarget::Background|ConfirmationTarget::MempoolMinimum => 253,
85 ConfirmationTarget::Normal => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
92 impl Router for FuzzRouter {
94 &self, _payer: &PublicKey, _params: &RouteParameters, _first_hops: Option<&[&ChannelDetails]>,
95 _inflight_htlcs: InFlightHtlcs
96 ) -> Result<Route, msgs::LightningError> {
97 Err(msgs::LightningError {
98 err: String::from("Not implemented"),
99 action: msgs::ErrorAction::IgnoreError
104 pub struct TestBroadcaster {}
105 impl BroadcasterInterface for TestBroadcaster {
106 fn broadcast_transactions(&self, _txs: &[&Transaction]) { }
109 pub struct VecWriter(pub Vec<u8>);
110 impl Writer for VecWriter {
111 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
112 self.0.extend_from_slice(buf);
117 struct TestChainMonitor {
118 pub logger: Arc<dyn Logger>,
119 pub keys: Arc<KeyProvider>,
120 pub persister: Arc<TestPersister>,
121 pub chain_monitor: Arc<chainmonitor::ChainMonitor<TestChannelSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
122 // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
123 // logic will automatically force-close our channels for us (as we don't have an up-to-date
124 // monitor implying we are not able to punish misbehaving counterparties). Because this test
125 // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
126 // fully-serialized monitor state here, as well as the corresponding update_id.
127 pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
128 pub should_update_manager: atomic::AtomicBool,
130 impl TestChainMonitor {
131 pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>, keys: Arc<KeyProvider>) -> Self {
133 chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, Arc::clone(&persister))),
137 latest_monitors: Mutex::new(HashMap::new()),
138 should_update_manager: atomic::AtomicBool::new(false),
142 impl chain::Watch<TestChannelSigner> for TestChainMonitor {
143 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<TestChannelSigner>) -> chain::ChannelMonitorUpdateStatus {
144 let mut ser = VecWriter(Vec::new());
145 monitor.write(&mut ser).unwrap();
146 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
147 panic!("Already had monitor pre-watch_channel");
149 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
150 self.chain_monitor.watch_channel(funding_txo, monitor)
153 fn update_channel(&self, funding_txo: OutPoint, update: &channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
154 let mut map_lock = self.latest_monitors.lock().unwrap();
155 let mut map_entry = match map_lock.entry(funding_txo) {
156 hash_map::Entry::Occupied(entry) => entry,
157 hash_map::Entry::Vacant(_) => panic!("Didn't have monitor on update call"),
159 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::
160 read(&mut Cursor::new(&map_entry.get().1), (&*self.keys, &*self.keys)).unwrap().1;
161 deserialized_monitor.update_monitor(update, &&TestBroadcaster{}, &FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
162 let mut ser = VecWriter(Vec::new());
163 deserialized_monitor.write(&mut ser).unwrap();
164 map_entry.insert((update.update_id, ser.0));
165 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
166 self.chain_monitor.update_channel(funding_txo, update)
169 fn release_pending_monitor_events(&self) -> Vec<(OutPoint, Vec<MonitorEvent>, Option<PublicKey>)> {
170 return self.chain_monitor.release_pending_monitor_events();
175 node_secret: SecretKey,
176 rand_bytes_id: atomic::AtomicU32,
177 enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
180 impl EntropySource for KeyProvider {
181 fn get_secure_random_bytes(&self) -> [u8; 32] {
182 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
183 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]];
184 res[30-4..30].copy_from_slice(&id.to_le_bytes());
189 impl NodeSigner for KeyProvider {
190 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
191 let node_secret = match recipient {
192 Recipient::Node => Ok(&self.node_secret),
193 Recipient::PhantomNode => Err(())
195 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
198 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
199 let mut node_secret = match recipient {
200 Recipient::Node => Ok(self.node_secret.clone()),
201 Recipient::PhantomNode => Err(())
203 if let Some(tweak) = tweak {
204 node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
206 Ok(SharedSecret::new(other_key, &node_secret))
209 fn get_inbound_payment_key_material(&self) -> KeyMaterial {
210 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]])
213 fn sign_invoice(&self, _hrp_bytes: &[u8], _invoice_data: &[u5], _recipient: Recipient) -> Result<RecoverableSignature, ()> {
217 fn sign_bolt12_invoice_request(
218 &self, _invoice_request: &UnsignedInvoiceRequest
219 ) -> Result<schnorr::Signature, ()> {
223 fn sign_bolt12_invoice(
224 &self, _invoice: &UnsignedBolt12Invoice,
225 ) -> Result<schnorr::Signature, ()> {
229 fn sign_gossip_message(&self, msg: lightning::ln::msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
230 let msg_hash = Message::from_slice(&Sha256dHash::hash(&msg.encode()[..])[..]).map_err(|_| ())?;
231 let secp_ctx = Secp256k1::signing_only();
232 Ok(secp_ctx.sign_ecdsa(&msg_hash, &self.node_secret))
236 impl SignerProvider for KeyProvider {
237 type Signer = TestChannelSigner;
239 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] {
240 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed) as u8;
244 fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> Self::Signer {
245 let secp_ctx = Secp256k1::signing_only();
246 let id = channel_keys_id[0];
247 let keys = InMemorySigner::new(
249 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, self.node_secret[31]]).unwrap(),
250 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(),
251 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(),
252 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(),
253 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(),
254 [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]],
255 channel_value_satoshis,
259 let revoked_commitment = self.make_enforcement_state_cell(keys.commitment_seed);
260 TestChannelSigner::new_with_revoked(keys, revoked_commitment, false)
263 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, DecodeError> {
264 let mut reader = std::io::Cursor::new(buffer);
266 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
267 let state = self.make_enforcement_state_cell(inner.commitment_seed);
269 Ok(TestChannelSigner {
272 disable_revocation_policy_check: false,
276 fn get_destination_script(&self) -> Result<Script, ()> {
277 let secp_ctx = Secp256k1::signing_only();
278 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();
279 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
280 Ok(Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script())
283 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
284 let secp_ctx = Secp256k1::signing_only();
285 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();
286 let pubkey_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &secret_key).serialize());
287 Ok(ShutdownScript::new_p2wpkh(&pubkey_hash))
292 fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
293 let mut revoked_commitments = self.enforcement_states.lock().unwrap();
294 if !revoked_commitments.contains_key(&commitment_seed) {
295 revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(EnforcementState::new())));
297 let cell = revoked_commitments.get(&commitment_seed).unwrap();
303 fn check_api_err(api_err: APIError, sendable_bounds_violated: bool) {
305 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
306 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
307 APIError::InvalidRoute { .. } => panic!("Our routes should work"),
308 APIError::ChannelUnavailable { err } => {
309 // Test the error against a list of errors we can hit, and reject
310 // all others. If you hit this panic, the list of acceptable errors
311 // is probably just stale and you should add new messages here.
313 "Peer for first hop currently disconnected" => {},
314 _ if err.starts_with("Cannot send less than our next-HTLC minimum - ") => {},
315 _ if err.starts_with("Cannot send more than our next-HTLC maximum - ") => {},
316 _ => panic!("{}", err),
318 assert!(sendable_bounds_violated);
320 APIError::MonitorUpdateInProgress => {
321 // We can (obviously) temp-fail a monitor update
323 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
327 fn check_payment_err(send_err: PaymentSendFailure, sendable_bounds_violated: bool) {
329 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err, sendable_bounds_violated),
330 PaymentSendFailure::PathParameterError(per_path_results) => {
331 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err, sendable_bounds_violated); } }
333 PaymentSendFailure::AllFailedResendSafe(per_path_results) => {
334 for api_err in per_path_results { check_api_err(api_err, sendable_bounds_violated); }
336 PaymentSendFailure::PartialFailure { results, .. } => {
337 for res in results { if let Err(api_err) = res { check_api_err(api_err, sendable_bounds_violated); } }
339 PaymentSendFailure::DuplicatePayment => panic!(),
343 type ChanMan<'a> = ChannelManager<Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<KeyProvider>, Arc<KeyProvider>, Arc<FuzzEstimator>, &'a FuzzRouter, Arc<dyn Logger>>;
346 fn get_payment_secret_hash(dest: &ChanMan, payment_id: &mut u8) -> Option<(PaymentSecret, PaymentHash)> {
347 let mut payment_hash;
349 payment_hash = PaymentHash(Sha256::hash(&[*payment_id; 1]).into_inner());
350 if let Ok(payment_secret) = dest.create_inbound_payment_for_hash(payment_hash, None, 3600, None) {
351 return Some((payment_secret, payment_hash));
353 *payment_id = payment_id.wrapping_add(1);
359 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8, payment_idx: &mut u64) -> bool {
360 let (payment_secret, payment_hash) =
361 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
362 let mut payment_id = [0; 32];
363 payment_id[0..8].copy_from_slice(&payment_idx.to_ne_bytes());
365 let (min_value_sendable, max_value_sendable) = source.list_usable_channels()
366 .iter().find(|chan| chan.short_channel_id == Some(dest_chan_id))
368 (chan.next_outbound_htlc_minimum_msat, chan.next_outbound_htlc_limit_msat))
370 if let Err(err) = source.send_payment_with_route(&Route {
371 paths: vec![Path { hops: vec![RouteHop {
372 pubkey: dest.get_our_node_id(),
373 node_features: dest.node_features(),
374 short_channel_id: dest_chan_id,
375 channel_features: dest.channel_features(),
377 cltv_expiry_delta: 200,
378 }], blinded_tail: None }],
380 }, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
381 check_payment_err(err, amt > max_value_sendable || amt < min_value_sendable);
384 // Note that while the max is a strict upper-bound, we can occasionally send substantially
385 // below the minimum, with some gap which is unusable immediately below the minimum. Thus,
386 // we don't check against min_value_sendable here.
387 assert!(amt <= max_value_sendable);
392 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 {
393 let (payment_secret, payment_hash) =
394 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
395 let mut payment_id = [0; 32];
396 payment_id[0..8].copy_from_slice(&payment_idx.to_ne_bytes());
398 let (min_value_sendable, max_value_sendable) = source.list_usable_channels()
399 .iter().find(|chan| chan.short_channel_id == Some(middle_chan_id))
401 (chan.next_outbound_htlc_minimum_msat, chan.next_outbound_htlc_limit_msat))
403 let first_hop_fee = 50_000;
404 if let Err(err) = source.send_payment_with_route(&Route {
405 paths: vec![Path { hops: vec![RouteHop {
406 pubkey: middle.get_our_node_id(),
407 node_features: middle.node_features(),
408 short_channel_id: middle_chan_id,
409 channel_features: middle.channel_features(),
410 fee_msat: first_hop_fee,
411 cltv_expiry_delta: 100,
413 pubkey: dest.get_our_node_id(),
414 node_features: dest.node_features(),
415 short_channel_id: dest_chan_id,
416 channel_features: dest.channel_features(),
418 cltv_expiry_delta: 200,
419 }], blinded_tail: None }],
421 }, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
422 let sent_amt = amt + first_hop_fee;
423 check_payment_err(err, sent_amt < min_value_sendable || sent_amt > max_value_sendable);
426 // Note that while the max is a strict upper-bound, we can occasionally send substantially
427 // below the minimum, with some gap which is unusable immediately below the minimum. Thus,
428 // we don't check against min_value_sendable here.
429 assert!(amt + first_hop_fee <= max_value_sendable);
435 pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
436 let out = SearchingOutput::new(underlying_out);
437 let broadcast = Arc::new(TestBroadcaster{});
438 let router = FuzzRouter {};
440 macro_rules! make_node {
441 ($node_id: expr, $fee_estimator: expr) => { {
442 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
443 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();
444 let keys_manager = Arc::new(KeyProvider { node_secret, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
445 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
446 Arc::new(TestPersister {
447 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
448 }), Arc::clone(&keys_manager)));
450 let mut config = UserConfig::default();
451 config.channel_config.forwarding_fee_proportional_millionths = 0;
452 config.channel_handshake_config.announced_channel = true;
453 let network = Network::Bitcoin;
454 let best_block_timestamp = genesis_block(network).header.time;
455 let params = ChainParameters {
457 best_block: BestBlock::from_network(network),
459 (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), &router, Arc::clone(&logger), keys_manager.clone(), keys_manager.clone(), keys_manager.clone(), config, params, best_block_timestamp),
460 monitor, keys_manager)
464 macro_rules! reload_node {
465 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
466 let keys_manager = Arc::clone(& $keys_manager);
467 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
468 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
469 Arc::new(TestPersister {
470 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
471 }), Arc::clone(& $keys_manager)));
473 let mut config = UserConfig::default();
474 config.channel_config.forwarding_fee_proportional_millionths = 0;
475 config.channel_handshake_config.announced_channel = true;
477 let mut monitors = HashMap::new();
478 let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
479 for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
480 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(&mut Cursor::new(&monitor_ser), (&*$keys_manager, &*$keys_manager)).expect("Failed to read monitor").1);
481 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
483 let mut monitor_refs = HashMap::new();
484 for (outpoint, monitor) in monitors.iter_mut() {
485 monitor_refs.insert(*outpoint, monitor);
488 let read_args = ChannelManagerReadArgs {
489 entropy_source: keys_manager.clone(),
490 node_signer: keys_manager.clone(),
491 signer_provider: keys_manager.clone(),
492 fee_estimator: $fee_estimator.clone(),
493 chain_monitor: chain_monitor.clone(),
494 tx_broadcaster: broadcast.clone(),
497 default_config: config,
498 channel_monitors: monitor_refs,
501 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
502 for (funding_txo, mon) in monitors.drain() {
503 assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
504 ChannelMonitorUpdateStatus::Completed);
510 let mut channel_txn = Vec::new();
511 macro_rules! make_channel {
512 ($source: expr, $dest: expr, $chan_id: expr) => { {
513 $source.peer_connected(&$dest.get_our_node_id(), &Init {
514 features: $dest.init_features(), networks: None, remote_network_address: None
516 $dest.peer_connected(&$source.get_our_node_id(), &Init {
517 features: $source.init_features(), networks: None, remote_network_address: None
520 $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
522 let events = $source.get_and_clear_pending_msg_events();
523 assert_eq!(events.len(), 1);
524 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
526 } else { panic!("Wrong event type"); }
529 $dest.handle_open_channel(&$source.get_our_node_id(), &open_channel);
530 let accept_channel = {
531 let events = $dest.get_and_clear_pending_msg_events();
532 assert_eq!(events.len(), 1);
533 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
535 } else { panic!("Wrong event type"); }
538 $source.handle_accept_channel(&$dest.get_our_node_id(), &accept_channel);
541 let events = $source.get_and_clear_pending_events();
542 assert_eq!(events.len(), 1);
543 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
544 let tx = Transaction { version: $chan_id, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
545 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
547 funding_output = OutPoint { txid: tx.txid(), index: 0 };
548 $source.funding_transaction_generated(&temporary_channel_id, &$dest.get_our_node_id(), tx.clone()).unwrap();
549 channel_txn.push(tx);
550 } else { panic!("Wrong event type"); }
553 let funding_created = {
554 let events = $source.get_and_clear_pending_msg_events();
555 assert_eq!(events.len(), 1);
556 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
558 } else { panic!("Wrong event type"); }
560 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
562 let funding_signed = {
563 let events = $dest.get_and_clear_pending_msg_events();
564 assert_eq!(events.len(), 1);
565 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
567 } else { panic!("Wrong event type"); }
569 let events = $dest.get_and_clear_pending_events();
570 assert_eq!(events.len(), 1);
571 if let events::Event::ChannelPending{ ref counterparty_node_id, .. } = events[0] {
572 assert_eq!(counterparty_node_id, &$source.get_our_node_id());
573 } else { panic!("Wrong event type"); }
575 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
576 let events = $source.get_and_clear_pending_events();
577 assert_eq!(events.len(), 1);
578 if let events::Event::ChannelPending{ ref counterparty_node_id, .. } = events[0] {
579 assert_eq!(counterparty_node_id, &$dest.get_our_node_id());
580 } else { panic!("Wrong event type"); }
586 macro_rules! confirm_txn {
588 let chain_hash = genesis_block(Network::Bitcoin).block_hash();
589 let mut header = create_dummy_header(chain_hash, 42);
590 let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
591 $node.transactions_confirmed(&header, &txdata, 1);
593 header = create_dummy_header(header.block_hash(), 42);
595 $node.best_block_updated(&header, 99);
599 macro_rules! lock_fundings {
600 ($nodes: expr) => { {
601 let mut node_events = Vec::new();
602 for node in $nodes.iter() {
603 node_events.push(node.get_and_clear_pending_msg_events());
605 for (idx, node_event) in node_events.iter().enumerate() {
606 for event in node_event {
607 if let events::MessageSendEvent::SendChannelReady { ref node_id, ref msg } = event {
608 for node in $nodes.iter() {
609 if node.get_our_node_id() == *node_id {
610 node.handle_channel_ready(&$nodes[idx].get_our_node_id(), msg);
613 } else { panic!("Wrong event type"); }
617 for node in $nodes.iter() {
618 let events = node.get_and_clear_pending_msg_events();
619 for event in events {
620 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
621 } else { panic!("Wrong event type"); }
627 let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
628 let mut last_htlc_clear_fee_a = 253;
629 let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
630 let mut last_htlc_clear_fee_b = 253;
631 let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
632 let mut last_htlc_clear_fee_c = 253;
634 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
636 let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
637 let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
638 let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);
640 let mut nodes = [node_a, node_b, node_c];
642 let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
643 let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
645 for node in nodes.iter() {
649 lock_fundings!(nodes);
651 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
652 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
654 let mut payment_id: u8 = 0;
655 let mut payment_idx: u64 = 0;
657 let mut chan_a_disconnected = false;
658 let mut chan_b_disconnected = false;
659 let mut ab_events = Vec::new();
660 let mut ba_events = Vec::new();
661 let mut bc_events = Vec::new();
662 let mut cb_events = Vec::new();
664 let mut node_a_ser = VecWriter(Vec::new());
665 nodes[0].write(&mut node_a_ser).unwrap();
666 let mut node_b_ser = VecWriter(Vec::new());
667 nodes[1].write(&mut node_b_ser).unwrap();
668 let mut node_c_ser = VecWriter(Vec::new());
669 nodes[2].write(&mut node_c_ser).unwrap();
671 macro_rules! test_return {
673 assert_eq!(nodes[0].list_channels().len(), 1);
674 assert_eq!(nodes[1].list_channels().len(), 2);
675 assert_eq!(nodes[2].list_channels().len(), 1);
680 let mut read_pos = 0;
681 macro_rules! get_slice {
684 let slice_len = $len as usize;
685 if data.len() < read_pos + slice_len {
688 read_pos += slice_len;
689 &data[read_pos - slice_len..read_pos]
695 // Push any events from Node B onto ba_events and bc_events
696 macro_rules! push_excess_b_events {
697 ($excess_events: expr, $expect_drop_node: expr) => { {
698 let a_id = nodes[0].get_our_node_id();
699 let expect_drop_node: Option<usize> = $expect_drop_node;
700 let expect_drop_id = if let Some(id) = expect_drop_node { Some(nodes[id].get_our_node_id()) } else { None };
701 for event in $excess_events {
702 let push_a = match event {
703 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
704 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
707 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
708 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
711 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
712 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
715 events::MessageSendEvent::SendChannelReady { .. } => continue,
716 events::MessageSendEvent::SendAnnouncementSignatures { .. } => continue,
717 events::MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
718 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
719 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
722 _ => panic!("Unhandled message event {:?}", event),
724 if push_a { ba_events.push(event); } else { bc_events.push(event); }
729 // While delivering messages, we select across three possible message selection processes
730 // to ensure we get as much coverage as possible. See the individual enum variants for more
733 enum ProcessMessages {
734 /// Deliver all available messages, including fetching any new messages from
735 /// `get_and_clear_pending_msg_events()` (which may have side effects).
737 /// Call `get_and_clear_pending_msg_events()` first, and then deliver up to one
738 /// message (which may already be queued).
740 /// Deliver up to one already-queued message. This avoids any potential side-effects
741 /// of `get_and_clear_pending_msg_events()` (eg freeing the HTLC holding cell), which
742 /// provides potentially more coverage.
746 macro_rules! process_msg_events {
747 ($node: expr, $corrupt_forward: expr, $limit_events: expr) => { {
748 let mut events = if $node == 1 {
749 let mut new_events = Vec::new();
750 mem::swap(&mut new_events, &mut ba_events);
751 new_events.extend_from_slice(&bc_events[..]);
754 } else if $node == 0 {
755 let mut new_events = Vec::new();
756 mem::swap(&mut new_events, &mut ab_events);
759 let mut new_events = Vec::new();
760 mem::swap(&mut new_events, &mut cb_events);
763 let mut new_events = Vec::new();
764 if $limit_events != ProcessMessages::OnePendingMessage {
765 new_events = nodes[$node].get_and_clear_pending_msg_events();
767 let mut had_events = false;
768 let mut events_iter = events.drain(..).chain(new_events.drain(..));
769 let mut extra_ev = None;
770 for event in &mut events_iter {
773 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
774 for (idx, dest) in nodes.iter().enumerate() {
775 if dest.get_our_node_id() == node_id {
776 for update_add in update_add_htlcs.iter() {
777 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
778 if !$corrupt_forward {
779 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
781 // Corrupt the update_add_htlc message so that its HMAC
782 // check will fail and we generate a
783 // update_fail_malformed_htlc instead of an
784 // update_fail_htlc as we do when we reject a payment.
785 let mut msg_ser = update_add.encode();
786 msg_ser[1000] ^= 0xff;
787 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
788 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
791 for update_fulfill in update_fulfill_htlcs.iter() {
792 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
793 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
795 for update_fail in update_fail_htlcs.iter() {
796 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
797 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
799 for update_fail_malformed in update_fail_malformed_htlcs.iter() {
800 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
801 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
803 if let Some(msg) = update_fee {
804 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
805 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
807 let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
808 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
809 if $limit_events != ProcessMessages::AllMessages && processed_change {
810 // If we only want to process some messages, don't deliver the CS until later.
811 extra_ev = Some(events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate {
812 update_add_htlcs: Vec::new(),
813 update_fail_htlcs: Vec::new(),
814 update_fulfill_htlcs: Vec::new(),
815 update_fail_malformed_htlcs: Vec::new(),
821 out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
822 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
827 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
828 for (idx, dest) in nodes.iter().enumerate() {
829 if dest.get_our_node_id() == *node_id {
830 out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
831 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
835 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
836 for (idx, dest) in nodes.iter().enumerate() {
837 if dest.get_our_node_id() == *node_id {
838 out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
839 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
843 events::MessageSendEvent::SendChannelReady { .. } => {
844 // Can be generated as a reestablish response
846 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {
847 // Can be generated as a reestablish response
849 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
850 // When we reconnect we will resend a channel_update to make sure our
851 // counterparty has the latest parameters for receiving payments
852 // through us. We do, however, check that the message does not include
853 // the "disabled" bit, as we should never ever have a channel which is
854 // disabled when we send such an update (or it may indicate channel
855 // force-close which we should detect as an error).
856 assert_eq!(msg.contents.flags & 2, 0);
858 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
861 panic!("Unhandled message event {:?}", event)
864 if $limit_events != ProcessMessages::AllMessages {
869 push_excess_b_events!(extra_ev.into_iter().chain(events_iter), None);
870 } else if $node == 0 {
871 if let Some(ev) = extra_ev { ab_events.push(ev); }
872 for event in events_iter { ab_events.push(event); }
874 if let Some(ev) = extra_ev { cb_events.push(ev); }
875 for event in events_iter { cb_events.push(event); }
881 macro_rules! drain_msg_events_on_disconnect {
882 ($counterparty_id: expr) => { {
883 if $counterparty_id == 0 {
884 for event in nodes[0].get_and_clear_pending_msg_events() {
886 events::MessageSendEvent::UpdateHTLCs { .. } => {},
887 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
888 events::MessageSendEvent::SendChannelReestablish { .. } => {},
889 events::MessageSendEvent::SendChannelReady { .. } => {},
890 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
891 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
892 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
894 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
897 panic!("Unhandled message event")
901 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(0));
905 for event in nodes[2].get_and_clear_pending_msg_events() {
907 events::MessageSendEvent::UpdateHTLCs { .. } => {},
908 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
909 events::MessageSendEvent::SendChannelReestablish { .. } => {},
910 events::MessageSendEvent::SendChannelReady { .. } => {},
911 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
912 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
913 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
915 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
918 panic!("Unhandled message event")
922 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(2));
929 macro_rules! process_events {
930 ($node: expr, $fail: expr) => { {
931 // In case we get 256 payments we may have a hash collision, resulting in the
932 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
933 // deduplicate the calls here.
934 let mut claim_set = HashSet::new();
935 let mut events = nodes[$node].get_and_clear_pending_events();
936 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
937 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
938 // PaymentClaimable, claiming/failing two HTLCs, but leaving a just-generated
939 // PaymentClaimable event for the second HTLC in our pending_events (and breaking
940 // our claim_set deduplication).
941 events.sort_by(|a, b| {
942 if let events::Event::PaymentClaimable { .. } = a {
943 if let events::Event::PendingHTLCsForwardable { .. } = b {
945 } else { Ordering::Equal }
946 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
947 if let events::Event::PaymentClaimable { .. } = b {
949 } else { Ordering::Equal }
950 } else { Ordering::Equal }
952 let had_events = !events.is_empty();
953 for event in events.drain(..) {
955 events::Event::PaymentClaimable { payment_hash, .. } => {
956 if claim_set.insert(payment_hash.0) {
958 nodes[$node].fail_htlc_backwards(&payment_hash);
960 nodes[$node].claim_funds(PaymentPreimage(payment_hash.0));
964 events::Event::PaymentSent { .. } => {},
965 events::Event::PaymentClaimed { .. } => {},
966 events::Event::PaymentPathSuccessful { .. } => {},
967 events::Event::PaymentPathFailed { .. } => {},
968 events::Event::PaymentFailed { .. } => {},
969 events::Event::ProbeSuccessful { .. } | events::Event::ProbeFailed { .. } => {
970 // Even though we don't explicitly send probes, because probes are
971 // detected based on hashing the payment hash+preimage, its rather
972 // trivial for the fuzzer to build payments that accidentally end up
973 // looking like probes.
975 events::Event::PaymentForwarded { .. } if $node == 1 => {},
976 events::Event::ChannelReady { .. } => {},
977 events::Event::PendingHTLCsForwardable { .. } => {
978 nodes[$node].process_pending_htlc_forwards();
980 events::Event::HTLCHandlingFailed { .. } => {},
981 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
984 panic!("Unhandled event")
992 let v = get_slice!(1)[0];
993 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
995 // In general, we keep related message groups close together in binary form, allowing
996 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
999 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
1000 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
1001 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
1002 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
1003 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
1004 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
1007 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1008 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1009 nodes[0].process_monitor_events();
1013 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1014 monitor_b.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1015 nodes[1].process_monitor_events();
1019 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1020 monitor_b.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1021 nodes[1].process_monitor_events();
1025 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1026 monitor_c.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1027 nodes[2].process_monitor_events();
1032 if !chan_a_disconnected {
1033 nodes[0].peer_disconnected(&nodes[1].get_our_node_id());
1034 nodes[1].peer_disconnected(&nodes[0].get_our_node_id());
1035 chan_a_disconnected = true;
1036 drain_msg_events_on_disconnect!(0);
1040 if !chan_b_disconnected {
1041 nodes[1].peer_disconnected(&nodes[2].get_our_node_id());
1042 nodes[2].peer_disconnected(&nodes[1].get_our_node_id());
1043 chan_b_disconnected = true;
1044 drain_msg_events_on_disconnect!(2);
1048 if chan_a_disconnected {
1049 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init {
1050 features: nodes[1].init_features(), networks: None, remote_network_address: None
1052 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init {
1053 features: nodes[0].init_features(), networks: None, remote_network_address: None
1055 chan_a_disconnected = false;
1059 if chan_b_disconnected {
1060 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init {
1061 features: nodes[2].init_features(), networks: None, remote_network_address: None
1063 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init {
1064 features: nodes[1].init_features(), networks: None, remote_network_address: None
1066 chan_b_disconnected = false;
1070 0x10 => { process_msg_events!(0, true, ProcessMessages::AllMessages); },
1071 0x11 => { process_msg_events!(0, false, ProcessMessages::AllMessages); },
1072 0x12 => { process_msg_events!(0, true, ProcessMessages::OneMessage); },
1073 0x13 => { process_msg_events!(0, false, ProcessMessages::OneMessage); },
1074 0x14 => { process_msg_events!(0, true, ProcessMessages::OnePendingMessage); },
1075 0x15 => { process_msg_events!(0, false, ProcessMessages::OnePendingMessage); },
1077 0x16 => { process_events!(0, true); },
1078 0x17 => { process_events!(0, false); },
1080 0x18 => { process_msg_events!(1, true, ProcessMessages::AllMessages); },
1081 0x19 => { process_msg_events!(1, false, ProcessMessages::AllMessages); },
1082 0x1a => { process_msg_events!(1, true, ProcessMessages::OneMessage); },
1083 0x1b => { process_msg_events!(1, false, ProcessMessages::OneMessage); },
1084 0x1c => { process_msg_events!(1, true, ProcessMessages::OnePendingMessage); },
1085 0x1d => { process_msg_events!(1, false, ProcessMessages::OnePendingMessage); },
1087 0x1e => { process_events!(1, true); },
1088 0x1f => { process_events!(1, false); },
1090 0x20 => { process_msg_events!(2, true, ProcessMessages::AllMessages); },
1091 0x21 => { process_msg_events!(2, false, ProcessMessages::AllMessages); },
1092 0x22 => { process_msg_events!(2, true, ProcessMessages::OneMessage); },
1093 0x23 => { process_msg_events!(2, false, ProcessMessages::OneMessage); },
1094 0x24 => { process_msg_events!(2, true, ProcessMessages::OnePendingMessage); },
1095 0x25 => { process_msg_events!(2, false, ProcessMessages::OnePendingMessage); },
1097 0x26 => { process_events!(2, true); },
1098 0x27 => { process_events!(2, false); },
1101 if !chan_a_disconnected {
1102 nodes[1].peer_disconnected(&nodes[0].get_our_node_id());
1103 chan_a_disconnected = true;
1104 drain_msg_events_on_disconnect!(0);
1106 if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
1107 node_a_ser.0.clear();
1108 nodes[0].write(&mut node_a_ser).unwrap();
1110 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
1111 nodes[0] = new_node_a;
1112 monitor_a = new_monitor_a;
1115 if !chan_a_disconnected {
1116 nodes[0].peer_disconnected(&nodes[1].get_our_node_id());
1117 chan_a_disconnected = true;
1118 nodes[0].get_and_clear_pending_msg_events();
1122 if !chan_b_disconnected {
1123 nodes[2].peer_disconnected(&nodes[1].get_our_node_id());
1124 chan_b_disconnected = true;
1125 nodes[2].get_and_clear_pending_msg_events();
1129 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
1130 nodes[1] = new_node_b;
1131 monitor_b = new_monitor_b;
1134 if !chan_b_disconnected {
1135 nodes[1].peer_disconnected(&nodes[2].get_our_node_id());
1136 chan_b_disconnected = true;
1137 drain_msg_events_on_disconnect!(2);
1139 if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
1140 node_c_ser.0.clear();
1141 nodes[2].write(&mut node_c_ser).unwrap();
1143 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
1144 nodes[2] = new_node_c;
1145 monitor_c = new_monitor_c;
1148 // 1/10th the channel size:
1149 0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1150 0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1151 0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1152 0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1153 0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1154 0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1156 0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1157 0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1158 0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1159 0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1160 0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1161 0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1163 0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1164 0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1165 0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1166 0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1167 0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1168 0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1170 0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1171 0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1172 0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1173 0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1174 0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1175 0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1177 0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1178 0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1179 0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1180 0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1181 0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1182 0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1184 0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id, &mut payment_idx); },
1185 0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id, &mut payment_idx); },
1186 0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id, &mut payment_idx); },
1187 0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id, &mut payment_idx); },
1188 0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id, &mut payment_idx); },
1189 0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id, &mut payment_idx); },
1191 0x60 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id, &mut payment_idx); },
1192 0x61 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id, &mut payment_idx); },
1193 0x62 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id, &mut payment_idx); },
1194 0x63 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id, &mut payment_idx); },
1195 0x64 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id, &mut payment_idx); },
1196 0x65 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id, &mut payment_idx); },
1198 0x68 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id, &mut payment_idx); },
1199 0x69 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id, &mut payment_idx); },
1200 0x6a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id, &mut payment_idx); },
1201 0x6b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id, &mut payment_idx); },
1202 0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id, &mut payment_idx); },
1203 0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id, &mut payment_idx); },
1206 let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1207 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1208 fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
1210 nodes[0].maybe_update_chan_fees();
1212 0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },
1215 let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1216 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1217 fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
1219 nodes[1].maybe_update_chan_fees();
1221 0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },
1224 let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1225 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1226 fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
1228 nodes[2].maybe_update_chan_fees();
1230 0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },
1233 // Test that no channel is in a stuck state where neither party can send funds even
1234 // after we resolve all pending events.
1235 // First make sure there are no pending monitor updates, resetting the error state
1236 // and calling force_channel_monitor_updated for each monitor.
1237 *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1238 *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1239 *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1241 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1242 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1243 nodes[0].process_monitor_events();
1245 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1246 monitor_b.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1247 nodes[1].process_monitor_events();
1249 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1250 monitor_b.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1251 nodes[1].process_monitor_events();
1253 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1254 monitor_c.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1255 nodes[2].process_monitor_events();
1258 // Next, make sure peers are all connected to each other
1259 if chan_a_disconnected {
1260 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init {
1261 features: nodes[1].init_features(), networks: None, remote_network_address: None
1263 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init {
1264 features: nodes[0].init_features(), networks: None, remote_network_address: None
1266 chan_a_disconnected = false;
1268 if chan_b_disconnected {
1269 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init {
1270 features: nodes[2].init_features(), networks: None, remote_network_address: None
1272 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init {
1273 features: nodes[1].init_features(), networks: None, remote_network_address: None
1275 chan_b_disconnected = false;
1278 for i in 0..std::usize::MAX {
1279 if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
1280 // Then, make sure any current forwards make their way to their destination
1281 if process_msg_events!(0, false, ProcessMessages::AllMessages) { continue; }
1282 if process_msg_events!(1, false, ProcessMessages::AllMessages) { continue; }
1283 if process_msg_events!(2, false, ProcessMessages::AllMessages) { continue; }
1284 // ...making sure any pending PendingHTLCsForwardable events are handled and
1285 // payments claimed.
1286 if process_events!(0, false) { continue; }
1287 if process_events!(1, false) { continue; }
1288 if process_events!(2, false) { continue; }
1292 // Finally, make sure that at least one end of each channel can make a substantial payment
1294 send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id, &mut payment_idx) ||
1295 send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx));
1297 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx) ||
1298 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id, &mut payment_idx));
1300 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
1301 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
1302 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
1304 _ => test_return!(),
1307 node_a_ser.0.clear();
1308 nodes[0].write(&mut node_a_ser).unwrap();
1309 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
1310 node_b_ser.0.clear();
1311 nodes[1].write(&mut node_b_ser).unwrap();
1312 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
1313 node_c_ser.0.clear();
1314 nodes[2].write(&mut node_c_ser).unwrap();
1315 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
1319 /// We actually have different behavior based on if a certain log string has been seen, so we have
1320 /// to do a bit more tracking.
1322 struct SearchingOutput<O: Output> {
1324 may_fail: Arc<atomic::AtomicBool>,
1326 impl<O: Output> Output for SearchingOutput<O> {
1327 fn locked_write(&self, data: &[u8]) {
1328 // We hit a design limitation of LN state machine (see CONCURRENT_INBOUND_HTLC_FEE_BUFFER)
1329 if std::str::from_utf8(data).unwrap().contains("Outbound update_fee HTLC buffer overflow - counterparty should force-close this channel") {
1330 self.may_fail.store(true, atomic::Ordering::Release);
1332 self.output.locked_write(data)
1335 impl<O: Output> SearchingOutput<O> {
1336 pub fn new(output: O) -> Self {
1337 Self { output, may_fail: Arc::new(atomic::AtomicBool::new(false)) }
1341 pub fn chanmon_consistency_test<Out: Output>(data: &[u8], out: Out) {
1346 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
1347 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});