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::{KeysInterface, InMemoryChannelKeys};
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::features::{ChannelFeatures, InitFeatures, NodeFeatures};
33 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, ErrorAction, UpdateAddHTLC, Init};
34 use lightning::util::enforcing_trait_impls::EnforcingChannelKeys;
35 use lightning::util::events;
36 use lightning::util::logger::Logger;
37 use lightning::util::config::UserConfig;
38 use lightning::util::events::{EventsProvider, MessageSendEventsProvider};
39 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
41 use utils::test_logger;
43 use secp256k1::key::{PublicKey,SecretKey};
44 use secp256k1::Secp256k1;
47 use std::cmp::Ordering;
48 use std::collections::{HashSet, hash_map, HashMap};
49 use std::sync::{Arc,Mutex};
50 use std::sync::atomic;
53 struct FuzzEstimator {}
54 impl FeeEstimator for FuzzEstimator {
55 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
60 pub struct TestBroadcaster {}
61 impl BroadcasterInterface for TestBroadcaster {
62 fn broadcast_transaction(&self, _tx: &Transaction) { }
65 pub struct VecWriter(pub Vec<u8>);
66 impl Writer for VecWriter {
67 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
68 self.0.extend_from_slice(buf);
71 fn size_hint(&mut self, size: usize) {
72 self.0.reserve_exact(size);
76 static mut IN_RESTORE: bool = false;
77 pub struct TestChannelMonitor {
78 pub simple_monitor: Arc<channelmonitor::SimpleManyChannelMonitor<OutPoint, EnforcingChannelKeys>>,
79 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
80 pub latest_good_update: Mutex<HashMap<OutPoint, Vec<u8>>>,
81 pub latest_update_good: Mutex<HashMap<OutPoint, bool>>,
82 pub latest_updates_good_at_last_ser: Mutex<HashMap<OutPoint, bool>>,
83 pub should_update_manager: atomic::AtomicBool,
85 impl TestChannelMonitor {
86 pub fn new(chain_monitor: Arc<dyn chaininterface::ChainWatchInterface>, broadcaster: Arc<dyn chaininterface::BroadcasterInterface>, logger: Arc<dyn Logger>, feeest: Arc<dyn chaininterface::FeeEstimator>) -> Self {
88 simple_monitor: Arc::new(channelmonitor::SimpleManyChannelMonitor::new(chain_monitor, broadcaster, logger, feeest)),
89 update_ret: Mutex::new(Ok(())),
90 latest_good_update: Mutex::new(HashMap::new()),
91 latest_update_good: Mutex::new(HashMap::new()),
92 latest_updates_good_at_last_ser: Mutex::new(HashMap::new()),
93 should_update_manager: atomic::AtomicBool::new(false),
97 impl channelmonitor::ManyChannelMonitor<EnforcingChannelKeys> for TestChannelMonitor {
98 fn add_update_monitor(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingChannelKeys>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
99 let ret = self.update_ret.lock().unwrap().clone();
100 if let Ok(()) = ret {
101 let mut ser = VecWriter(Vec::new());
102 monitor.write_for_disk(&mut ser).unwrap();
103 self.latest_good_update.lock().unwrap().insert(funding_txo, ser.0);
104 match self.latest_update_good.lock().unwrap().entry(funding_txo) {
105 hash_map::Entry::Vacant(e) => { e.insert(true); },
106 hash_map::Entry::Occupied(mut e) => {
107 if !e.get() && unsafe { IN_RESTORE } {
108 // Technically we can't consider an update to be "good" unless we're doing
109 // it in response to a test_restore_channel_monitor as the channel may
110 // still be waiting on such a call, so only set us to good if we're in the
111 // middle of a restore call.
116 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
118 self.latest_update_good.lock().unwrap().insert(funding_txo, false);
120 assert!(self.simple_monitor.add_update_monitor(funding_txo, monitor).is_ok());
124 fn fetch_pending_htlc_updated(&self) -> Vec<HTLCUpdate> {
125 return self.simple_monitor.fetch_pending_htlc_updated();
131 session_id: atomic::AtomicU8,
132 channel_id: atomic::AtomicU8,
134 impl KeysInterface for KeyProvider {
135 type ChanKeySigner = EnforcingChannelKeys;
137 fn get_node_secret(&self) -> SecretKey {
138 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()
141 fn get_destination_script(&self) -> Script {
142 let secp_ctx = Secp256k1::signing_only();
143 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();
144 let our_channel_monitor_claim_key_hash = Hash160::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
145 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
148 fn get_shutdown_pubkey(&self) -> PublicKey {
149 let secp_ctx = Secp256k1::signing_only();
150 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())
153 fn get_channel_keys(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingChannelKeys {
154 let secp_ctx = Secp256k1::signing_only();
155 EnforcingChannelKeys::new(InMemoryChannelKeys::new(
157 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(),
158 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(),
159 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(),
160 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(),
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, 8, self.node_id]).unwrap(),
162 [0, 0, 0, 0, 0, 0, 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],
163 channel_value_satoshis,
167 fn get_onion_rand(&self) -> (SecretKey, [u8; 32]) {
168 let id = self.session_id.fetch_add(1, atomic::Ordering::Relaxed);
169 (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(),
173 fn get_channel_id(&self) -> [u8; 32] {
174 let id = self.channel_id.fetch_add(1, atomic::Ordering::Relaxed);
175 [0, 0, 0, 0, 0, 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]
180 pub fn do_test(data: &[u8]) {
181 let fee_est = Arc::new(FuzzEstimator{});
182 let broadcast = Arc::new(TestBroadcaster{});
184 macro_rules! make_node {
185 ($node_id: expr) => { {
186 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string()));
187 let watch = Arc::new(ChainWatchInterfaceUtil::new(Network::Bitcoin, Arc::clone(&logger)));
188 let monitor = Arc::new(TestChannelMonitor::new(watch.clone(), broadcast.clone(), logger.clone(), fee_est.clone()));
190 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, session_id: atomic::AtomicU8::new(0), channel_id: atomic::AtomicU8::new(0) });
191 let mut config = UserConfig::default();
192 config.channel_options.fee_proportional_millionths = 0;
193 config.channel_options.announced_channel = true;
194 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
195 (Arc::new(ChannelManager::new(Network::Bitcoin, fee_est.clone(), monitor.clone() as Arc<channelmonitor::ManyChannelMonitor<EnforcingChannelKeys>>, broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, 0).unwrap()),
200 macro_rules! reload_node {
201 ($ser: expr, $node_id: expr, $old_monitors: expr) => { {
202 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string()));
203 let watch = Arc::new(ChainWatchInterfaceUtil::new(Network::Bitcoin, Arc::clone(&logger)));
204 let monitor = Arc::new(TestChannelMonitor::new(watch.clone(), broadcast.clone(), logger.clone(), fee_est.clone()));
206 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, session_id: atomic::AtomicU8::new(0), channel_id: atomic::AtomicU8::new(0) });
207 let mut config = UserConfig::default();
208 config.channel_options.fee_proportional_millionths = 0;
209 config.channel_options.announced_channel = true;
210 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
212 let mut monitors = HashMap::new();
213 let mut old_monitors = $old_monitors.latest_good_update.lock().unwrap();
214 for (outpoint, monitor_ser) in old_monitors.drain() {
215 monitors.insert(outpoint, <(Sha256d, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut Cursor::new(&monitor_ser), Arc::clone(&logger)).expect("Failed to read monitor").1);
216 monitor.latest_good_update.lock().unwrap().insert(outpoint, monitor_ser);
218 let mut monitor_refs = HashMap::new();
219 for (outpoint, monitor) in monitors.iter_mut() {
220 monitor_refs.insert(*outpoint, monitor);
223 let read_args = ChannelManagerReadArgs {
225 fee_estimator: fee_est.clone(),
226 monitor: monitor.clone() as Arc<channelmonitor::ManyChannelMonitor<EnforcingChannelKeys>>,
227 tx_broadcaster: broadcast.clone(),
229 default_config: config,
230 channel_monitors: &mut monitor_refs,
233 let res = (<(Sha256d, ChannelManager<EnforcingChannelKeys, Arc<channelmonitor::ManyChannelMonitor<EnforcingChannelKeys>>>)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, monitor);
234 for (_, was_good) in $old_monitors.latest_updates_good_at_last_ser.lock().unwrap().iter() {
236 // If the last time we updated a monitor we didn't successfully update (and we
237 // have sense updated our serialized copy of the ChannelManager) we may
238 // force-close the channel on our counterparty cause we know we're missing
239 // something. Thus, we just return here since we can't continue to test.
247 let mut channel_txn = Vec::new();
248 macro_rules! make_channel {
249 ($source: expr, $dest: expr, $chan_id: expr) => { {
250 $source.create_channel($dest.get_our_node_id(), 10000000, 42, 0).unwrap();
252 let events = $source.get_and_clear_pending_msg_events();
253 assert_eq!(events.len(), 1);
254 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
256 } else { panic!("Wrong event type"); }
259 $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::supported(), &open_channel);
260 let accept_channel = {
261 let events = $dest.get_and_clear_pending_msg_events();
262 assert_eq!(events.len(), 1);
263 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
265 } else { panic!("Wrong event type"); }
268 $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::supported(), &accept_channel);
270 let events = $source.get_and_clear_pending_events();
271 assert_eq!(events.len(), 1);
272 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
273 let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
274 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
276 let funding_output = OutPoint::new(tx.txid(), 0);
277 $source.funding_transaction_generated(&temporary_channel_id, funding_output);
278 channel_txn.push(tx);
279 } else { panic!("Wrong event type"); }
282 let funding_created = {
283 let events = $source.get_and_clear_pending_msg_events();
284 assert_eq!(events.len(), 1);
285 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
287 } else { panic!("Wrong event type"); }
289 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
291 let funding_signed = {
292 let events = $dest.get_and_clear_pending_msg_events();
293 assert_eq!(events.len(), 1);
294 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
296 } else { panic!("Wrong event type"); }
298 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
301 let events = $source.get_and_clear_pending_events();
302 assert_eq!(events.len(), 1);
303 if let events::Event::FundingBroadcastSafe { .. } = events[0] {
304 } else { panic!("Wrong event type"); }
309 macro_rules! confirm_txn {
311 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
312 let mut txn = Vec::with_capacity(channel_txn.len());
313 let mut posn = Vec::with_capacity(channel_txn.len());
314 for i in 0..channel_txn.len() {
315 txn.push(&channel_txn[i]);
316 posn.push(i as u32 + 1);
318 $node.block_connected(&header, 1, &txn, &posn);
320 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
321 $node.block_connected(&header, i, &Vec::new(), &[0; 0]);
326 macro_rules! lock_fundings {
327 ($nodes: expr) => { {
328 let mut node_events = Vec::new();
329 for node in $nodes.iter() {
330 node_events.push(node.get_and_clear_pending_msg_events());
332 for (idx, node_event) in node_events.iter().enumerate() {
333 for event in node_event {
334 if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
335 for node in $nodes.iter() {
336 if node.get_our_node_id() == *node_id {
337 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
340 } else { panic!("Wrong event type"); }
344 for node in $nodes.iter() {
345 let events = node.get_and_clear_pending_msg_events();
346 for event in events {
347 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
348 } else { panic!("Wrong event type"); }
354 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
356 let (mut node_a, mut monitor_a) = make_node!(0);
357 let (mut node_b, mut monitor_b) = make_node!(1);
358 let (mut node_c, mut monitor_c) = make_node!(2);
360 let mut nodes = [node_a, node_b, node_c];
362 make_channel!(nodes[0], nodes[1], 0);
363 make_channel!(nodes[1], nodes[2], 1);
365 for node in nodes.iter() {
369 lock_fundings!(nodes);
371 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
372 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
374 let mut payment_id = 0;
376 let mut chan_a_disconnected = false;
377 let mut chan_b_disconnected = false;
378 let mut ba_events = Vec::new();
379 let mut bc_events = Vec::new();
381 let mut node_a_ser = VecWriter(Vec::new());
382 nodes[0].write(&mut node_a_ser).unwrap();
383 let mut node_b_ser = VecWriter(Vec::new());
384 nodes[1].write(&mut node_b_ser).unwrap();
385 let mut node_c_ser = VecWriter(Vec::new());
386 nodes[2].write(&mut node_c_ser).unwrap();
388 macro_rules! test_return {
390 assert_eq!(nodes[0].list_channels().len(), 1);
391 assert_eq!(nodes[1].list_channels().len(), 2);
392 assert_eq!(nodes[2].list_channels().len(), 1);
397 let mut read_pos = 0;
398 macro_rules! get_slice {
401 let slice_len = $len as usize;
402 if data.len() < read_pos + slice_len {
405 read_pos += slice_len;
406 &data[read_pos - slice_len..read_pos]
412 macro_rules! send_payment {
413 ($source: expr, $dest: expr) => { {
414 let payment_hash = Sha256::hash(&[payment_id; 1]);
415 payment_id = payment_id.wrapping_add(1);
416 if let Err(_) = $source.send_payment(Route {
417 hops: vec![RouteHop {
418 pubkey: $dest.0.get_our_node_id(),
419 node_features: NodeFeatures::empty(),
420 short_channel_id: $dest.1,
421 channel_features: ChannelFeatures::empty(),
423 cltv_expiry_delta: 200,
425 }, PaymentHash(payment_hash.into_inner())) {
426 // Probably ran out of funds
430 ($source: expr, $middle: expr, $dest: expr) => { {
431 let payment_hash = Sha256::hash(&[payment_id; 1]);
432 payment_id = payment_id.wrapping_add(1);
433 if let Err(_) = $source.send_payment(Route {
434 hops: vec![RouteHop {
435 pubkey: $middle.0.get_our_node_id(),
436 node_features: NodeFeatures::empty(),
437 short_channel_id: $middle.1,
438 channel_features: ChannelFeatures::empty(),
440 cltv_expiry_delta: 100,
442 pubkey: $dest.0.get_our_node_id(),
443 node_features: NodeFeatures::empty(),
444 short_channel_id: $dest.1,
445 channel_features: ChannelFeatures::empty(),
447 cltv_expiry_delta: 200,
449 }, PaymentHash(payment_hash.into_inner())) {
450 // Probably ran out of funds
456 macro_rules! process_msg_events {
457 ($node: expr, $corrupt_forward: expr) => { {
458 let events = if $node == 1 {
459 let mut new_events = Vec::new();
460 mem::swap(&mut new_events, &mut ba_events);
461 new_events.extend_from_slice(&bc_events[..]);
464 } else { Vec::new() };
465 for event in events.iter().chain(nodes[$node].get_and_clear_pending_msg_events().iter()) {
467 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 } } => {
468 for dest in nodes.iter() {
469 if dest.get_our_node_id() == *node_id {
470 assert!(update_fee.is_none());
471 for update_add in update_add_htlcs {
472 if !$corrupt_forward {
473 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &update_add);
475 // Corrupt the update_add_htlc message so that its HMAC
476 // check will fail and we generate a
477 // update_fail_malformed_htlc instead of an
478 // update_fail_htlc as we do when we reject a payment.
479 let mut msg_ser = update_add.encode();
480 msg_ser[1000] ^= 0xff;
481 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
482 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
485 for update_fulfill in update_fulfill_htlcs {
486 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), &update_fulfill);
488 for update_fail in update_fail_htlcs {
489 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), &update_fail);
491 for update_fail_malformed in update_fail_malformed_htlcs {
492 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), &update_fail_malformed);
494 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
498 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
499 for dest in nodes.iter() {
500 if dest.get_our_node_id() == *node_id {
501 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
505 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
506 for dest in nodes.iter() {
507 if dest.get_our_node_id() == *node_id {
508 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
512 events::MessageSendEvent::SendFundingLocked { .. } => {
513 // Can be generated as a reestablish response
515 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
516 // Can be generated due to a payment forward being rejected due to a
517 // channel having previously failed a monitor update
519 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {
520 // Can be generated at any processing step to send back an error, disconnect
521 // peer or just ignore
523 _ => panic!("Unhandled message event"),
529 macro_rules! drain_msg_events_on_disconnect {
530 ($counterparty_id: expr) => { {
531 if $counterparty_id == 0 {
532 for event in nodes[0].get_and_clear_pending_msg_events() {
534 events::MessageSendEvent::UpdateHTLCs { .. } => {},
535 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
536 events::MessageSendEvent::SendChannelReestablish { .. } => {},
537 events::MessageSendEvent::SendFundingLocked { .. } => {},
538 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
539 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
540 _ => panic!("Unhandled message event"),
545 for event in nodes[2].get_and_clear_pending_msg_events() {
547 events::MessageSendEvent::UpdateHTLCs { .. } => {},
548 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
549 events::MessageSendEvent::SendChannelReestablish { .. } => {},
550 events::MessageSendEvent::SendFundingLocked { .. } => {},
551 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
552 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
553 _ => panic!("Unhandled message event"),
558 let mut events = nodes[1].get_and_clear_pending_msg_events();
559 let drop_node_id = if $counterparty_id == 0 { nodes[0].get_our_node_id() } else { nodes[2].get_our_node_id() };
560 let msg_sink = if $counterparty_id == 0 { &mut bc_events } else { &mut ba_events };
561 for event in events.drain(..) {
562 let push = match event {
563 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
564 if *node_id != drop_node_id { true } else { false }
566 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
567 if *node_id != drop_node_id { true } else { false }
569 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
570 if *node_id != drop_node_id { true } else { false }
572 events::MessageSendEvent::SendFundingLocked { .. } => false,
573 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => false,
574 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => false,
575 _ => panic!("Unhandled message event"),
577 if push { msg_sink.push(event); }
582 macro_rules! process_events {
583 ($node: expr, $fail: expr) => { {
584 // In case we get 256 payments we may have a hash collision, resulting in the
585 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
586 // deduplicate the calls here.
587 let mut claim_set = HashSet::new();
588 let mut events = nodes[$node].get_and_clear_pending_events();
589 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
590 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
591 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
592 // PaymentReceived event for the second HTLC in our pending_events (and breaking
593 // our claim_set deduplication).
594 events.sort_by(|a, b| {
595 if let events::Event::PaymentReceived { .. } = a {
596 if let events::Event::PendingHTLCsForwardable { .. } = b {
598 } else { Ordering::Equal }
599 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
600 if let events::Event::PaymentReceived { .. } = b {
602 } else { Ordering::Equal }
603 } else { Ordering::Equal }
605 for event in events.drain(..) {
607 events::Event::PaymentReceived { payment_hash, .. } => {
608 if claim_set.insert(payment_hash.0) {
610 assert!(nodes[$node].fail_htlc_backwards(&payment_hash));
612 assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0), 5_000_000));
616 events::Event::PaymentSent { .. } => {},
617 events::Event::PaymentFailed { .. } => {},
618 events::Event::PendingHTLCsForwardable { .. } => {
619 nodes[$node].process_pending_htlc_forwards();
621 _ => panic!("Unhandled event"),
627 match get_slice!(1)[0] {
628 0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
629 0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
630 0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
631 0x03 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
632 0x04 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
633 0x05 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
634 0x06 => { unsafe { IN_RESTORE = true }; nodes[0].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
635 0x07 => { unsafe { IN_RESTORE = true }; nodes[1].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
636 0x08 => { unsafe { IN_RESTORE = true }; nodes[2].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
637 0x09 => send_payment!(nodes[0], (&nodes[1], chan_a)),
638 0x0a => send_payment!(nodes[1], (&nodes[0], chan_a)),
639 0x0b => send_payment!(nodes[1], (&nodes[2], chan_b)),
640 0x0c => send_payment!(nodes[2], (&nodes[1], chan_b)),
641 0x0d => send_payment!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b)),
642 0x0e => send_payment!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a)),
644 if !chan_a_disconnected {
645 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
646 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
647 chan_a_disconnected = true;
648 drain_msg_events_on_disconnect!(0);
652 if !chan_b_disconnected {
653 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
654 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
655 chan_b_disconnected = true;
656 drain_msg_events_on_disconnect!(2);
660 if chan_a_disconnected {
661 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
662 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
663 chan_a_disconnected = false;
667 if chan_b_disconnected {
668 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
669 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
670 chan_b_disconnected = false;
673 0x13 => process_msg_events!(0, true),
674 0x14 => process_msg_events!(0, false),
675 0x15 => process_events!(0, true),
676 0x16 => process_events!(0, false),
677 0x17 => process_msg_events!(1, true),
678 0x18 => process_msg_events!(1, false),
679 0x19 => process_events!(1, true),
680 0x1a => process_events!(1, false),
681 0x1b => process_msg_events!(2, true),
682 0x1c => process_msg_events!(2, false),
683 0x1d => process_events!(2, true),
684 0x1e => process_events!(2, false),
686 if !chan_a_disconnected {
687 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
688 chan_a_disconnected = true;
689 drain_msg_events_on_disconnect!(0);
691 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a);
692 node_a = Arc::new(new_node_a);
693 nodes[0] = node_a.clone();
694 monitor_a = new_monitor_a;
697 if !chan_a_disconnected {
698 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
699 chan_a_disconnected = true;
700 nodes[0].get_and_clear_pending_msg_events();
703 if !chan_b_disconnected {
704 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
705 chan_b_disconnected = true;
706 nodes[2].get_and_clear_pending_msg_events();
709 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b);
710 node_b = Arc::new(new_node_b);
711 nodes[1] = node_b.clone();
712 monitor_b = new_monitor_b;
715 if !chan_b_disconnected {
716 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
717 chan_b_disconnected = true;
718 drain_msg_events_on_disconnect!(2);
720 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c);
721 node_c = Arc::new(new_node_c);
722 nodes[2] = node_c.clone();
723 monitor_c = new_monitor_c;
728 if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
729 node_a_ser.0.clear();
730 nodes[0].write(&mut node_a_ser).unwrap();
731 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
732 *monitor_a.latest_updates_good_at_last_ser.lock().unwrap() = monitor_a.latest_update_good.lock().unwrap().clone();
734 if monitor_b.should_update_manager.load(atomic::Ordering::Relaxed) {
735 node_b_ser.0.clear();
736 nodes[1].write(&mut node_b_ser).unwrap();
737 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
738 *monitor_b.latest_updates_good_at_last_ser.lock().unwrap() = monitor_b.latest_update_good.lock().unwrap().clone();
740 if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
741 node_c_ser.0.clear();
742 nodes[2].write(&mut node_c_ser).unwrap();
743 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
744 *monitor_c.latest_updates_good_at_last_ser.lock().unwrap() = monitor_c.latest_update_good.lock().unwrap().clone();
750 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
751 do_test(unsafe { std::slice::from_raw_parts(data, datalen) });