1 //! Test that monitor update failures don't get our channel state out of sync.
2 //! One of the biggest concern with the monitor update failure handling code is that messages
3 //! resent after monitor updating is restored are delivered out-of-order, resulting in
4 //! commitment_signed messages having "invalid signatures".
5 //! To test this we stand up a network of three nodes and read bytes from the fuzz input to denote
6 //! actions such as sending payments, handling events, or changing monitor update return values on
7 //! a per-node basis. This should allow it to find any cases where the ordering of actions results
8 //! in us getting out of sync with ourselves, and, assuming at least one of our recieve- or
9 //! send-side handling is correct, other peers. We consider it a failure if any action results in a
10 //! channel being force-closed.
12 use bitcoin::BitcoinHash;
13 use bitcoin::blockdata::block::BlockHeader;
14 use bitcoin::blockdata::transaction::{Transaction, TxOut};
15 use bitcoin::blockdata::script::{Builder, Script};
16 use bitcoin::blockdata::opcodes;
17 use bitcoin::network::constants::Network;
19 use bitcoin::hashes::Hash as TraitImport;
20 use bitcoin::hashes::sha256::Hash as Sha256;
21 use bitcoin::hash_types::{BlockHash, WPubkeyHash};
23 use lightning::chain::transaction::OutPoint;
24 use lightning::chain::chaininterface::{BroadcasterInterface, ChainListener, ConfirmationTarget, FeeEstimator};
25 use lightning::chain::keysinterface::{KeysInterface, InMemoryChannelKeys};
26 use lightning::ln::channelmonitor;
27 use lightning::ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, HTLCUpdate};
28 use lightning::ln::channelmanager::{ChannelManager, PaymentHash, PaymentPreimage, PaymentSecret, ChannelManagerReadArgs};
29 use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
30 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, ErrorAction, UpdateAddHTLC, Init};
31 use lightning::util::enforcing_trait_impls::EnforcingChannelKeys;
32 use lightning::util::events;
33 use lightning::util::logger::Logger;
34 use lightning::util::config::UserConfig;
35 use lightning::util::events::{EventsProvider, MessageSendEventsProvider};
36 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
37 use lightning::routing::router::{Route, RouteHop};
40 use utils::test_logger;
42 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
43 use bitcoin::secp256k1::Secp256k1;
46 use std::cmp::Ordering;
47 use std::collections::{HashSet, hash_map, HashMap};
48 use std::sync::{Arc,Mutex};
49 use std::sync::atomic;
52 struct FuzzEstimator {}
53 impl FeeEstimator for FuzzEstimator {
54 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
59 pub struct TestBroadcaster {}
60 impl BroadcasterInterface for TestBroadcaster {
61 fn broadcast_transaction(&self, _tx: &Transaction) { }
64 pub struct VecWriter(pub Vec<u8>);
65 impl Writer for VecWriter {
66 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
67 self.0.extend_from_slice(buf);
70 fn size_hint(&mut self, size: usize) {
71 self.0.reserve_exact(size);
75 struct TestChannelMonitor {
76 pub logger: Arc<dyn Logger>,
77 pub simple_monitor: Arc<channelmonitor::SimpleManyChannelMonitor<OutPoint, EnforcingChannelKeys, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>>>,
78 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
79 // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
80 // logic will automatically force-close our channels for us (as we don't have an up-to-date
81 // monitor implying we are not able to punish misbehaving counterparties). Because this test
82 // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
83 // fully-serialized monitor state here, as well as the corresponding update_id.
84 pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
85 pub should_update_manager: atomic::AtomicBool,
87 impl TestChannelMonitor {
88 pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>) -> Self {
90 simple_monitor: Arc::new(channelmonitor::SimpleManyChannelMonitor::new(broadcaster, logger.clone(), feeest)),
92 update_ret: Mutex::new(Ok(())),
93 latest_monitors: Mutex::new(HashMap::new()),
94 should_update_manager: atomic::AtomicBool::new(false),
98 impl channelmonitor::ManyChannelMonitor for TestChannelMonitor {
99 type Keys = EnforcingChannelKeys;
101 fn add_monitor(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingChannelKeys>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
102 let mut ser = VecWriter(Vec::new());
103 monitor.write_for_disk(&mut ser).unwrap();
104 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
105 panic!("Already had monitor pre-add_monitor");
107 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
108 assert!(self.simple_monitor.add_monitor(funding_txo, monitor).is_ok());
109 self.update_ret.lock().unwrap().clone()
112 fn update_monitor(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
113 let mut map_lock = self.latest_monitors.lock().unwrap();
114 let mut map_entry = match map_lock.entry(funding_txo) {
115 hash_map::Entry::Occupied(entry) => entry,
116 hash_map::Entry::Vacant(_) => panic!("Didn't have monitor on update call"),
118 let mut deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::
119 read(&mut Cursor::new(&map_entry.get().1)).unwrap().1;
120 deserialized_monitor.update_monitor(update.clone(), &&TestBroadcaster {}, &self.logger).unwrap();
121 let mut ser = VecWriter(Vec::new());
122 deserialized_monitor.write_for_disk(&mut ser).unwrap();
123 map_entry.insert((update.update_id, ser.0));
124 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
125 self.update_ret.lock().unwrap().clone()
128 fn get_and_clear_pending_htlcs_updated(&self) -> Vec<HTLCUpdate> {
129 return self.simple_monitor.get_and_clear_pending_htlcs_updated();
135 session_id: atomic::AtomicU8,
136 channel_id: atomic::AtomicU8,
138 impl KeysInterface for KeyProvider {
139 type ChanKeySigner = EnforcingChannelKeys;
141 fn get_node_secret(&self) -> SecretKey {
142 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()
145 fn get_destination_script(&self) -> Script {
146 let secp_ctx = Secp256k1::signing_only();
147 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();
148 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
149 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
152 fn get_shutdown_pubkey(&self) -> PublicKey {
153 let secp_ctx = Secp256k1::signing_only();
154 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())
157 fn get_channel_keys(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingChannelKeys {
158 let secp_ctx = Secp256k1::signing_only();
159 EnforcingChannelKeys::new(InMemoryChannelKeys::new(
161 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(),
162 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(),
163 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(),
164 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(),
165 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(),
166 [0, 0, 0, 0, 0, 0, 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],
167 channel_value_satoshis,
172 fn get_onion_rand(&self) -> (SecretKey, [u8; 32]) {
173 let id = self.session_id.fetch_add(1, atomic::Ordering::Relaxed);
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, id, 10, self.node_id]).unwrap(),
178 fn get_channel_id(&self) -> [u8; 32] {
179 let id = self.channel_id.fetch_add(1, atomic::Ordering::Relaxed);
180 [0, 0, 0, 0, 0, 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]
185 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
186 let fee_est = Arc::new(FuzzEstimator{});
187 let broadcast = Arc::new(TestBroadcaster{});
189 macro_rules! make_node {
190 ($node_id: expr) => { {
191 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
192 let monitor = Arc::new(TestChannelMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone()));
194 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, session_id: atomic::AtomicU8::new(0), channel_id: atomic::AtomicU8::new(0) });
195 let mut config = UserConfig::default();
196 config.channel_options.fee_proportional_millionths = 0;
197 config.channel_options.announced_channel = true;
198 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
199 (Arc::new(ChannelManager::new(Network::Bitcoin, fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, 0)),
204 macro_rules! reload_node {
205 ($ser: expr, $node_id: expr, $old_monitors: expr) => { {
206 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
207 let monitor = Arc::new(TestChannelMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone()));
209 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, session_id: atomic::AtomicU8::new(0), channel_id: atomic::AtomicU8::new(0) });
210 let mut config = UserConfig::default();
211 config.channel_options.fee_proportional_millionths = 0;
212 config.channel_options.announced_channel = true;
213 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
215 let mut monitors = HashMap::new();
216 let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
217 for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
218 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut Cursor::new(&monitor_ser)).expect("Failed to read monitor").1);
219 monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
221 let mut monitor_refs = HashMap::new();
222 for (outpoint, monitor) in monitors.iter_mut() {
223 monitor_refs.insert(*outpoint, monitor);
226 let read_args = ChannelManagerReadArgs {
228 fee_estimator: fee_est.clone(),
229 monitor: monitor.clone(),
230 tx_broadcaster: broadcast.clone(),
232 default_config: config,
233 channel_monitors: &mut monitor_refs,
236 (<(BlockHash, ChannelManager<EnforcingChannelKeys, Arc<TestChannelMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, monitor)
240 let mut channel_txn = Vec::new();
241 macro_rules! make_channel {
242 ($source: expr, $dest: expr, $chan_id: expr) => { {
243 $source.create_channel($dest.get_our_node_id(), 10000000, 42, 0, None).unwrap();
245 let events = $source.get_and_clear_pending_msg_events();
246 assert_eq!(events.len(), 1);
247 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
249 } else { panic!("Wrong event type"); }
252 $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::known(), &open_channel);
253 let accept_channel = {
254 let events = $dest.get_and_clear_pending_msg_events();
255 assert_eq!(events.len(), 1);
256 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
258 } else { panic!("Wrong event type"); }
261 $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::known(), &accept_channel);
264 let events = $source.get_and_clear_pending_events();
265 assert_eq!(events.len(), 1);
266 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
267 let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
268 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
270 funding_output = OutPoint { txid: tx.txid(), index: 0 };
271 $source.funding_transaction_generated(&temporary_channel_id, funding_output);
272 channel_txn.push(tx);
273 } else { panic!("Wrong event type"); }
276 let funding_created = {
277 let events = $source.get_and_clear_pending_msg_events();
278 assert_eq!(events.len(), 1);
279 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
281 } else { panic!("Wrong event type"); }
283 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
285 let funding_signed = {
286 let events = $dest.get_and_clear_pending_msg_events();
287 assert_eq!(events.len(), 1);
288 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
290 } else { panic!("Wrong event type"); }
292 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
295 let events = $source.get_and_clear_pending_events();
296 assert_eq!(events.len(), 1);
297 if let events::Event::FundingBroadcastSafe { .. } = events[0] {
298 } else { panic!("Wrong event type"); }
304 macro_rules! confirm_txn {
306 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
307 let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
308 $node.block_connected(&header, &txdata, 1);
310 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
311 $node.block_connected(&header, &[], i);
316 macro_rules! lock_fundings {
317 ($nodes: expr) => { {
318 let mut node_events = Vec::new();
319 for node in $nodes.iter() {
320 node_events.push(node.get_and_clear_pending_msg_events());
322 for (idx, node_event) in node_events.iter().enumerate() {
323 for event in node_event {
324 if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
325 for node in $nodes.iter() {
326 if node.get_our_node_id() == *node_id {
327 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
330 } else { panic!("Wrong event type"); }
334 for node in $nodes.iter() {
335 let events = node.get_and_clear_pending_msg_events();
336 for event in events {
337 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
338 } else { panic!("Wrong event type"); }
344 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
346 let (mut node_a, mut monitor_a) = make_node!(0);
347 let (mut node_b, mut monitor_b) = make_node!(1);
348 let (mut node_c, mut monitor_c) = make_node!(2);
350 let mut nodes = [node_a, node_b, node_c];
352 let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
353 let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
355 for node in nodes.iter() {
359 lock_fundings!(nodes);
361 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
362 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
364 let mut payment_id = 0;
366 let mut chan_a_disconnected = false;
367 let mut chan_b_disconnected = false;
368 let mut ba_events = Vec::new();
369 let mut bc_events = Vec::new();
371 let mut node_a_ser = VecWriter(Vec::new());
372 nodes[0].write(&mut node_a_ser).unwrap();
373 let mut node_b_ser = VecWriter(Vec::new());
374 nodes[1].write(&mut node_b_ser).unwrap();
375 let mut node_c_ser = VecWriter(Vec::new());
376 nodes[2].write(&mut node_c_ser).unwrap();
378 macro_rules! test_return {
380 assert_eq!(nodes[0].list_channels().len(), 1);
381 assert_eq!(nodes[1].list_channels().len(), 2);
382 assert_eq!(nodes[2].list_channels().len(), 1);
387 let mut read_pos = 0;
388 macro_rules! get_slice {
391 let slice_len = $len as usize;
392 if data.len() < read_pos + slice_len {
395 read_pos += slice_len;
396 &data[read_pos - slice_len..read_pos]
402 macro_rules! send_payment {
403 ($source: expr, $dest: expr, $amt: expr) => { {
404 let payment_hash = Sha256::hash(&[payment_id; 1]);
405 payment_id = payment_id.wrapping_add(1);
406 if let Err(_) = $source.send_payment(&Route {
407 paths: vec![vec![RouteHop {
408 pubkey: $dest.0.get_our_node_id(),
409 node_features: NodeFeatures::empty(),
410 short_channel_id: $dest.1,
411 channel_features: ChannelFeatures::empty(),
413 cltv_expiry_delta: 200,
415 }, PaymentHash(payment_hash.into_inner()), &None) {
416 // Probably ran out of funds
420 ($source: expr, $middle: expr, $dest: expr, $amt: expr) => { {
421 let payment_hash = Sha256::hash(&[payment_id; 1]);
422 payment_id = payment_id.wrapping_add(1);
423 if let Err(_) = $source.send_payment(&Route {
424 paths: vec![vec![RouteHop {
425 pubkey: $middle.0.get_our_node_id(),
426 node_features: NodeFeatures::empty(),
427 short_channel_id: $middle.1,
428 channel_features: ChannelFeatures::empty(),
430 cltv_expiry_delta: 100,
432 pubkey: $dest.0.get_our_node_id(),
433 node_features: NodeFeatures::empty(),
434 short_channel_id: $dest.1,
435 channel_features: ChannelFeatures::empty(),
437 cltv_expiry_delta: 200,
439 }, PaymentHash(payment_hash.into_inner()), &None) {
440 // Probably ran out of funds
445 macro_rules! send_payment_with_secret {
446 ($source: expr, $middle: expr, $dest: expr) => { {
447 let payment_hash = Sha256::hash(&[payment_id; 1]);
448 payment_id = payment_id.wrapping_add(1);
449 let payment_secret = Sha256::hash(&[payment_id; 1]);
450 payment_id = payment_id.wrapping_add(1);
451 if let Err(_) = $source.send_payment(&Route {
452 paths: vec![vec![RouteHop {
453 pubkey: $middle.0.get_our_node_id(),
454 node_features: NodeFeatures::empty(),
455 short_channel_id: $middle.1,
456 channel_features: ChannelFeatures::empty(),
458 cltv_expiry_delta: 100,
460 pubkey: $dest.0.get_our_node_id(),
461 node_features: NodeFeatures::empty(),
462 short_channel_id: $dest.1,
463 channel_features: ChannelFeatures::empty(),
465 cltv_expiry_delta: 200,
467 pubkey: $middle.0.get_our_node_id(),
468 node_features: NodeFeatures::empty(),
469 short_channel_id: $middle.1,
470 channel_features: ChannelFeatures::empty(),
472 cltv_expiry_delta: 100,
474 pubkey: $dest.0.get_our_node_id(),
475 node_features: NodeFeatures::empty(),
476 short_channel_id: $dest.1,
477 channel_features: ChannelFeatures::empty(),
479 cltv_expiry_delta: 200,
481 }, PaymentHash(payment_hash.into_inner()), &Some(PaymentSecret(payment_secret.into_inner()))) {
482 // Probably ran out of funds
488 macro_rules! process_msg_events {
489 ($node: expr, $corrupt_forward: expr) => { {
490 let events = if $node == 1 {
491 let mut new_events = Vec::new();
492 mem::swap(&mut new_events, &mut ba_events);
493 new_events.extend_from_slice(&bc_events[..]);
496 } else { Vec::new() };
497 for event in events.iter().chain(nodes[$node].get_and_clear_pending_msg_events().iter()) {
499 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 } } => {
500 for dest in nodes.iter() {
501 if dest.get_our_node_id() == *node_id {
502 assert!(update_fee.is_none());
503 for update_add in update_add_htlcs {
504 if !$corrupt_forward {
505 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &update_add);
507 // Corrupt the update_add_htlc message so that its HMAC
508 // check will fail and we generate a
509 // update_fail_malformed_htlc instead of an
510 // update_fail_htlc as we do when we reject a payment.
511 let mut msg_ser = update_add.encode();
512 msg_ser[1000] ^= 0xff;
513 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
514 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
517 for update_fulfill in update_fulfill_htlcs {
518 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), &update_fulfill);
520 for update_fail in update_fail_htlcs {
521 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), &update_fail);
523 for update_fail_malformed in update_fail_malformed_htlcs {
524 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), &update_fail_malformed);
526 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
530 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
531 for dest in nodes.iter() {
532 if dest.get_our_node_id() == *node_id {
533 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
537 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
538 for dest in nodes.iter() {
539 if dest.get_our_node_id() == *node_id {
540 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
544 events::MessageSendEvent::SendFundingLocked { .. } => {
545 // Can be generated as a reestablish response
547 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
548 // Can be generated due to a payment forward being rejected due to a
549 // channel having previously failed a monitor update
551 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {
552 // Can be generated at any processing step to send back an error, disconnect
553 // peer or just ignore
555 _ => panic!("Unhandled message event"),
561 macro_rules! drain_msg_events_on_disconnect {
562 ($counterparty_id: expr) => { {
563 if $counterparty_id == 0 {
564 for event in nodes[0].get_and_clear_pending_msg_events() {
566 events::MessageSendEvent::UpdateHTLCs { .. } => {},
567 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
568 events::MessageSendEvent::SendChannelReestablish { .. } => {},
569 events::MessageSendEvent::SendFundingLocked { .. } => {},
570 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
571 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
572 _ => panic!("Unhandled message event"),
577 for event in nodes[2].get_and_clear_pending_msg_events() {
579 events::MessageSendEvent::UpdateHTLCs { .. } => {},
580 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
581 events::MessageSendEvent::SendChannelReestablish { .. } => {},
582 events::MessageSendEvent::SendFundingLocked { .. } => {},
583 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
584 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
585 _ => panic!("Unhandled message event"),
590 let mut events = nodes[1].get_and_clear_pending_msg_events();
591 let drop_node_id = if $counterparty_id == 0 { nodes[0].get_our_node_id() } else { nodes[2].get_our_node_id() };
592 let msg_sink = if $counterparty_id == 0 { &mut bc_events } else { &mut ba_events };
593 for event in events.drain(..) {
594 let push = match event {
595 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
596 if *node_id != drop_node_id { true } else { false }
598 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
599 if *node_id != drop_node_id { true } else { false }
601 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
602 if *node_id != drop_node_id { true } else { false }
604 events::MessageSendEvent::SendFundingLocked { .. } => false,
605 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => false,
606 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => false,
607 _ => panic!("Unhandled message event"),
609 if push { msg_sink.push(event); }
614 macro_rules! process_events {
615 ($node: expr, $fail: expr) => { {
616 // In case we get 256 payments we may have a hash collision, resulting in the
617 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
618 // deduplicate the calls here.
619 let mut claim_set = HashSet::new();
620 let mut events = nodes[$node].get_and_clear_pending_events();
621 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
622 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
623 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
624 // PaymentReceived event for the second HTLC in our pending_events (and breaking
625 // our claim_set deduplication).
626 events.sort_by(|a, b| {
627 if let events::Event::PaymentReceived { .. } = a {
628 if let events::Event::PendingHTLCsForwardable { .. } = b {
630 } else { Ordering::Equal }
631 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
632 if let events::Event::PaymentReceived { .. } = b {
634 } else { Ordering::Equal }
635 } else { Ordering::Equal }
637 for event in events.drain(..) {
639 events::Event::PaymentReceived { payment_hash, payment_secret, amt } => {
640 if claim_set.insert(payment_hash.0) {
642 assert!(nodes[$node].fail_htlc_backwards(&payment_hash, &payment_secret));
644 assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0), &payment_secret, amt));
648 events::Event::PaymentSent { .. } => {},
649 events::Event::PaymentFailed { .. } => {},
650 events::Event::PendingHTLCsForwardable { .. } => {
651 nodes[$node].process_pending_htlc_forwards();
653 _ => panic!("Unhandled event"),
659 match get_slice!(1)[0] {
660 0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
661 0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
662 0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
663 0x03 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
664 0x04 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
665 0x05 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
667 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
668 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
672 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
673 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
677 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
678 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
682 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
683 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
686 0x09 => send_payment!(nodes[0], (&nodes[1], chan_a), 5_000_000),
687 0x0a => send_payment!(nodes[1], (&nodes[0], chan_a), 5_000_000),
688 0x0b => send_payment!(nodes[1], (&nodes[2], chan_b), 5_000_000),
689 0x0c => send_payment!(nodes[2], (&nodes[1], chan_b), 5_000_000),
690 0x0d => send_payment!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b), 5_000_000),
691 0x0e => send_payment!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a), 5_000_000),
693 if !chan_a_disconnected {
694 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
695 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
696 chan_a_disconnected = true;
697 drain_msg_events_on_disconnect!(0);
701 if !chan_b_disconnected {
702 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
703 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
704 chan_b_disconnected = true;
705 drain_msg_events_on_disconnect!(2);
709 if chan_a_disconnected {
710 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
711 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
712 chan_a_disconnected = false;
716 if chan_b_disconnected {
717 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
718 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
719 chan_b_disconnected = false;
722 0x13 => process_msg_events!(0, true),
723 0x14 => process_msg_events!(0, false),
724 0x15 => process_events!(0, true),
725 0x16 => process_events!(0, false),
726 0x17 => process_msg_events!(1, true),
727 0x18 => process_msg_events!(1, false),
728 0x19 => process_events!(1, true),
729 0x1a => process_events!(1, false),
730 0x1b => process_msg_events!(2, true),
731 0x1c => process_msg_events!(2, false),
732 0x1d => process_events!(2, true),
733 0x1e => process_events!(2, false),
735 if !chan_a_disconnected {
736 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
737 chan_a_disconnected = true;
738 drain_msg_events_on_disconnect!(0);
740 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a);
741 node_a = Arc::new(new_node_a);
742 nodes[0] = node_a.clone();
743 monitor_a = new_monitor_a;
746 if !chan_a_disconnected {
747 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
748 chan_a_disconnected = true;
749 nodes[0].get_and_clear_pending_msg_events();
752 if !chan_b_disconnected {
753 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
754 chan_b_disconnected = true;
755 nodes[2].get_and_clear_pending_msg_events();
758 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b);
759 node_b = Arc::new(new_node_b);
760 nodes[1] = node_b.clone();
761 monitor_b = new_monitor_b;
764 if !chan_b_disconnected {
765 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
766 chan_b_disconnected = true;
767 drain_msg_events_on_disconnect!(2);
769 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c);
770 node_c = Arc::new(new_node_c);
771 nodes[2] = node_c.clone();
772 monitor_c = new_monitor_c;
774 0x22 => send_payment_with_secret!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b)),
775 0x23 => send_payment_with_secret!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a)),
776 0x25 => send_payment!(nodes[0], (&nodes[1], chan_a), 10),
777 0x26 => send_payment!(nodes[1], (&nodes[0], chan_a), 10),
778 0x27 => send_payment!(nodes[1], (&nodes[2], chan_b), 10),
779 0x28 => send_payment!(nodes[2], (&nodes[1], chan_b), 10),
780 0x29 => send_payment!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b), 10),
781 0x2a => send_payment!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a), 10),
782 0x2b => send_payment!(nodes[0], (&nodes[1], chan_a), 1_000),
783 0x2c => send_payment!(nodes[1], (&nodes[0], chan_a), 1_000),
784 0x2d => send_payment!(nodes[1], (&nodes[2], chan_b), 1_000),
785 0x2e => send_payment!(nodes[2], (&nodes[1], chan_b), 1_000),
786 0x2f => send_payment!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b), 1_000),
787 0x30 => send_payment!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a), 1_000),
788 0x31 => send_payment!(nodes[0], (&nodes[1], chan_a), 100_000),
789 0x32 => send_payment!(nodes[1], (&nodes[0], chan_a), 100_000),
790 0x33 => send_payment!(nodes[1], (&nodes[2], chan_b), 100_000),
791 0x34 => send_payment!(nodes[2], (&nodes[1], chan_b), 100_000),
792 0x35 => send_payment!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b), 100_000),
793 0x36 => send_payment!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a), 100_000),
794 // 0x24 defined above
798 node_a_ser.0.clear();
799 nodes[0].write(&mut node_a_ser).unwrap();
800 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
801 node_b_ser.0.clear();
802 nodes[1].write(&mut node_b_ser).unwrap();
803 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
804 node_c_ser.0.clear();
805 nodes[2].write(&mut node_c_ser).unwrap();
806 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
810 pub fn chanmon_consistency_test<Out: test_logger::Output>(data: &[u8], out: Out) {
815 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
816 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});