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::hash160::Hash as Hash160;
21 use bitcoin_hashes::sha256::Hash as Sha256;
22 use bitcoin_hashes::sha256d::Hash as Sha256d;
24 use lightning::chain::chaininterface;
25 use lightning::chain::transaction::OutPoint;
26 use lightning::chain::chaininterface::{BroadcasterInterface,ConfirmationTarget,ChainListener,FeeEstimator,ChainWatchInterfaceUtil};
27 use lightning::chain::keysinterface::{ChannelKeys, KeysInterface};
28 use lightning::ln::channelmonitor;
29 use lightning::ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, HTLCUpdate};
30 use lightning::ln::channelmanager::{ChannelManager, PaymentHash, PaymentPreimage, ChannelManagerReadArgs};
31 use lightning::ln::router::{Route, RouteHop};
32 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, ErrorAction, LightningError, UpdateAddHTLC, LocalFeatures};
33 use lightning::util::events;
34 use lightning::util::logger::Logger;
35 use lightning::util::config::UserConfig;
36 use lightning::util::events::{EventsProvider, MessageSendEventsProvider};
37 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
39 use utils::test_logger;
41 use secp256k1::key::{PublicKey,SecretKey};
42 use secp256k1::Secp256k1;
45 use std::cmp::Ordering;
46 use std::collections::{HashSet, hash_map, HashMap};
47 use std::sync::{Arc,Mutex};
48 use std::sync::atomic;
51 struct FuzzEstimator {}
52 impl FeeEstimator for FuzzEstimator {
53 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
58 pub struct TestBroadcaster {}
59 impl BroadcasterInterface for TestBroadcaster {
60 fn broadcast_transaction(&self, _tx: &Transaction) { }
63 pub struct VecWriter(pub Vec<u8>);
64 impl Writer for VecWriter {
65 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
66 self.0.extend_from_slice(buf);
69 fn size_hint(&mut self, size: usize) {
70 self.0.reserve_exact(size);
74 static mut IN_RESTORE: bool = false;
75 pub struct TestChannelMonitor {
76 pub simple_monitor: Arc<channelmonitor::SimpleManyChannelMonitor<OutPoint>>,
77 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
78 pub latest_good_update: Mutex<HashMap<OutPoint, Vec<u8>>>,
79 pub latest_update_good: Mutex<HashMap<OutPoint, bool>>,
80 pub latest_updates_good_at_last_ser: Mutex<HashMap<OutPoint, bool>>,
81 pub should_update_manager: atomic::AtomicBool,
83 impl TestChannelMonitor {
84 pub fn new(chain_monitor: Arc<dyn chaininterface::ChainWatchInterface>, broadcaster: Arc<dyn chaininterface::BroadcasterInterface>, logger: Arc<dyn Logger>, feeest: Arc<dyn chaininterface::FeeEstimator>) -> Self {
86 simple_monitor: channelmonitor::SimpleManyChannelMonitor::new(chain_monitor, broadcaster, logger, feeest),
87 update_ret: Mutex::new(Ok(())),
88 latest_good_update: Mutex::new(HashMap::new()),
89 latest_update_good: Mutex::new(HashMap::new()),
90 latest_updates_good_at_last_ser: Mutex::new(HashMap::new()),
91 should_update_manager: atomic::AtomicBool::new(false),
95 impl channelmonitor::ManyChannelMonitor for TestChannelMonitor {
96 fn add_update_monitor(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
97 let ret = self.update_ret.lock().unwrap().clone();
99 let mut ser = VecWriter(Vec::new());
100 monitor.write_for_disk(&mut ser).unwrap();
101 self.latest_good_update.lock().unwrap().insert(funding_txo, ser.0);
102 match self.latest_update_good.lock().unwrap().entry(funding_txo) {
103 hash_map::Entry::Vacant(e) => { e.insert(true); },
104 hash_map::Entry::Occupied(mut e) => {
105 if !e.get() && unsafe { IN_RESTORE } {
106 // Technically we can't consider an update to be "good" unless we're doing
107 // it in response to a test_restore_channel_monitor as the channel may
108 // still be waiting on such a call, so only set us to good if we're in the
109 // middle of a restore call.
114 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
116 self.latest_update_good.lock().unwrap().insert(funding_txo, false);
118 assert!(self.simple_monitor.add_update_monitor(funding_txo, monitor).is_ok());
122 fn fetch_pending_htlc_updated(&self) -> Vec<HTLCUpdate> {
123 return self.simple_monitor.fetch_pending_htlc_updated();
129 session_id: atomic::AtomicU8,
130 channel_id: atomic::AtomicU8,
132 impl KeysInterface for KeyProvider {
133 fn get_node_secret(&self) -> SecretKey {
134 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()
137 fn get_destination_script(&self) -> Script {
138 let secp_ctx = Secp256k1::signing_only();
139 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();
140 let our_channel_monitor_claim_key_hash = Hash160::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
141 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
144 fn get_shutdown_pubkey(&self) -> PublicKey {
145 let secp_ctx = Secp256k1::signing_only();
146 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())
149 fn get_channel_keys(&self, _inbound: bool) -> ChannelKeys {
151 funding_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, 4, self.node_id]).unwrap(),
152 revocation_base_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, 5, self.node_id]).unwrap(),
153 payment_base_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, 6, self.node_id]).unwrap(),
154 delayed_payment_base_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, 7, self.node_id]).unwrap(),
155 htlc_base_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, 8, self.node_id]).unwrap(),
156 commitment_seed: [0, 0, 0, 0, 0, 0, 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],
160 fn get_onion_rand(&self) -> (SecretKey, [u8; 32]) {
161 let id = self.session_id.fetch_add(1, atomic::Ordering::Relaxed);
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, id, 10, self.node_id]).unwrap(),
166 fn get_channel_id(&self) -> [u8; 32] {
167 let id = self.channel_id.fetch_add(1, atomic::Ordering::Relaxed);
168 [0, 0, 0, 0, 0, 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]
173 pub fn do_test(data: &[u8]) {
174 let fee_est = Arc::new(FuzzEstimator{});
175 let broadcast = Arc::new(TestBroadcaster{});
177 macro_rules! make_node {
178 ($node_id: expr) => { {
179 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string()));
180 let watch = Arc::new(ChainWatchInterfaceUtil::new(Network::Bitcoin, Arc::clone(&logger)));
181 let monitor = Arc::new(TestChannelMonitor::new(watch.clone(), broadcast.clone(), logger.clone(), fee_est.clone()));
183 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, session_id: atomic::AtomicU8::new(0), channel_id: atomic::AtomicU8::new(0) });
184 let mut config = UserConfig::default();
185 config.channel_options.fee_proportional_millionths = 0;
186 config.channel_options.announced_channel = true;
187 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
188 (ChannelManager::new(Network::Bitcoin, fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, 0).unwrap(),
193 macro_rules! reload_node {
194 ($ser: expr, $node_id: expr, $old_monitors: expr) => { {
195 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string()));
196 let watch = Arc::new(ChainWatchInterfaceUtil::new(Network::Bitcoin, Arc::clone(&logger)));
197 let monitor = Arc::new(TestChannelMonitor::new(watch.clone(), broadcast.clone(), logger.clone(), fee_est.clone()));
199 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, session_id: atomic::AtomicU8::new(0), channel_id: atomic::AtomicU8::new(0) });
200 let mut config = UserConfig::default();
201 config.channel_options.fee_proportional_millionths = 0;
202 config.channel_options.announced_channel = true;
203 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
205 let mut monitors = HashMap::new();
206 let mut old_monitors = $old_monitors.latest_good_update.lock().unwrap();
207 for (outpoint, monitor_ser) in old_monitors.drain() {
208 monitors.insert(outpoint, <(Sha256d, ChannelMonitor)>::read(&mut Cursor::new(&monitor_ser), Arc::clone(&logger)).expect("Failed to read monitor").1);
209 monitor.latest_good_update.lock().unwrap().insert(outpoint, monitor_ser);
211 let mut monitor_refs = HashMap::new();
212 for (outpoint, monitor) in monitors.iter() {
213 monitor_refs.insert(*outpoint, monitor);
216 let read_args = ChannelManagerReadArgs {
218 fee_estimator: fee_est.clone(),
219 monitor: monitor.clone(),
220 tx_broadcaster: broadcast.clone(),
222 default_config: config,
223 channel_monitors: &monitor_refs,
226 let res = (<(Sha256d, ChannelManager)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, monitor);
227 for (_, was_good) in $old_monitors.latest_updates_good_at_last_ser.lock().unwrap().iter() {
229 // If the last time we updated a monitor we didn't successfully update (and we
230 // have sense updated our serialized copy of the ChannelManager) we may
231 // force-close the channel on our counterparty cause we know we're missing
232 // something. Thus, we just return here since we can't continue to test.
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).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(), LocalFeatures::new(), &open_channel).unwrap();
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(), LocalFeatures::new(), &accept_channel).unwrap();
263 let events = $source.get_and_clear_pending_events();
264 assert_eq!(events.len(), 1);
265 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
266 let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
267 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
269 let funding_output = OutPoint::new(tx.txid(), 0);
270 $source.funding_transaction_generated(&temporary_channel_id, funding_output);
271 channel_txn.push(tx);
272 } else { panic!("Wrong event type"); }
275 let funding_created = {
276 let events = $source.get_and_clear_pending_msg_events();
277 assert_eq!(events.len(), 1);
278 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
280 } else { panic!("Wrong event type"); }
282 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created).unwrap();
284 let funding_signed = {
285 let events = $dest.get_and_clear_pending_msg_events();
286 assert_eq!(events.len(), 1);
287 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
289 } else { panic!("Wrong event type"); }
291 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed).unwrap();
294 let events = $source.get_and_clear_pending_events();
295 assert_eq!(events.len(), 1);
296 if let events::Event::FundingBroadcastSafe { .. } = events[0] {
297 } else { panic!("Wrong event type"); }
302 macro_rules! confirm_txn {
304 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
305 let mut txn = Vec::with_capacity(channel_txn.len());
306 let mut posn = Vec::with_capacity(channel_txn.len());
307 for i in 0..channel_txn.len() {
308 txn.push(&channel_txn[i]);
309 posn.push(i as u32 + 1);
311 $node.block_connected(&header, 1, &txn, &posn);
313 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
314 $node.block_connected(&header, i, &Vec::new(), &[0; 0]);
319 macro_rules! lock_fundings {
320 ($nodes: expr) => { {
321 let mut node_events = Vec::new();
322 for node in $nodes.iter() {
323 node_events.push(node.get_and_clear_pending_msg_events());
325 for (idx, node_event) in node_events.iter().enumerate() {
326 for event in node_event {
327 if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
328 for node in $nodes.iter() {
329 if node.get_our_node_id() == *node_id {
330 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg).unwrap();
333 } else { panic!("Wrong event type"); }
337 for node in $nodes.iter() {
338 let events = node.get_and_clear_pending_msg_events();
339 for event in events {
340 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
341 } else { panic!("Wrong event type"); }
347 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
349 let (mut node_a, mut monitor_a) = make_node!(0);
350 let (mut node_b, mut monitor_b) = make_node!(1);
351 let (mut node_c, mut monitor_c) = make_node!(2);
353 let mut nodes = [node_a, node_b, node_c];
355 make_channel!(nodes[0], nodes[1], 0);
356 make_channel!(nodes[1], nodes[2], 1);
358 for node in nodes.iter() {
362 lock_fundings!(nodes);
364 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
365 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
367 let mut payment_id = 0;
369 let mut chan_a_disconnected = false;
370 let mut chan_b_disconnected = false;
371 let mut ba_events = Vec::new();
372 let mut bc_events = Vec::new();
374 let mut node_a_ser = VecWriter(Vec::new());
375 nodes[0].write(&mut node_a_ser).unwrap();
376 let mut node_b_ser = VecWriter(Vec::new());
377 nodes[1].write(&mut node_b_ser).unwrap();
378 let mut node_c_ser = VecWriter(Vec::new());
379 nodes[2].write(&mut node_c_ser).unwrap();
381 macro_rules! test_err {
385 Err(LightningError { action: ErrorAction::IgnoreError, .. }) => { },
386 _ => { $res.unwrap() },
391 macro_rules! test_return {
393 assert_eq!(nodes[0].list_channels().len(), 1);
394 assert_eq!(nodes[1].list_channels().len(), 2);
395 assert_eq!(nodes[2].list_channels().len(), 1);
400 let mut read_pos = 0;
401 macro_rules! get_slice {
404 let slice_len = $len as usize;
405 if data.len() < read_pos + slice_len {
408 read_pos += slice_len;
409 &data[read_pos - slice_len..read_pos]
415 macro_rules! send_payment {
416 ($source: expr, $dest: expr) => { {
417 let payment_hash = Sha256::hash(&[payment_id; 1]);
418 payment_id = payment_id.wrapping_add(1);
419 if let Err(_) = $source.send_payment(Route {
420 hops: vec![RouteHop {
421 pubkey: $dest.0.get_our_node_id(),
422 short_channel_id: $dest.1,
424 cltv_expiry_delta: 200,
426 }, PaymentHash(payment_hash.into_inner())) {
427 // Probably ran out of funds
431 ($source: expr, $middle: expr, $dest: expr) => { {
432 let payment_hash = Sha256::hash(&[payment_id; 1]);
433 payment_id = payment_id.wrapping_add(1);
434 if let Err(_) = $source.send_payment(Route {
435 hops: vec![RouteHop {
436 pubkey: $middle.0.get_our_node_id(),
437 short_channel_id: $middle.1,
439 cltv_expiry_delta: 100,
441 pubkey: $dest.0.get_our_node_id(),
442 short_channel_id: $dest.1,
444 cltv_expiry_delta: 200,
446 }, PaymentHash(payment_hash.into_inner())) {
447 // Probably ran out of funds
453 macro_rules! process_msg_events {
454 ($node: expr, $corrupt_forward: expr) => { {
455 let events = if $node == 1 {
456 let mut new_events = Vec::new();
457 mem::swap(&mut new_events, &mut ba_events);
458 new_events.extend_from_slice(&bc_events[..]);
461 } else { Vec::new() };
462 for event in events.iter().chain(nodes[$node].get_and_clear_pending_msg_events().iter()) {
464 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 } } => {
465 for dest in nodes.iter() {
466 if dest.get_our_node_id() == *node_id {
467 assert!(update_fee.is_none());
468 for update_add in update_add_htlcs {
469 if !$corrupt_forward {
470 test_err!(dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &update_add));
472 // Corrupt the update_add_htlc message so that its HMAC
473 // check will fail and we generate a
474 // update_fail_malformed_htlc instead of an
475 // update_fail_htlc as we do when we reject a payment.
476 let mut msg_ser = update_add.encode();
477 msg_ser[1000] ^= 0xff;
478 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
479 test_err!(dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg));
482 for update_fulfill in update_fulfill_htlcs {
483 test_err!(dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), &update_fulfill));
485 for update_fail in update_fail_htlcs {
486 test_err!(dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), &update_fail));
488 for update_fail_malformed in update_fail_malformed_htlcs {
489 test_err!(dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), &update_fail_malformed));
491 test_err!(dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed));
495 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
496 for dest in nodes.iter() {
497 if dest.get_our_node_id() == *node_id {
498 test_err!(dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg));
502 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
503 for dest in nodes.iter() {
504 if dest.get_our_node_id() == *node_id {
505 test_err!(dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg));
509 events::MessageSendEvent::SendFundingLocked { .. } => {
510 // Can be generated as a reestablish response
512 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
513 // Can be generated due to a payment forward being rejected due to a
514 // channel having previously failed a monitor update
516 _ => panic!("Unhandled message event"),
522 macro_rules! drain_msg_events_on_disconnect {
523 ($counterparty_id: expr) => { {
524 if $counterparty_id == 0 {
525 for event in nodes[0].get_and_clear_pending_msg_events() {
527 events::MessageSendEvent::UpdateHTLCs { .. } => {},
528 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
529 events::MessageSendEvent::SendChannelReestablish { .. } => {},
530 events::MessageSendEvent::SendFundingLocked { .. } => {},
531 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
532 _ => panic!("Unhandled message event"),
537 for event in nodes[2].get_and_clear_pending_msg_events() {
539 events::MessageSendEvent::UpdateHTLCs { .. } => {},
540 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
541 events::MessageSendEvent::SendChannelReestablish { .. } => {},
542 events::MessageSendEvent::SendFundingLocked { .. } => {},
543 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
544 _ => panic!("Unhandled message event"),
549 let mut events = nodes[1].get_and_clear_pending_msg_events();
550 let drop_node_id = if $counterparty_id == 0 { nodes[0].get_our_node_id() } else { nodes[2].get_our_node_id() };
551 let msg_sink = if $counterparty_id == 0 { &mut bc_events } else { &mut ba_events };
552 for event in events.drain(..) {
553 let push = match event {
554 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
555 if *node_id != drop_node_id { true } else { false }
557 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
558 if *node_id != drop_node_id { true } else { false }
560 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
561 if *node_id != drop_node_id { true } else { false }
563 events::MessageSendEvent::SendFundingLocked { .. } => false,
564 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => false,
565 _ => panic!("Unhandled message event"),
567 if push { msg_sink.push(event); }
572 macro_rules! process_events {
573 ($node: expr, $fail: expr) => { {
574 // In case we get 256 payments we may have a hash collision, resulting in the
575 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
576 // deduplicate the calls here.
577 let mut claim_set = HashSet::new();
578 let mut events = nodes[$node].get_and_clear_pending_events();
579 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
580 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
581 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
582 // PaymentReceived event for the second HTLC in our pending_events (and breaking
583 // our claim_set deduplication).
584 events.sort_by(|a, b| {
585 if let events::Event::PaymentReceived { .. } = a {
586 if let events::Event::PendingHTLCsForwardable { .. } = b {
588 } else { Ordering::Equal }
589 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
590 if let events::Event::PaymentReceived { .. } = b {
592 } else { Ordering::Equal }
593 } else { Ordering::Equal }
595 for event in events.drain(..) {
597 events::Event::PaymentReceived { payment_hash, .. } => {
598 if claim_set.insert(payment_hash.0) {
600 assert!(nodes[$node].fail_htlc_backwards(&payment_hash));
602 assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0), 5_000_000));
606 events::Event::PaymentSent { .. } => {},
607 events::Event::PaymentFailed { .. } => {},
608 events::Event::PendingHTLCsForwardable { .. } => {
609 nodes[$node].process_pending_htlc_forwards();
611 _ => panic!("Unhandled event"),
617 match get_slice!(1)[0] {
618 0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
619 0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
620 0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
621 0x03 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
622 0x04 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
623 0x05 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
624 0x06 => { unsafe { IN_RESTORE = true }; nodes[0].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
625 0x07 => { unsafe { IN_RESTORE = true }; nodes[1].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
626 0x08 => { unsafe { IN_RESTORE = true }; nodes[2].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
627 0x09 => send_payment!(nodes[0], (&nodes[1], chan_a)),
628 0x0a => send_payment!(nodes[1], (&nodes[0], chan_a)),
629 0x0b => send_payment!(nodes[1], (&nodes[2], chan_b)),
630 0x0c => send_payment!(nodes[2], (&nodes[1], chan_b)),
631 0x0d => send_payment!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b)),
632 0x0e => send_payment!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a)),
634 if !chan_a_disconnected {
635 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
636 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
637 chan_a_disconnected = true;
638 drain_msg_events_on_disconnect!(0);
642 if !chan_b_disconnected {
643 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
644 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
645 chan_b_disconnected = true;
646 drain_msg_events_on_disconnect!(2);
650 if chan_a_disconnected {
651 nodes[0].peer_connected(&nodes[1].get_our_node_id());
652 nodes[1].peer_connected(&nodes[0].get_our_node_id());
653 chan_a_disconnected = false;
657 if chan_b_disconnected {
658 nodes[1].peer_connected(&nodes[2].get_our_node_id());
659 nodes[2].peer_connected(&nodes[1].get_our_node_id());
660 chan_b_disconnected = false;
663 0x13 => process_msg_events!(0, true),
664 0x14 => process_msg_events!(0, false),
665 0x15 => process_events!(0, true),
666 0x16 => process_events!(0, false),
667 0x17 => process_msg_events!(1, true),
668 0x18 => process_msg_events!(1, false),
669 0x19 => process_events!(1, true),
670 0x1a => process_events!(1, false),
671 0x1b => process_msg_events!(2, true),
672 0x1c => process_msg_events!(2, false),
673 0x1d => process_events!(2, true),
674 0x1e => process_events!(2, false),
676 if !chan_a_disconnected {
677 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
678 chan_a_disconnected = true;
679 drain_msg_events_on_disconnect!(0);
681 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a);
682 node_a = Arc::new(new_node_a);
683 nodes[0] = node_a.clone();
684 monitor_a = new_monitor_a;
687 if !chan_a_disconnected {
688 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
689 chan_a_disconnected = true;
690 nodes[0].get_and_clear_pending_msg_events();
693 if !chan_b_disconnected {
694 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
695 chan_b_disconnected = true;
696 nodes[2].get_and_clear_pending_msg_events();
699 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b);
700 node_b = Arc::new(new_node_b);
701 nodes[1] = node_b.clone();
702 monitor_b = new_monitor_b;
705 if !chan_b_disconnected {
706 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
707 chan_b_disconnected = true;
708 drain_msg_events_on_disconnect!(2);
710 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c);
711 node_c = Arc::new(new_node_c);
712 nodes[2] = node_c.clone();
713 monitor_c = new_monitor_c;
718 if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
719 node_a_ser.0.clear();
720 nodes[0].write(&mut node_a_ser).unwrap();
721 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
722 *monitor_a.latest_updates_good_at_last_ser.lock().unwrap() = monitor_a.latest_update_good.lock().unwrap().clone();
724 if monitor_b.should_update_manager.load(atomic::Ordering::Relaxed) {
725 node_b_ser.0.clear();
726 nodes[1].write(&mut node_b_ser).unwrap();
727 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
728 *monitor_b.latest_updates_good_at_last_ser.lock().unwrap() = monitor_b.latest_update_good.lock().unwrap().clone();
730 if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
731 node_c_ser.0.clear();
732 nodes[2].write(&mut node_c_ser).unwrap();
733 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
734 *monitor_c.latest_updates_good_at_last_ser.lock().unwrap() = monitor_c.latest_update_good.lock().unwrap().clone();
740 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
741 do_test(unsafe { std::slice::from_raw_parts(data, datalen) });
747 fn duplicate_crash() {
748 super::do_test(&::hex::decode("00").unwrap());