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::Confirm;
34 use lightning::chain::chainmonitor;
35 use lightning::chain::channelmonitor;
36 use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, MonitorEvent};
37 use lightning::chain::transaction::OutPoint;
38 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
39 use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
40 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
41 use lightning::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs};
42 use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
43 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, ErrorAction, UpdateAddHTLC, Init};
44 use lightning::util::enforcing_trait_impls::{EnforcingSigner, INITIAL_REVOKED_COMMITMENT_NUMBER};
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::{EventsProvider, MessageSendEventsProvider};
50 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
51 use lightning::util::test_utils::OnlyReadsKeysInterface;
52 use lightning::routing::router::{Route, RouteHop};
55 use utils::test_logger;
56 use utils::test_persister::TestPersister;
58 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
59 use bitcoin::secp256k1::Secp256k1;
62 use std::cmp::Ordering;
63 use std::collections::{HashSet, hash_map, HashMap};
64 use std::sync::{Arc,Mutex};
65 use std::sync::atomic;
68 struct FuzzEstimator {}
69 impl FeeEstimator for FuzzEstimator {
70 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
75 pub struct TestBroadcaster {}
76 impl BroadcasterInterface for TestBroadcaster {
77 fn broadcast_transaction(&self, _tx: &Transaction) { }
80 pub struct VecWriter(pub Vec<u8>);
81 impl Writer for VecWriter {
82 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
83 self.0.extend_from_slice(buf);
86 fn size_hint(&mut self, size: usize) {
87 self.0.reserve_exact(size);
91 struct TestChainMonitor {
92 pub logger: Arc<dyn Logger>,
93 pub chain_monitor: Arc<chainmonitor::ChainMonitor<EnforcingSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
94 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
95 // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
96 // logic will automatically force-close our channels for us (as we don't have an up-to-date
97 // monitor implying we are not able to punish misbehaving counterparties). Because this test
98 // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
99 // fully-serialized monitor state here, as well as the corresponding update_id.
100 pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
101 pub should_update_manager: atomic::AtomicBool,
103 impl TestChainMonitor {
104 pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>) -> Self {
106 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), &OnlyReadsKeysInterface {}).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 self.update_ret.lock().unwrap().clone()
142 fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
143 return self.chain_monitor.release_pending_monitor_events();
149 rand_bytes_id: atomic::AtomicU8,
150 revoked_commitments: Mutex<HashMap<[u8;32], Arc<Mutex<u64>>>>,
152 impl KeysInterface for KeyProvider {
153 type Signer = EnforcingSigner;
155 fn get_node_secret(&self) -> SecretKey {
156 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()
159 fn get_destination_script(&self) -> Script {
160 let secp_ctx = Secp256k1::signing_only();
161 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();
162 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
163 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
166 fn get_shutdown_pubkey(&self) -> PublicKey {
167 let secp_ctx = Secp256k1::signing_only();
168 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())
171 fn get_channel_signer(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner {
172 let secp_ctx = Secp256k1::signing_only();
173 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
174 let keys = InMemorySigner::new(
176 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(),
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, 5, 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, 6, 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, 7, 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, 8, self.node_id]).unwrap(),
181 [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_id],
182 channel_value_satoshis,
185 let revoked_commitment = self.make_revoked_commitment_cell(keys.commitment_seed);
186 EnforcingSigner::new_with_revoked(keys, revoked_commitment, false)
189 fn get_secure_random_bytes(&self) -> [u8; 32] {
190 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
191 [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, id, 11, self.node_id]
194 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, DecodeError> {
195 let mut reader = std::io::Cursor::new(buffer);
197 let inner: InMemorySigner = Readable::read(&mut reader)?;
198 let revoked_commitment = self.make_revoked_commitment_cell(inner.commitment_seed);
200 let last_commitment_number = Readable::read(&mut reader)?;
204 last_commitment_number: Arc::new(Mutex::new(last_commitment_number)),
206 disable_revocation_policy_check: false,
212 fn make_revoked_commitment_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<u64>> {
213 let mut revoked_commitments = self.revoked_commitments.lock().unwrap();
214 if !revoked_commitments.contains_key(&commitment_seed) {
215 revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(INITIAL_REVOKED_COMMITMENT_NUMBER)));
217 let cell = revoked_commitments.get(&commitment_seed).unwrap();
223 fn check_api_err(api_err: APIError) {
225 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
226 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
227 APIError::RouteError { .. } => panic!("Our routes should work"),
228 APIError::ChannelUnavailable { err } => {
229 // Test the error against a list of errors we can hit, and reject
230 // all others. If you hit this panic, the list of acceptable errors
231 // is probably just stale and you should add new messages here.
233 "Peer for first hop currently disconnected/pending monitor update!" => {},
234 _ if err.starts_with("Cannot push more than their max accepted HTLCs ") => {},
235 _ if err.starts_with("Cannot send value that would put us over the max HTLC value in flight our peer will accept ") => {},
236 _ if err.starts_with("Cannot send value that would put our balance under counterparty-announced channel reserve value") => {},
237 _ if err.starts_with("Cannot send value that would overdraw remaining funds.") => {},
238 _ if err.starts_with("Cannot send value that would not leave enough to pay for fees.") => {},
239 _ => panic!("{}", err),
242 APIError::MonitorUpdateFailed => {
243 // We can (obviously) temp-fail a monitor update
248 fn check_payment_err(send_err: PaymentSendFailure) {
250 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err),
251 PaymentSendFailure::PathParameterError(per_path_results) => {
252 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
254 PaymentSendFailure::AllFailedRetrySafe(per_path_results) => {
255 for api_err in per_path_results { check_api_err(api_err); }
257 PaymentSendFailure::PartialFailure(per_path_results) => {
258 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
263 type ChanMan = ChannelManager<EnforcingSigner, Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>;
266 fn get_payment_secret_hash(dest: &ChanMan, payment_id: &mut u8) -> Option<(PaymentSecret, PaymentHash)> {
267 let mut payment_hash;
269 payment_hash = PaymentHash(Sha256::hash(&[*payment_id; 1]).into_inner());
270 if let Ok(payment_secret) = dest.create_inbound_payment_for_hash(payment_hash, None, 7200, 0) {
271 return Some((payment_secret, payment_hash));
273 *payment_id = payment_id.wrapping_add(1);
279 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
280 let (payment_secret, payment_hash) =
281 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
282 if let Err(err) = source.send_payment(&Route {
283 paths: vec![vec![RouteHop {
284 pubkey: dest.get_our_node_id(),
285 node_features: NodeFeatures::known(),
286 short_channel_id: dest_chan_id,
287 channel_features: ChannelFeatures::known(),
289 cltv_expiry_delta: 200,
291 }, payment_hash, &Some(payment_secret)) {
292 check_payment_err(err);
297 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 {
298 let (payment_secret, payment_hash) =
299 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
300 if let Err(err) = source.send_payment(&Route {
301 paths: vec![vec![RouteHop {
302 pubkey: middle.get_our_node_id(),
303 node_features: NodeFeatures::known(),
304 short_channel_id: middle_chan_id,
305 channel_features: ChannelFeatures::known(),
307 cltv_expiry_delta: 100,
309 pubkey: dest.get_our_node_id(),
310 node_features: NodeFeatures::known(),
311 short_channel_id: dest_chan_id,
312 channel_features: ChannelFeatures::known(),
314 cltv_expiry_delta: 200,
316 }, payment_hash, &Some(payment_secret)) {
317 check_payment_err(err);
323 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
324 let fee_est = Arc::new(FuzzEstimator{});
325 let broadcast = Arc::new(TestBroadcaster{});
327 macro_rules! make_node {
328 ($node_id: expr) => { {
329 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
330 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{})));
332 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU8::new(0), revoked_commitments: Mutex::new(HashMap::new()) });
333 let mut config = UserConfig::default();
334 config.channel_options.fee_proportional_millionths = 0;
335 config.channel_options.announced_channel = true;
336 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
337 let network = Network::Bitcoin;
338 let params = ChainParameters {
340 best_block: BestBlock::from_genesis(network),
342 (ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
343 monitor, keys_manager)
347 macro_rules! reload_node {
348 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr) => { {
349 let keys_manager = Arc::clone(& $keys_manager);
350 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
351 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{})));
353 let mut config = UserConfig::default();
354 config.channel_options.fee_proportional_millionths = 0;
355 config.channel_options.announced_channel = true;
356 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
358 let mut monitors = HashMap::new();
359 let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
360 for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
361 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut Cursor::new(&monitor_ser), &OnlyReadsKeysInterface {}).expect("Failed to read monitor").1);
362 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
364 let mut monitor_refs = HashMap::new();
365 for (outpoint, monitor) in monitors.iter_mut() {
366 monitor_refs.insert(*outpoint, monitor);
369 let read_args = ChannelManagerReadArgs {
371 fee_estimator: fee_est.clone(),
372 chain_monitor: chain_monitor.clone(),
373 tx_broadcaster: broadcast.clone(),
375 default_config: config,
376 channel_monitors: monitor_refs,
379 (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor)
383 let mut channel_txn = Vec::new();
384 macro_rules! make_channel {
385 ($source: expr, $dest: expr, $chan_id: expr) => { {
386 $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
388 let events = $source.get_and_clear_pending_msg_events();
389 assert_eq!(events.len(), 1);
390 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
392 } else { panic!("Wrong event type"); }
395 $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::known(), &open_channel);
396 let accept_channel = {
397 let events = $dest.get_and_clear_pending_msg_events();
398 assert_eq!(events.len(), 1);
399 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
401 } else { panic!("Wrong event type"); }
404 $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::known(), &accept_channel);
407 let events = $source.get_and_clear_pending_events();
408 assert_eq!(events.len(), 1);
409 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
410 let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
411 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
413 funding_output = OutPoint { txid: tx.txid(), index: 0 };
414 $source.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
415 channel_txn.push(tx);
416 } else { panic!("Wrong event type"); }
419 let funding_created = {
420 let events = $source.get_and_clear_pending_msg_events();
421 assert_eq!(events.len(), 1);
422 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
424 } else { panic!("Wrong event type"); }
426 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
428 let funding_signed = {
429 let events = $dest.get_and_clear_pending_msg_events();
430 assert_eq!(events.len(), 1);
431 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
433 } else { panic!("Wrong event type"); }
435 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
441 macro_rules! confirm_txn {
443 let chain_hash = genesis_block(Network::Bitcoin).block_hash();
444 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: chain_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
445 let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
446 $node.transactions_confirmed(&header, &txdata, 1);
448 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
450 $node.best_block_updated(&header, 99);
454 macro_rules! lock_fundings {
455 ($nodes: expr) => { {
456 let mut node_events = Vec::new();
457 for node in $nodes.iter() {
458 node_events.push(node.get_and_clear_pending_msg_events());
460 for (idx, node_event) in node_events.iter().enumerate() {
461 for event in node_event {
462 if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
463 for node in $nodes.iter() {
464 if node.get_our_node_id() == *node_id {
465 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
468 } else { panic!("Wrong event type"); }
472 for node in $nodes.iter() {
473 let events = node.get_and_clear_pending_msg_events();
474 for event in events {
475 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
476 } else { panic!("Wrong event type"); }
482 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
484 let (node_a, mut monitor_a, keys_manager_a) = make_node!(0);
485 let (node_b, mut monitor_b, keys_manager_b) = make_node!(1);
486 let (node_c, mut monitor_c, keys_manager_c) = make_node!(2);
488 let mut nodes = [node_a, node_b, node_c];
490 let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
491 let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
493 for node in nodes.iter() {
497 lock_fundings!(nodes);
499 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
500 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
502 let mut payment_id: u8 = 0;
504 let mut chan_a_disconnected = false;
505 let mut chan_b_disconnected = false;
506 let mut ba_events = Vec::new();
507 let mut bc_events = Vec::new();
509 let mut node_a_ser = VecWriter(Vec::new());
510 nodes[0].write(&mut node_a_ser).unwrap();
511 let mut node_b_ser = VecWriter(Vec::new());
512 nodes[1].write(&mut node_b_ser).unwrap();
513 let mut node_c_ser = VecWriter(Vec::new());
514 nodes[2].write(&mut node_c_ser).unwrap();
516 macro_rules! test_return {
518 assert_eq!(nodes[0].list_channels().len(), 1);
519 assert_eq!(nodes[1].list_channels().len(), 2);
520 assert_eq!(nodes[2].list_channels().len(), 1);
525 let mut read_pos = 0;
526 macro_rules! get_slice {
529 let slice_len = $len as usize;
530 if data.len() < read_pos + slice_len {
533 read_pos += slice_len;
534 &data[read_pos - slice_len..read_pos]
540 macro_rules! process_msg_events {
541 ($node: expr, $corrupt_forward: expr) => { {
542 let events = if $node == 1 {
543 let mut new_events = Vec::new();
544 mem::swap(&mut new_events, &mut ba_events);
545 new_events.extend_from_slice(&bc_events[..]);
548 } else { Vec::new() };
549 let mut had_events = false;
550 for event in events.iter().chain(nodes[$node].get_and_clear_pending_msg_events().iter()) {
553 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 } } => {
554 for dest in nodes.iter() {
555 if dest.get_our_node_id() == *node_id {
556 assert!(update_fee.is_none());
557 for update_add in update_add_htlcs {
558 if !$corrupt_forward {
559 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &update_add);
561 // Corrupt the update_add_htlc message so that its HMAC
562 // check will fail and we generate a
563 // update_fail_malformed_htlc instead of an
564 // update_fail_htlc as we do when we reject a payment.
565 let mut msg_ser = update_add.encode();
566 msg_ser[1000] ^= 0xff;
567 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
568 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
571 for update_fulfill in update_fulfill_htlcs {
572 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), &update_fulfill);
574 for update_fail in update_fail_htlcs {
575 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), &update_fail);
577 for update_fail_malformed in update_fail_malformed_htlcs {
578 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), &update_fail_malformed);
580 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
584 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
585 for dest in nodes.iter() {
586 if dest.get_our_node_id() == *node_id {
587 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
591 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
592 for dest in nodes.iter() {
593 if dest.get_our_node_id() == *node_id {
594 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
598 events::MessageSendEvent::SendFundingLocked { .. } => {
599 // Can be generated as a reestablish response
601 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
602 // Can be generated due to a payment forward being rejected due to a
603 // channel having previously failed a monitor update
605 _ => panic!("Unhandled message event"),
612 macro_rules! drain_msg_events_on_disconnect {
613 ($counterparty_id: expr) => { {
614 if $counterparty_id == 0 {
615 for event in nodes[0].get_and_clear_pending_msg_events() {
617 events::MessageSendEvent::UpdateHTLCs { .. } => {},
618 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
619 events::MessageSendEvent::SendChannelReestablish { .. } => {},
620 events::MessageSendEvent::SendFundingLocked { .. } => {},
621 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
622 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
623 _ => panic!("Unhandled message event"),
628 for event in nodes[2].get_and_clear_pending_msg_events() {
630 events::MessageSendEvent::UpdateHTLCs { .. } => {},
631 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
632 events::MessageSendEvent::SendChannelReestablish { .. } => {},
633 events::MessageSendEvent::SendFundingLocked { .. } => {},
634 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
635 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
636 _ => panic!("Unhandled message event"),
641 let mut events = nodes[1].get_and_clear_pending_msg_events();
642 let drop_node_id = if $counterparty_id == 0 { nodes[0].get_our_node_id() } else { nodes[2].get_our_node_id() };
643 let msg_sink = if $counterparty_id == 0 { &mut bc_events } else { &mut ba_events };
644 for event in events.drain(..) {
645 let push = match event {
646 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
647 if *node_id != drop_node_id { true } else { false }
649 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
650 if *node_id != drop_node_id { true } else { false }
652 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
653 if *node_id != drop_node_id { true } else { false }
655 events::MessageSendEvent::SendFundingLocked { .. } => false,
656 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => false,
657 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => false,
658 _ => panic!("Unhandled message event"),
660 if push { msg_sink.push(event); }
665 macro_rules! process_events {
666 ($node: expr, $fail: expr) => { {
667 // In case we get 256 payments we may have a hash collision, resulting in the
668 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
669 // deduplicate the calls here.
670 let mut claim_set = HashSet::new();
671 let mut events = nodes[$node].get_and_clear_pending_events();
672 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
673 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
674 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
675 // PaymentReceived event for the second HTLC in our pending_events (and breaking
676 // our claim_set deduplication).
677 events.sort_by(|a, b| {
678 if let events::Event::PaymentReceived { .. } = a {
679 if let events::Event::PendingHTLCsForwardable { .. } = b {
681 } else { Ordering::Equal }
682 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
683 if let events::Event::PaymentReceived { .. } = b {
685 } else { Ordering::Equal }
686 } else { Ordering::Equal }
688 let had_events = !events.is_empty();
689 for event in events.drain(..) {
691 events::Event::PaymentReceived { payment_hash, .. } => {
692 if claim_set.insert(payment_hash.0) {
694 assert!(nodes[$node].fail_htlc_backwards(&payment_hash));
696 assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0)));
700 events::Event::PaymentSent { .. } => {},
701 events::Event::PaymentFailed { .. } => {},
702 events::Event::PendingHTLCsForwardable { .. } => {
703 nodes[$node].process_pending_htlc_forwards();
705 _ => panic!("Unhandled event"),
712 match get_slice!(1)[0] {
713 // In general, we keep related message groups close together in binary form, allowing
714 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
717 0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
718 0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
719 0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
720 0x04 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
721 0x05 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
722 0x06 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
725 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
726 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
730 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
731 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
735 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
736 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
740 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
741 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
746 if !chan_a_disconnected {
747 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
748 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
749 chan_a_disconnected = true;
750 drain_msg_events_on_disconnect!(0);
754 if !chan_b_disconnected {
755 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
756 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
757 chan_b_disconnected = true;
758 drain_msg_events_on_disconnect!(2);
762 if chan_a_disconnected {
763 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
764 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::known() });
765 chan_a_disconnected = false;
769 if chan_b_disconnected {
770 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::known() });
771 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
772 chan_b_disconnected = false;
776 0x10 => { process_msg_events!(0, true); },
777 0x11 => { process_msg_events!(0, false); },
778 0x12 => { process_events!(0, true); },
779 0x13 => { process_events!(0, false); },
780 0x14 => { process_msg_events!(1, true); },
781 0x15 => { process_msg_events!(1, false); },
782 0x16 => { process_events!(1, true); },
783 0x17 => { process_events!(1, false); },
784 0x18 => { process_msg_events!(2, true); },
785 0x19 => { process_msg_events!(2, false); },
786 0x1a => { process_events!(2, true); },
787 0x1b => { process_events!(2, false); },
790 if !chan_a_disconnected {
791 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
792 chan_a_disconnected = true;
793 drain_msg_events_on_disconnect!(0);
795 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a);
796 nodes[0] = new_node_a;
797 monitor_a = new_monitor_a;
800 if !chan_a_disconnected {
801 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
802 chan_a_disconnected = true;
803 nodes[0].get_and_clear_pending_msg_events();
806 if !chan_b_disconnected {
807 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
808 chan_b_disconnected = true;
809 nodes[2].get_and_clear_pending_msg_events();
812 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b);
813 nodes[1] = new_node_b;
814 monitor_b = new_monitor_b;
817 if !chan_b_disconnected {
818 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
819 chan_b_disconnected = true;
820 drain_msg_events_on_disconnect!(2);
822 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c);
823 nodes[2] = new_node_c;
824 monitor_c = new_monitor_c;
827 // 1/10th the channel size:
828 0x20 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id); },
829 0x21 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id); },
830 0x22 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id); },
831 0x23 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id); },
832 0x24 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id); },
833 0x25 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id); },
835 0x28 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id); },
836 0x29 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id); },
837 0x2a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id); },
838 0x2b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id); },
839 0x2c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id); },
840 0x2d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id); },
842 0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id); },
843 0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id); },
844 0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id); },
845 0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id); },
846 0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id); },
847 0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id); },
849 0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id); },
850 0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id); },
851 0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id); },
852 0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id); },
853 0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id); },
854 0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id); },
856 0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id); },
857 0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id); },
858 0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id); },
859 0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id); },
860 0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id); },
861 0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id); },
863 0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id); },
864 0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id); },
865 0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id); },
866 0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id); },
867 0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id); },
868 0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id); },
870 0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id); },
871 0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id); },
872 0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id); },
873 0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id); },
874 0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id); },
875 0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id); },
877 0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id); },
878 0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id); },
879 0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id); },
880 0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id); },
881 0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
882 0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },
885 // Test that no channel is in a stuck state where neither party can send funds even
886 // after we resolve all pending events.
887 // First make sure there are no pending monitor updates, resetting the error state
888 // and calling channel_monitor_updated for each monitor.
889 *monitor_a.update_ret.lock().unwrap() = Ok(());
890 *monitor_b.update_ret.lock().unwrap() = Ok(());
891 *monitor_c.update_ret.lock().unwrap() = Ok(());
893 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
894 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
896 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
897 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
899 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
900 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
902 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
903 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
906 // Next, make sure peers are all connected to each other
907 if chan_a_disconnected {
908 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
909 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::known() });
910 chan_a_disconnected = false;
912 if chan_b_disconnected {
913 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::known() });
914 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
915 chan_b_disconnected = false;
918 for i in 0..std::usize::MAX {
919 if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
920 // Then, make sure any current forwards make their way to their destination
921 if process_msg_events!(0, false) { continue; }
922 if process_msg_events!(1, false) { continue; }
923 if process_msg_events!(2, false) { continue; }
924 // ...making sure any pending PendingHTLCsForwardable events are handled and
926 if process_events!(0, false) { continue; }
927 if process_events!(1, false) { continue; }
928 if process_events!(2, false) { continue; }
932 // Finally, make sure that at least one end of each channel can make a substantial payment.
934 send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id) ||
935 send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id));
937 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
938 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));
943 node_a_ser.0.clear();
944 nodes[0].write(&mut node_a_ser).unwrap();
945 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
946 node_b_ser.0.clear();
947 nodes[1].write(&mut node_b_ser).unwrap();
948 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
949 node_c_ser.0.clear();
950 nodes[2].write(&mut node_c_ser).unwrap();
951 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
955 pub fn chanmon_consistency_test<Out: test_logger::Output>(data: &[u8], out: Out) {
960 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
961 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});