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, Arc<chaininterface::BroadcasterInterface>>>,
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 update_monitor(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
125 unimplemented!(); //TODO
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 = Hash160::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,
171 fn get_onion_rand(&self) -> (SecretKey, [u8; 32]) {
172 let id = self.session_id.fetch_add(1, atomic::Ordering::Relaxed);
173 (SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, id, 10, self.node_id]).unwrap(),
177 fn get_channel_id(&self) -> [u8; 32] {
178 let id = self.channel_id.fetch_add(1, atomic::Ordering::Relaxed);
179 [0, 0, 0, 0, 0, 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]
184 pub fn do_test(data: &[u8]) {
185 let fee_est = Arc::new(FuzzEstimator{});
186 let broadcast = Arc::new(TestBroadcaster{});
188 macro_rules! make_node {
189 ($node_id: expr) => { {
190 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string()));
191 let watch = Arc::new(ChainWatchInterfaceUtil::new(Network::Bitcoin, Arc::clone(&logger)));
192 let monitor = Arc::new(TestChannelMonitor::new(watch.clone(), 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).unwrap()),
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()));
207 let watch = Arc::new(ChainWatchInterfaceUtil::new(Network::Bitcoin, Arc::clone(&logger)));
208 let monitor = Arc::new(TestChannelMonitor::new(watch.clone(), broadcast.clone(), logger.clone(), fee_est.clone()));
210 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, session_id: atomic::AtomicU8::new(0), channel_id: atomic::AtomicU8::new(0) });
211 let mut config = UserConfig::default();
212 config.channel_options.fee_proportional_millionths = 0;
213 config.channel_options.announced_channel = true;
214 config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
216 let mut monitors = HashMap::new();
217 let mut old_monitors = $old_monitors.latest_good_update.lock().unwrap();
218 for (outpoint, monitor_ser) in old_monitors.drain() {
219 monitors.insert(outpoint, <(Sha256d, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut Cursor::new(&monitor_ser), Arc::clone(&logger)).expect("Failed to read monitor").1);
220 monitor.latest_good_update.lock().unwrap().insert(outpoint, monitor_ser);
222 let mut monitor_refs = HashMap::new();
223 for (outpoint, monitor) in monitors.iter_mut() {
224 monitor_refs.insert(*outpoint, monitor);
227 let read_args = ChannelManagerReadArgs {
229 fee_estimator: fee_est.clone(),
230 monitor: monitor.clone(),
231 tx_broadcaster: broadcast.clone(),
233 default_config: config,
234 channel_monitors: &mut monitor_refs,
237 let res = (<(Sha256d, ChannelManager<EnforcingChannelKeys, Arc<TestChannelMonitor>, Arc<TestBroadcaster>>)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, monitor);
238 for (_, was_good) in $old_monitors.latest_updates_good_at_last_ser.lock().unwrap().iter() {
240 // If the last time we updated a monitor we didn't successfully update (and we
241 // have sense updated our serialized copy of the ChannelManager) we may
242 // force-close the channel on our counterparty cause we know we're missing
243 // something. Thus, we just return here since we can't continue to test.
251 let mut channel_txn = Vec::new();
252 macro_rules! make_channel {
253 ($source: expr, $dest: expr, $chan_id: expr) => { {
254 $source.create_channel($dest.get_our_node_id(), 10000000, 42, 0).unwrap();
256 let events = $source.get_and_clear_pending_msg_events();
257 assert_eq!(events.len(), 1);
258 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
260 } else { panic!("Wrong event type"); }
263 $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::supported(), &open_channel);
264 let accept_channel = {
265 let events = $dest.get_and_clear_pending_msg_events();
266 assert_eq!(events.len(), 1);
267 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
269 } else { panic!("Wrong event type"); }
272 $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::supported(), &accept_channel);
274 let events = $source.get_and_clear_pending_events();
275 assert_eq!(events.len(), 1);
276 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
277 let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
278 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
280 let funding_output = OutPoint::new(tx.txid(), 0);
281 $source.funding_transaction_generated(&temporary_channel_id, funding_output);
282 channel_txn.push(tx);
283 } else { panic!("Wrong event type"); }
286 let funding_created = {
287 let events = $source.get_and_clear_pending_msg_events();
288 assert_eq!(events.len(), 1);
289 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
291 } else { panic!("Wrong event type"); }
293 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
295 let funding_signed = {
296 let events = $dest.get_and_clear_pending_msg_events();
297 assert_eq!(events.len(), 1);
298 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
300 } else { panic!("Wrong event type"); }
302 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
305 let events = $source.get_and_clear_pending_events();
306 assert_eq!(events.len(), 1);
307 if let events::Event::FundingBroadcastSafe { .. } = events[0] {
308 } else { panic!("Wrong event type"); }
313 macro_rules! confirm_txn {
315 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
316 let mut txn = Vec::with_capacity(channel_txn.len());
317 let mut posn = Vec::with_capacity(channel_txn.len());
318 for i in 0..channel_txn.len() {
319 txn.push(&channel_txn[i]);
320 posn.push(i as u32 + 1);
322 $node.block_connected(&header, 1, &txn, &posn);
324 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
325 $node.block_connected(&header, i, &Vec::new(), &[0; 0]);
330 macro_rules! lock_fundings {
331 ($nodes: expr) => { {
332 let mut node_events = Vec::new();
333 for node in $nodes.iter() {
334 node_events.push(node.get_and_clear_pending_msg_events());
336 for (idx, node_event) in node_events.iter().enumerate() {
337 for event in node_event {
338 if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
339 for node in $nodes.iter() {
340 if node.get_our_node_id() == *node_id {
341 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
344 } else { panic!("Wrong event type"); }
348 for node in $nodes.iter() {
349 let events = node.get_and_clear_pending_msg_events();
350 for event in events {
351 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
352 } else { panic!("Wrong event type"); }
358 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
360 let (mut node_a, mut monitor_a) = make_node!(0);
361 let (mut node_b, mut monitor_b) = make_node!(1);
362 let (mut node_c, mut monitor_c) = make_node!(2);
364 let mut nodes = [node_a, node_b, node_c];
366 make_channel!(nodes[0], nodes[1], 0);
367 make_channel!(nodes[1], nodes[2], 1);
369 for node in nodes.iter() {
373 lock_fundings!(nodes);
375 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
376 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
378 let mut payment_id = 0;
380 let mut chan_a_disconnected = false;
381 let mut chan_b_disconnected = false;
382 let mut ba_events = Vec::new();
383 let mut bc_events = Vec::new();
385 let mut node_a_ser = VecWriter(Vec::new());
386 nodes[0].write(&mut node_a_ser).unwrap();
387 let mut node_b_ser = VecWriter(Vec::new());
388 nodes[1].write(&mut node_b_ser).unwrap();
389 let mut node_c_ser = VecWriter(Vec::new());
390 nodes[2].write(&mut node_c_ser).unwrap();
392 macro_rules! test_return {
394 assert_eq!(nodes[0].list_channels().len(), 1);
395 assert_eq!(nodes[1].list_channels().len(), 2);
396 assert_eq!(nodes[2].list_channels().len(), 1);
401 let mut read_pos = 0;
402 macro_rules! get_slice {
405 let slice_len = $len as usize;
406 if data.len() < read_pos + slice_len {
409 read_pos += slice_len;
410 &data[read_pos - slice_len..read_pos]
416 macro_rules! send_payment {
417 ($source: expr, $dest: expr) => { {
418 let payment_hash = Sha256::hash(&[payment_id; 1]);
419 payment_id = payment_id.wrapping_add(1);
420 if let Err(_) = $source.send_payment(Route {
421 hops: vec![RouteHop {
422 pubkey: $dest.0.get_our_node_id(),
423 node_features: NodeFeatures::empty(),
424 short_channel_id: $dest.1,
425 channel_features: ChannelFeatures::empty(),
427 cltv_expiry_delta: 200,
429 }, PaymentHash(payment_hash.into_inner())) {
430 // Probably ran out of funds
434 ($source: expr, $middle: expr, $dest: expr) => { {
435 let payment_hash = Sha256::hash(&[payment_id; 1]);
436 payment_id = payment_id.wrapping_add(1);
437 if let Err(_) = $source.send_payment(Route {
438 hops: vec![RouteHop {
439 pubkey: $middle.0.get_our_node_id(),
440 node_features: NodeFeatures::empty(),
441 short_channel_id: $middle.1,
442 channel_features: ChannelFeatures::empty(),
444 cltv_expiry_delta: 100,
446 pubkey: $dest.0.get_our_node_id(),
447 node_features: NodeFeatures::empty(),
448 short_channel_id: $dest.1,
449 channel_features: ChannelFeatures::empty(),
451 cltv_expiry_delta: 200,
453 }, PaymentHash(payment_hash.into_inner())) {
454 // Probably ran out of funds
460 macro_rules! process_msg_events {
461 ($node: expr, $corrupt_forward: expr) => { {
462 let events = if $node == 1 {
463 let mut new_events = Vec::new();
464 mem::swap(&mut new_events, &mut ba_events);
465 new_events.extend_from_slice(&bc_events[..]);
468 } else { Vec::new() };
469 for event in events.iter().chain(nodes[$node].get_and_clear_pending_msg_events().iter()) {
471 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 } } => {
472 for dest in nodes.iter() {
473 if dest.get_our_node_id() == *node_id {
474 assert!(update_fee.is_none());
475 for update_add in update_add_htlcs {
476 if !$corrupt_forward {
477 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &update_add);
479 // Corrupt the update_add_htlc message so that its HMAC
480 // check will fail and we generate a
481 // update_fail_malformed_htlc instead of an
482 // update_fail_htlc as we do when we reject a payment.
483 let mut msg_ser = update_add.encode();
484 msg_ser[1000] ^= 0xff;
485 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
486 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
489 for update_fulfill in update_fulfill_htlcs {
490 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), &update_fulfill);
492 for update_fail in update_fail_htlcs {
493 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), &update_fail);
495 for update_fail_malformed in update_fail_malformed_htlcs {
496 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), &update_fail_malformed);
498 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
502 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
503 for dest in nodes.iter() {
504 if dest.get_our_node_id() == *node_id {
505 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
509 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
510 for dest in nodes.iter() {
511 if dest.get_our_node_id() == *node_id {
512 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
516 events::MessageSendEvent::SendFundingLocked { .. } => {
517 // Can be generated as a reestablish response
519 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
520 // Can be generated due to a payment forward being rejected due to a
521 // channel having previously failed a monitor update
523 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {
524 // Can be generated at any processing step to send back an error, disconnect
525 // peer or just ignore
527 _ => panic!("Unhandled message event"),
533 macro_rules! drain_msg_events_on_disconnect {
534 ($counterparty_id: expr) => { {
535 if $counterparty_id == 0 {
536 for event in nodes[0].get_and_clear_pending_msg_events() {
538 events::MessageSendEvent::UpdateHTLCs { .. } => {},
539 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
540 events::MessageSendEvent::SendChannelReestablish { .. } => {},
541 events::MessageSendEvent::SendFundingLocked { .. } => {},
542 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
543 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
544 _ => panic!("Unhandled message event"),
549 for event in nodes[2].get_and_clear_pending_msg_events() {
551 events::MessageSendEvent::UpdateHTLCs { .. } => {},
552 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
553 events::MessageSendEvent::SendChannelReestablish { .. } => {},
554 events::MessageSendEvent::SendFundingLocked { .. } => {},
555 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
556 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => {},
557 _ => panic!("Unhandled message event"),
562 let mut events = nodes[1].get_and_clear_pending_msg_events();
563 let drop_node_id = if $counterparty_id == 0 { nodes[0].get_our_node_id() } else { nodes[2].get_our_node_id() };
564 let msg_sink = if $counterparty_id == 0 { &mut bc_events } else { &mut ba_events };
565 for event in events.drain(..) {
566 let push = match event {
567 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
568 if *node_id != drop_node_id { true } else { false }
570 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
571 if *node_id != drop_node_id { true } else { false }
573 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
574 if *node_id != drop_node_id { true } else { false }
576 events::MessageSendEvent::SendFundingLocked { .. } => false,
577 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => false,
578 events::MessageSendEvent::HandleError { action: ErrorAction::IgnoreError, .. } => false,
579 _ => panic!("Unhandled message event"),
581 if push { msg_sink.push(event); }
586 macro_rules! process_events {
587 ($node: expr, $fail: expr) => { {
588 // In case we get 256 payments we may have a hash collision, resulting in the
589 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
590 // deduplicate the calls here.
591 let mut claim_set = HashSet::new();
592 let mut events = nodes[$node].get_and_clear_pending_events();
593 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
594 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
595 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
596 // PaymentReceived event for the second HTLC in our pending_events (and breaking
597 // our claim_set deduplication).
598 events.sort_by(|a, b| {
599 if let events::Event::PaymentReceived { .. } = a {
600 if let events::Event::PendingHTLCsForwardable { .. } = b {
602 } else { Ordering::Equal }
603 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
604 if let events::Event::PaymentReceived { .. } = b {
606 } else { Ordering::Equal }
607 } else { Ordering::Equal }
609 for event in events.drain(..) {
611 events::Event::PaymentReceived { payment_hash, .. } => {
612 if claim_set.insert(payment_hash.0) {
614 assert!(nodes[$node].fail_htlc_backwards(&payment_hash));
616 assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0), 5_000_000));
620 events::Event::PaymentSent { .. } => {},
621 events::Event::PaymentFailed { .. } => {},
622 events::Event::PendingHTLCsForwardable { .. } => {
623 nodes[$node].process_pending_htlc_forwards();
625 _ => panic!("Unhandled event"),
631 match get_slice!(1)[0] {
632 0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
633 0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
634 0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
635 0x03 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
636 0x04 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
637 0x05 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
638 0x06 => { unsafe { IN_RESTORE = true }; nodes[0].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
639 0x07 => { unsafe { IN_RESTORE = true }; nodes[1].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
640 0x08 => { unsafe { IN_RESTORE = true }; nodes[2].test_restore_channel_monitor(); unsafe { IN_RESTORE = false }; },
641 0x09 => send_payment!(nodes[0], (&nodes[1], chan_a)),
642 0x0a => send_payment!(nodes[1], (&nodes[0], chan_a)),
643 0x0b => send_payment!(nodes[1], (&nodes[2], chan_b)),
644 0x0c => send_payment!(nodes[2], (&nodes[1], chan_b)),
645 0x0d => send_payment!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b)),
646 0x0e => send_payment!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a)),
648 if !chan_a_disconnected {
649 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
650 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
651 chan_a_disconnected = true;
652 drain_msg_events_on_disconnect!(0);
656 if !chan_b_disconnected {
657 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
658 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
659 chan_b_disconnected = true;
660 drain_msg_events_on_disconnect!(2);
664 if chan_a_disconnected {
665 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
666 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::empty() });
667 chan_a_disconnected = false;
671 if chan_b_disconnected {
672 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::empty() });
673 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::empty() });
674 chan_b_disconnected = false;
677 0x13 => process_msg_events!(0, true),
678 0x14 => process_msg_events!(0, false),
679 0x15 => process_events!(0, true),
680 0x16 => process_events!(0, false),
681 0x17 => process_msg_events!(1, true),
682 0x18 => process_msg_events!(1, false),
683 0x19 => process_events!(1, true),
684 0x1a => process_events!(1, false),
685 0x1b => process_msg_events!(2, true),
686 0x1c => process_msg_events!(2, false),
687 0x1d => process_events!(2, true),
688 0x1e => process_events!(2, false),
690 if !chan_a_disconnected {
691 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
692 chan_a_disconnected = true;
693 drain_msg_events_on_disconnect!(0);
695 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a);
696 node_a = Arc::new(new_node_a);
697 nodes[0] = node_a.clone();
698 monitor_a = new_monitor_a;
701 if !chan_a_disconnected {
702 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
703 chan_a_disconnected = true;
704 nodes[0].get_and_clear_pending_msg_events();
707 if !chan_b_disconnected {
708 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
709 chan_b_disconnected = true;
710 nodes[2].get_and_clear_pending_msg_events();
713 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b);
714 node_b = Arc::new(new_node_b);
715 nodes[1] = node_b.clone();
716 monitor_b = new_monitor_b;
719 if !chan_b_disconnected {
720 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
721 chan_b_disconnected = true;
722 drain_msg_events_on_disconnect!(2);
724 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c);
725 node_c = Arc::new(new_node_c);
726 nodes[2] = node_c.clone();
727 monitor_c = new_monitor_c;
732 if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
733 node_a_ser.0.clear();
734 nodes[0].write(&mut node_a_ser).unwrap();
735 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
736 *monitor_a.latest_updates_good_at_last_ser.lock().unwrap() = monitor_a.latest_update_good.lock().unwrap().clone();
738 if monitor_b.should_update_manager.load(atomic::Ordering::Relaxed) {
739 node_b_ser.0.clear();
740 nodes[1].write(&mut node_b_ser).unwrap();
741 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
742 *monitor_b.latest_updates_good_at_last_ser.lock().unwrap() = monitor_b.latest_update_good.lock().unwrap().clone();
744 if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
745 node_c_ser.0.clear();
746 nodes[2].write(&mut node_c_ser).unwrap();
747 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
748 *monitor_c.latest_updates_good_at_last_ser.lock().unwrap() = monitor_c.latest_update_good.lock().unwrap().clone();
754 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
755 do_test(unsafe { std::slice::from_raw_parts(data, datalen) });