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, 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::routing::router::{Route, RouteHop};
51 use utils::test_logger;
52 use utils::test_persister::TestPersister;
54 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
55 use bitcoin::secp256k1::Secp256k1;
58 use std::cmp::Ordering;
59 use std::collections::{HashSet, hash_map, HashMap};
60 use std::sync::{Arc,Mutex};
61 use std::sync::atomic;
64 struct FuzzEstimator {}
65 impl FeeEstimator for FuzzEstimator {
66 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
71 pub struct TestBroadcaster {}
72 impl BroadcasterInterface for TestBroadcaster {
73 fn broadcast_transaction(&self, _tx: &Transaction) { }
76 pub struct VecWriter(pub Vec<u8>);
77 impl Writer for VecWriter {
78 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
79 self.0.extend_from_slice(buf);
82 fn size_hint(&mut self, size: usize) {
83 self.0.reserve_exact(size);
87 struct TestChainMonitor {
88 pub logger: Arc<dyn Logger>,
89 pub chain_monitor: Arc<chainmonitor::ChainMonitor<EnforcingChannelKeys, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
90 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
91 // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
92 // logic will automatically force-close our channels for us (as we don't have an up-to-date
93 // monitor implying we are not able to punish misbehaving counterparties). Because this test
94 // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
95 // fully-serialized monitor state here, as well as the corresponding update_id.
96 pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
97 pub should_update_manager: atomic::AtomicBool,
99 impl TestChainMonitor {
100 pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>) -> Self {
102 chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, persister)),
104 update_ret: Mutex::new(Ok(())),
105 latest_monitors: Mutex::new(HashMap::new()),
106 should_update_manager: atomic::AtomicBool::new(false),
110 impl chain::Watch for TestChainMonitor {
111 type Keys = EnforcingChannelKeys;
113 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingChannelKeys>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
114 let mut ser = VecWriter(Vec::new());
115 monitor.serialize_for_disk(&mut ser).unwrap();
116 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
117 panic!("Already had monitor pre-watch_channel");
119 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
120 assert!(self.chain_monitor.watch_channel(funding_txo, monitor).is_ok());
121 self.update_ret.lock().unwrap().clone()
124 fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
125 let mut map_lock = self.latest_monitors.lock().unwrap();
126 let mut map_entry = match map_lock.entry(funding_txo) {
127 hash_map::Entry::Occupied(entry) => entry,
128 hash_map::Entry::Vacant(_) => panic!("Didn't have monitor on update call"),
130 let mut deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::
131 read(&mut Cursor::new(&map_entry.get().1)).unwrap().1;
132 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
133 let mut ser = VecWriter(Vec::new());
134 deserialized_monitor.serialize_for_disk(&mut ser).unwrap();
135 map_entry.insert((update.update_id, ser.0));
136 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
137 self.update_ret.lock().unwrap().clone()
140 fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
141 return self.chain_monitor.release_pending_monitor_events();
147 rand_bytes_id: atomic::AtomicU8,
149 impl KeysInterface for KeyProvider {
150 type ChanKeySigner = EnforcingChannelKeys;
152 fn get_node_secret(&self) -> SecretKey {
153 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()
156 fn get_destination_script(&self) -> Script {
157 let secp_ctx = Secp256k1::signing_only();
158 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();
159 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
160 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
163 fn get_shutdown_pubkey(&self) -> PublicKey {
164 let secp_ctx = Secp256k1::signing_only();
165 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())
168 fn get_channel_keys(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingChannelKeys {
169 let secp_ctx = Secp256k1::signing_only();
170 EnforcingChannelKeys::new(InMemoryChannelKeys::new(
172 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(),
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, 5, 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, 6, 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, 7, 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, 8, self.node_id]).unwrap(),
177 [0, 0, 0, 0, 0, 0, 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],
178 channel_value_satoshis,
183 fn get_secure_random_bytes(&self) -> [u8; 32] {
184 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
185 [0, 0, 0, 0, 0, 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]
190 fn check_api_err(api_err: APIError) {
192 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
193 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
194 APIError::RouteError { .. } => panic!("Our routes should work"),
195 APIError::ChannelUnavailable { err } => {
196 // Test the error against a list of errors we can hit, and reject
197 // all others. If you hit this panic, the list of acceptable errors
198 // is probably just stale and you should add new messages here.
200 "Peer for first hop currently disconnected/pending monitor update!" => {},
201 _ if err.starts_with("Cannot push more than their max accepted HTLCs ") => {},
202 _ if err.starts_with("Cannot send value that would put us over the max HTLC value in flight our peer will accept ") => {},
203 _ if err.starts_with("Cannot send value that would put our balance under counterparty-announced channel reserve value") => {},
204 _ if err.starts_with("Cannot send value that would overdraw remaining funds.") => {},
205 _ if err.starts_with("Cannot send value that would not leave enough to pay for fees.") => {},
209 APIError::MonitorUpdateFailed => {
210 // We can (obviously) temp-fail a monitor update
215 fn check_payment_err(send_err: PaymentSendFailure) {
217 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err),
218 PaymentSendFailure::PathParameterError(per_path_results) => {
219 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
221 PaymentSendFailure::AllFailedRetrySafe(per_path_results) => {
222 for api_err in per_path_results { check_api_err(api_err); }
224 PaymentSendFailure::PartialFailure(per_path_results) => {
225 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
230 type ChanMan = ChannelManager<EnforcingChannelKeys, Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>;
233 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
234 let payment_hash = Sha256::hash(&[*payment_id; 1]);
235 *payment_id = payment_id.wrapping_add(1);
236 if let Err(err) = source.send_payment(&Route {
237 paths: vec![vec![RouteHop {
238 pubkey: dest.get_our_node_id(),
239 node_features: NodeFeatures::empty(),
240 short_channel_id: dest_chan_id,
241 channel_features: ChannelFeatures::empty(),
243 cltv_expiry_delta: 200,
245 }, PaymentHash(payment_hash.into_inner()), &None) {
246 check_payment_err(err);
251 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 {
252 let payment_hash = Sha256::hash(&[*payment_id; 1]);
253 *payment_id = payment_id.wrapping_add(1);
254 if let Err(err) = source.send_payment(&Route {
255 paths: vec![vec![RouteHop {
256 pubkey: middle.get_our_node_id(),
257 node_features: NodeFeatures::empty(),
258 short_channel_id: middle_chan_id,
259 channel_features: ChannelFeatures::empty(),
261 cltv_expiry_delta: 100,
263 pubkey: dest.get_our_node_id(),
264 node_features: NodeFeatures::empty(),
265 short_channel_id: dest_chan_id,
266 channel_features: ChannelFeatures::empty(),
268 cltv_expiry_delta: 200,
270 }, PaymentHash(payment_hash.into_inner()), &None) {
271 check_payment_err(err);
277 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
278 let fee_est = Arc::new(FuzzEstimator{});
279 let broadcast = Arc::new(TestBroadcaster{});
281 macro_rules! make_node {
282 ($node_id: expr) => { {
283 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
284 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{})));
286 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU8::new(0) });
287 let mut config = UserConfig::default();
288 config.channel_options.fee_proportional_millionths = 0;
289 config.channel_options.announced_channel = true;
290 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
291 (ChannelManager::new(Network::Bitcoin, fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, 0),
296 macro_rules! reload_node {
297 ($ser: expr, $node_id: expr, $old_monitors: expr) => { {
298 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
299 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{})));
301 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU8::new(0) });
302 let mut config = UserConfig::default();
303 config.channel_options.fee_proportional_millionths = 0;
304 config.channel_options.announced_channel = true;
305 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
307 let mut monitors = HashMap::new();
308 let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
309 for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
310 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut Cursor::new(&monitor_ser)).expect("Failed to read monitor").1);
311 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
313 let mut monitor_refs = HashMap::new();
314 for (outpoint, monitor) in monitors.iter_mut() {
315 monitor_refs.insert(*outpoint, monitor);
318 let read_args = ChannelManagerReadArgs {
320 fee_estimator: fee_est.clone(),
321 chain_monitor: chain_monitor.clone(),
322 tx_broadcaster: broadcast.clone(),
324 default_config: config,
325 channel_monitors: monitor_refs,
328 (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor)
332 let mut channel_txn = Vec::new();
333 macro_rules! make_channel {
334 ($source: expr, $dest: expr, $chan_id: expr) => { {
335 $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
337 let events = $source.get_and_clear_pending_msg_events();
338 assert_eq!(events.len(), 1);
339 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
341 } else { panic!("Wrong event type"); }
344 $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::known(), &open_channel);
345 let accept_channel = {
346 let events = $dest.get_and_clear_pending_msg_events();
347 assert_eq!(events.len(), 1);
348 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
350 } else { panic!("Wrong event type"); }
353 $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::known(), &accept_channel);
356 let events = $source.get_and_clear_pending_events();
357 assert_eq!(events.len(), 1);
358 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
359 let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
360 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
362 funding_output = OutPoint { txid: tx.txid(), index: 0 };
363 $source.funding_transaction_generated(&temporary_channel_id, funding_output);
364 channel_txn.push(tx);
365 } else { panic!("Wrong event type"); }
368 let funding_created = {
369 let events = $source.get_and_clear_pending_msg_events();
370 assert_eq!(events.len(), 1);
371 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
373 } else { panic!("Wrong event type"); }
375 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
377 let funding_signed = {
378 let events = $dest.get_and_clear_pending_msg_events();
379 assert_eq!(events.len(), 1);
380 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
382 } else { panic!("Wrong event type"); }
384 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
387 let events = $source.get_and_clear_pending_events();
388 assert_eq!(events.len(), 1);
389 if let events::Event::FundingBroadcastSafe { .. } = events[0] {
390 } else { panic!("Wrong event type"); }
396 macro_rules! confirm_txn {
398 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
399 let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
400 $node.block_connected(&header, &txdata, 1);
402 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
403 $node.block_connected(&header, &[], i);
408 macro_rules! lock_fundings {
409 ($nodes: expr) => { {
410 let mut node_events = Vec::new();
411 for node in $nodes.iter() {
412 node_events.push(node.get_and_clear_pending_msg_events());
414 for (idx, node_event) in node_events.iter().enumerate() {
415 for event in node_event {
416 if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
417 for node in $nodes.iter() {
418 if node.get_our_node_id() == *node_id {
419 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
422 } else { panic!("Wrong event type"); }
426 for node in $nodes.iter() {
427 let events = node.get_and_clear_pending_msg_events();
428 for event in events {
429 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
430 } else { panic!("Wrong event type"); }
436 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
438 let (node_a, mut monitor_a) = make_node!(0);
439 let (node_b, mut monitor_b) = make_node!(1);
440 let (node_c, mut monitor_c) = make_node!(2);
442 let mut nodes = [node_a, node_b, node_c];
444 let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
445 let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
447 for node in nodes.iter() {
451 lock_fundings!(nodes);
453 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
454 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
456 let mut payment_id: u8 = 0;
458 let mut chan_a_disconnected = false;
459 let mut chan_b_disconnected = false;
460 let mut ba_events = Vec::new();
461 let mut bc_events = Vec::new();
463 let mut node_a_ser = VecWriter(Vec::new());
464 nodes[0].write(&mut node_a_ser).unwrap();
465 let mut node_b_ser = VecWriter(Vec::new());
466 nodes[1].write(&mut node_b_ser).unwrap();
467 let mut node_c_ser = VecWriter(Vec::new());
468 nodes[2].write(&mut node_c_ser).unwrap();
470 macro_rules! test_return {
472 assert_eq!(nodes[0].list_channels().len(), 1);
473 assert_eq!(nodes[1].list_channels().len(), 2);
474 assert_eq!(nodes[2].list_channels().len(), 1);
479 let mut read_pos = 0;
480 macro_rules! get_slice {
483 let slice_len = $len as usize;
484 if data.len() < read_pos + slice_len {
487 read_pos += slice_len;
488 &data[read_pos - slice_len..read_pos]
494 macro_rules! send_payment_with_secret {
495 ($source: expr, $middle: expr, $dest: expr) => { {
496 let payment_hash = Sha256::hash(&[payment_id; 1]);
497 payment_id = payment_id.wrapping_add(1);
498 let payment_secret = Sha256::hash(&[payment_id; 1]);
499 payment_id = payment_id.wrapping_add(1);
500 if let Err(err) = $source.send_payment(&Route {
501 paths: vec![vec![RouteHop {
502 pubkey: $middle.0.get_our_node_id(),
503 node_features: NodeFeatures::empty(),
504 short_channel_id: $middle.1,
505 channel_features: ChannelFeatures::empty(),
507 cltv_expiry_delta: 100,
509 pubkey: $dest.0.get_our_node_id(),
510 node_features: NodeFeatures::empty(),
511 short_channel_id: $dest.1,
512 channel_features: ChannelFeatures::empty(),
513 fee_msat: 10_000_000,
514 cltv_expiry_delta: 200,
516 pubkey: $middle.0.get_our_node_id(),
517 node_features: NodeFeatures::empty(),
518 short_channel_id: $middle.1,
519 channel_features: ChannelFeatures::empty(),
521 cltv_expiry_delta: 100,
523 pubkey: $dest.0.get_our_node_id(),
524 node_features: NodeFeatures::empty(),
525 short_channel_id: $dest.1,
526 channel_features: ChannelFeatures::empty(),
527 fee_msat: 10_000_000,
528 cltv_expiry_delta: 200,
530 }, PaymentHash(payment_hash.into_inner()), &Some(PaymentSecret(payment_secret.into_inner()))) {
531 check_payment_err(err);
536 macro_rules! process_msg_events {
537 ($node: expr, $corrupt_forward: expr) => { {
538 let events = if $node == 1 {
539 let mut new_events = Vec::new();
540 mem::swap(&mut new_events, &mut ba_events);
541 new_events.extend_from_slice(&bc_events[..]);
544 } else { Vec::new() };
545 let mut had_events = false;
546 for event in events.iter().chain(nodes[$node].get_and_clear_pending_msg_events().iter()) {
549 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 } } => {
550 for dest in nodes.iter() {
551 if dest.get_our_node_id() == *node_id {
552 assert!(update_fee.is_none());
553 for update_add in update_add_htlcs {
554 if !$corrupt_forward {
555 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &update_add);
557 // Corrupt the update_add_htlc message so that its HMAC
558 // check will fail and we generate a
559 // update_fail_malformed_htlc instead of an
560 // update_fail_htlc as we do when we reject a payment.
561 let mut msg_ser = update_add.encode();
562 msg_ser[1000] ^= 0xff;
563 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
564 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
567 for update_fulfill in update_fulfill_htlcs {
568 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), &update_fulfill);
570 for update_fail in update_fail_htlcs {
571 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), &update_fail);
573 for update_fail_malformed in update_fail_malformed_htlcs {
574 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), &update_fail_malformed);
576 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
580 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
581 for dest in nodes.iter() {
582 if dest.get_our_node_id() == *node_id {
583 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
587 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
588 for dest in nodes.iter() {
589 if dest.get_our_node_id() == *node_id {
590 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
594 events::MessageSendEvent::SendFundingLocked { .. } => {
595 // Can be generated as a reestablish response
597 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
598 // Can be generated due to a payment forward being rejected due to a
599 // channel having previously failed a monitor update
601 _ => panic!("Unhandled message event"),
608 macro_rules! drain_msg_events_on_disconnect {
609 ($counterparty_id: expr) => { {
610 if $counterparty_id == 0 {
611 for event in nodes[0].get_and_clear_pending_msg_events() {
613 events::MessageSendEvent::UpdateHTLCs { .. } => {},
614 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
615 events::MessageSendEvent::SendChannelReestablish { .. } => {},
616 events::MessageSendEvent::SendFundingLocked { .. } => {},
617 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
618 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
619 _ => panic!("Unhandled message event"),
624 for event in nodes[2].get_and_clear_pending_msg_events() {
626 events::MessageSendEvent::UpdateHTLCs { .. } => {},
627 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
628 events::MessageSendEvent::SendChannelReestablish { .. } => {},
629 events::MessageSendEvent::SendFundingLocked { .. } => {},
630 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
631 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
632 _ => panic!("Unhandled message event"),
637 let mut events = nodes[1].get_and_clear_pending_msg_events();
638 let drop_node_id = if $counterparty_id == 0 { nodes[0].get_our_node_id() } else { nodes[2].get_our_node_id() };
639 let msg_sink = if $counterparty_id == 0 { &mut bc_events } else { &mut ba_events };
640 for event in events.drain(..) {
641 let push = match event {
642 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
643 if *node_id != drop_node_id { true } else { false }
645 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
646 if *node_id != drop_node_id { true } else { false }
648 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
649 if *node_id != drop_node_id { true } else { false }
651 events::MessageSendEvent::SendFundingLocked { .. } => false,
652 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => false,
653 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => false,
654 _ => panic!("Unhandled message event"),
656 if push { msg_sink.push(event); }
661 macro_rules! process_events {
662 ($node: expr, $fail: expr) => { {
663 // In case we get 256 payments we may have a hash collision, resulting in the
664 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
665 // deduplicate the calls here.
666 let mut claim_set = HashSet::new();
667 let mut events = nodes[$node].get_and_clear_pending_events();
668 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
669 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
670 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
671 // PaymentReceived event for the second HTLC in our pending_events (and breaking
672 // our claim_set deduplication).
673 events.sort_by(|a, b| {
674 if let events::Event::PaymentReceived { .. } = a {
675 if let events::Event::PendingHTLCsForwardable { .. } = b {
677 } else { Ordering::Equal }
678 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
679 if let events::Event::PaymentReceived { .. } = b {
681 } else { Ordering::Equal }
682 } else { Ordering::Equal }
684 let had_events = !events.is_empty();
685 for event in events.drain(..) {
687 events::Event::PaymentReceived { payment_hash, payment_secret, amt } => {
688 if claim_set.insert(payment_hash.0) {
690 assert!(nodes[$node].fail_htlc_backwards(&payment_hash, &payment_secret));
692 assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0), &payment_secret, amt));
696 events::Event::PaymentSent { .. } => {},
697 events::Event::PaymentFailed { .. } => {},
698 events::Event::PendingHTLCsForwardable { .. } => {
699 nodes[$node].process_pending_htlc_forwards();
701 _ => panic!("Unhandled event"),
708 match get_slice!(1)[0] {
709 // In general, we keep related message groups close together in binary form, allowing
710 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
713 0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
714 0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
715 0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
716 0x04 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
717 0x05 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
718 0x06 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
721 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
722 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
726 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
727 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
731 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
732 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
736 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
737 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
742 if !chan_a_disconnected {
743 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
744 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
745 chan_a_disconnected = true;
746 drain_msg_events_on_disconnect!(0);
750 if !chan_b_disconnected {
751 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
752 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
753 chan_b_disconnected = true;
754 drain_msg_events_on_disconnect!(2);
758 if chan_a_disconnected {
759 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
760 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
761 chan_a_disconnected = false;
765 if chan_b_disconnected {
766 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
767 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
768 chan_b_disconnected = false;
772 0x10 => { process_msg_events!(0, true); },
773 0x11 => { process_msg_events!(0, false); },
774 0x12 => { process_events!(0, true); },
775 0x13 => { process_events!(0, false); },
776 0x14 => { process_msg_events!(1, true); },
777 0x15 => { process_msg_events!(1, false); },
778 0x16 => { process_events!(1, true); },
779 0x17 => { process_events!(1, false); },
780 0x18 => { process_msg_events!(2, true); },
781 0x19 => { process_msg_events!(2, false); },
782 0x1a => { process_events!(2, true); },
783 0x1b => { process_events!(2, false); },
786 if !chan_a_disconnected {
787 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
788 chan_a_disconnected = true;
789 drain_msg_events_on_disconnect!(0);
791 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a);
792 nodes[0] = new_node_a;
793 monitor_a = new_monitor_a;
796 if !chan_a_disconnected {
797 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
798 chan_a_disconnected = true;
799 nodes[0].get_and_clear_pending_msg_events();
802 if !chan_b_disconnected {
803 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
804 chan_b_disconnected = true;
805 nodes[2].get_and_clear_pending_msg_events();
808 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b);
809 nodes[1] = new_node_b;
810 monitor_b = new_monitor_b;
813 if !chan_b_disconnected {
814 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
815 chan_b_disconnected = true;
816 drain_msg_events_on_disconnect!(2);
818 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c);
819 nodes[2] = new_node_c;
820 monitor_c = new_monitor_c;
823 // 1/10th the channel size:
824 0x20 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id); },
825 0x21 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id); },
826 0x22 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id); },
827 0x23 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id); },
828 0x24 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id); },
829 0x25 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id); },
831 0x26 => { send_payment_with_secret!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b)); },
832 0x27 => { send_payment_with_secret!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a)); },
834 0x28 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id); },
835 0x29 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id); },
836 0x2a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id); },
837 0x2b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id); },
838 0x2c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id); },
839 0x2d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id); },
841 0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id); },
842 0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id); },
843 0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id); },
844 0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id); },
845 0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id); },
846 0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id); },
848 0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id); },
849 0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id); },
850 0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id); },
851 0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id); },
852 0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id); },
853 0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id); },
855 0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id); },
856 0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id); },
857 0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id); },
858 0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id); },
859 0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id); },
860 0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id); },
862 0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id); },
863 0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id); },
864 0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id); },
865 0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id); },
866 0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id); },
867 0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id); },
869 0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id); },
870 0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id); },
871 0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id); },
872 0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id); },
873 0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id); },
874 0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id); },
876 0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id); },
877 0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id); },
878 0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id); },
879 0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id); },
880 0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
881 0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },
884 // Test that no channel is in a stuck state where neither party can send funds even
885 // after we resolve all pending events.
886 // First make sure there are no pending monitor updates, resetting the error state
887 // and calling channel_monitor_updated for each monitor.
888 *monitor_a.update_ret.lock().unwrap() = Ok(());
889 *monitor_b.update_ret.lock().unwrap() = Ok(());
890 *monitor_c.update_ret.lock().unwrap() = Ok(());
892 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
893 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
895 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
896 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
898 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
899 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
901 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
902 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
905 // Next, make sure peers are all connected to each other
906 if chan_a_disconnected {
907 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
908 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
909 chan_a_disconnected = false;
911 if chan_b_disconnected {
912 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
913 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
914 chan_b_disconnected = false;
917 for i in 0..std::usize::MAX {
918 if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
919 // Then, make sure any current forwards make their way to their destination
920 if process_msg_events!(0, false) { continue; }
921 if process_msg_events!(1, false) { continue; }
922 if process_msg_events!(2, false) { continue; }
923 // ...making sure any pending PendingHTLCsForwardable events are handled and
925 if process_events!(0, false) { continue; }
926 if process_events!(1, false) { continue; }
927 if process_events!(2, false) { continue; }
931 // Finally, make sure that at least one end of each channel can make a substantial payment.
933 send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id) ||
934 send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id));
936 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
937 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));
942 node_a_ser.0.clear();
943 nodes[0].write(&mut node_a_ser).unwrap();
944 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
945 node_b_ser.0.clear();
946 nodes[1].write(&mut node_b_ser).unwrap();
947 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
948 node_c_ser.0.clear();
949 nodes[2].write(&mut node_c_ser).unwrap();
950 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
954 pub fn chanmon_consistency_test<Out: test_logger::Output>(data: &[u8], out: Out) {
959 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
960 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});