1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Test that monitor update failures don't get our channel state out of sync.
11 //! One of the biggest concern with the monitor update failure handling code is that messages
12 //! resent after monitor updating is restored are delivered out-of-order, resulting in
13 //! commitment_signed messages having "invalid signatures".
14 //! To test this we stand up a network of three nodes and read bytes from the fuzz input to denote
15 //! actions such as sending payments, handling events, or changing monitor update return values on
16 //! a per-node basis. This should allow it to find any cases where the ordering of actions results
17 //! in us getting out of sync with ourselves, and, assuming at least one of our recieve- or
18 //! send-side handling is correct, other peers. We consider it a failure if any action results in a
19 //! channel being force-closed.
21 use bitcoin::blockdata::block::BlockHeader;
22 use bitcoin::blockdata::constants::genesis_block;
23 use bitcoin::blockdata::transaction::{Transaction, TxOut};
24 use bitcoin::blockdata::script::{Builder, Script};
25 use bitcoin::blockdata::opcodes;
26 use bitcoin::network::constants::Network;
28 use bitcoin::hashes::Hash as TraitImport;
29 use bitcoin::hashes::sha256::Hash as Sha256;
30 use bitcoin::hash_types::{BlockHash, WPubkeyHash};
33 use lightning::chain::chainmonitor;
34 use lightning::chain::channelmonitor;
35 use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, MonitorEvent};
36 use lightning::chain::transaction::OutPoint;
37 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
38 use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
39 use lightning::ln::channelmanager::{ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentSecret, PaymentSendFailure, ChannelManagerReadArgs};
40 use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
41 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, ErrorAction, UpdateAddHTLC, Init};
42 use lightning::util::enforcing_trait_impls::{EnforcingSigner, INITIAL_REVOKED_COMMITMENT_NUMBER};
43 use lightning::util::errors::APIError;
44 use lightning::util::events;
45 use lightning::util::logger::Logger;
46 use lightning::util::config::UserConfig;
47 use lightning::util::events::{EventsProvider, MessageSendEventsProvider};
48 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
49 use lightning::util::test_utils::OnlyReadsKeysInterface;
50 use lightning::routing::router::{Route, RouteHop};
53 use utils::test_logger;
54 use utils::test_persister::TestPersister;
56 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
57 use bitcoin::secp256k1::Secp256k1;
60 use std::cmp::Ordering;
61 use std::collections::{HashSet, hash_map, HashMap};
62 use std::sync::{Arc,Mutex};
63 use std::sync::atomic;
66 struct FuzzEstimator {}
67 impl FeeEstimator for FuzzEstimator {
68 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
73 pub struct TestBroadcaster {}
74 impl BroadcasterInterface for TestBroadcaster {
75 fn broadcast_transaction(&self, _tx: &Transaction) { }
78 pub struct VecWriter(pub Vec<u8>);
79 impl Writer for VecWriter {
80 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
81 self.0.extend_from_slice(buf);
84 fn size_hint(&mut self, size: usize) {
85 self.0.reserve_exact(size);
89 struct TestChainMonitor {
90 pub logger: Arc<dyn Logger>,
91 pub chain_monitor: Arc<chainmonitor::ChainMonitor<EnforcingSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
92 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
93 // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
94 // logic will automatically force-close our channels for us (as we don't have an up-to-date
95 // monitor implying we are not able to punish misbehaving counterparties). Because this test
96 // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
97 // fully-serialized monitor state here, as well as the corresponding update_id.
98 pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
99 pub should_update_manager: atomic::AtomicBool,
101 impl TestChainMonitor {
102 pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>) -> Self {
104 chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, persister)),
106 update_ret: Mutex::new(Ok(())),
107 latest_monitors: Mutex::new(HashMap::new()),
108 should_update_manager: atomic::AtomicBool::new(false),
112 impl chain::Watch<EnforcingSigner> for TestChainMonitor {
113 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
114 let mut ser = VecWriter(Vec::new());
115 monitor.write(&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 deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
131 read(&mut Cursor::new(&map_entry.get().1), &OnlyReadsKeysInterface {}).unwrap().1;
132 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
133 let mut ser = VecWriter(Vec::new());
134 deserialized_monitor.write(&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,
148 revoked_commitments: Mutex<HashMap<[u8;32], Arc<Mutex<u64>>>>,
150 impl KeysInterface for KeyProvider {
151 type Signer = EnforcingSigner;
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_signer(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner {
170 let secp_ctx = Secp256k1::signing_only();
171 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
172 let keys = InMemorySigner::new(
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, 4, 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, 5, 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, 6, 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, 7, 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, 8, self.node_id]).unwrap(),
179 [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],
180 channel_value_satoshis,
183 let revoked_commitment = self.make_revoked_commitment_cell(keys.commitment_seed);
184 EnforcingSigner::new_with_revoked(keys, revoked_commitment, false)
187 fn get_secure_random_bytes(&self) -> [u8; 32] {
188 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
189 [0, 0, 0, 0, 0, 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]
192 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, DecodeError> {
193 let mut reader = std::io::Cursor::new(buffer);
195 let inner: InMemorySigner = Readable::read(&mut reader)?;
196 let revoked_commitment = self.make_revoked_commitment_cell(inner.commitment_seed);
198 let last_commitment_number = Readable::read(&mut reader)?;
202 last_commitment_number: Arc::new(Mutex::new(last_commitment_number)),
204 disable_revocation_policy_check: false,
210 fn make_revoked_commitment_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<u64>> {
211 let mut revoked_commitments = self.revoked_commitments.lock().unwrap();
212 if !revoked_commitments.contains_key(&commitment_seed) {
213 revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(INITIAL_REVOKED_COMMITMENT_NUMBER)));
215 let cell = revoked_commitments.get(&commitment_seed).unwrap();
221 fn check_api_err(api_err: APIError) {
223 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
224 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
225 APIError::RouteError { .. } => panic!("Our routes should work"),
226 APIError::ChannelUnavailable { err } => {
227 // Test the error against a list of errors we can hit, and reject
228 // all others. If you hit this panic, the list of acceptable errors
229 // is probably just stale and you should add new messages here.
231 "Peer for first hop currently disconnected/pending monitor update!" => {},
232 _ if err.starts_with("Cannot push more than their max accepted HTLCs ") => {},
233 _ if err.starts_with("Cannot send value that would put us over the max HTLC value in flight our peer will accept ") => {},
234 _ if err.starts_with("Cannot send value that would put our balance under counterparty-announced channel reserve value") => {},
235 _ if err.starts_with("Cannot send value that would overdraw remaining funds.") => {},
236 _ if err.starts_with("Cannot send value that would not leave enough to pay for fees.") => {},
240 APIError::MonitorUpdateFailed => {
241 // We can (obviously) temp-fail a monitor update
246 fn check_payment_err(send_err: PaymentSendFailure) {
248 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err),
249 PaymentSendFailure::PathParameterError(per_path_results) => {
250 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
252 PaymentSendFailure::AllFailedRetrySafe(per_path_results) => {
253 for api_err in per_path_results { check_api_err(api_err); }
255 PaymentSendFailure::PartialFailure(per_path_results) => {
256 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
261 type ChanMan = ChannelManager<EnforcingSigner, Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>;
264 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
265 let payment_hash = Sha256::hash(&[*payment_id; 1]);
266 *payment_id = payment_id.wrapping_add(1);
267 if let Err(err) = source.send_payment(&Route {
268 paths: vec![vec![RouteHop {
269 pubkey: dest.get_our_node_id(),
270 node_features: NodeFeatures::empty(),
271 short_channel_id: dest_chan_id,
272 channel_features: ChannelFeatures::empty(),
274 cltv_expiry_delta: 200,
276 }, PaymentHash(payment_hash.into_inner()), &None) {
277 check_payment_err(err);
282 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 {
283 let payment_hash = Sha256::hash(&[*payment_id; 1]);
284 *payment_id = payment_id.wrapping_add(1);
285 if let Err(err) = source.send_payment(&Route {
286 paths: vec![vec![RouteHop {
287 pubkey: middle.get_our_node_id(),
288 node_features: NodeFeatures::empty(),
289 short_channel_id: middle_chan_id,
290 channel_features: ChannelFeatures::empty(),
292 cltv_expiry_delta: 100,
294 pubkey: dest.get_our_node_id(),
295 node_features: NodeFeatures::empty(),
296 short_channel_id: dest_chan_id,
297 channel_features: ChannelFeatures::empty(),
299 cltv_expiry_delta: 200,
301 }, PaymentHash(payment_hash.into_inner()), &None) {
302 check_payment_err(err);
308 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
309 let fee_est = Arc::new(FuzzEstimator{});
310 let broadcast = Arc::new(TestBroadcaster{});
312 macro_rules! make_node {
313 ($node_id: expr) => { {
314 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
315 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{})));
317 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU8::new(0), revoked_commitments: Mutex::new(HashMap::new()) });
318 let mut config = UserConfig::default();
319 config.channel_options.fee_proportional_millionths = 0;
320 config.channel_options.announced_channel = true;
321 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
322 let network = Network::Bitcoin;
323 let params = ChainParameters {
325 latest_hash: genesis_block(network).block_hash(),
328 (ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
329 monitor, keys_manager)
333 macro_rules! reload_node {
334 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr) => { {
335 let keys_manager = Arc::clone(& $keys_manager);
336 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
337 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{})));
339 let mut config = UserConfig::default();
340 config.channel_options.fee_proportional_millionths = 0;
341 config.channel_options.announced_channel = true;
342 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
344 let mut monitors = HashMap::new();
345 let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
346 for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
347 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut Cursor::new(&monitor_ser), &OnlyReadsKeysInterface {}).expect("Failed to read monitor").1);
348 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
350 let mut monitor_refs = HashMap::new();
351 for (outpoint, monitor) in monitors.iter_mut() {
352 monitor_refs.insert(*outpoint, monitor);
355 let read_args = ChannelManagerReadArgs {
357 fee_estimator: fee_est.clone(),
358 chain_monitor: chain_monitor.clone(),
359 tx_broadcaster: broadcast.clone(),
361 default_config: config,
362 channel_monitors: monitor_refs,
365 (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor)
369 let mut channel_txn = Vec::new();
370 macro_rules! make_channel {
371 ($source: expr, $dest: expr, $chan_id: expr) => { {
372 $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
374 let events = $source.get_and_clear_pending_msg_events();
375 assert_eq!(events.len(), 1);
376 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
378 } else { panic!("Wrong event type"); }
381 $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::known(), &open_channel);
382 let accept_channel = {
383 let events = $dest.get_and_clear_pending_msg_events();
384 assert_eq!(events.len(), 1);
385 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
387 } else { panic!("Wrong event type"); }
390 $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::known(), &accept_channel);
393 let events = $source.get_and_clear_pending_events();
394 assert_eq!(events.len(), 1);
395 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
396 let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
397 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
399 funding_output = OutPoint { txid: tx.txid(), index: 0 };
400 $source.funding_transaction_generated(&temporary_channel_id, funding_output);
401 channel_txn.push(tx);
402 } else { panic!("Wrong event type"); }
405 let funding_created = {
406 let events = $source.get_and_clear_pending_msg_events();
407 assert_eq!(events.len(), 1);
408 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
410 } else { panic!("Wrong event type"); }
412 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
414 let funding_signed = {
415 let events = $dest.get_and_clear_pending_msg_events();
416 assert_eq!(events.len(), 1);
417 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
419 } else { panic!("Wrong event type"); }
421 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
424 let events = $source.get_and_clear_pending_events();
425 assert_eq!(events.len(), 1);
426 if let events::Event::FundingBroadcastSafe { .. } = events[0] {
427 } else { panic!("Wrong event type"); }
433 macro_rules! confirm_txn {
435 let chain_hash = genesis_block(Network::Bitcoin).block_hash();
436 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: chain_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
437 let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
438 $node.block_connected(&header, &txdata, 1);
440 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
441 $node.block_connected(&header, &[], i);
446 macro_rules! lock_fundings {
447 ($nodes: expr) => { {
448 let mut node_events = Vec::new();
449 for node in $nodes.iter() {
450 node_events.push(node.get_and_clear_pending_msg_events());
452 for (idx, node_event) in node_events.iter().enumerate() {
453 for event in node_event {
454 if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
455 for node in $nodes.iter() {
456 if node.get_our_node_id() == *node_id {
457 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
460 } else { panic!("Wrong event type"); }
464 for node in $nodes.iter() {
465 let events = node.get_and_clear_pending_msg_events();
466 for event in events {
467 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
468 } else { panic!("Wrong event type"); }
474 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
476 let (node_a, mut monitor_a, keys_manager_a) = make_node!(0);
477 let (node_b, mut monitor_b, keys_manager_b) = make_node!(1);
478 let (node_c, mut monitor_c, keys_manager_c) = make_node!(2);
480 let mut nodes = [node_a, node_b, node_c];
482 let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
483 let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
485 for node in nodes.iter() {
489 lock_fundings!(nodes);
491 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
492 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
494 let mut payment_id: u8 = 0;
496 let mut chan_a_disconnected = false;
497 let mut chan_b_disconnected = false;
498 let mut ba_events = Vec::new();
499 let mut bc_events = Vec::new();
501 let mut node_a_ser = VecWriter(Vec::new());
502 nodes[0].write(&mut node_a_ser).unwrap();
503 let mut node_b_ser = VecWriter(Vec::new());
504 nodes[1].write(&mut node_b_ser).unwrap();
505 let mut node_c_ser = VecWriter(Vec::new());
506 nodes[2].write(&mut node_c_ser).unwrap();
508 macro_rules! test_return {
510 assert_eq!(nodes[0].list_channels().len(), 1);
511 assert_eq!(nodes[1].list_channels().len(), 2);
512 assert_eq!(nodes[2].list_channels().len(), 1);
517 let mut read_pos = 0;
518 macro_rules! get_slice {
521 let slice_len = $len as usize;
522 if data.len() < read_pos + slice_len {
525 read_pos += slice_len;
526 &data[read_pos - slice_len..read_pos]
532 macro_rules! send_payment_with_secret {
533 ($source: expr, $middle: expr, $dest: expr) => { {
534 let payment_hash = Sha256::hash(&[payment_id; 1]);
535 payment_id = payment_id.wrapping_add(1);
536 let payment_secret = Sha256::hash(&[payment_id; 1]);
537 payment_id = payment_id.wrapping_add(1);
538 if let Err(err) = $source.send_payment(&Route {
539 paths: vec![vec![RouteHop {
540 pubkey: $middle.0.get_our_node_id(),
541 node_features: NodeFeatures::empty(),
542 short_channel_id: $middle.1,
543 channel_features: ChannelFeatures::empty(),
545 cltv_expiry_delta: 100,
547 pubkey: $dest.0.get_our_node_id(),
548 node_features: NodeFeatures::empty(),
549 short_channel_id: $dest.1,
550 channel_features: ChannelFeatures::empty(),
551 fee_msat: 10_000_000,
552 cltv_expiry_delta: 200,
554 pubkey: $middle.0.get_our_node_id(),
555 node_features: NodeFeatures::empty(),
556 short_channel_id: $middle.1,
557 channel_features: ChannelFeatures::empty(),
559 cltv_expiry_delta: 100,
561 pubkey: $dest.0.get_our_node_id(),
562 node_features: NodeFeatures::empty(),
563 short_channel_id: $dest.1,
564 channel_features: ChannelFeatures::empty(),
565 fee_msat: 10_000_000,
566 cltv_expiry_delta: 200,
568 }, PaymentHash(payment_hash.into_inner()), &Some(PaymentSecret(payment_secret.into_inner()))) {
569 check_payment_err(err);
574 macro_rules! process_msg_events {
575 ($node: expr, $corrupt_forward: expr) => { {
576 let events = if $node == 1 {
577 let mut new_events = Vec::new();
578 mem::swap(&mut new_events, &mut ba_events);
579 new_events.extend_from_slice(&bc_events[..]);
582 } else { Vec::new() };
583 let mut had_events = false;
584 for event in events.iter().chain(nodes[$node].get_and_clear_pending_msg_events().iter()) {
587 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 } } => {
588 for dest in nodes.iter() {
589 if dest.get_our_node_id() == *node_id {
590 assert!(update_fee.is_none());
591 for update_add in update_add_htlcs {
592 if !$corrupt_forward {
593 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &update_add);
595 // Corrupt the update_add_htlc message so that its HMAC
596 // check will fail and we generate a
597 // update_fail_malformed_htlc instead of an
598 // update_fail_htlc as we do when we reject a payment.
599 let mut msg_ser = update_add.encode();
600 msg_ser[1000] ^= 0xff;
601 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
602 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
605 for update_fulfill in update_fulfill_htlcs {
606 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), &update_fulfill);
608 for update_fail in update_fail_htlcs {
609 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), &update_fail);
611 for update_fail_malformed in update_fail_malformed_htlcs {
612 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), &update_fail_malformed);
614 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
618 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
619 for dest in nodes.iter() {
620 if dest.get_our_node_id() == *node_id {
621 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
625 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
626 for dest in nodes.iter() {
627 if dest.get_our_node_id() == *node_id {
628 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
632 events::MessageSendEvent::SendFundingLocked { .. } => {
633 // Can be generated as a reestablish response
635 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
636 // Can be generated due to a payment forward being rejected due to a
637 // channel having previously failed a monitor update
639 _ => panic!("Unhandled message event"),
646 macro_rules! drain_msg_events_on_disconnect {
647 ($counterparty_id: expr) => { {
648 if $counterparty_id == 0 {
649 for event in nodes[0].get_and_clear_pending_msg_events() {
651 events::MessageSendEvent::UpdateHTLCs { .. } => {},
652 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
653 events::MessageSendEvent::SendChannelReestablish { .. } => {},
654 events::MessageSendEvent::SendFundingLocked { .. } => {},
655 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
656 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
657 _ => panic!("Unhandled message event"),
662 for event in nodes[2].get_and_clear_pending_msg_events() {
664 events::MessageSendEvent::UpdateHTLCs { .. } => {},
665 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
666 events::MessageSendEvent::SendChannelReestablish { .. } => {},
667 events::MessageSendEvent::SendFundingLocked { .. } => {},
668 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
669 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
670 _ => panic!("Unhandled message event"),
675 let mut events = nodes[1].get_and_clear_pending_msg_events();
676 let drop_node_id = if $counterparty_id == 0 { nodes[0].get_our_node_id() } else { nodes[2].get_our_node_id() };
677 let msg_sink = if $counterparty_id == 0 { &mut bc_events } else { &mut ba_events };
678 for event in events.drain(..) {
679 let push = match event {
680 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
681 if *node_id != drop_node_id { true } else { false }
683 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
684 if *node_id != drop_node_id { true } else { false }
686 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
687 if *node_id != drop_node_id { true } else { false }
689 events::MessageSendEvent::SendFundingLocked { .. } => false,
690 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => false,
691 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => false,
692 _ => panic!("Unhandled message event"),
694 if push { msg_sink.push(event); }
699 macro_rules! process_events {
700 ($node: expr, $fail: expr) => { {
701 // In case we get 256 payments we may have a hash collision, resulting in the
702 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
703 // deduplicate the calls here.
704 let mut claim_set = HashSet::new();
705 let mut events = nodes[$node].get_and_clear_pending_events();
706 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
707 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
708 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
709 // PaymentReceived event for the second HTLC in our pending_events (and breaking
710 // our claim_set deduplication).
711 events.sort_by(|a, b| {
712 if let events::Event::PaymentReceived { .. } = a {
713 if let events::Event::PendingHTLCsForwardable { .. } = b {
715 } else { Ordering::Equal }
716 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
717 if let events::Event::PaymentReceived { .. } = b {
719 } else { Ordering::Equal }
720 } else { Ordering::Equal }
722 let had_events = !events.is_empty();
723 for event in events.drain(..) {
725 events::Event::PaymentReceived { payment_hash, payment_secret, amt } => {
726 if claim_set.insert(payment_hash.0) {
728 assert!(nodes[$node].fail_htlc_backwards(&payment_hash, &payment_secret));
730 assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0), &payment_secret, amt));
734 events::Event::PaymentSent { .. } => {},
735 events::Event::PaymentFailed { .. } => {},
736 events::Event::PendingHTLCsForwardable { .. } => {
737 nodes[$node].process_pending_htlc_forwards();
739 _ => panic!("Unhandled event"),
746 match get_slice!(1)[0] {
747 // In general, we keep related message groups close together in binary form, allowing
748 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
751 0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
752 0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
753 0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
754 0x04 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
755 0x05 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
756 0x06 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
759 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
760 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
764 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
765 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
769 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
770 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
774 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
775 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
780 if !chan_a_disconnected {
781 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
782 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
783 chan_a_disconnected = true;
784 drain_msg_events_on_disconnect!(0);
788 if !chan_b_disconnected {
789 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
790 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
791 chan_b_disconnected = true;
792 drain_msg_events_on_disconnect!(2);
796 if chan_a_disconnected {
797 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
798 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
799 chan_a_disconnected = false;
803 if chan_b_disconnected {
804 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
805 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
806 chan_b_disconnected = false;
810 0x10 => { process_msg_events!(0, true); },
811 0x11 => { process_msg_events!(0, false); },
812 0x12 => { process_events!(0, true); },
813 0x13 => { process_events!(0, false); },
814 0x14 => { process_msg_events!(1, true); },
815 0x15 => { process_msg_events!(1, false); },
816 0x16 => { process_events!(1, true); },
817 0x17 => { process_events!(1, false); },
818 0x18 => { process_msg_events!(2, true); },
819 0x19 => { process_msg_events!(2, false); },
820 0x1a => { process_events!(2, true); },
821 0x1b => { process_events!(2, false); },
824 if !chan_a_disconnected {
825 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
826 chan_a_disconnected = true;
827 drain_msg_events_on_disconnect!(0);
829 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a);
830 nodes[0] = new_node_a;
831 monitor_a = new_monitor_a;
834 if !chan_a_disconnected {
835 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
836 chan_a_disconnected = true;
837 nodes[0].get_and_clear_pending_msg_events();
840 if !chan_b_disconnected {
841 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
842 chan_b_disconnected = true;
843 nodes[2].get_and_clear_pending_msg_events();
846 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b);
847 nodes[1] = new_node_b;
848 monitor_b = new_monitor_b;
851 if !chan_b_disconnected {
852 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
853 chan_b_disconnected = true;
854 drain_msg_events_on_disconnect!(2);
856 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c);
857 nodes[2] = new_node_c;
858 monitor_c = new_monitor_c;
861 // 1/10th the channel size:
862 0x20 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id); },
863 0x21 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id); },
864 0x22 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id); },
865 0x23 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id); },
866 0x24 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id); },
867 0x25 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id); },
869 0x26 => { send_payment_with_secret!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b)); },
870 0x27 => { send_payment_with_secret!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a)); },
872 0x28 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id); },
873 0x29 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id); },
874 0x2a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id); },
875 0x2b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id); },
876 0x2c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id); },
877 0x2d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id); },
879 0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id); },
880 0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id); },
881 0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id); },
882 0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id); },
883 0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id); },
884 0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id); },
886 0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id); },
887 0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id); },
888 0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id); },
889 0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id); },
890 0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id); },
891 0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id); },
893 0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id); },
894 0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id); },
895 0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id); },
896 0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id); },
897 0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id); },
898 0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id); },
900 0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id); },
901 0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id); },
902 0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id); },
903 0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id); },
904 0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id); },
905 0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id); },
907 0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id); },
908 0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id); },
909 0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id); },
910 0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id); },
911 0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id); },
912 0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id); },
914 0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id); },
915 0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id); },
916 0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id); },
917 0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id); },
918 0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
919 0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },
922 // Test that no channel is in a stuck state where neither party can send funds even
923 // after we resolve all pending events.
924 // First make sure there are no pending monitor updates, resetting the error state
925 // and calling channel_monitor_updated for each monitor.
926 *monitor_a.update_ret.lock().unwrap() = Ok(());
927 *monitor_b.update_ret.lock().unwrap() = Ok(());
928 *monitor_c.update_ret.lock().unwrap() = Ok(());
930 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
931 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
933 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
934 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
936 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
937 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
939 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
940 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
943 // Next, make sure peers are all connected to each other
944 if chan_a_disconnected {
945 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
946 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
947 chan_a_disconnected = false;
949 if chan_b_disconnected {
950 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
951 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
952 chan_b_disconnected = false;
955 for i in 0..std::usize::MAX {
956 if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
957 // Then, make sure any current forwards make their way to their destination
958 if process_msg_events!(0, false) { continue; }
959 if process_msg_events!(1, false) { continue; }
960 if process_msg_events!(2, false) { continue; }
961 // ...making sure any pending PendingHTLCsForwardable events are handled and
963 if process_events!(0, false) { continue; }
964 if process_events!(1, false) { continue; }
965 if process_events!(2, false) { continue; }
969 // Finally, make sure that at least one end of each channel can make a substantial payment.
971 send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id) ||
972 send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id));
974 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
975 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));
980 node_a_ser.0.clear();
981 nodes[0].write(&mut node_a_ser).unwrap();
982 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
983 node_b_ser.0.clear();
984 nodes[1].write(&mut node_b_ser).unwrap();
985 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
986 node_c_ser.0.clear();
987 nodes[2].write(&mut node_c_ser).unwrap();
988 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
992 pub fn chanmon_consistency_test<Out: test_logger::Output>(data: &[u8], out: Out) {
997 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
998 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});