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, ScriptBuf};
24 use bitcoin::blockdata::opcodes;
25 use bitcoin::blockdata::locktime::absolute::LockTime;
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::OnChainSweep => MAX_FEE,
84 ConfirmationTarget::ChannelCloseMinimum|ConfirmationTarget::AnchorChannelFee|ConfirmationTarget::MinAllowedAnchorChannelRemoteFee|ConfirmationTarget::MinAllowedNonAnchorChannelRemoteFee => 253,
85 ConfirmationTarget::NonAnchorChannelFee => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
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>)>>,
129 impl TestChainMonitor {
130 pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>, keys: Arc<KeyProvider>) -> Self {
132 chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, Arc::clone(&persister))),
136 latest_monitors: Mutex::new(HashMap::new()),
140 impl chain::Watch<TestChannelSigner> for TestChainMonitor {
141 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<TestChannelSigner>) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
142 let mut ser = VecWriter(Vec::new());
143 monitor.write(&mut ser).unwrap();
144 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
145 panic!("Already had monitor pre-watch_channel");
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<TestChannelSigner>)>::
157 read(&mut Cursor::new(&map_entry.get().1), (&*self.keys, &*self.keys)).unwrap().1;
158 deserialized_monitor.update_monitor(update, &&TestBroadcaster{}, &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
159 let mut ser = VecWriter(Vec::new());
160 deserialized_monitor.write(&mut ser).unwrap();
161 map_entry.insert((update.update_id, ser.0));
162 self.chain_monitor.update_channel(funding_txo, update)
165 fn release_pending_monitor_events(&self) -> Vec<(OutPoint, Vec<MonitorEvent>, Option<PublicKey>)> {
166 return self.chain_monitor.release_pending_monitor_events();
171 node_secret: SecretKey,
172 rand_bytes_id: atomic::AtomicU32,
173 enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
176 impl EntropySource for KeyProvider {
177 fn get_secure_random_bytes(&self) -> [u8; 32] {
178 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
179 let mut res = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 11, self.node_secret[31]];
180 res[30-4..30].copy_from_slice(&id.to_le_bytes());
185 impl NodeSigner for KeyProvider {
186 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
187 let node_secret = match recipient {
188 Recipient::Node => Ok(&self.node_secret),
189 Recipient::PhantomNode => Err(())
191 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
194 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
195 let mut node_secret = match recipient {
196 Recipient::Node => Ok(self.node_secret.clone()),
197 Recipient::PhantomNode => Err(())
199 if let Some(tweak) = tweak {
200 node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
202 Ok(SharedSecret::new(other_key, &node_secret))
205 fn get_inbound_payment_key_material(&self) -> KeyMaterial {
206 KeyMaterial([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, self.node_secret[31]])
209 fn sign_invoice(&self, _hrp_bytes: &[u8], _invoice_data: &[u5], _recipient: Recipient) -> Result<RecoverableSignature, ()> {
213 fn sign_bolt12_invoice_request(
214 &self, _invoice_request: &UnsignedInvoiceRequest
215 ) -> Result<schnorr::Signature, ()> {
219 fn sign_bolt12_invoice(
220 &self, _invoice: &UnsignedBolt12Invoice,
221 ) -> Result<schnorr::Signature, ()> {
225 fn sign_gossip_message(&self, msg: lightning::ln::msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
226 let msg_hash = Message::from_slice(&Sha256dHash::hash(&msg.encode()[..])[..]).map_err(|_| ())?;
227 let secp_ctx = Secp256k1::signing_only();
228 Ok(secp_ctx.sign_ecdsa(&msg_hash, &self.node_secret))
232 impl SignerProvider for KeyProvider {
233 type EcdsaSigner = TestChannelSigner;
235 type TaprootSigner = TestChannelSigner;
237 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] {
238 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed) as u8;
242 fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> Self::EcdsaSigner {
243 let secp_ctx = Secp256k1::signing_only();
244 let id = channel_keys_id[0];
245 let keys = InMemorySigner::new(
247 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, self.node_secret[31]]).unwrap(),
248 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, self.node_secret[31]]).unwrap(),
249 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, 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, 7, 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, 8, self.node_secret[31]]).unwrap(),
252 [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]],
253 channel_value_satoshis,
257 let revoked_commitment = self.make_enforcement_state_cell(keys.commitment_seed);
258 TestChannelSigner::new_with_revoked(keys, revoked_commitment, false)
261 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::EcdsaSigner, DecodeError> {
262 let mut reader = std::io::Cursor::new(buffer);
264 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
265 let state = self.make_enforcement_state_cell(inner.commitment_seed);
267 Ok(TestChannelSigner {
270 disable_revocation_policy_check: false,
271 available: Arc::new(Mutex::new(true)),
275 fn get_destination_script(&self, _channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> {
276 let secp_ctx = Secp256k1::signing_only();
277 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();
278 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
279 Ok(Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(our_channel_monitor_claim_key_hash).into_script())
282 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
283 let secp_ctx = Secp256k1::signing_only();
284 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();
285 let pubkey_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &secret_key).serialize());
286 Ok(ShutdownScript::new_p2wpkh(&pubkey_hash))
291 fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
292 let mut revoked_commitments = self.enforcement_states.lock().unwrap();
293 if !revoked_commitments.contains_key(&commitment_seed) {
294 revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(EnforcementState::new())));
296 let cell = revoked_commitments.get(&commitment_seed).unwrap();
302 fn check_api_err(api_err: APIError, sendable_bounds_violated: bool) {
304 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
305 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
306 APIError::InvalidRoute { .. } => panic!("Our routes should work"),
307 APIError::ChannelUnavailable { err } => {
308 // Test the error against a list of errors we can hit, and reject
309 // all others. If you hit this panic, the list of acceptable errors
310 // is probably just stale and you should add new messages here.
312 "Peer for first hop currently disconnected" => {},
313 _ if err.starts_with("Cannot send less than our next-HTLC minimum - ") => {},
314 _ if err.starts_with("Cannot send more than our next-HTLC maximum - ") => {},
315 _ => panic!("{}", err),
317 assert!(sendable_bounds_violated);
319 APIError::MonitorUpdateInProgress => {
320 // We can (obviously) temp-fail a monitor update
322 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
326 fn check_payment_err(send_err: PaymentSendFailure, sendable_bounds_violated: bool) {
328 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err, sendable_bounds_violated),
329 PaymentSendFailure::PathParameterError(per_path_results) => {
330 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err, sendable_bounds_violated); } }
332 PaymentSendFailure::AllFailedResendSafe(per_path_results) => {
333 for api_err in per_path_results { check_api_err(api_err, sendable_bounds_violated); }
335 PaymentSendFailure::PartialFailure { results, .. } => {
336 for res in results { if let Err(api_err) = res { check_api_err(api_err, sendable_bounds_violated); } }
338 PaymentSendFailure::DuplicatePayment => panic!(),
342 type ChanMan<'a> = ChannelManager<Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<KeyProvider>, Arc<KeyProvider>, Arc<FuzzEstimator>, &'a FuzzRouter, Arc<dyn Logger>>;
345 fn get_payment_secret_hash(dest: &ChanMan, payment_id: &mut u8) -> Option<(PaymentSecret, PaymentHash)> {
346 let mut payment_hash;
348 payment_hash = PaymentHash(Sha256::hash(&[*payment_id; 1]).to_byte_array());
349 if let Ok(payment_secret) = dest.create_inbound_payment_for_hash(payment_hash, None, 3600, None) {
350 return Some((payment_secret, payment_hash));
352 *payment_id = payment_id.wrapping_add(1);
358 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8, payment_idx: &mut u64) -> bool {
359 let (payment_secret, payment_hash) =
360 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
361 let mut payment_id = [0; 32];
362 payment_id[0..8].copy_from_slice(&payment_idx.to_ne_bytes());
364 let (min_value_sendable, max_value_sendable) = source.list_usable_channels()
365 .iter().find(|chan| chan.short_channel_id == Some(dest_chan_id))
367 (chan.next_outbound_htlc_minimum_msat, chan.next_outbound_htlc_limit_msat))
369 if let Err(err) = source.send_payment_with_route(&Route {
370 paths: vec![Path { hops: vec![RouteHop {
371 pubkey: dest.get_our_node_id(),
372 node_features: dest.node_features(),
373 short_channel_id: dest_chan_id,
374 channel_features: dest.channel_features(),
376 cltv_expiry_delta: 200,
377 maybe_announced_channel: true,
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,
412 maybe_announced_channel: true,
414 pubkey: dest.get_our_node_id(),
415 node_features: dest.node_features(),
416 short_channel_id: dest_chan_id,
417 channel_features: dest.channel_features(),
419 cltv_expiry_delta: 200,
420 maybe_announced_channel: true,
421 }], blinded_tail: None }],
423 }, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
424 let sent_amt = amt + first_hop_fee;
425 check_payment_err(err, sent_amt < min_value_sendable || sent_amt > max_value_sendable);
428 // Note that while the max is a strict upper-bound, we can occasionally send substantially
429 // below the minimum, with some gap which is unusable immediately below the minimum. Thus,
430 // we don't check against min_value_sendable here.
431 assert!(amt + first_hop_fee <= max_value_sendable);
437 pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out, anchors: bool) {
438 let out = SearchingOutput::new(underlying_out);
439 let broadcast = Arc::new(TestBroadcaster{});
440 let router = FuzzRouter {};
442 macro_rules! make_node {
443 ($node_id: expr, $fee_estimator: expr) => { {
444 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
445 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();
446 let keys_manager = Arc::new(KeyProvider { node_secret, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
447 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
448 Arc::new(TestPersister {
449 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
450 }), Arc::clone(&keys_manager)));
452 let mut config = UserConfig::default();
453 config.channel_config.forwarding_fee_proportional_millionths = 0;
454 config.channel_handshake_config.announced_channel = true;
456 config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
457 config.manually_accept_inbound_channels = true;
459 let network = Network::Bitcoin;
460 let best_block_timestamp = genesis_block(network).header.time;
461 let params = ChainParameters {
463 best_block: BestBlock::from_network(network),
465 (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),
466 monitor, keys_manager)
470 macro_rules! reload_node {
471 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
472 let keys_manager = Arc::clone(& $keys_manager);
473 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
474 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(),
475 Arc::new(TestPersister {
476 update_ret: Mutex::new(ChannelMonitorUpdateStatus::Completed)
477 }), Arc::clone(& $keys_manager)));
479 let mut config = UserConfig::default();
480 config.channel_config.forwarding_fee_proportional_millionths = 0;
481 config.channel_handshake_config.announced_channel = true;
483 config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
484 config.manually_accept_inbound_channels = true;
487 let mut monitors = HashMap::new();
488 let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
489 for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
490 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(&mut Cursor::new(&monitor_ser), (&*$keys_manager, &*$keys_manager)).expect("Failed to read monitor").1);
491 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
493 let mut monitor_refs = HashMap::new();
494 for (outpoint, monitor) in monitors.iter_mut() {
495 monitor_refs.insert(*outpoint, monitor);
498 let read_args = ChannelManagerReadArgs {
499 entropy_source: keys_manager.clone(),
500 node_signer: keys_manager.clone(),
501 signer_provider: keys_manager.clone(),
502 fee_estimator: $fee_estimator.clone(),
503 chain_monitor: chain_monitor.clone(),
504 tx_broadcaster: broadcast.clone(),
507 default_config: config,
508 channel_monitors: monitor_refs,
511 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
512 for (funding_txo, mon) in monitors.drain() {
513 assert_eq!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon),
514 Ok(ChannelMonitorUpdateStatus::Completed));
520 let mut channel_txn = Vec::new();
521 macro_rules! make_channel {
522 ($source: expr, $dest: expr, $dest_keys_manager: expr, $chan_id: expr) => { {
523 $source.peer_connected(&$dest.get_our_node_id(), &Init {
524 features: $dest.init_features(), networks: None, remote_network_address: None
526 $dest.peer_connected(&$source.get_our_node_id(), &Init {
527 features: $source.init_features(), networks: None, remote_network_address: None
530 $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None, None).unwrap();
532 let events = $source.get_and_clear_pending_msg_events();
533 assert_eq!(events.len(), 1);
534 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
536 } else { panic!("Wrong event type"); }
539 $dest.handle_open_channel(&$source.get_our_node_id(), &open_channel);
540 let accept_channel = {
542 let events = $dest.get_and_clear_pending_events();
543 assert_eq!(events.len(), 1);
544 if let events::Event::OpenChannelRequest {
545 ref temporary_channel_id, ref counterparty_node_id, ..
547 let mut random_bytes = [0u8; 16];
548 random_bytes.copy_from_slice(&$dest_keys_manager.get_secure_random_bytes()[..16]);
549 let user_channel_id = u128::from_be_bytes(random_bytes);
550 $dest.accept_inbound_channel(
551 temporary_channel_id,
552 counterparty_node_id,
555 } else { panic!("Wrong event type"); }
557 let events = $dest.get_and_clear_pending_msg_events();
558 assert_eq!(events.len(), 1);
559 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
561 } else { panic!("Wrong event type"); }
564 $source.handle_accept_channel(&$dest.get_our_node_id(), &accept_channel);
567 let events = $source.get_and_clear_pending_events();
568 assert_eq!(events.len(), 1);
569 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
570 let tx = Transaction { version: $chan_id, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
571 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
573 funding_output = OutPoint { txid: tx.txid(), index: 0 };
574 $source.funding_transaction_generated(&temporary_channel_id, &$dest.get_our_node_id(), tx.clone()).unwrap();
575 channel_txn.push(tx);
576 } else { panic!("Wrong event type"); }
579 let funding_created = {
580 let events = $source.get_and_clear_pending_msg_events();
581 assert_eq!(events.len(), 1);
582 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
584 } else { panic!("Wrong event type"); }
586 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
588 let funding_signed = {
589 let events = $dest.get_and_clear_pending_msg_events();
590 assert_eq!(events.len(), 1);
591 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
593 } else { panic!("Wrong event type"); }
595 let events = $dest.get_and_clear_pending_events();
596 assert_eq!(events.len(), 1);
597 if let events::Event::ChannelPending{ ref counterparty_node_id, .. } = events[0] {
598 assert_eq!(counterparty_node_id, &$source.get_our_node_id());
599 } else { panic!("Wrong event type"); }
601 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
602 let events = $source.get_and_clear_pending_events();
603 assert_eq!(events.len(), 1);
604 if let events::Event::ChannelPending{ ref counterparty_node_id, .. } = events[0] {
605 assert_eq!(counterparty_node_id, &$dest.get_our_node_id());
606 } else { panic!("Wrong event type"); }
612 macro_rules! confirm_txn {
614 let chain_hash = genesis_block(Network::Bitcoin).block_hash();
615 let mut header = create_dummy_header(chain_hash, 42);
616 let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
617 $node.transactions_confirmed(&header, &txdata, 1);
619 header = create_dummy_header(header.block_hash(), 42);
621 $node.best_block_updated(&header, 99);
625 macro_rules! lock_fundings {
626 ($nodes: expr) => { {
627 let mut node_events = Vec::new();
628 for node in $nodes.iter() {
629 node_events.push(node.get_and_clear_pending_msg_events());
631 for (idx, node_event) in node_events.iter().enumerate() {
632 for event in node_event {
633 if let events::MessageSendEvent::SendChannelReady { ref node_id, ref msg } = event {
634 for node in $nodes.iter() {
635 if node.get_our_node_id() == *node_id {
636 node.handle_channel_ready(&$nodes[idx].get_our_node_id(), msg);
639 } else { panic!("Wrong event type"); }
643 for node in $nodes.iter() {
644 let events = node.get_and_clear_pending_msg_events();
645 for event in events {
646 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
647 } else { panic!("Wrong event type"); }
653 let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
654 let mut last_htlc_clear_fee_a = 253;
655 let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
656 let mut last_htlc_clear_fee_b = 253;
657 let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
658 let mut last_htlc_clear_fee_c = 253;
660 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
662 let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
663 let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
664 let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);
666 let mut nodes = [node_a, node_b, node_c];
668 let chan_1_funding = make_channel!(nodes[0], nodes[1], keys_manager_b, 0);
669 let chan_2_funding = make_channel!(nodes[1], nodes[2], keys_manager_c, 1);
671 for node in nodes.iter() {
675 lock_fundings!(nodes);
677 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
678 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
680 let mut payment_id: u8 = 0;
681 let mut payment_idx: u64 = 0;
683 let mut chan_a_disconnected = false;
684 let mut chan_b_disconnected = false;
685 let mut ab_events = Vec::new();
686 let mut ba_events = Vec::new();
687 let mut bc_events = Vec::new();
688 let mut cb_events = Vec::new();
690 let mut node_a_ser = VecWriter(Vec::new());
691 nodes[0].write(&mut node_a_ser).unwrap();
692 let mut node_b_ser = VecWriter(Vec::new());
693 nodes[1].write(&mut node_b_ser).unwrap();
694 let mut node_c_ser = VecWriter(Vec::new());
695 nodes[2].write(&mut node_c_ser).unwrap();
697 macro_rules! test_return {
699 assert_eq!(nodes[0].list_channels().len(), 1);
700 assert_eq!(nodes[1].list_channels().len(), 2);
701 assert_eq!(nodes[2].list_channels().len(), 1);
706 let mut read_pos = 0;
707 macro_rules! get_slice {
710 let slice_len = $len as usize;
711 if data.len() < read_pos + slice_len {
714 read_pos += slice_len;
715 &data[read_pos - slice_len..read_pos]
721 // Push any events from Node B onto ba_events and bc_events
722 macro_rules! push_excess_b_events {
723 ($excess_events: expr, $expect_drop_node: expr) => { {
724 let a_id = nodes[0].get_our_node_id();
725 let expect_drop_node: Option<usize> = $expect_drop_node;
726 let expect_drop_id = if let Some(id) = expect_drop_node { Some(nodes[id].get_our_node_id()) } else { None };
727 for event in $excess_events {
728 let push_a = match event {
729 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
730 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
733 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
734 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
737 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
738 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
741 events::MessageSendEvent::SendChannelReady { .. } => continue,
742 events::MessageSendEvent::SendAnnouncementSignatures { .. } => continue,
743 events::MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
744 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
745 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
748 _ => panic!("Unhandled message event {:?}", event),
750 if push_a { ba_events.push(event); } else { bc_events.push(event); }
755 // While delivering messages, we select across three possible message selection processes
756 // to ensure we get as much coverage as possible. See the individual enum variants for more
759 enum ProcessMessages {
760 /// Deliver all available messages, including fetching any new messages from
761 /// `get_and_clear_pending_msg_events()` (which may have side effects).
763 /// Call `get_and_clear_pending_msg_events()` first, and then deliver up to one
764 /// message (which may already be queued).
766 /// Deliver up to one already-queued message. This avoids any potential side-effects
767 /// of `get_and_clear_pending_msg_events()` (eg freeing the HTLC holding cell), which
768 /// provides potentially more coverage.
772 macro_rules! process_msg_events {
773 ($node: expr, $corrupt_forward: expr, $limit_events: expr) => { {
774 let mut events = if $node == 1 {
775 let mut new_events = Vec::new();
776 mem::swap(&mut new_events, &mut ba_events);
777 new_events.extend_from_slice(&bc_events[..]);
780 } else if $node == 0 {
781 let mut new_events = Vec::new();
782 mem::swap(&mut new_events, &mut ab_events);
785 let mut new_events = Vec::new();
786 mem::swap(&mut new_events, &mut cb_events);
789 let mut new_events = Vec::new();
790 if $limit_events != ProcessMessages::OnePendingMessage {
791 new_events = nodes[$node].get_and_clear_pending_msg_events();
793 let mut had_events = false;
794 let mut events_iter = events.drain(..).chain(new_events.drain(..));
795 let mut extra_ev = None;
796 for event in &mut events_iter {
799 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
800 for (idx, dest) in nodes.iter().enumerate() {
801 if dest.get_our_node_id() == node_id {
802 for update_add in update_add_htlcs.iter() {
803 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
804 if !$corrupt_forward {
805 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
807 // Corrupt the update_add_htlc message so that its HMAC
808 // check will fail and we generate a
809 // update_fail_malformed_htlc instead of an
810 // update_fail_htlc as we do when we reject a payment.
811 let mut msg_ser = update_add.encode();
812 msg_ser[1000] ^= 0xff;
813 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
814 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
817 for update_fulfill in update_fulfill_htlcs.iter() {
818 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
819 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
821 for update_fail in update_fail_htlcs.iter() {
822 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
823 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
825 for update_fail_malformed in update_fail_malformed_htlcs.iter() {
826 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
827 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
829 if let Some(msg) = update_fee {
830 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
831 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
833 let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
834 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
835 if $limit_events != ProcessMessages::AllMessages && processed_change {
836 // If we only want to process some messages, don't deliver the CS until later.
837 extra_ev = Some(events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate {
838 update_add_htlcs: Vec::new(),
839 update_fail_htlcs: Vec::new(),
840 update_fulfill_htlcs: Vec::new(),
841 update_fail_malformed_htlcs: Vec::new(),
847 out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
848 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
853 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
854 for (idx, dest) in nodes.iter().enumerate() {
855 if dest.get_our_node_id() == *node_id {
856 out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
857 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
861 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
862 for (idx, dest) in nodes.iter().enumerate() {
863 if dest.get_our_node_id() == *node_id {
864 out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
865 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
869 events::MessageSendEvent::SendChannelReady { .. } => {
870 // Can be generated as a reestablish response
872 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {
873 // Can be generated as a reestablish response
875 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
876 // When we reconnect we will resend a channel_update to make sure our
877 // counterparty has the latest parameters for receiving payments
878 // through us. We do, however, check that the message does not include
879 // the "disabled" bit, as we should never ever have a channel which is
880 // disabled when we send such an update (or it may indicate channel
881 // force-close which we should detect as an error).
882 assert_eq!(msg.contents.flags & 2, 0);
884 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
887 panic!("Unhandled message event {:?}", event)
890 if $limit_events != ProcessMessages::AllMessages {
895 push_excess_b_events!(extra_ev.into_iter().chain(events_iter), None);
896 } else if $node == 0 {
897 if let Some(ev) = extra_ev { ab_events.push(ev); }
898 for event in events_iter { ab_events.push(event); }
900 if let Some(ev) = extra_ev { cb_events.push(ev); }
901 for event in events_iter { cb_events.push(event); }
907 macro_rules! drain_msg_events_on_disconnect {
908 ($counterparty_id: expr) => { {
909 if $counterparty_id == 0 {
910 for event in nodes[0].get_and_clear_pending_msg_events() {
912 events::MessageSendEvent::UpdateHTLCs { .. } => {},
913 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
914 events::MessageSendEvent::SendChannelReestablish { .. } => {},
915 events::MessageSendEvent::SendChannelReady { .. } => {},
916 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
917 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
918 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
920 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
923 panic!("Unhandled message event")
927 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(0));
931 for event in nodes[2].get_and_clear_pending_msg_events() {
933 events::MessageSendEvent::UpdateHTLCs { .. } => {},
934 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
935 events::MessageSendEvent::SendChannelReestablish { .. } => {},
936 events::MessageSendEvent::SendChannelReady { .. } => {},
937 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
938 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
939 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
941 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
944 panic!("Unhandled message event")
948 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(2));
955 macro_rules! process_events {
956 ($node: expr, $fail: expr) => { {
957 // In case we get 256 payments we may have a hash collision, resulting in the
958 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
959 // deduplicate the calls here.
960 let mut claim_set = HashSet::new();
961 let mut events = nodes[$node].get_and_clear_pending_events();
962 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
963 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
964 // PaymentClaimable, claiming/failing two HTLCs, but leaving a just-generated
965 // PaymentClaimable event for the second HTLC in our pending_events (and breaking
966 // our claim_set deduplication).
967 events.sort_by(|a, b| {
968 if let events::Event::PaymentClaimable { .. } = a {
969 if let events::Event::PendingHTLCsForwardable { .. } = b {
971 } else { Ordering::Equal }
972 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
973 if let events::Event::PaymentClaimable { .. } = b {
975 } else { Ordering::Equal }
976 } else { Ordering::Equal }
978 let had_events = !events.is_empty();
979 for event in events.drain(..) {
981 events::Event::PaymentClaimable { payment_hash, .. } => {
982 if claim_set.insert(payment_hash.0) {
984 nodes[$node].fail_htlc_backwards(&payment_hash);
986 nodes[$node].claim_funds(PaymentPreimage(payment_hash.0));
990 events::Event::PaymentSent { .. } => {},
991 events::Event::PaymentClaimed { .. } => {},
992 events::Event::PaymentPathSuccessful { .. } => {},
993 events::Event::PaymentPathFailed { .. } => {},
994 events::Event::PaymentFailed { .. } => {},
995 events::Event::ProbeSuccessful { .. } | events::Event::ProbeFailed { .. } => {
996 // Even though we don't explicitly send probes, because probes are
997 // detected based on hashing the payment hash+preimage, its rather
998 // trivial for the fuzzer to build payments that accidentally end up
999 // looking like probes.
1001 events::Event::PaymentForwarded { .. } if $node == 1 => {},
1002 events::Event::ChannelReady { .. } => {},
1003 events::Event::PendingHTLCsForwardable { .. } => {
1004 nodes[$node].process_pending_htlc_forwards();
1006 events::Event::HTLCHandlingFailed { .. } => {},
1007 _ => if out.may_fail.load(atomic::Ordering::Acquire) {
1010 panic!("Unhandled event")
1018 let v = get_slice!(1)[0];
1019 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
1021 // In general, we keep related message groups close together in binary form, allowing
1022 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
1023 // harm in doing so.
1025 0x00 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
1026 0x01 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
1027 0x02 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::InProgress,
1028 0x04 => *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
1029 0x05 => *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
1030 0x06 => *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed,
1033 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1034 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1035 nodes[0].process_monitor_events();
1039 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1040 monitor_b.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1041 nodes[1].process_monitor_events();
1045 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1046 monitor_b.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1047 nodes[1].process_monitor_events();
1051 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1052 monitor_c.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1053 nodes[2].process_monitor_events();
1058 if !chan_a_disconnected {
1059 nodes[0].peer_disconnected(&nodes[1].get_our_node_id());
1060 nodes[1].peer_disconnected(&nodes[0].get_our_node_id());
1061 chan_a_disconnected = true;
1062 drain_msg_events_on_disconnect!(0);
1066 if !chan_b_disconnected {
1067 nodes[1].peer_disconnected(&nodes[2].get_our_node_id());
1068 nodes[2].peer_disconnected(&nodes[1].get_our_node_id());
1069 chan_b_disconnected = true;
1070 drain_msg_events_on_disconnect!(2);
1074 if chan_a_disconnected {
1075 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init {
1076 features: nodes[1].init_features(), networks: None, remote_network_address: None
1078 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init {
1079 features: nodes[0].init_features(), networks: None, remote_network_address: None
1081 chan_a_disconnected = false;
1085 if chan_b_disconnected {
1086 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init {
1087 features: nodes[2].init_features(), networks: None, remote_network_address: None
1089 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init {
1090 features: nodes[1].init_features(), networks: None, remote_network_address: None
1092 chan_b_disconnected = false;
1096 0x10 => { process_msg_events!(0, true, ProcessMessages::AllMessages); },
1097 0x11 => { process_msg_events!(0, false, ProcessMessages::AllMessages); },
1098 0x12 => { process_msg_events!(0, true, ProcessMessages::OneMessage); },
1099 0x13 => { process_msg_events!(0, false, ProcessMessages::OneMessage); },
1100 0x14 => { process_msg_events!(0, true, ProcessMessages::OnePendingMessage); },
1101 0x15 => { process_msg_events!(0, false, ProcessMessages::OnePendingMessage); },
1103 0x16 => { process_events!(0, true); },
1104 0x17 => { process_events!(0, false); },
1106 0x18 => { process_msg_events!(1, true, ProcessMessages::AllMessages); },
1107 0x19 => { process_msg_events!(1, false, ProcessMessages::AllMessages); },
1108 0x1a => { process_msg_events!(1, true, ProcessMessages::OneMessage); },
1109 0x1b => { process_msg_events!(1, false, ProcessMessages::OneMessage); },
1110 0x1c => { process_msg_events!(1, true, ProcessMessages::OnePendingMessage); },
1111 0x1d => { process_msg_events!(1, false, ProcessMessages::OnePendingMessage); },
1113 0x1e => { process_events!(1, true); },
1114 0x1f => { process_events!(1, false); },
1116 0x20 => { process_msg_events!(2, true, ProcessMessages::AllMessages); },
1117 0x21 => { process_msg_events!(2, false, ProcessMessages::AllMessages); },
1118 0x22 => { process_msg_events!(2, true, ProcessMessages::OneMessage); },
1119 0x23 => { process_msg_events!(2, false, ProcessMessages::OneMessage); },
1120 0x24 => { process_msg_events!(2, true, ProcessMessages::OnePendingMessage); },
1121 0x25 => { process_msg_events!(2, false, ProcessMessages::OnePendingMessage); },
1123 0x26 => { process_events!(2, true); },
1124 0x27 => { process_events!(2, false); },
1127 if !chan_a_disconnected {
1128 nodes[1].peer_disconnected(&nodes[0].get_our_node_id());
1129 chan_a_disconnected = true;
1130 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(0));
1134 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
1135 nodes[0] = new_node_a;
1136 monitor_a = new_monitor_a;
1139 if !chan_a_disconnected {
1140 nodes[0].peer_disconnected(&nodes[1].get_our_node_id());
1141 chan_a_disconnected = true;
1142 nodes[0].get_and_clear_pending_msg_events();
1146 if !chan_b_disconnected {
1147 nodes[2].peer_disconnected(&nodes[1].get_our_node_id());
1148 chan_b_disconnected = true;
1149 nodes[2].get_and_clear_pending_msg_events();
1153 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
1154 nodes[1] = new_node_b;
1155 monitor_b = new_monitor_b;
1158 if !chan_b_disconnected {
1159 nodes[1].peer_disconnected(&nodes[2].get_our_node_id());
1160 chan_b_disconnected = true;
1161 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(2));
1165 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
1166 nodes[2] = new_node_c;
1167 monitor_c = new_monitor_c;
1170 // 1/10th the channel size:
1171 0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1172 0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1173 0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1174 0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1175 0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx); },
1176 0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx); },
1178 0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1179 0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1180 0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1181 0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1182 0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id, &mut payment_idx); },
1183 0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id, &mut payment_idx); },
1185 0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1186 0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1187 0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1188 0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1189 0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id, &mut payment_idx); },
1190 0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id, &mut payment_idx); },
1192 0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1193 0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1194 0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1195 0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1196 0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id, &mut payment_idx); },
1197 0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id, &mut payment_idx); },
1199 0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1200 0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1201 0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1202 0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1203 0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id, &mut payment_idx); },
1204 0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id, &mut payment_idx); },
1206 0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id, &mut payment_idx); },
1207 0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id, &mut payment_idx); },
1208 0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id, &mut payment_idx); },
1209 0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id, &mut payment_idx); },
1210 0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id, &mut payment_idx); },
1211 0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id, &mut payment_idx); },
1213 0x60 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id, &mut payment_idx); },
1214 0x61 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id, &mut payment_idx); },
1215 0x62 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id, &mut payment_idx); },
1216 0x63 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id, &mut payment_idx); },
1217 0x64 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id, &mut payment_idx); },
1218 0x65 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id, &mut payment_idx); },
1220 0x68 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id, &mut payment_idx); },
1221 0x69 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id, &mut payment_idx); },
1222 0x6a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id, &mut payment_idx); },
1223 0x6b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id, &mut payment_idx); },
1224 0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id, &mut payment_idx); },
1225 0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id, &mut payment_idx); },
1228 let mut max_feerate = last_htlc_clear_fee_a;
1230 max_feerate *= FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1232 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1233 fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
1235 nodes[0].maybe_update_chan_fees();
1237 0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },
1240 let mut max_feerate = last_htlc_clear_fee_b;
1242 max_feerate *= FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1244 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1245 fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
1247 nodes[1].maybe_update_chan_fees();
1249 0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },
1252 let mut max_feerate = last_htlc_clear_fee_c;
1254 max_feerate *= FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1256 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1257 fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
1259 nodes[2].maybe_update_chan_fees();
1261 0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },
1264 // Test that no channel is in a stuck state where neither party can send funds even
1265 // after we resolve all pending events.
1266 // First make sure there are no pending monitor updates, resetting the error state
1267 // and calling force_channel_monitor_updated for each monitor.
1268 *monitor_a.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1269 *monitor_b.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1270 *monitor_c.persister.update_ret.lock().unwrap() = ChannelMonitorUpdateStatus::Completed;
1272 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1273 monitor_a.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1274 nodes[0].process_monitor_events();
1276 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1277 monitor_b.chain_monitor.force_channel_monitor_updated(chan_1_funding, *id);
1278 nodes[1].process_monitor_events();
1280 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1281 monitor_b.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1282 nodes[1].process_monitor_events();
1284 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1285 monitor_c.chain_monitor.force_channel_monitor_updated(chan_2_funding, *id);
1286 nodes[2].process_monitor_events();
1289 // Next, make sure peers are all connected to each other
1290 if chan_a_disconnected {
1291 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init {
1292 features: nodes[1].init_features(), networks: None, remote_network_address: None
1294 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init {
1295 features: nodes[0].init_features(), networks: None, remote_network_address: None
1297 chan_a_disconnected = false;
1299 if chan_b_disconnected {
1300 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init {
1301 features: nodes[2].init_features(), networks: None, remote_network_address: None
1303 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init {
1304 features: nodes[1].init_features(), networks: None, remote_network_address: None
1306 chan_b_disconnected = false;
1309 for i in 0..std::usize::MAX {
1310 if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
1311 // Then, make sure any current forwards make their way to their destination
1312 if process_msg_events!(0, false, ProcessMessages::AllMessages) { continue; }
1313 if process_msg_events!(1, false, ProcessMessages::AllMessages) { continue; }
1314 if process_msg_events!(2, false, ProcessMessages::AllMessages) { continue; }
1315 // ...making sure any pending PendingHTLCsForwardable events are handled and
1316 // payments claimed.
1317 if process_events!(0, false) { continue; }
1318 if process_events!(1, false) { continue; }
1319 if process_events!(2, false) { continue; }
1323 // Finally, make sure that at least one end of each channel can make a substantial payment
1325 send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id, &mut payment_idx) ||
1326 send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id, &mut payment_idx));
1328 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id, &mut payment_idx) ||
1329 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id, &mut payment_idx));
1331 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
1332 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
1333 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
1335 _ => test_return!(),
1338 if nodes[0].get_and_clear_needs_persistence() == true {
1339 node_a_ser.0.clear();
1340 nodes[0].write(&mut node_a_ser).unwrap();
1342 if nodes[1].get_and_clear_needs_persistence() == true {
1343 node_b_ser.0.clear();
1344 nodes[1].write(&mut node_b_ser).unwrap();
1346 if nodes[2].get_and_clear_needs_persistence() == true {
1347 node_c_ser.0.clear();
1348 nodes[2].write(&mut node_c_ser).unwrap();
1353 /// We actually have different behavior based on if a certain log string has been seen, so we have
1354 /// to do a bit more tracking.
1356 struct SearchingOutput<O: Output> {
1358 may_fail: Arc<atomic::AtomicBool>,
1360 impl<O: Output> Output for SearchingOutput<O> {
1361 fn locked_write(&self, data: &[u8]) {
1362 // We hit a design limitation of LN state machine (see CONCURRENT_INBOUND_HTLC_FEE_BUFFER)
1363 if std::str::from_utf8(data).unwrap().contains("Outbound update_fee HTLC buffer overflow - counterparty should force-close this channel") {
1364 self.may_fail.store(true, atomic::Ordering::Release);
1366 self.output.locked_write(data)
1369 impl<O: Output> SearchingOutput<O> {
1370 pub fn new(output: O) -> Self {
1371 Self { output, may_fail: Arc::new(atomic::AtomicBool::new(false)) }
1375 pub fn chanmon_consistency_test<Out: Output>(data: &[u8], out: Out) {
1376 do_test(data, out.clone(), false);
1377 do_test(data, out, true);
1381 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
1382 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{}, false);
1383 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{}, true);