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::{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::{BestBlock, ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs};
40 use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
41 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
42 use lightning::util::enforcing_trait_impls::{EnforcingSigner, INITIAL_REVOKED_COMMITMENT_NUMBER};
43 use lightning::util::errors::APIError;
44 use lightning::util::events;
45 use lightning::util::logger::Logger;
46 use lightning::util::config::UserConfig;
47 use lightning::util::events::MessageSendEventsProvider;
48 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
49 use lightning::routing::router::{Route, RouteHop};
52 use utils::test_logger;
53 use utils::test_persister::TestPersister;
55 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
56 use bitcoin::secp256k1::recovery::RecoverableSignature;
57 use bitcoin::secp256k1::Secp256k1;
60 use std::cmp::Ordering;
61 use std::collections::{HashSet, hash_map, HashMap};
62 use std::sync::{Arc,Mutex};
63 use std::sync::atomic;
66 struct FuzzEstimator {}
67 impl FeeEstimator for FuzzEstimator {
68 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
73 pub struct TestBroadcaster {}
74 impl BroadcasterInterface for TestBroadcaster {
75 fn broadcast_transaction(&self, _tx: &Transaction) { }
78 pub struct VecWriter(pub Vec<u8>);
79 impl Writer for VecWriter {
80 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
81 self.0.extend_from_slice(buf);
84 fn size_hint(&mut self, size: usize) {
85 self.0.reserve_exact(size);
89 struct TestChainMonitor {
90 pub logger: Arc<dyn Logger>,
91 pub keys: Arc<KeyProvider>,
92 pub chain_monitor: Arc<chainmonitor::ChainMonitor<EnforcingSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
93 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
94 // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
95 // logic will automatically force-close our channels for us (as we don't have an up-to-date
96 // monitor implying we are not able to punish misbehaving counterparties). Because this test
97 // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
98 // fully-serialized monitor state here, as well as the corresponding update_id.
99 pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
100 pub should_update_manager: atomic::AtomicBool,
102 impl TestChainMonitor {
103 pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>, keys: Arc<KeyProvider>) -> Self {
105 chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, persister)),
108 update_ret: Mutex::new(Ok(())),
109 latest_monitors: Mutex::new(HashMap::new()),
110 should_update_manager: atomic::AtomicBool::new(false),
114 impl chain::Watch<EnforcingSigner> for TestChainMonitor {
115 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
116 let mut ser = VecWriter(Vec::new());
117 monitor.write(&mut ser).unwrap();
118 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
119 panic!("Already had monitor pre-watch_channel");
121 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
122 assert!(self.chain_monitor.watch_channel(funding_txo, monitor).is_ok());
123 self.update_ret.lock().unwrap().clone()
126 fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
127 let mut map_lock = self.latest_monitors.lock().unwrap();
128 let mut map_entry = match map_lock.entry(funding_txo) {
129 hash_map::Entry::Occupied(entry) => entry,
130 hash_map::Entry::Vacant(_) => panic!("Didn't have monitor on update call"),
132 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
133 read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
134 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
135 let mut ser = VecWriter(Vec::new());
136 deserialized_monitor.write(&mut ser).unwrap();
137 map_entry.insert((update.update_id, ser.0));
138 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
139 assert!(self.chain_monitor.update_channel(funding_txo, update).is_ok());
140 self.update_ret.lock().unwrap().clone()
143 fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
144 return self.chain_monitor.release_pending_monitor_events();
150 rand_bytes_id: atomic::AtomicU32,
151 revoked_commitments: Mutex<HashMap<[u8;32], Arc<Mutex<u64>>>>,
153 impl KeysInterface for KeyProvider {
154 type Signer = EnforcingSigner;
156 fn get_node_secret(&self) -> SecretKey {
157 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()
160 fn get_destination_script(&self) -> Script {
161 let secp_ctx = Secp256k1::signing_only();
162 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();
163 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
164 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
167 fn get_shutdown_pubkey(&self) -> PublicKey {
168 let secp_ctx = Secp256k1::signing_only();
169 PublicKey::from_secret_key(&secp_ctx, &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())
172 fn get_channel_signer(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner {
173 let secp_ctx = Secp256k1::signing_only();
174 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
175 let keys = InMemorySigner::new(
177 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(),
178 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(),
179 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(),
180 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(),
181 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(),
182 [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],
183 channel_value_satoshis,
186 let revoked_commitment = self.make_revoked_commitment_cell(keys.commitment_seed);
187 EnforcingSigner::new_with_revoked(keys, revoked_commitment, false)
190 fn get_secure_random_bytes(&self) -> [u8; 32] {
191 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
192 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];
193 res[30-4..30].copy_from_slice(&id.to_le_bytes());
197 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, DecodeError> {
198 let mut reader = std::io::Cursor::new(buffer);
200 let inner: InMemorySigner = Readable::read(&mut reader)?;
201 let revoked_commitment = self.make_revoked_commitment_cell(inner.commitment_seed);
203 let last_commitment_number = Readable::read(&mut reader)?;
207 last_commitment_number: Arc::new(Mutex::new(last_commitment_number)),
209 disable_revocation_policy_check: false,
213 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> {
219 fn make_revoked_commitment_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<u64>> {
220 let mut revoked_commitments = self.revoked_commitments.lock().unwrap();
221 if !revoked_commitments.contains_key(&commitment_seed) {
222 revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(INITIAL_REVOKED_COMMITMENT_NUMBER)));
224 let cell = revoked_commitments.get(&commitment_seed).unwrap();
230 fn check_api_err(api_err: APIError) {
232 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
233 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
234 APIError::RouteError { .. } => panic!("Our routes should work"),
235 APIError::ChannelUnavailable { err } => {
236 // Test the error against a list of errors we can hit, and reject
237 // all others. If you hit this panic, the list of acceptable errors
238 // is probably just stale and you should add new messages here.
240 "Peer for first hop currently disconnected/pending monitor update!" => {},
241 _ if err.starts_with("Cannot push more than their max accepted HTLCs ") => {},
242 _ if err.starts_with("Cannot send value that would put us over the max HTLC value in flight our peer will accept ") => {},
243 _ if err.starts_with("Cannot send value that would put our balance under counterparty-announced channel reserve value") => {},
244 _ if err.starts_with("Cannot send value that would overdraw remaining funds.") => {},
245 _ if err.starts_with("Cannot send value that would not leave enough to pay for fees.") => {},
246 _ => panic!("{}", err),
249 APIError::MonitorUpdateFailed => {
250 // We can (obviously) temp-fail a monitor update
255 fn check_payment_err(send_err: PaymentSendFailure) {
257 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err),
258 PaymentSendFailure::PathParameterError(per_path_results) => {
259 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
261 PaymentSendFailure::AllFailedRetrySafe(per_path_results) => {
262 for api_err in per_path_results { check_api_err(api_err); }
264 PaymentSendFailure::PartialFailure(per_path_results) => {
265 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
270 type ChanMan = ChannelManager<EnforcingSigner, Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>;
273 fn get_payment_secret_hash(dest: &ChanMan, payment_id: &mut u8) -> Option<(PaymentSecret, PaymentHash)> {
274 let mut payment_hash;
276 payment_hash = PaymentHash(Sha256::hash(&[*payment_id; 1]).into_inner());
277 if let Ok(payment_secret) = dest.create_inbound_payment_for_hash(payment_hash, None, 3600, 0) {
278 return Some((payment_secret, payment_hash));
280 *payment_id = payment_id.wrapping_add(1);
286 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
287 let (payment_secret, payment_hash) =
288 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
289 if let Err(err) = source.send_payment(&Route {
290 paths: vec![vec![RouteHop {
291 pubkey: dest.get_our_node_id(),
292 node_features: NodeFeatures::known(),
293 short_channel_id: dest_chan_id,
294 channel_features: ChannelFeatures::known(),
296 cltv_expiry_delta: 200,
298 }, payment_hash, &Some(payment_secret)) {
299 check_payment_err(err);
304 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 {
305 let (payment_secret, payment_hash) =
306 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
307 if let Err(err) = source.send_payment(&Route {
308 paths: vec![vec![RouteHop {
309 pubkey: middle.get_our_node_id(),
310 node_features: NodeFeatures::known(),
311 short_channel_id: middle_chan_id,
312 channel_features: ChannelFeatures::known(),
314 cltv_expiry_delta: 100,
316 pubkey: dest.get_our_node_id(),
317 node_features: NodeFeatures::known(),
318 short_channel_id: dest_chan_id,
319 channel_features: ChannelFeatures::known(),
321 cltv_expiry_delta: 200,
323 }, payment_hash, &Some(payment_secret)) {
324 check_payment_err(err);
330 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
331 let fee_est = Arc::new(FuzzEstimator{});
332 let broadcast = Arc::new(TestBroadcaster{});
334 macro_rules! make_node {
335 ($node_id: expr) => { {
336 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
337 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), revoked_commitments: Mutex::new(HashMap::new()) });
338 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));
340 let mut config = UserConfig::default();
341 config.channel_options.fee_proportional_millionths = 0;
342 config.channel_options.announced_channel = true;
343 let network = Network::Bitcoin;
344 let params = ChainParameters {
346 best_block: BestBlock::from_genesis(network),
348 (ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
349 monitor, keys_manager)
353 macro_rules! reload_node {
354 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr) => { {
355 let keys_manager = Arc::clone(& $keys_manager);
356 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
357 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));
359 let mut config = UserConfig::default();
360 config.channel_options.fee_proportional_millionths = 0;
361 config.channel_options.announced_channel = true;
363 let mut monitors = HashMap::new();
364 let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
365 for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
366 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut Cursor::new(&monitor_ser), &*$keys_manager).expect("Failed to read monitor").1);
367 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
369 let mut monitor_refs = HashMap::new();
370 for (outpoint, monitor) in monitors.iter_mut() {
371 monitor_refs.insert(*outpoint, monitor);
374 let read_args = ChannelManagerReadArgs {
376 fee_estimator: fee_est.clone(),
377 chain_monitor: chain_monitor.clone(),
378 tx_broadcaster: broadcast.clone(),
380 default_config: config,
381 channel_monitors: monitor_refs,
384 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
385 for (funding_txo, mon) in monitors.drain() {
386 assert!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon).is_ok());
392 let mut channel_txn = Vec::new();
393 macro_rules! make_channel {
394 ($source: expr, $dest: expr, $chan_id: expr) => { {
395 $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
397 let events = $source.get_and_clear_pending_msg_events();
398 assert_eq!(events.len(), 1);
399 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
401 } else { panic!("Wrong event type"); }
404 $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::known(), &open_channel);
405 let accept_channel = {
406 let events = $dest.get_and_clear_pending_msg_events();
407 assert_eq!(events.len(), 1);
408 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
410 } else { panic!("Wrong event type"); }
413 $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::known(), &accept_channel);
416 let events = $source.get_and_clear_pending_events();
417 assert_eq!(events.len(), 1);
418 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
419 let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
420 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
422 funding_output = OutPoint { txid: tx.txid(), index: 0 };
423 $source.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
424 channel_txn.push(tx);
425 } else { panic!("Wrong event type"); }
428 let funding_created = {
429 let events = $source.get_and_clear_pending_msg_events();
430 assert_eq!(events.len(), 1);
431 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
433 } else { panic!("Wrong event type"); }
435 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
437 let funding_signed = {
438 let events = $dest.get_and_clear_pending_msg_events();
439 assert_eq!(events.len(), 1);
440 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
442 } else { panic!("Wrong event type"); }
444 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
450 macro_rules! confirm_txn {
452 let chain_hash = genesis_block(Network::Bitcoin).block_hash();
453 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: chain_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
454 let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
455 $node.transactions_confirmed(&header, &txdata, 1);
457 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
459 $node.best_block_updated(&header, 99);
463 macro_rules! lock_fundings {
464 ($nodes: expr) => { {
465 let mut node_events = Vec::new();
466 for node in $nodes.iter() {
467 node_events.push(node.get_and_clear_pending_msg_events());
469 for (idx, node_event) in node_events.iter().enumerate() {
470 for event in node_event {
471 if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
472 for node in $nodes.iter() {
473 if node.get_our_node_id() == *node_id {
474 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
477 } else { panic!("Wrong event type"); }
481 for node in $nodes.iter() {
482 let events = node.get_and_clear_pending_msg_events();
483 for event in events {
484 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
485 } else { panic!("Wrong event type"); }
491 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
493 let (node_a, mut monitor_a, keys_manager_a) = make_node!(0);
494 let (node_b, mut monitor_b, keys_manager_b) = make_node!(1);
495 let (node_c, mut monitor_c, keys_manager_c) = make_node!(2);
497 let mut nodes = [node_a, node_b, node_c];
499 let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
500 let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
502 for node in nodes.iter() {
506 lock_fundings!(nodes);
508 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
509 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
511 let mut payment_id: u8 = 0;
513 let mut chan_a_disconnected = false;
514 let mut chan_b_disconnected = false;
515 let mut ba_events = Vec::new();
516 let mut bc_events = Vec::new();
518 let mut node_a_ser = VecWriter(Vec::new());
519 nodes[0].write(&mut node_a_ser).unwrap();
520 let mut node_b_ser = VecWriter(Vec::new());
521 nodes[1].write(&mut node_b_ser).unwrap();
522 let mut node_c_ser = VecWriter(Vec::new());
523 nodes[2].write(&mut node_c_ser).unwrap();
525 macro_rules! test_return {
527 assert_eq!(nodes[0].list_channels().len(), 1);
528 assert_eq!(nodes[1].list_channels().len(), 2);
529 assert_eq!(nodes[2].list_channels().len(), 1);
534 let mut read_pos = 0;
535 macro_rules! get_slice {
538 let slice_len = $len as usize;
539 if data.len() < read_pos + slice_len {
542 read_pos += slice_len;
543 &data[read_pos - slice_len..read_pos]
549 macro_rules! process_msg_events {
550 ($node: expr, $corrupt_forward: expr) => { {
551 let events = if $node == 1 {
552 let mut new_events = Vec::new();
553 mem::swap(&mut new_events, &mut ba_events);
554 new_events.extend_from_slice(&bc_events[..]);
557 } else { Vec::new() };
558 let mut had_events = false;
559 for event in events.iter().chain(nodes[$node].get_and_clear_pending_msg_events().iter()) {
562 events::MessageSendEvent::UpdateHTLCs { ref node_id, updates: CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
563 for dest in nodes.iter() {
564 if dest.get_our_node_id() == *node_id {
565 assert!(update_fee.is_none());
566 for update_add in update_add_htlcs {
567 if !$corrupt_forward {
568 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &update_add);
570 // Corrupt the update_add_htlc message so that its HMAC
571 // check will fail and we generate a
572 // update_fail_malformed_htlc instead of an
573 // update_fail_htlc as we do when we reject a payment.
574 let mut msg_ser = update_add.encode();
575 msg_ser[1000] ^= 0xff;
576 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
577 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
580 for update_fulfill in update_fulfill_htlcs {
581 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), &update_fulfill);
583 for update_fail in update_fail_htlcs {
584 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), &update_fail);
586 for update_fail_malformed in update_fail_malformed_htlcs {
587 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), &update_fail_malformed);
589 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
593 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
594 for dest in nodes.iter() {
595 if dest.get_our_node_id() == *node_id {
596 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
600 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
601 for dest in nodes.iter() {
602 if dest.get_our_node_id() == *node_id {
603 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
607 events::MessageSendEvent::SendFundingLocked { .. } => {
608 // Can be generated as a reestablish response
610 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {
611 // Can be generated as a reestablish response
613 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
614 // Can be generated due to a payment forward being rejected due to a
615 // channel having previously failed a monitor update
617 _ => panic!("Unhandled message event"),
624 macro_rules! drain_msg_events_on_disconnect {
625 ($counterparty_id: expr) => { {
626 if $counterparty_id == 0 {
627 for event in nodes[0].get_and_clear_pending_msg_events() {
629 events::MessageSendEvent::UpdateHTLCs { .. } => {},
630 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
631 events::MessageSendEvent::SendChannelReestablish { .. } => {},
632 events::MessageSendEvent::SendFundingLocked { .. } => {},
633 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
634 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
635 _ => panic!("Unhandled message event"),
640 for event in nodes[2].get_and_clear_pending_msg_events() {
642 events::MessageSendEvent::UpdateHTLCs { .. } => {},
643 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
644 events::MessageSendEvent::SendChannelReestablish { .. } => {},
645 events::MessageSendEvent::SendFundingLocked { .. } => {},
646 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
647 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
648 _ => panic!("Unhandled message event"),
653 let mut events = nodes[1].get_and_clear_pending_msg_events();
654 let drop_node_id = if $counterparty_id == 0 { nodes[0].get_our_node_id() } else { nodes[2].get_our_node_id() };
655 let msg_sink = if $counterparty_id == 0 { &mut bc_events } else { &mut ba_events };
656 for event in events.drain(..) {
657 let push = match event {
658 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
659 if *node_id != drop_node_id { true } else { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
661 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
662 if *node_id != drop_node_id { true } else { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
664 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
665 if *node_id != drop_node_id { true } else { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
667 events::MessageSendEvent::SendFundingLocked { .. } => false,
668 events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
669 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => false,
670 _ => panic!("Unhandled message event"),
672 if push { msg_sink.push(event); }
677 macro_rules! process_events {
678 ($node: expr, $fail: expr) => { {
679 // In case we get 256 payments we may have a hash collision, resulting in the
680 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
681 // deduplicate the calls here.
682 let mut claim_set = HashSet::new();
683 let mut events = nodes[$node].get_and_clear_pending_events();
684 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
685 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
686 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
687 // PaymentReceived event for the second HTLC in our pending_events (and breaking
688 // our claim_set deduplication).
689 events.sort_by(|a, b| {
690 if let events::Event::PaymentReceived { .. } = a {
691 if let events::Event::PendingHTLCsForwardable { .. } = b {
693 } else { Ordering::Equal }
694 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
695 if let events::Event::PaymentReceived { .. } = b {
697 } else { Ordering::Equal }
698 } else { Ordering::Equal }
700 let had_events = !events.is_empty();
701 for event in events.drain(..) {
703 events::Event::PaymentReceived { payment_hash, .. } => {
704 if claim_set.insert(payment_hash.0) {
706 assert!(nodes[$node].fail_htlc_backwards(&payment_hash));
708 assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0)));
712 events::Event::PaymentSent { .. } => {},
713 events::Event::PaymentFailed { .. } => {},
714 events::Event::PendingHTLCsForwardable { .. } => {
715 nodes[$node].process_pending_htlc_forwards();
717 _ => panic!("Unhandled event"),
724 match get_slice!(1)[0] {
725 // In general, we keep related message groups close together in binary form, allowing
726 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
729 0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
730 0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
731 0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
732 0x04 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
733 0x05 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
734 0x06 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
737 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
738 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
742 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
743 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
747 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
748 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
752 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
753 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
758 if !chan_a_disconnected {
759 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
760 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
761 chan_a_disconnected = true;
762 drain_msg_events_on_disconnect!(0);
766 if !chan_b_disconnected {
767 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
768 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
769 chan_b_disconnected = true;
770 drain_msg_events_on_disconnect!(2);
774 if chan_a_disconnected {
775 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
776 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::known() });
777 chan_a_disconnected = false;
781 if chan_b_disconnected {
782 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::known() });
783 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
784 chan_b_disconnected = false;
788 0x10 => { process_msg_events!(0, true); },
789 0x11 => { process_msg_events!(0, false); },
790 0x12 => { process_events!(0, true); },
791 0x13 => { process_events!(0, false); },
792 0x14 => { process_msg_events!(1, true); },
793 0x15 => { process_msg_events!(1, false); },
794 0x16 => { process_events!(1, true); },
795 0x17 => { process_events!(1, false); },
796 0x18 => { process_msg_events!(2, true); },
797 0x19 => { process_msg_events!(2, false); },
798 0x1a => { process_events!(2, true); },
799 0x1b => { process_events!(2, false); },
802 if !chan_a_disconnected {
803 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
804 chan_a_disconnected = true;
805 drain_msg_events_on_disconnect!(0);
807 if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
808 node_a_ser.0.clear();
809 nodes[0].write(&mut node_a_ser).unwrap();
811 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a);
812 nodes[0] = new_node_a;
813 monitor_a = new_monitor_a;
816 if !chan_a_disconnected {
817 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
818 chan_a_disconnected = true;
819 nodes[0].get_and_clear_pending_msg_events();
822 if !chan_b_disconnected {
823 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
824 chan_b_disconnected = true;
825 nodes[2].get_and_clear_pending_msg_events();
828 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b);
829 nodes[1] = new_node_b;
830 monitor_b = new_monitor_b;
833 if !chan_b_disconnected {
834 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
835 chan_b_disconnected = true;
836 drain_msg_events_on_disconnect!(2);
838 if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
839 node_c_ser.0.clear();
840 nodes[2].write(&mut node_c_ser).unwrap();
842 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c);
843 nodes[2] = new_node_c;
844 monitor_c = new_monitor_c;
847 // 1/10th the channel size:
848 0x20 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id); },
849 0x21 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id); },
850 0x22 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id); },
851 0x23 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id); },
852 0x24 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id); },
853 0x25 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id); },
855 0x28 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id); },
856 0x29 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id); },
857 0x2a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id); },
858 0x2b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id); },
859 0x2c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id); },
860 0x2d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id); },
862 0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id); },
863 0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id); },
864 0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id); },
865 0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id); },
866 0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id); },
867 0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id); },
869 0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id); },
870 0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id); },
871 0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id); },
872 0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id); },
873 0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id); },
874 0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id); },
876 0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id); },
877 0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id); },
878 0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id); },
879 0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id); },
880 0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id); },
881 0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id); },
883 0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id); },
884 0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id); },
885 0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id); },
886 0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id); },
887 0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id); },
888 0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id); },
890 0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id); },
891 0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id); },
892 0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id); },
893 0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id); },
894 0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id); },
895 0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id); },
897 0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id); },
898 0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id); },
899 0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id); },
900 0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id); },
901 0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
902 0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },
905 // Test that no channel is in a stuck state where neither party can send funds even
906 // after we resolve all pending events.
907 // First make sure there are no pending monitor updates, resetting the error state
908 // and calling channel_monitor_updated for each monitor.
909 *monitor_a.update_ret.lock().unwrap() = Ok(());
910 *monitor_b.update_ret.lock().unwrap() = Ok(());
911 *monitor_c.update_ret.lock().unwrap() = Ok(());
913 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
914 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
916 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
917 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
919 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
920 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
922 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
923 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
926 // Next, make sure peers are all connected to each other
927 if chan_a_disconnected {
928 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
929 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::known() });
930 chan_a_disconnected = false;
932 if chan_b_disconnected {
933 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::known() });
934 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
935 chan_b_disconnected = false;
938 for i in 0..std::usize::MAX {
939 if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
940 // Then, make sure any current forwards make their way to their destination
941 if process_msg_events!(0, false) { continue; }
942 if process_msg_events!(1, false) { continue; }
943 if process_msg_events!(2, false) { continue; }
944 // ...making sure any pending PendingHTLCsForwardable events are handled and
946 if process_events!(0, false) { continue; }
947 if process_events!(1, false) { continue; }
948 if process_events!(2, false) { continue; }
952 // Finally, make sure that at least one end of each channel can make a substantial payment.
954 send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id) ||
955 send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id));
957 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
958 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));
963 node_a_ser.0.clear();
964 nodes[0].write(&mut node_a_ser).unwrap();
965 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
966 node_b_ser.0.clear();
967 nodes[1].write(&mut node_b_ser).unwrap();
968 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
969 node_c_ser.0.clear();
970 nodes[2].write(&mut node_c_ser).unwrap();
971 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
975 pub fn chanmon_consistency_test<Out: test_logger::Output>(data: &[u8], out: Out) {
980 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
981 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});