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::block::BlockHeader;
22 use bitcoin::blockdata::constants::genesis_block;
23 use bitcoin::blockdata::transaction::{Transaction, TxOut};
24 use bitcoin::blockdata::script::{Builder, Script};
25 use bitcoin::blockdata::opcodes;
26 use bitcoin::network::constants::Network;
28 use bitcoin::hashes::Hash as TraitImport;
29 use bitcoin::hashes::sha256::Hash as Sha256;
30 use bitcoin::hash_types::{BlockHash, WPubkeyHash};
33 use lightning::chain::{BestBlock, chainmonitor, channelmonitor, Confirm, Watch};
34 use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, MonitorEvent};
35 use lightning::chain::transaction::OutPoint;
36 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
37 use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
38 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
39 use lightning::ln::channelmanager::{ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs};
40 use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
41 use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
42 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
43 use lightning::ln::script::ShutdownScript;
44 use lightning::util::enforcing_trait_impls::{EnforcingSigner, EnforcementState};
45 use lightning::util::errors::APIError;
46 use lightning::util::events;
47 use lightning::util::logger::Logger;
48 use lightning::util::config::UserConfig;
49 use lightning::util::events::MessageSendEventsProvider;
50 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
51 use lightning::routing::router::{Route, RouteHop};
54 use utils::test_logger;
55 use utils::test_persister::TestPersister;
57 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
58 use bitcoin::secp256k1::recovery::RecoverableSignature;
59 use bitcoin::secp256k1::Secp256k1;
62 use std::cmp::{self, Ordering};
63 use std::collections::{HashSet, hash_map, HashMap};
64 use std::sync::{Arc,Mutex};
65 use std::sync::atomic;
68 const MAX_FEE: u32 = 10_000;
69 struct FuzzEstimator {
70 ret_val: atomic::AtomicU32,
72 impl FeeEstimator for FuzzEstimator {
73 fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
74 // We force-close channels if our counterparty sends us a feerate which is a small multiple
75 // of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
76 // always return a HighPriority feerate here which is >= the maximum Normal feerate and a
77 // Background feerate which is <= the minimum Normal feerate.
79 ConfirmationTarget::HighPriority => MAX_FEE,
80 ConfirmationTarget::Background => 253,
81 ConfirmationTarget::Normal => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
86 pub struct TestBroadcaster {}
87 impl BroadcasterInterface for TestBroadcaster {
88 fn broadcast_transaction(&self, _tx: &Transaction) { }
91 pub struct VecWriter(pub Vec<u8>);
92 impl Writer for VecWriter {
93 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
94 self.0.extend_from_slice(buf);
99 struct TestChainMonitor {
100 pub logger: Arc<dyn Logger>,
101 pub keys: Arc<KeyProvider>,
102 pub chain_monitor: Arc<chainmonitor::ChainMonitor<EnforcingSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
103 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
104 // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
105 // logic will automatically force-close our channels for us (as we don't have an up-to-date
106 // monitor implying we are not able to punish misbehaving counterparties). Because this test
107 // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
108 // fully-serialized monitor state here, as well as the corresponding update_id.
109 pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
110 pub should_update_manager: atomic::AtomicBool,
112 impl TestChainMonitor {
113 pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>, keys: Arc<KeyProvider>) -> Self {
115 chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, persister)),
118 update_ret: Mutex::new(Ok(())),
119 latest_monitors: Mutex::new(HashMap::new()),
120 should_update_manager: atomic::AtomicBool::new(false),
124 impl chain::Watch<EnforcingSigner> for TestChainMonitor {
125 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
126 let mut ser = VecWriter(Vec::new());
127 monitor.write(&mut ser).unwrap();
128 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
129 panic!("Already had monitor pre-watch_channel");
131 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
132 assert!(self.chain_monitor.watch_channel(funding_txo, monitor).is_ok());
133 self.update_ret.lock().unwrap().clone()
136 fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
137 let mut map_lock = self.latest_monitors.lock().unwrap();
138 let mut map_entry = match map_lock.entry(funding_txo) {
139 hash_map::Entry::Occupied(entry) => entry,
140 hash_map::Entry::Vacant(_) => panic!("Didn't have monitor on update call"),
142 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
143 read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
144 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
145 let mut ser = VecWriter(Vec::new());
146 deserialized_monitor.write(&mut ser).unwrap();
147 map_entry.insert((update.update_id, ser.0));
148 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
149 assert!(self.chain_monitor.update_channel(funding_txo, update).is_ok());
150 self.update_ret.lock().unwrap().clone()
153 fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
154 return self.chain_monitor.release_pending_monitor_events();
160 rand_bytes_id: atomic::AtomicU32,
161 enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
163 impl KeysInterface for KeyProvider {
164 type Signer = EnforcingSigner;
166 fn get_node_secret(&self) -> SecretKey {
167 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, self.node_id]).unwrap()
170 fn get_destination_script(&self) -> Script {
171 let secp_ctx = Secp256k1::signing_only();
172 let channel_monitor_claim_key = SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, self.node_id]).unwrap();
173 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
174 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
177 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
178 let secp_ctx = Secp256k1::signing_only();
179 let secret_key = SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, self.node_id]).unwrap();
180 let pubkey_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &secret_key).serialize());
181 ShutdownScript::new_p2wpkh(&pubkey_hash)
184 fn get_channel_signer(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner {
185 let secp_ctx = Secp256k1::signing_only();
186 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
187 let keys = InMemorySigner::new(
189 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, self.node_id]).unwrap(),
190 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, self.node_id]).unwrap(),
191 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, self.node_id]).unwrap(),
192 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, self.node_id]).unwrap(),
193 SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 8, self.node_id]).unwrap(),
194 [id as u8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 9, self.node_id],
195 channel_value_satoshis,
198 let revoked_commitment = self.make_enforcement_state_cell(keys.commitment_seed);
199 EnforcingSigner::new_with_revoked(keys, revoked_commitment, false)
202 fn get_secure_random_bytes(&self) -> [u8; 32] {
203 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
204 let mut res = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 11, self.node_id];
205 res[30-4..30].copy_from_slice(&id.to_le_bytes());
209 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, DecodeError> {
210 let mut reader = std::io::Cursor::new(buffer);
212 let inner: InMemorySigner = Readable::read(&mut reader)?;
213 let state = self.make_enforcement_state_cell(inner.commitment_seed);
218 disable_revocation_policy_check: false,
222 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> {
228 fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
229 let mut revoked_commitments = self.enforcement_states.lock().unwrap();
230 if !revoked_commitments.contains_key(&commitment_seed) {
231 revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(EnforcementState::new())));
233 let cell = revoked_commitments.get(&commitment_seed).unwrap();
239 fn check_api_err(api_err: APIError) {
241 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
242 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
243 APIError::RouteError { .. } => panic!("Our routes should work"),
244 APIError::ChannelUnavailable { err } => {
245 // Test the error against a list of errors we can hit, and reject
246 // all others. If you hit this panic, the list of acceptable errors
247 // is probably just stale and you should add new messages here.
249 "Peer for first hop currently disconnected/pending monitor update!" => {},
250 _ if err.starts_with("Cannot push more than their max accepted HTLCs ") => {},
251 _ if err.starts_with("Cannot send value that would put us over the max HTLC value in flight our peer will accept ") => {},
252 _ if err.starts_with("Cannot send value that would put our balance under counterparty-announced channel reserve value") => {},
253 _ if err.starts_with("Cannot send value that would put counterparty balance under holder-announced channel reserve value") => {},
254 _ if err.starts_with("Cannot send value that would overdraw remaining funds.") => {},
255 _ if err.starts_with("Cannot send value that would not leave enough to pay for fees.") => {},
256 _ if err.starts_with("Cannot send value that would put our exposure to dust HTLCs at") => {},
257 _ => panic!("{}", err),
260 APIError::MonitorUpdateFailed => {
261 // We can (obviously) temp-fail a monitor update
263 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
267 fn check_payment_err(send_err: PaymentSendFailure) {
269 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err),
270 PaymentSendFailure::PathParameterError(per_path_results) => {
271 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
273 PaymentSendFailure::AllFailedRetrySafe(per_path_results) => {
274 for api_err in per_path_results { check_api_err(api_err); }
276 PaymentSendFailure::PartialFailure(per_path_results) => {
277 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
282 type ChanMan = ChannelManager<EnforcingSigner, Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>;
285 fn get_payment_secret_hash(dest: &ChanMan, payment_id: &mut u8) -> Option<(PaymentSecret, PaymentHash)> {
286 let mut payment_hash;
288 payment_hash = PaymentHash(Sha256::hash(&[*payment_id; 1]).into_inner());
289 if let Ok(payment_secret) = dest.create_inbound_payment_for_hash(payment_hash, None, 3600, 0) {
290 return Some((payment_secret, payment_hash));
292 *payment_id = payment_id.wrapping_add(1);
298 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
299 let (payment_secret, payment_hash) =
300 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
301 if let Err(err) = source.send_payment(&Route {
302 paths: vec![vec![RouteHop {
303 pubkey: dest.get_our_node_id(),
304 node_features: NodeFeatures::known(),
305 short_channel_id: dest_chan_id,
306 channel_features: ChannelFeatures::known(),
308 cltv_expiry_delta: 200,
310 }, payment_hash, &Some(payment_secret)) {
311 check_payment_err(err);
316 fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
317 let (payment_secret, payment_hash) =
318 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
319 if let Err(err) = source.send_payment(&Route {
320 paths: vec![vec![RouteHop {
321 pubkey: middle.get_our_node_id(),
322 node_features: NodeFeatures::known(),
323 short_channel_id: middle_chan_id,
324 channel_features: ChannelFeatures::known(),
326 cltv_expiry_delta: 100,
328 pubkey: dest.get_our_node_id(),
329 node_features: NodeFeatures::known(),
330 short_channel_id: dest_chan_id,
331 channel_features: ChannelFeatures::known(),
333 cltv_expiry_delta: 200,
335 }, payment_hash, &Some(payment_secret)) {
336 check_payment_err(err);
342 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
343 let broadcast = Arc::new(TestBroadcaster{});
345 macro_rules! make_node {
346 ($node_id: expr, $fee_estimator: expr) => { {
347 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
348 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), enforcement_states: Mutex::new(HashMap::new()) });
349 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));
351 let mut config = UserConfig::default();
352 config.channel_options.forwarding_fee_proportional_millionths = 0;
353 config.channel_options.announced_channel = true;
354 let network = Network::Bitcoin;
355 let params = ChainParameters {
357 best_block: BestBlock::from_genesis(network),
359 (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
360 monitor, keys_manager)
364 macro_rules! reload_node {
365 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
366 let keys_manager = Arc::clone(& $keys_manager);
367 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
368 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));
370 let mut config = UserConfig::default();
371 config.channel_options.forwarding_fee_proportional_millionths = 0;
372 config.channel_options.announced_channel = true;
374 let mut monitors = HashMap::new();
375 let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
376 for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
377 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut Cursor::new(&monitor_ser), &*$keys_manager).expect("Failed to read monitor").1);
378 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
380 let mut monitor_refs = HashMap::new();
381 for (outpoint, monitor) in monitors.iter_mut() {
382 monitor_refs.insert(*outpoint, monitor);
385 let read_args = ChannelManagerReadArgs {
387 fee_estimator: $fee_estimator.clone(),
388 chain_monitor: chain_monitor.clone(),
389 tx_broadcaster: broadcast.clone(),
391 default_config: config,
392 channel_monitors: monitor_refs,
395 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
396 for (funding_txo, mon) in monitors.drain() {
397 assert!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon).is_ok());
403 let mut channel_txn = Vec::new();
404 macro_rules! make_channel {
405 ($source: expr, $dest: expr, $chan_id: expr) => { {
406 $source.peer_connected(&$dest.get_our_node_id(), &Init { features: InitFeatures::known() });
407 $dest.peer_connected(&$source.get_our_node_id(), &Init { features: InitFeatures::known() });
409 $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
411 let events = $source.get_and_clear_pending_msg_events();
412 assert_eq!(events.len(), 1);
413 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
415 } else { panic!("Wrong event type"); }
418 $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::known(), &open_channel);
419 let accept_channel = {
420 let events = $dest.get_and_clear_pending_msg_events();
421 assert_eq!(events.len(), 1);
422 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
424 } else { panic!("Wrong event type"); }
427 $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::known(), &accept_channel);
430 let events = $source.get_and_clear_pending_events();
431 assert_eq!(events.len(), 1);
432 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
433 let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
434 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
436 funding_output = OutPoint { txid: tx.txid(), index: 0 };
437 $source.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
438 channel_txn.push(tx);
439 } else { panic!("Wrong event type"); }
442 let funding_created = {
443 let events = $source.get_and_clear_pending_msg_events();
444 assert_eq!(events.len(), 1);
445 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
447 } else { panic!("Wrong event type"); }
449 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
451 let funding_signed = {
452 let events = $dest.get_and_clear_pending_msg_events();
453 assert_eq!(events.len(), 1);
454 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
456 } else { panic!("Wrong event type"); }
458 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
464 macro_rules! confirm_txn {
466 let chain_hash = genesis_block(Network::Bitcoin).block_hash();
467 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: chain_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
468 let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
469 $node.transactions_confirmed(&header, &txdata, 1);
471 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
473 $node.best_block_updated(&header, 99);
477 macro_rules! lock_fundings {
478 ($nodes: expr) => { {
479 let mut node_events = Vec::new();
480 for node in $nodes.iter() {
481 node_events.push(node.get_and_clear_pending_msg_events());
483 for (idx, node_event) in node_events.iter().enumerate() {
484 for event in node_event {
485 if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
486 for node in $nodes.iter() {
487 if node.get_our_node_id() == *node_id {
488 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
491 } else { panic!("Wrong event type"); }
495 for node in $nodes.iter() {
496 let events = node.get_and_clear_pending_msg_events();
497 for event in events {
498 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
499 } else { panic!("Wrong event type"); }
505 let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
506 let mut last_htlc_clear_fee_a = 253;
507 let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
508 let mut last_htlc_clear_fee_b = 253;
509 let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
510 let mut last_htlc_clear_fee_c = 253;
512 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
514 let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
515 let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
516 let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);
518 let mut nodes = [node_a, node_b, node_c];
520 let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
521 let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
523 for node in nodes.iter() {
527 lock_fundings!(nodes);
529 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
530 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
532 let mut payment_id: u8 = 0;
534 let mut chan_a_disconnected = false;
535 let mut chan_b_disconnected = false;
536 let mut ab_events = Vec::new();
537 let mut ba_events = Vec::new();
538 let mut bc_events = Vec::new();
539 let mut cb_events = Vec::new();
541 let mut node_a_ser = VecWriter(Vec::new());
542 nodes[0].write(&mut node_a_ser).unwrap();
543 let mut node_b_ser = VecWriter(Vec::new());
544 nodes[1].write(&mut node_b_ser).unwrap();
545 let mut node_c_ser = VecWriter(Vec::new());
546 nodes[2].write(&mut node_c_ser).unwrap();
548 macro_rules! test_return {
550 assert_eq!(nodes[0].list_channels().len(), 1);
551 assert_eq!(nodes[1].list_channels().len(), 2);
552 assert_eq!(nodes[2].list_channels().len(), 1);
557 let mut read_pos = 0;
558 macro_rules! get_slice {
561 let slice_len = $len as usize;
562 if data.len() < read_pos + slice_len {
565 read_pos += slice_len;
566 &data[read_pos - slice_len..read_pos]
572 // Push any events from Node B onto ba_events and bc_events
573 macro_rules! push_excess_b_events {
574 ($excess_events: expr, $expect_drop_node: expr) => { {
575 let a_id = nodes[0].get_our_node_id();
576 let expect_drop_node: Option<usize> = $expect_drop_node;
577 let expect_drop_id = if let Some(id) = expect_drop_node { Some(nodes[id].get_our_node_id()) } else { None };
578 for event in $excess_events {
579 let push_a = match event {
580 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
581 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
584 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
585 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
588 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
589 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
592 events::MessageSendEvent::SendFundingLocked { .. } => continue,
593 events::MessageSendEvent::SendAnnouncementSignatures { .. } => continue,
594 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => continue,
595 events::MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
596 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
597 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
600 _ => panic!("Unhandled message event {:?}", event),
602 if push_a { ba_events.push(event); } else { bc_events.push(event); }
607 // While delivering messages, we select across three possible message selection processes
608 // to ensure we get as much coverage as possible. See the individual enum variants for more
611 enum ProcessMessages {
612 /// Deliver all available messages, including fetching any new messages from
613 /// `get_and_clear_pending_msg_events()` (which may have side effects).
615 /// Call `get_and_clear_pending_msg_events()` first, and then deliver up to one
616 /// message (which may already be queued).
618 /// Deliver up to one already-queued message. This avoids any potential side-effects
619 /// of `get_and_clear_pending_msg_events()` (eg freeing the HTLC holding cell), which
620 /// provides potentially more coverage.
624 macro_rules! process_msg_events {
625 ($node: expr, $corrupt_forward: expr, $limit_events: expr) => { {
626 let mut events = if $node == 1 {
627 let mut new_events = Vec::new();
628 mem::swap(&mut new_events, &mut ba_events);
629 new_events.extend_from_slice(&bc_events[..]);
632 } else if $node == 0 {
633 let mut new_events = Vec::new();
634 mem::swap(&mut new_events, &mut ab_events);
637 let mut new_events = Vec::new();
638 mem::swap(&mut new_events, &mut cb_events);
641 let mut new_events = Vec::new();
642 if $limit_events != ProcessMessages::OnePendingMessage {
643 new_events = nodes[$node].get_and_clear_pending_msg_events();
645 let mut had_events = false;
646 let mut events_iter = events.drain(..).chain(new_events.drain(..));
647 let mut extra_ev = None;
648 for event in &mut events_iter {
651 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
652 for (idx, dest) in nodes.iter().enumerate() {
653 if dest.get_our_node_id() == node_id {
654 for update_add in update_add_htlcs.iter() {
655 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
656 if !$corrupt_forward {
657 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
659 // Corrupt the update_add_htlc message so that its HMAC
660 // check will fail and we generate a
661 // update_fail_malformed_htlc instead of an
662 // update_fail_htlc as we do when we reject a payment.
663 let mut msg_ser = update_add.encode();
664 msg_ser[1000] ^= 0xff;
665 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
666 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
669 for update_fulfill in update_fulfill_htlcs.iter() {
670 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
671 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
673 for update_fail in update_fail_htlcs.iter() {
674 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
675 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
677 for update_fail_malformed in update_fail_malformed_htlcs.iter() {
678 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
679 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
681 if let Some(msg) = update_fee {
682 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
683 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
685 let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
686 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
687 if $limit_events != ProcessMessages::AllMessages && processed_change {
688 // If we only want to process some messages, don't deliver the CS until later.
689 extra_ev = Some(events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate {
690 update_add_htlcs: Vec::new(),
691 update_fail_htlcs: Vec::new(),
692 update_fulfill_htlcs: Vec::new(),
693 update_fail_malformed_htlcs: Vec::new(),
699 out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
700 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
705 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
706 for (idx, dest) in nodes.iter().enumerate() {
707 if dest.get_our_node_id() == *node_id {
708 out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
709 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
713 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
714 for (idx, dest) in nodes.iter().enumerate() {
715 if dest.get_our_node_id() == *node_id {
716 out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
717 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
721 events::MessageSendEvent::SendFundingLocked { .. } => {
722 // Can be generated as a reestablish response
724 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {
725 // Can be generated as a reestablish response
727 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
728 // Can be generated due to a payment forward being rejected due to a
729 // channel having previously failed a monitor update
731 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
732 // When we reconnect we will resend a channel_update to make sure our
733 // counterparty has the latest parameters for receiving payments
734 // through us. We do, however, check that the message does not include
735 // the "disabled" bit, as we should never ever have a channel which is
736 // disabled when we send such an update (or it may indicate channel
737 // force-close which we should detect as an error).
738 assert_eq!(msg.contents.flags & 2, 0);
740 _ => panic!("Unhandled message event {:?}", event),
742 if $limit_events != ProcessMessages::AllMessages {
747 push_excess_b_events!(extra_ev.into_iter().chain(events_iter), None);
748 } else if $node == 0 {
749 if let Some(ev) = extra_ev { ab_events.push(ev); }
750 for event in events_iter { ab_events.push(event); }
752 if let Some(ev) = extra_ev { cb_events.push(ev); }
753 for event in events_iter { cb_events.push(event); }
759 macro_rules! drain_msg_events_on_disconnect {
760 ($counterparty_id: expr) => { {
761 if $counterparty_id == 0 {
762 for event in nodes[0].get_and_clear_pending_msg_events() {
764 events::MessageSendEvent::UpdateHTLCs { .. } => {},
765 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
766 events::MessageSendEvent::SendChannelReestablish { .. } => {},
767 events::MessageSendEvent::SendFundingLocked { .. } => {},
768 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
769 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
770 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
771 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
773 _ => panic!("Unhandled message event"),
776 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(0));
780 for event in nodes[2].get_and_clear_pending_msg_events() {
782 events::MessageSendEvent::UpdateHTLCs { .. } => {},
783 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
784 events::MessageSendEvent::SendChannelReestablish { .. } => {},
785 events::MessageSendEvent::SendFundingLocked { .. } => {},
786 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
787 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
788 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
789 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
791 _ => panic!("Unhandled message event"),
794 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(2));
801 macro_rules! process_events {
802 ($node: expr, $fail: expr) => { {
803 // In case we get 256 payments we may have a hash collision, resulting in the
804 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
805 // deduplicate the calls here.
806 let mut claim_set = HashSet::new();
807 let mut events = nodes[$node].get_and_clear_pending_events();
808 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
809 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
810 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
811 // PaymentReceived event for the second HTLC in our pending_events (and breaking
812 // our claim_set deduplication).
813 events.sort_by(|a, b| {
814 if let events::Event::PaymentReceived { .. } = a {
815 if let events::Event::PendingHTLCsForwardable { .. } = b {
817 } else { Ordering::Equal }
818 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
819 if let events::Event::PaymentReceived { .. } = b {
821 } else { Ordering::Equal }
822 } else { Ordering::Equal }
824 let had_events = !events.is_empty();
825 for event in events.drain(..) {
827 events::Event::PaymentReceived { payment_hash, .. } => {
828 if claim_set.insert(payment_hash.0) {
830 assert!(nodes[$node].fail_htlc_backwards(&payment_hash));
832 assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0)));
836 events::Event::PaymentSent { .. } => {},
837 events::Event::PaymentFailed { .. } => {},
838 events::Event::PaymentForwarded { .. } if $node == 1 => {},
839 events::Event::PendingHTLCsForwardable { .. } => {
840 nodes[$node].process_pending_htlc_forwards();
842 _ => panic!("Unhandled event"),
849 let v = get_slice!(1)[0];
850 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
852 // In general, we keep related message groups close together in binary form, allowing
853 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
856 0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
857 0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
858 0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
859 0x04 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
860 0x05 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
861 0x06 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
864 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
865 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
869 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
870 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
874 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
875 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
879 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
880 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
885 if !chan_a_disconnected {
886 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
887 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
888 chan_a_disconnected = true;
889 drain_msg_events_on_disconnect!(0);
893 if !chan_b_disconnected {
894 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
895 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
896 chan_b_disconnected = true;
897 drain_msg_events_on_disconnect!(2);
901 if chan_a_disconnected {
902 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
903 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::known() });
904 chan_a_disconnected = false;
908 if chan_b_disconnected {
909 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::known() });
910 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
911 chan_b_disconnected = false;
915 0x10 => { process_msg_events!(0, true, ProcessMessages::AllMessages); },
916 0x11 => { process_msg_events!(0, false, ProcessMessages::AllMessages); },
917 0x12 => { process_msg_events!(0, true, ProcessMessages::OneMessage); },
918 0x13 => { process_msg_events!(0, false, ProcessMessages::OneMessage); },
919 0x14 => { process_msg_events!(0, true, ProcessMessages::OnePendingMessage); },
920 0x15 => { process_msg_events!(0, false, ProcessMessages::OnePendingMessage); },
922 0x16 => { process_events!(0, true); },
923 0x17 => { process_events!(0, false); },
925 0x18 => { process_msg_events!(1, true, ProcessMessages::AllMessages); },
926 0x19 => { process_msg_events!(1, false, ProcessMessages::AllMessages); },
927 0x1a => { process_msg_events!(1, true, ProcessMessages::OneMessage); },
928 0x1b => { process_msg_events!(1, false, ProcessMessages::OneMessage); },
929 0x1c => { process_msg_events!(1, true, ProcessMessages::OnePendingMessage); },
930 0x1d => { process_msg_events!(1, false, ProcessMessages::OnePendingMessage); },
932 0x1e => { process_events!(1, true); },
933 0x1f => { process_events!(1, false); },
935 0x20 => { process_msg_events!(2, true, ProcessMessages::AllMessages); },
936 0x21 => { process_msg_events!(2, false, ProcessMessages::AllMessages); },
937 0x22 => { process_msg_events!(2, true, ProcessMessages::OneMessage); },
938 0x23 => { process_msg_events!(2, false, ProcessMessages::OneMessage); },
939 0x24 => { process_msg_events!(2, true, ProcessMessages::OnePendingMessage); },
940 0x25 => { process_msg_events!(2, false, ProcessMessages::OnePendingMessage); },
942 0x26 => { process_events!(2, true); },
943 0x27 => { process_events!(2, false); },
946 if !chan_a_disconnected {
947 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
948 chan_a_disconnected = true;
949 drain_msg_events_on_disconnect!(0);
951 if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
952 node_a_ser.0.clear();
953 nodes[0].write(&mut node_a_ser).unwrap();
955 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
956 nodes[0] = new_node_a;
957 monitor_a = new_monitor_a;
960 if !chan_a_disconnected {
961 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
962 chan_a_disconnected = true;
963 nodes[0].get_and_clear_pending_msg_events();
967 if !chan_b_disconnected {
968 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
969 chan_b_disconnected = true;
970 nodes[2].get_and_clear_pending_msg_events();
974 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
975 nodes[1] = new_node_b;
976 monitor_b = new_monitor_b;
979 if !chan_b_disconnected {
980 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
981 chan_b_disconnected = true;
982 drain_msg_events_on_disconnect!(2);
984 if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
985 node_c_ser.0.clear();
986 nodes[2].write(&mut node_c_ser).unwrap();
988 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
989 nodes[2] = new_node_c;
990 monitor_c = new_monitor_c;
993 // 1/10th the channel size:
994 0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id); },
995 0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id); },
996 0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id); },
997 0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id); },
998 0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id); },
999 0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id); },
1001 0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id); },
1002 0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id); },
1003 0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id); },
1004 0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id); },
1005 0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id); },
1006 0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id); },
1008 0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id); },
1009 0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id); },
1010 0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id); },
1011 0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id); },
1012 0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id); },
1013 0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id); },
1015 0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id); },
1016 0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id); },
1017 0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id); },
1018 0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id); },
1019 0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id); },
1020 0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id); },
1022 0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id); },
1023 0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id); },
1024 0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id); },
1025 0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id); },
1026 0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id); },
1027 0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id); },
1029 0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id); },
1030 0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id); },
1031 0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id); },
1032 0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id); },
1033 0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id); },
1034 0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id); },
1036 0x60 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id); },
1037 0x61 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id); },
1038 0x62 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id); },
1039 0x63 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id); },
1040 0x64 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id); },
1041 0x65 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id); },
1043 0x68 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id); },
1044 0x69 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id); },
1045 0x6a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id); },
1046 0x6b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id); },
1047 0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
1048 0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },
1051 let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1052 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1053 fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
1055 nodes[0].maybe_update_chan_fees();
1057 0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },
1060 let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1061 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1062 fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
1064 nodes[1].maybe_update_chan_fees();
1066 0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },
1069 let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
1070 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
1071 fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
1073 nodes[2].maybe_update_chan_fees();
1075 0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },
1078 // Test that no channel is in a stuck state where neither party can send funds even
1079 // after we resolve all pending events.
1080 // First make sure there are no pending monitor updates, resetting the error state
1081 // and calling channel_monitor_updated for each monitor.
1082 *monitor_a.update_ret.lock().unwrap() = Ok(());
1083 *monitor_b.update_ret.lock().unwrap() = Ok(());
1084 *monitor_c.update_ret.lock().unwrap() = Ok(());
1086 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1087 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
1089 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1090 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
1092 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1093 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
1095 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1096 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
1099 // Next, make sure peers are all connected to each other
1100 if chan_a_disconnected {
1101 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
1102 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::known() });
1103 chan_a_disconnected = false;
1105 if chan_b_disconnected {
1106 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::known() });
1107 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
1108 chan_b_disconnected = false;
1111 for i in 0..std::usize::MAX {
1112 if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
1113 // Then, make sure any current forwards make their way to their destination
1114 if process_msg_events!(0, false, ProcessMessages::AllMessages) { continue; }
1115 if process_msg_events!(1, false, ProcessMessages::AllMessages) { continue; }
1116 if process_msg_events!(2, false, ProcessMessages::AllMessages) { continue; }
1117 // ...making sure any pending PendingHTLCsForwardable events are handled and
1118 // payments claimed.
1119 if process_events!(0, false) { continue; }
1120 if process_events!(1, false) { continue; }
1121 if process_events!(2, false) { continue; }
1125 // Finally, make sure that at least one end of each channel can make a substantial payment.
1127 send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id) ||
1128 send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id));
1130 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
1131 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));
1133 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
1134 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
1135 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
1137 _ => test_return!(),
1140 node_a_ser.0.clear();
1141 nodes[0].write(&mut node_a_ser).unwrap();
1142 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
1143 node_b_ser.0.clear();
1144 nodes[1].write(&mut node_b_ser).unwrap();
1145 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
1146 node_c_ser.0.clear();
1147 nodes[2].write(&mut node_c_ser).unwrap();
1148 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
1152 pub fn chanmon_consistency_test<Out: test_logger::Output>(data: &[u8], out: Out) {
1157 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
1158 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});