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::transaction::{Transaction, TxOut};
23 use bitcoin::blockdata::script::{Builder, Script};
24 use bitcoin::blockdata::opcodes;
25 use bitcoin::network::constants::Network;
27 use bitcoin::hashes::Hash as TraitImport;
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hash_types::{BlockHash, WPubkeyHash};
32 use lightning::chain::chainmonitor;
33 use lightning::chain::channelmonitor;
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, InMemoryChannelKeys};
38 use lightning::ln::channelmanager::{ChannelManager, PaymentHash, PaymentPreimage, PaymentSecret, PaymentSendFailure, ChannelManagerReadArgs};
39 use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
40 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, ErrorAction, UpdateAddHTLC, Init};
41 use lightning::util::enforcing_trait_impls::EnforcingChannelKeys;
42 use lightning::util::errors::APIError;
43 use lightning::util::events;
44 use lightning::util::logger::Logger;
45 use lightning::util::config::UserConfig;
46 use lightning::util::events::{EventsProvider, MessageSendEventsProvider};
47 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
48 use lightning::util::test_utils::OnlyReadsKeysInterface;
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::Secp256k1;
59 use std::cmp::Ordering;
60 use std::collections::{HashSet, hash_map, HashMap};
61 use std::sync::{Arc,Mutex};
62 use std::sync::atomic;
65 struct FuzzEstimator {}
66 impl FeeEstimator for FuzzEstimator {
67 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
72 pub struct TestBroadcaster {}
73 impl BroadcasterInterface for TestBroadcaster {
74 fn broadcast_transaction(&self, _tx: &Transaction) { }
77 pub struct VecWriter(pub Vec<u8>);
78 impl Writer for VecWriter {
79 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
80 self.0.extend_from_slice(buf);
83 fn size_hint(&mut self, size: usize) {
84 self.0.reserve_exact(size);
88 struct TestChainMonitor {
89 pub logger: Arc<dyn Logger>,
90 pub chain_monitor: Arc<chainmonitor::ChainMonitor<EnforcingChannelKeys, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
91 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
92 // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
93 // logic will automatically force-close our channels for us (as we don't have an up-to-date
94 // monitor implying we are not able to punish misbehaving counterparties). Because this test
95 // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
96 // fully-serialized monitor state here, as well as the corresponding update_id.
97 pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
98 pub should_update_manager: atomic::AtomicBool,
100 impl TestChainMonitor {
101 pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>) -> Self {
103 chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, persister)),
105 update_ret: Mutex::new(Ok(())),
106 latest_monitors: Mutex::new(HashMap::new()),
107 should_update_manager: atomic::AtomicBool::new(false),
111 impl chain::Watch for TestChainMonitor {
112 type Keys = EnforcingChannelKeys;
114 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingChannelKeys>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
115 let mut ser = VecWriter(Vec::new());
116 monitor.write(&mut ser).unwrap();
117 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
118 panic!("Already had monitor pre-watch_channel");
120 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
121 assert!(self.chain_monitor.watch_channel(funding_txo, monitor).is_ok());
122 self.update_ret.lock().unwrap().clone()
125 fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
126 let mut map_lock = self.latest_monitors.lock().unwrap();
127 let mut map_entry = match map_lock.entry(funding_txo) {
128 hash_map::Entry::Occupied(entry) => entry,
129 hash_map::Entry::Vacant(_) => panic!("Didn't have monitor on update call"),
131 let mut deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::
132 read(&mut Cursor::new(&map_entry.get().1), &OnlyReadsKeysInterface {}).unwrap().1;
133 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
134 let mut ser = VecWriter(Vec::new());
135 deserialized_monitor.write(&mut ser).unwrap();
136 map_entry.insert((update.update_id, ser.0));
137 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
138 self.update_ret.lock().unwrap().clone()
141 fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
142 return self.chain_monitor.release_pending_monitor_events();
148 rand_bytes_id: atomic::AtomicU8,
150 impl KeysInterface for KeyProvider {
151 type ChanKeySigner = EnforcingChannelKeys;
153 fn get_node_secret(&self) -> SecretKey {
154 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()
157 fn get_destination_script(&self) -> Script {
158 let secp_ctx = Secp256k1::signing_only();
159 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();
160 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
161 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
164 fn get_shutdown_pubkey(&self) -> PublicKey {
165 let secp_ctx = Secp256k1::signing_only();
166 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())
169 fn get_channel_keys(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingChannelKeys {
170 let secp_ctx = Secp256k1::signing_only();
171 EnforcingChannelKeys::new(InMemoryChannelKeys::new(
173 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(),
174 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(),
175 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(),
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, 7, 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, 8, self.node_id]).unwrap(),
178 [0, 0, 0, 0, 0, 0, 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],
179 channel_value_satoshis,
184 fn get_secure_random_bytes(&self) -> [u8; 32] {
185 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
186 [0, 0, 0, 0, 0, 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]
189 fn read_chan_signer(&self, data: &[u8]) -> Result<EnforcingChannelKeys, DecodeError> {
190 EnforcingChannelKeys::read(&mut std::io::Cursor::new(data))
195 fn check_api_err(api_err: APIError) {
197 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
198 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
199 APIError::RouteError { .. } => panic!("Our routes should work"),
200 APIError::ChannelUnavailable { err } => {
201 // Test the error against a list of errors we can hit, and reject
202 // all others. If you hit this panic, the list of acceptable errors
203 // is probably just stale and you should add new messages here.
205 "Peer for first hop currently disconnected/pending monitor update!" => {},
206 _ if err.starts_with("Cannot push more than their max accepted HTLCs ") => {},
207 _ if err.starts_with("Cannot send value that would put us over the max HTLC value in flight our peer will accept ") => {},
208 _ if err.starts_with("Cannot send value that would put our balance under counterparty-announced channel reserve value") => {},
209 _ if err.starts_with("Cannot send value that would overdraw remaining funds.") => {},
210 _ if err.starts_with("Cannot send value that would not leave enough to pay for fees.") => {},
214 APIError::MonitorUpdateFailed => {
215 // We can (obviously) temp-fail a monitor update
220 fn check_payment_err(send_err: PaymentSendFailure) {
222 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err),
223 PaymentSendFailure::PathParameterError(per_path_results) => {
224 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
226 PaymentSendFailure::AllFailedRetrySafe(per_path_results) => {
227 for api_err in per_path_results { check_api_err(api_err); }
229 PaymentSendFailure::PartialFailure(per_path_results) => {
230 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
235 type ChanMan = ChannelManager<EnforcingChannelKeys, Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>;
238 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
239 let payment_hash = Sha256::hash(&[*payment_id; 1]);
240 *payment_id = payment_id.wrapping_add(1);
241 if let Err(err) = source.send_payment(&Route {
242 paths: vec![vec![RouteHop {
243 pubkey: dest.get_our_node_id(),
244 node_features: NodeFeatures::empty(),
245 short_channel_id: dest_chan_id,
246 channel_features: ChannelFeatures::empty(),
248 cltv_expiry_delta: 200,
250 }, PaymentHash(payment_hash.into_inner()), &None) {
251 check_payment_err(err);
256 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 {
257 let payment_hash = Sha256::hash(&[*payment_id; 1]);
258 *payment_id = payment_id.wrapping_add(1);
259 if let Err(err) = source.send_payment(&Route {
260 paths: vec![vec![RouteHop {
261 pubkey: middle.get_our_node_id(),
262 node_features: NodeFeatures::empty(),
263 short_channel_id: middle_chan_id,
264 channel_features: ChannelFeatures::empty(),
266 cltv_expiry_delta: 100,
268 pubkey: dest.get_our_node_id(),
269 node_features: NodeFeatures::empty(),
270 short_channel_id: dest_chan_id,
271 channel_features: ChannelFeatures::empty(),
273 cltv_expiry_delta: 200,
275 }, PaymentHash(payment_hash.into_inner()), &None) {
276 check_payment_err(err);
282 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
283 let fee_est = Arc::new(FuzzEstimator{});
284 let broadcast = Arc::new(TestBroadcaster{});
286 macro_rules! make_node {
287 ($node_id: expr) => { {
288 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
289 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{})));
291 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU8::new(0) });
292 let mut config = UserConfig::default();
293 config.channel_options.fee_proportional_millionths = 0;
294 config.channel_options.announced_channel = true;
295 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
296 (ChannelManager::new(Network::Bitcoin, fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, 0),
301 macro_rules! reload_node {
302 ($ser: expr, $node_id: expr, $old_monitors: expr) => { {
303 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
304 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{})));
306 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU8::new(0) });
307 let mut config = UserConfig::default();
308 config.channel_options.fee_proportional_millionths = 0;
309 config.channel_options.announced_channel = true;
310 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
312 let mut monitors = HashMap::new();
313 let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
314 for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
315 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut Cursor::new(&monitor_ser), &OnlyReadsKeysInterface {}).expect("Failed to read monitor").1);
316 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
318 let mut monitor_refs = HashMap::new();
319 for (outpoint, monitor) in monitors.iter_mut() {
320 monitor_refs.insert(*outpoint, monitor);
323 let read_args = ChannelManagerReadArgs {
325 fee_estimator: fee_est.clone(),
326 chain_monitor: chain_monitor.clone(),
327 tx_broadcaster: broadcast.clone(),
329 default_config: config,
330 channel_monitors: monitor_refs,
333 (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor)
337 let mut channel_txn = Vec::new();
338 macro_rules! make_channel {
339 ($source: expr, $dest: expr, $chan_id: expr) => { {
340 $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
342 let events = $source.get_and_clear_pending_msg_events();
343 assert_eq!(events.len(), 1);
344 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
346 } else { panic!("Wrong event type"); }
349 $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::known(), &open_channel);
350 let accept_channel = {
351 let events = $dest.get_and_clear_pending_msg_events();
352 assert_eq!(events.len(), 1);
353 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
355 } else { panic!("Wrong event type"); }
358 $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::known(), &accept_channel);
361 let events = $source.get_and_clear_pending_events();
362 assert_eq!(events.len(), 1);
363 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
364 let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
365 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
367 funding_output = OutPoint { txid: tx.txid(), index: 0 };
368 $source.funding_transaction_generated(&temporary_channel_id, funding_output);
369 channel_txn.push(tx);
370 } else { panic!("Wrong event type"); }
373 let funding_created = {
374 let events = $source.get_and_clear_pending_msg_events();
375 assert_eq!(events.len(), 1);
376 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
378 } else { panic!("Wrong event type"); }
380 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
382 let funding_signed = {
383 let events = $dest.get_and_clear_pending_msg_events();
384 assert_eq!(events.len(), 1);
385 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
387 } else { panic!("Wrong event type"); }
389 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
392 let events = $source.get_and_clear_pending_events();
393 assert_eq!(events.len(), 1);
394 if let events::Event::FundingBroadcastSafe { .. } = events[0] {
395 } else { panic!("Wrong event type"); }
401 macro_rules! confirm_txn {
403 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
404 let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
405 $node.block_connected(&header, &txdata, 1);
407 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
408 $node.block_connected(&header, &[], i);
413 macro_rules! lock_fundings {
414 ($nodes: expr) => { {
415 let mut node_events = Vec::new();
416 for node in $nodes.iter() {
417 node_events.push(node.get_and_clear_pending_msg_events());
419 for (idx, node_event) in node_events.iter().enumerate() {
420 for event in node_event {
421 if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
422 for node in $nodes.iter() {
423 if node.get_our_node_id() == *node_id {
424 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
427 } else { panic!("Wrong event type"); }
431 for node in $nodes.iter() {
432 let events = node.get_and_clear_pending_msg_events();
433 for event in events {
434 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
435 } else { panic!("Wrong event type"); }
441 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
443 let (node_a, mut monitor_a) = make_node!(0);
444 let (node_b, mut monitor_b) = make_node!(1);
445 let (node_c, mut monitor_c) = make_node!(2);
447 let mut nodes = [node_a, node_b, node_c];
449 let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
450 let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
452 for node in nodes.iter() {
456 lock_fundings!(nodes);
458 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
459 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
461 let mut payment_id: u8 = 0;
463 let mut chan_a_disconnected = false;
464 let mut chan_b_disconnected = false;
465 let mut ba_events = Vec::new();
466 let mut bc_events = Vec::new();
468 let mut node_a_ser = VecWriter(Vec::new());
469 nodes[0].write(&mut node_a_ser).unwrap();
470 let mut node_b_ser = VecWriter(Vec::new());
471 nodes[1].write(&mut node_b_ser).unwrap();
472 let mut node_c_ser = VecWriter(Vec::new());
473 nodes[2].write(&mut node_c_ser).unwrap();
475 macro_rules! test_return {
477 assert_eq!(nodes[0].list_channels().len(), 1);
478 assert_eq!(nodes[1].list_channels().len(), 2);
479 assert_eq!(nodes[2].list_channels().len(), 1);
484 let mut read_pos = 0;
485 macro_rules! get_slice {
488 let slice_len = $len as usize;
489 if data.len() < read_pos + slice_len {
492 read_pos += slice_len;
493 &data[read_pos - slice_len..read_pos]
499 macro_rules! send_payment_with_secret {
500 ($source: expr, $middle: expr, $dest: expr) => { {
501 let payment_hash = Sha256::hash(&[payment_id; 1]);
502 payment_id = payment_id.wrapping_add(1);
503 let payment_secret = Sha256::hash(&[payment_id; 1]);
504 payment_id = payment_id.wrapping_add(1);
505 if let Err(err) = $source.send_payment(&Route {
506 paths: vec![vec![RouteHop {
507 pubkey: $middle.0.get_our_node_id(),
508 node_features: NodeFeatures::empty(),
509 short_channel_id: $middle.1,
510 channel_features: ChannelFeatures::empty(),
512 cltv_expiry_delta: 100,
514 pubkey: $dest.0.get_our_node_id(),
515 node_features: NodeFeatures::empty(),
516 short_channel_id: $dest.1,
517 channel_features: ChannelFeatures::empty(),
518 fee_msat: 10_000_000,
519 cltv_expiry_delta: 200,
521 pubkey: $middle.0.get_our_node_id(),
522 node_features: NodeFeatures::empty(),
523 short_channel_id: $middle.1,
524 channel_features: ChannelFeatures::empty(),
526 cltv_expiry_delta: 100,
528 pubkey: $dest.0.get_our_node_id(),
529 node_features: NodeFeatures::empty(),
530 short_channel_id: $dest.1,
531 channel_features: ChannelFeatures::empty(),
532 fee_msat: 10_000_000,
533 cltv_expiry_delta: 200,
535 }, PaymentHash(payment_hash.into_inner()), &Some(PaymentSecret(payment_secret.into_inner()))) {
536 check_payment_err(err);
541 macro_rules! process_msg_events {
542 ($node: expr, $corrupt_forward: expr) => { {
543 let events = if $node == 1 {
544 let mut new_events = Vec::new();
545 mem::swap(&mut new_events, &mut ba_events);
546 new_events.extend_from_slice(&bc_events[..]);
549 } else { Vec::new() };
550 let mut had_events = false;
551 for event in events.iter().chain(nodes[$node].get_and_clear_pending_msg_events().iter()) {
554 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 } } => {
555 for dest in nodes.iter() {
556 if dest.get_our_node_id() == *node_id {
557 assert!(update_fee.is_none());
558 for update_add in update_add_htlcs {
559 if !$corrupt_forward {
560 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &update_add);
562 // Corrupt the update_add_htlc message so that its HMAC
563 // check will fail and we generate a
564 // update_fail_malformed_htlc instead of an
565 // update_fail_htlc as we do when we reject a payment.
566 let mut msg_ser = update_add.encode();
567 msg_ser[1000] ^= 0xff;
568 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
569 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
572 for update_fulfill in update_fulfill_htlcs {
573 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), &update_fulfill);
575 for update_fail in update_fail_htlcs {
576 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), &update_fail);
578 for update_fail_malformed in update_fail_malformed_htlcs {
579 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), &update_fail_malformed);
581 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
585 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
586 for dest in nodes.iter() {
587 if dest.get_our_node_id() == *node_id {
588 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
592 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
593 for dest in nodes.iter() {
594 if dest.get_our_node_id() == *node_id {
595 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
599 events::MessageSendEvent::SendFundingLocked { .. } => {
600 // Can be generated as a reestablish response
602 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
603 // Can be generated due to a payment forward being rejected due to a
604 // channel having previously failed a monitor update
606 _ => panic!("Unhandled message event"),
613 macro_rules! drain_msg_events_on_disconnect {
614 ($counterparty_id: expr) => { {
615 if $counterparty_id == 0 {
616 for event in nodes[0].get_and_clear_pending_msg_events() {
618 events::MessageSendEvent::UpdateHTLCs { .. } => {},
619 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
620 events::MessageSendEvent::SendChannelReestablish { .. } => {},
621 events::MessageSendEvent::SendFundingLocked { .. } => {},
622 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
623 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
624 _ => panic!("Unhandled message event"),
629 for event in nodes[2].get_and_clear_pending_msg_events() {
631 events::MessageSendEvent::UpdateHTLCs { .. } => {},
632 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
633 events::MessageSendEvent::SendChannelReestablish { .. } => {},
634 events::MessageSendEvent::SendFundingLocked { .. } => {},
635 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
636 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
637 _ => panic!("Unhandled message event"),
642 let mut events = nodes[1].get_and_clear_pending_msg_events();
643 let drop_node_id = if $counterparty_id == 0 { nodes[0].get_our_node_id() } else { nodes[2].get_our_node_id() };
644 let msg_sink = if $counterparty_id == 0 { &mut bc_events } else { &mut ba_events };
645 for event in events.drain(..) {
646 let push = match event {
647 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
648 if *node_id != drop_node_id { true } else { false }
650 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
651 if *node_id != drop_node_id { true } else { false }
653 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
654 if *node_id != drop_node_id { true } else { false }
656 events::MessageSendEvent::SendFundingLocked { .. } => false,
657 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => false,
658 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => false,
659 _ => panic!("Unhandled message event"),
661 if push { msg_sink.push(event); }
666 macro_rules! process_events {
667 ($node: expr, $fail: expr) => { {
668 // In case we get 256 payments we may have a hash collision, resulting in the
669 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
670 // deduplicate the calls here.
671 let mut claim_set = HashSet::new();
672 let mut events = nodes[$node].get_and_clear_pending_events();
673 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
674 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
675 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
676 // PaymentReceived event for the second HTLC in our pending_events (and breaking
677 // our claim_set deduplication).
678 events.sort_by(|a, b| {
679 if let events::Event::PaymentReceived { .. } = a {
680 if let events::Event::PendingHTLCsForwardable { .. } = b {
682 } else { Ordering::Equal }
683 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
684 if let events::Event::PaymentReceived { .. } = b {
686 } else { Ordering::Equal }
687 } else { Ordering::Equal }
689 let had_events = !events.is_empty();
690 for event in events.drain(..) {
692 events::Event::PaymentReceived { payment_hash, payment_secret, amt } => {
693 if claim_set.insert(payment_hash.0) {
695 assert!(nodes[$node].fail_htlc_backwards(&payment_hash, &payment_secret));
697 assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0), &payment_secret, amt));
701 events::Event::PaymentSent { .. } => {},
702 events::Event::PaymentFailed { .. } => {},
703 events::Event::PendingHTLCsForwardable { .. } => {
704 nodes[$node].process_pending_htlc_forwards();
706 _ => panic!("Unhandled event"),
713 match get_slice!(1)[0] {
714 // In general, we keep related message groups close together in binary form, allowing
715 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
718 0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
719 0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
720 0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
721 0x04 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
722 0x05 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
723 0x06 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
726 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
727 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
731 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
732 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
736 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
737 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
741 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
742 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
747 if !chan_a_disconnected {
748 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
749 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
750 chan_a_disconnected = true;
751 drain_msg_events_on_disconnect!(0);
755 if !chan_b_disconnected {
756 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
757 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
758 chan_b_disconnected = true;
759 drain_msg_events_on_disconnect!(2);
763 if chan_a_disconnected {
764 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
765 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
766 chan_a_disconnected = false;
770 if chan_b_disconnected {
771 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
772 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
773 chan_b_disconnected = false;
777 0x10 => { process_msg_events!(0, true); },
778 0x11 => { process_msg_events!(0, false); },
779 0x12 => { process_events!(0, true); },
780 0x13 => { process_events!(0, false); },
781 0x14 => { process_msg_events!(1, true); },
782 0x15 => { process_msg_events!(1, false); },
783 0x16 => { process_events!(1, true); },
784 0x17 => { process_events!(1, false); },
785 0x18 => { process_msg_events!(2, true); },
786 0x19 => { process_msg_events!(2, false); },
787 0x1a => { process_events!(2, true); },
788 0x1b => { process_events!(2, false); },
791 if !chan_a_disconnected {
792 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
793 chan_a_disconnected = true;
794 drain_msg_events_on_disconnect!(0);
796 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a);
797 nodes[0] = new_node_a;
798 monitor_a = new_monitor_a;
801 if !chan_a_disconnected {
802 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
803 chan_a_disconnected = true;
804 nodes[0].get_and_clear_pending_msg_events();
807 if !chan_b_disconnected {
808 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
809 chan_b_disconnected = true;
810 nodes[2].get_and_clear_pending_msg_events();
813 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b);
814 nodes[1] = new_node_b;
815 monitor_b = new_monitor_b;
818 if !chan_b_disconnected {
819 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
820 chan_b_disconnected = true;
821 drain_msg_events_on_disconnect!(2);
823 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c);
824 nodes[2] = new_node_c;
825 monitor_c = new_monitor_c;
828 // 1/10th the channel size:
829 0x20 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id); },
830 0x21 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id); },
831 0x22 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id); },
832 0x23 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id); },
833 0x24 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id); },
834 0x25 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id); },
836 0x26 => { send_payment_with_secret!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b)); },
837 0x27 => { send_payment_with_secret!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a)); },
839 0x28 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id); },
840 0x29 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id); },
841 0x2a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id); },
842 0x2b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id); },
843 0x2c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id); },
844 0x2d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id); },
846 0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id); },
847 0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id); },
848 0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id); },
849 0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id); },
850 0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id); },
851 0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id); },
853 0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id); },
854 0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id); },
855 0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id); },
856 0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id); },
857 0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id); },
858 0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id); },
860 0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id); },
861 0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id); },
862 0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id); },
863 0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id); },
864 0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id); },
865 0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id); },
867 0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id); },
868 0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id); },
869 0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id); },
870 0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id); },
871 0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id); },
872 0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id); },
874 0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id); },
875 0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id); },
876 0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id); },
877 0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id); },
878 0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id); },
879 0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id); },
881 0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id); },
882 0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id); },
883 0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id); },
884 0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id); },
885 0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
886 0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },
889 // Test that no channel is in a stuck state where neither party can send funds even
890 // after we resolve all pending events.
891 // First make sure there are no pending monitor updates, resetting the error state
892 // and calling channel_monitor_updated for each monitor.
893 *monitor_a.update_ret.lock().unwrap() = Ok(());
894 *monitor_b.update_ret.lock().unwrap() = Ok(());
895 *monitor_c.update_ret.lock().unwrap() = Ok(());
897 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
898 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
900 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
901 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
903 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
904 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
906 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
907 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
910 // Next, make sure peers are all connected to each other
911 if chan_a_disconnected {
912 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
913 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
914 chan_a_disconnected = false;
916 if chan_b_disconnected {
917 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
918 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
919 chan_b_disconnected = false;
922 for i in 0..std::usize::MAX {
923 if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
924 // Then, make sure any current forwards make their way to their destination
925 if process_msg_events!(0, false) { continue; }
926 if process_msg_events!(1, false) { continue; }
927 if process_msg_events!(2, false) { continue; }
928 // ...making sure any pending PendingHTLCsForwardable events are handled and
930 if process_events!(0, false) { continue; }
931 if process_events!(1, false) { continue; }
932 if process_events!(2, false) { continue; }
936 // Finally, make sure that at least one end of each channel can make a substantial payment.
938 send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id) ||
939 send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id));
941 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
942 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));
947 node_a_ser.0.clear();
948 nodes[0].write(&mut node_a_ser).unwrap();
949 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
950 node_b_ser.0.clear();
951 nodes[1].write(&mut node_b_ser).unwrap();
952 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
953 node_c_ser.0.clear();
954 nodes[2].write(&mut node_c_ser).unwrap();
955 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
959 pub fn chanmon_consistency_test<Out: test_logger::Output>(data: &[u8], out: Out) {
964 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
965 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});