1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Test that monitor update failures don't get our channel state out of sync.
11 //! One of the biggest concern with the monitor update failure handling code is that messages
12 //! resent after monitor updating is restored are delivered out-of-order, resulting in
13 //! commitment_signed messages having "invalid signatures".
14 //! To test this we stand up a network of three nodes and read bytes from the fuzz input to denote
15 //! actions such as sending payments, handling events, or changing monitor update return values on
16 //! a per-node basis. This should allow it to find any cases where the ordering of actions results
17 //! in us getting out of sync with ourselves, and, assuming at least one of our recieve- or
18 //! send-side handling is correct, other peers. We consider it a failure if any action results in a
19 //! channel being force-closed.
21 use bitcoin::blockdata::block::BlockHeader;
22 use bitcoin::blockdata::constants::genesis_block;
23 use bitcoin::blockdata::transaction::{Transaction, TxOut};
24 use bitcoin::blockdata::script::{Builder, Script};
25 use bitcoin::blockdata::opcodes;
26 use bitcoin::network::constants::Network;
28 use bitcoin::hashes::Hash as TraitImport;
29 use bitcoin::hashes::sha256::Hash as Sha256;
30 use bitcoin::hash_types::{BlockHash, WPubkeyHash};
33 use lightning::chain::{BestBlock, chainmonitor, channelmonitor, Confirm, Watch};
34 use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, MonitorEvent};
35 use lightning::chain::transaction::OutPoint;
36 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
37 use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
38 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
39 use lightning::ln::channelmanager::{ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs};
40 use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
41 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
42 use lightning::ln::script::ShutdownScript;
43 use lightning::util::enforcing_trait_impls::{EnforcingSigner, INITIAL_REVOKED_COMMITMENT_NUMBER};
44 use lightning::util::errors::APIError;
45 use lightning::util::events;
46 use lightning::util::logger::Logger;
47 use lightning::util::config::UserConfig;
48 use lightning::util::events::MessageSendEventsProvider;
49 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
50 use lightning::routing::router::{Route, RouteHop};
53 use utils::test_logger;
54 use utils::test_persister::TestPersister;
56 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
57 use bitcoin::secp256k1::recovery::RecoverableSignature;
58 use bitcoin::secp256k1::Secp256k1;
61 use std::cmp::Ordering;
62 use std::collections::{HashSet, hash_map, HashMap};
63 use std::sync::{Arc,Mutex};
64 use std::sync::atomic;
67 struct FuzzEstimator {}
68 impl FeeEstimator for FuzzEstimator {
69 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
74 pub struct TestBroadcaster {}
75 impl BroadcasterInterface for TestBroadcaster {
76 fn broadcast_transaction(&self, _tx: &Transaction) { }
79 pub struct VecWriter(pub Vec<u8>);
80 impl Writer for VecWriter {
81 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
82 self.0.extend_from_slice(buf);
85 fn size_hint(&mut self, size: usize) {
86 self.0.reserve_exact(size);
90 struct TestChainMonitor {
91 pub logger: Arc<dyn Logger>,
92 pub keys: Arc<KeyProvider>,
93 pub chain_monitor: Arc<chainmonitor::ChainMonitor<EnforcingSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
94 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
95 // If we reload a node with an old copy of ChannelMonitors, the ChannelManager deserialization
96 // logic will automatically force-close our channels for us (as we don't have an up-to-date
97 // monitor implying we are not able to punish misbehaving counterparties). Because this test
98 // "fails" if we ever force-close a channel, we avoid doing so, always saving the latest
99 // fully-serialized monitor state here, as well as the corresponding update_id.
100 pub latest_monitors: Mutex<HashMap<OutPoint, (u64, Vec<u8>)>>,
101 pub should_update_manager: atomic::AtomicBool,
103 impl TestChainMonitor {
104 pub fn new(broadcaster: Arc<TestBroadcaster>, logger: Arc<dyn Logger>, feeest: Arc<FuzzEstimator>, persister: Arc<TestPersister>, keys: Arc<KeyProvider>) -> Self {
106 chain_monitor: Arc::new(chainmonitor::ChainMonitor::new(None, broadcaster, logger.clone(), feeest, persister)),
109 update_ret: Mutex::new(Ok(())),
110 latest_monitors: Mutex::new(HashMap::new()),
111 should_update_manager: atomic::AtomicBool::new(false),
115 impl chain::Watch<EnforcingSigner> for TestChainMonitor {
116 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
117 let mut ser = VecWriter(Vec::new());
118 monitor.write(&mut ser).unwrap();
119 if let Some(_) = self.latest_monitors.lock().unwrap().insert(funding_txo, (monitor.get_latest_update_id(), ser.0)) {
120 panic!("Already had monitor pre-watch_channel");
122 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
123 assert!(self.chain_monitor.watch_channel(funding_txo, monitor).is_ok());
124 self.update_ret.lock().unwrap().clone()
127 fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
128 let mut map_lock = self.latest_monitors.lock().unwrap();
129 let mut map_entry = match map_lock.entry(funding_txo) {
130 hash_map::Entry::Occupied(entry) => entry,
131 hash_map::Entry::Vacant(_) => panic!("Didn't have monitor on update call"),
133 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
134 read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
135 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
136 let mut ser = VecWriter(Vec::new());
137 deserialized_monitor.write(&mut ser).unwrap();
138 map_entry.insert((update.update_id, ser.0));
139 self.should_update_manager.store(true, atomic::Ordering::Relaxed);
140 assert!(self.chain_monitor.update_channel(funding_txo, update).is_ok());
141 self.update_ret.lock().unwrap().clone()
144 fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
145 return self.chain_monitor.release_pending_monitor_events();
151 rand_bytes_id: atomic::AtomicU32,
152 revoked_commitments: Mutex<HashMap<[u8;32], Arc<Mutex<u64>>>>,
154 impl KeysInterface for KeyProvider {
155 type Signer = EnforcingSigner;
157 fn get_node_secret(&self) -> SecretKey {
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, 1, self.node_id]).unwrap()
161 fn get_destination_script(&self) -> Script {
162 let secp_ctx = Secp256k1::signing_only();
163 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();
164 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
165 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
168 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
169 let secp_ctx = Secp256k1::signing_only();
170 let secret_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, 3, self.node_id]).unwrap();
171 let pubkey_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &secret_key).serialize());
172 ShutdownScript::new_p2wpkh(&pubkey_hash)
175 fn get_channel_signer(&self, _inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner {
176 let secp_ctx = Secp256k1::signing_only();
177 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
178 let keys = InMemorySigner::new(
180 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(),
181 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(),
182 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(),
183 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(),
184 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(),
185 [id as u8, 0, 0, 0, 0, 0, 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],
186 channel_value_satoshis,
189 let revoked_commitment = self.make_revoked_commitment_cell(keys.commitment_seed);
190 EnforcingSigner::new_with_revoked(keys, revoked_commitment, false)
193 fn get_secure_random_bytes(&self) -> [u8; 32] {
194 let id = self.rand_bytes_id.fetch_add(1, atomic::Ordering::Relaxed);
195 let mut res = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 11, self.node_id];
196 res[30-4..30].copy_from_slice(&id.to_le_bytes());
200 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, DecodeError> {
201 let mut reader = std::io::Cursor::new(buffer);
203 let inner: InMemorySigner = Readable::read(&mut reader)?;
204 let revoked_commitment = self.make_revoked_commitment_cell(inner.commitment_seed);
206 let last_commitment_number = Readable::read(&mut reader)?;
210 last_commitment_number: Arc::new(Mutex::new(last_commitment_number)),
212 disable_revocation_policy_check: false,
216 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> {
222 fn make_revoked_commitment_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<u64>> {
223 let mut revoked_commitments = self.revoked_commitments.lock().unwrap();
224 if !revoked_commitments.contains_key(&commitment_seed) {
225 revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(INITIAL_REVOKED_COMMITMENT_NUMBER)));
227 let cell = revoked_commitments.get(&commitment_seed).unwrap();
233 fn check_api_err(api_err: APIError) {
235 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
236 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
237 APIError::RouteError { .. } => panic!("Our routes should work"),
238 APIError::ChannelUnavailable { err } => {
239 // Test the error against a list of errors we can hit, and reject
240 // all others. If you hit this panic, the list of acceptable errors
241 // is probably just stale and you should add new messages here.
243 "Peer for first hop currently disconnected/pending monitor update!" => {},
244 _ if err.starts_with("Cannot push more than their max accepted HTLCs ") => {},
245 _ if err.starts_with("Cannot send value that would put us over the max HTLC value in flight our peer will accept ") => {},
246 _ if err.starts_with("Cannot send value that would put our balance under counterparty-announced channel reserve value") => {},
247 _ if err.starts_with("Cannot send value that would put counterparty balance under holder-announced channel reserve value") => {},
248 _ if err.starts_with("Cannot send value that would overdraw remaining funds.") => {},
249 _ if err.starts_with("Cannot send value that would not leave enough to pay for fees.") => {},
250 _ => panic!("{}", err),
253 APIError::MonitorUpdateFailed => {
254 // We can (obviously) temp-fail a monitor update
256 APIError::IncompatibleShutdownScript { .. } => panic!("Cannot send an incompatible shutdown script"),
260 fn check_payment_err(send_err: PaymentSendFailure) {
262 PaymentSendFailure::ParameterError(api_err) => check_api_err(api_err),
263 PaymentSendFailure::PathParameterError(per_path_results) => {
264 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
266 PaymentSendFailure::AllFailedRetrySafe(per_path_results) => {
267 for api_err in per_path_results { check_api_err(api_err); }
269 PaymentSendFailure::PartialFailure(per_path_results) => {
270 for res in per_path_results { if let Err(api_err) = res { check_api_err(api_err); } }
275 type ChanMan = ChannelManager<EnforcingSigner, Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>;
278 fn get_payment_secret_hash(dest: &ChanMan, payment_id: &mut u8) -> Option<(PaymentSecret, PaymentHash)> {
279 let mut payment_hash;
281 payment_hash = PaymentHash(Sha256::hash(&[*payment_id; 1]).into_inner());
282 if let Ok(payment_secret) = dest.create_inbound_payment_for_hash(payment_hash, None, 3600, 0) {
283 return Some((payment_secret, payment_hash));
285 *payment_id = payment_id.wrapping_add(1);
291 fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
292 let (payment_secret, payment_hash) =
293 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
294 if let Err(err) = source.send_payment(&Route {
295 paths: vec![vec![RouteHop {
296 pubkey: dest.get_our_node_id(),
297 node_features: NodeFeatures::known(),
298 short_channel_id: dest_chan_id,
299 channel_features: ChannelFeatures::known(),
301 cltv_expiry_delta: 200,
303 }, payment_hash, &Some(payment_secret)) {
304 check_payment_err(err);
309 fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, dest: &ChanMan, dest_chan_id: u64, amt: u64, payment_id: &mut u8) -> bool {
310 let (payment_secret, payment_hash) =
311 if let Some((secret, hash)) = get_payment_secret_hash(dest, payment_id) { (secret, hash) } else { return true; };
312 if let Err(err) = source.send_payment(&Route {
313 paths: vec![vec![RouteHop {
314 pubkey: middle.get_our_node_id(),
315 node_features: NodeFeatures::known(),
316 short_channel_id: middle_chan_id,
317 channel_features: ChannelFeatures::known(),
319 cltv_expiry_delta: 100,
321 pubkey: dest.get_our_node_id(),
322 node_features: NodeFeatures::known(),
323 short_channel_id: dest_chan_id,
324 channel_features: ChannelFeatures::known(),
326 cltv_expiry_delta: 200,
328 }, payment_hash, &Some(payment_secret)) {
329 check_payment_err(err);
335 pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
336 let fee_est = Arc::new(FuzzEstimator{});
337 let broadcast = Arc::new(TestBroadcaster{});
339 macro_rules! make_node {
340 ($node_id: expr) => { {
341 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
342 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), revoked_commitments: Mutex::new(HashMap::new()) });
343 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));
345 let mut config = UserConfig::default();
346 config.channel_options.forwarding_fee_proportional_millionths = 0;
347 config.channel_options.announced_channel = true;
348 let network = Network::Bitcoin;
349 let params = ChainParameters {
351 best_block: BestBlock::from_genesis(network),
353 (ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
354 monitor, keys_manager)
358 macro_rules! reload_node {
359 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr) => { {
360 let keys_manager = Arc::clone(& $keys_manager);
361 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
362 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));
364 let mut config = UserConfig::default();
365 config.channel_options.forwarding_fee_proportional_millionths = 0;
366 config.channel_options.announced_channel = true;
368 let mut monitors = HashMap::new();
369 let mut old_monitors = $old_monitors.latest_monitors.lock().unwrap();
370 for (outpoint, (update_id, monitor_ser)) in old_monitors.drain() {
371 monitors.insert(outpoint, <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut Cursor::new(&monitor_ser), &*$keys_manager).expect("Failed to read monitor").1);
372 chain_monitor.latest_monitors.lock().unwrap().insert(outpoint, (update_id, monitor_ser));
374 let mut monitor_refs = HashMap::new();
375 for (outpoint, monitor) in monitors.iter_mut() {
376 monitor_refs.insert(*outpoint, monitor);
379 let read_args = ChannelManagerReadArgs {
381 fee_estimator: fee_est.clone(),
382 chain_monitor: chain_monitor.clone(),
383 tx_broadcaster: broadcast.clone(),
385 default_config: config,
386 channel_monitors: monitor_refs,
389 let res = (<(BlockHash, ChanMan)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, chain_monitor.clone());
390 for (funding_txo, mon) in monitors.drain() {
391 assert!(chain_monitor.chain_monitor.watch_channel(funding_txo, mon).is_ok());
397 let mut channel_txn = Vec::new();
398 macro_rules! make_channel {
399 ($source: expr, $dest: expr, $chan_id: expr) => { {
400 $source.peer_connected(&$dest.get_our_node_id(), &Init { features: InitFeatures::known() });
401 $dest.peer_connected(&$source.get_our_node_id(), &Init { features: InitFeatures::known() });
403 $source.create_channel($dest.get_our_node_id(), 100_000, 42, 0, None).unwrap();
405 let events = $source.get_and_clear_pending_msg_events();
406 assert_eq!(events.len(), 1);
407 if let events::MessageSendEvent::SendOpenChannel { ref msg, .. } = events[0] {
409 } else { panic!("Wrong event type"); }
412 $dest.handle_open_channel(&$source.get_our_node_id(), InitFeatures::known(), &open_channel);
413 let accept_channel = {
414 let events = $dest.get_and_clear_pending_msg_events();
415 assert_eq!(events.len(), 1);
416 if let events::MessageSendEvent::SendAcceptChannel { ref msg, .. } = events[0] {
418 } else { panic!("Wrong event type"); }
421 $source.handle_accept_channel(&$dest.get_our_node_id(), InitFeatures::known(), &accept_channel);
424 let events = $source.get_and_clear_pending_events();
425 assert_eq!(events.len(), 1);
426 if let events::Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, .. } = events[0] {
427 let tx = Transaction { version: $chan_id, lock_time: 0, input: Vec::new(), output: vec![TxOut {
428 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
430 funding_output = OutPoint { txid: tx.txid(), index: 0 };
431 $source.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
432 channel_txn.push(tx);
433 } else { panic!("Wrong event type"); }
436 let funding_created = {
437 let events = $source.get_and_clear_pending_msg_events();
438 assert_eq!(events.len(), 1);
439 if let events::MessageSendEvent::SendFundingCreated { ref msg, .. } = events[0] {
441 } else { panic!("Wrong event type"); }
443 $dest.handle_funding_created(&$source.get_our_node_id(), &funding_created);
445 let funding_signed = {
446 let events = $dest.get_and_clear_pending_msg_events();
447 assert_eq!(events.len(), 1);
448 if let events::MessageSendEvent::SendFundingSigned { ref msg, .. } = events[0] {
450 } else { panic!("Wrong event type"); }
452 $source.handle_funding_signed(&$dest.get_our_node_id(), &funding_signed);
458 macro_rules! confirm_txn {
460 let chain_hash = genesis_block(Network::Bitcoin).block_hash();
461 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: chain_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
462 let txdata: Vec<_> = channel_txn.iter().enumerate().map(|(i, tx)| (i + 1, tx)).collect();
463 $node.transactions_confirmed(&header, &txdata, 1);
465 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
467 $node.best_block_updated(&header, 99);
471 macro_rules! lock_fundings {
472 ($nodes: expr) => { {
473 let mut node_events = Vec::new();
474 for node in $nodes.iter() {
475 node_events.push(node.get_and_clear_pending_msg_events());
477 for (idx, node_event) in node_events.iter().enumerate() {
478 for event in node_event {
479 if let events::MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = event {
480 for node in $nodes.iter() {
481 if node.get_our_node_id() == *node_id {
482 node.handle_funding_locked(&$nodes[idx].get_our_node_id(), msg);
485 } else { panic!("Wrong event type"); }
489 for node in $nodes.iter() {
490 let events = node.get_and_clear_pending_msg_events();
491 for event in events {
492 if let events::MessageSendEvent::SendAnnouncementSignatures { .. } = event {
493 } else { panic!("Wrong event type"); }
499 // 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
501 let (node_a, mut monitor_a, keys_manager_a) = make_node!(0);
502 let (node_b, mut monitor_b, keys_manager_b) = make_node!(1);
503 let (node_c, mut monitor_c, keys_manager_c) = make_node!(2);
505 let mut nodes = [node_a, node_b, node_c];
507 let chan_1_funding = make_channel!(nodes[0], nodes[1], 0);
508 let chan_2_funding = make_channel!(nodes[1], nodes[2], 1);
510 for node in nodes.iter() {
514 lock_fundings!(nodes);
516 let chan_a = nodes[0].list_usable_channels()[0].short_channel_id.unwrap();
517 let chan_b = nodes[2].list_usable_channels()[0].short_channel_id.unwrap();
519 let mut payment_id: u8 = 0;
521 let mut chan_a_disconnected = false;
522 let mut chan_b_disconnected = false;
523 let mut ab_events = Vec::new();
524 let mut ba_events = Vec::new();
525 let mut bc_events = Vec::new();
526 let mut cb_events = Vec::new();
528 let mut node_a_ser = VecWriter(Vec::new());
529 nodes[0].write(&mut node_a_ser).unwrap();
530 let mut node_b_ser = VecWriter(Vec::new());
531 nodes[1].write(&mut node_b_ser).unwrap();
532 let mut node_c_ser = VecWriter(Vec::new());
533 nodes[2].write(&mut node_c_ser).unwrap();
535 macro_rules! test_return {
537 assert_eq!(nodes[0].list_channels().len(), 1);
538 assert_eq!(nodes[1].list_channels().len(), 2);
539 assert_eq!(nodes[2].list_channels().len(), 1);
544 let mut read_pos = 0;
545 macro_rules! get_slice {
548 let slice_len = $len as usize;
549 if data.len() < read_pos + slice_len {
552 read_pos += slice_len;
553 &data[read_pos - slice_len..read_pos]
559 // Push any events from Node B onto ba_events and bc_events
560 macro_rules! push_excess_b_events {
561 ($excess_events: expr, $expect_drop_node: expr) => { {
562 let a_id = nodes[0].get_our_node_id();
563 let expect_drop_node: Option<usize> = $expect_drop_node;
564 let expect_drop_id = if let Some(id) = expect_drop_node { Some(nodes[id].get_our_node_id()) } else { None };
565 for event in $excess_events {
566 let push_a = match event {
567 events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
568 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
571 events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => {
572 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
575 events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => {
576 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
579 events::MessageSendEvent::SendFundingLocked { .. } => continue,
580 events::MessageSendEvent::SendAnnouncementSignatures { .. } => continue,
581 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => continue,
582 events::MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
583 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
584 if Some(*node_id) == expect_drop_id { panic!("peer_disconnected should drop msgs bound for the disconnected peer"); }
587 _ => panic!("Unhandled message event {:?}", event),
589 if push_a { ba_events.push(event); } else { bc_events.push(event); }
594 // While delivering messages, we select across three possible message selection processes
595 // to ensure we get as much coverage as possible. See the individual enum variants for more
598 enum ProcessMessages {
599 /// Deliver all available messages, including fetching any new messages from
600 /// `get_and_clear_pending_msg_events()` (which may have side effects).
602 /// Call `get_and_clear_pending_msg_events()` first, and then deliver up to one
603 /// message (which may already be queued).
605 /// Deliver up to one already-queued message. This avoids any potential side-effects
606 /// of `get_and_clear_pending_msg_events()` (eg freeing the HTLC holding cell), which
607 /// provides potentially more coverage.
611 macro_rules! process_msg_events {
612 ($node: expr, $corrupt_forward: expr, $limit_events: expr) => { {
613 let mut events = if $node == 1 {
614 let mut new_events = Vec::new();
615 mem::swap(&mut new_events, &mut ba_events);
616 new_events.extend_from_slice(&bc_events[..]);
619 } else if $node == 0 {
620 let mut new_events = Vec::new();
621 mem::swap(&mut new_events, &mut ab_events);
624 let mut new_events = Vec::new();
625 mem::swap(&mut new_events, &mut cb_events);
628 let mut new_events = Vec::new();
629 if $limit_events != ProcessMessages::OnePendingMessage {
630 new_events = nodes[$node].get_and_clear_pending_msg_events();
632 let mut had_events = false;
633 let mut events_iter = events.drain(..).chain(new_events.drain(..));
634 let mut extra_ev = None;
635 for event in &mut events_iter {
638 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
639 for dest in nodes.iter() {
640 if dest.get_our_node_id() == node_id {
641 assert!(update_fee.is_none());
642 for update_add in update_add_htlcs.iter() {
643 if !$corrupt_forward {
644 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
646 // Corrupt the update_add_htlc message so that its HMAC
647 // check will fail and we generate a
648 // update_fail_malformed_htlc instead of an
649 // update_fail_htlc as we do when we reject a payment.
650 let mut msg_ser = update_add.encode();
651 msg_ser[1000] ^= 0xff;
652 let new_msg = UpdateAddHTLC::read(&mut Cursor::new(&msg_ser)).unwrap();
653 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), &new_msg);
656 for update_fulfill in update_fulfill_htlcs.iter() {
657 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
659 for update_fail in update_fail_htlcs.iter() {
660 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
662 for update_fail_malformed in update_fail_malformed_htlcs.iter() {
663 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
665 let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
666 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
667 if $limit_events != ProcessMessages::AllMessages && processed_change {
668 // If we only want to process some messages, don't deliver the CS until later.
669 extra_ev = Some(events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate {
670 update_add_htlcs: Vec::new(),
671 update_fail_htlcs: Vec::new(),
672 update_fulfill_htlcs: Vec::new(),
673 update_fail_malformed_htlcs: Vec::new(),
679 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
684 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
685 for dest in nodes.iter() {
686 if dest.get_our_node_id() == *node_id {
687 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
691 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
692 for dest in nodes.iter() {
693 if dest.get_our_node_id() == *node_id {
694 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
698 events::MessageSendEvent::SendFundingLocked { .. } => {
699 // Can be generated as a reestablish response
701 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {
702 // Can be generated as a reestablish response
704 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {
705 // Can be generated due to a payment forward being rejected due to a
706 // channel having previously failed a monitor update
708 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
709 // When we reconnect we will resend a channel_update to make sure our
710 // counterparty has the latest parameters for receiving payments
711 // through us. We do, however, check that the message does not include
712 // the "disabled" bit, as we should never ever have a channel which is
713 // disabled when we send such an update (or it may indicate channel
714 // force-close which we should detect as an error).
715 assert_eq!(msg.contents.flags & 2, 0);
717 _ => panic!("Unhandled message event {:?}", event),
719 if $limit_events != ProcessMessages::AllMessages {
724 push_excess_b_events!(extra_ev.into_iter().chain(events_iter), None);
725 } else if $node == 0 {
726 if let Some(ev) = extra_ev { ab_events.push(ev); }
727 for event in events_iter { ab_events.push(event); }
729 if let Some(ev) = extra_ev { cb_events.push(ev); }
730 for event in events_iter { cb_events.push(event); }
736 macro_rules! drain_msg_events_on_disconnect {
737 ($counterparty_id: expr) => { {
738 if $counterparty_id == 0 {
739 for event in nodes[0].get_and_clear_pending_msg_events() {
741 events::MessageSendEvent::UpdateHTLCs { .. } => {},
742 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
743 events::MessageSendEvent::SendChannelReestablish { .. } => {},
744 events::MessageSendEvent::SendFundingLocked { .. } => {},
745 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
746 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
747 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
748 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
750 _ => panic!("Unhandled message event"),
753 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(0));
757 for event in nodes[2].get_and_clear_pending_msg_events() {
759 events::MessageSendEvent::UpdateHTLCs { .. } => {},
760 events::MessageSendEvent::SendRevokeAndACK { .. } => {},
761 events::MessageSendEvent::SendChannelReestablish { .. } => {},
762 events::MessageSendEvent::SendFundingLocked { .. } => {},
763 events::MessageSendEvent::SendAnnouncementSignatures { .. } => {},
764 events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
765 events::MessageSendEvent::SendChannelUpdate { ref msg, .. } => {
766 assert_eq!(msg.contents.flags & 2, 0); // The disable bit must never be set!
768 _ => panic!("Unhandled message event"),
771 push_excess_b_events!(nodes[1].get_and_clear_pending_msg_events().drain(..), Some(2));
778 macro_rules! process_events {
779 ($node: expr, $fail: expr) => { {
780 // In case we get 256 payments we may have a hash collision, resulting in the
781 // second claim/fail call not finding the duplicate-hash HTLC, so we have to
782 // deduplicate the calls here.
783 let mut claim_set = HashSet::new();
784 let mut events = nodes[$node].get_and_clear_pending_events();
785 // Sort events so that PendingHTLCsForwardable get processed last. This avoids a
786 // case where we first process a PendingHTLCsForwardable, then claim/fail on a
787 // PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
788 // PaymentReceived event for the second HTLC in our pending_events (and breaking
789 // our claim_set deduplication).
790 events.sort_by(|a, b| {
791 if let events::Event::PaymentReceived { .. } = a {
792 if let events::Event::PendingHTLCsForwardable { .. } = b {
794 } else { Ordering::Equal }
795 } else if let events::Event::PendingHTLCsForwardable { .. } = a {
796 if let events::Event::PaymentReceived { .. } = b {
798 } else { Ordering::Equal }
799 } else { Ordering::Equal }
801 let had_events = !events.is_empty();
802 for event in events.drain(..) {
804 events::Event::PaymentReceived { payment_hash, .. } => {
805 if claim_set.insert(payment_hash.0) {
807 assert!(nodes[$node].fail_htlc_backwards(&payment_hash));
809 assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0)));
813 events::Event::PaymentSent { .. } => {},
814 events::Event::PaymentFailed { .. } => {},
815 events::Event::PaymentForwarded { .. } if $node == 1 => {},
816 events::Event::PendingHTLCsForwardable { .. } => {
817 nodes[$node].process_pending_htlc_forwards();
819 _ => panic!("Unhandled event"),
826 match get_slice!(1)[0] {
827 // In general, we keep related message groups close together in binary form, allowing
828 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
831 0x00 => *monitor_a.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
832 0x01 => *monitor_b.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
833 0x02 => *monitor_c.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure),
834 0x04 => *monitor_a.update_ret.lock().unwrap() = Ok(()),
835 0x05 => *monitor_b.update_ret.lock().unwrap() = Ok(()),
836 0x06 => *monitor_c.update_ret.lock().unwrap() = Ok(()),
839 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
840 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
844 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
845 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
849 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
850 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
854 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
855 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
860 if !chan_a_disconnected {
861 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
862 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
863 chan_a_disconnected = true;
864 drain_msg_events_on_disconnect!(0);
868 if !chan_b_disconnected {
869 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
870 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
871 chan_b_disconnected = true;
872 drain_msg_events_on_disconnect!(2);
876 if chan_a_disconnected {
877 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
878 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::known() });
879 chan_a_disconnected = false;
883 if chan_b_disconnected {
884 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::known() });
885 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
886 chan_b_disconnected = false;
890 0x10 => { process_msg_events!(0, true, ProcessMessages::AllMessages); },
891 0x11 => { process_msg_events!(0, false, ProcessMessages::AllMessages); },
892 0x12 => { process_msg_events!(0, true, ProcessMessages::OneMessage); },
893 0x13 => { process_msg_events!(0, false, ProcessMessages::OneMessage); },
894 0x14 => { process_msg_events!(0, true, ProcessMessages::OnePendingMessage); },
895 0x15 => { process_msg_events!(0, false, ProcessMessages::OnePendingMessage); },
897 0x16 => { process_events!(0, true); },
898 0x17 => { process_events!(0, false); },
900 0x18 => { process_msg_events!(1, true, ProcessMessages::AllMessages); },
901 0x19 => { process_msg_events!(1, false, ProcessMessages::AllMessages); },
902 0x1a => { process_msg_events!(1, true, ProcessMessages::OneMessage); },
903 0x1b => { process_msg_events!(1, false, ProcessMessages::OneMessage); },
904 0x1c => { process_msg_events!(1, true, ProcessMessages::OnePendingMessage); },
905 0x1d => { process_msg_events!(1, false, ProcessMessages::OnePendingMessage); },
907 0x1e => { process_events!(1, true); },
908 0x1f => { process_events!(1, false); },
910 0x20 => { process_msg_events!(2, true, ProcessMessages::AllMessages); },
911 0x21 => { process_msg_events!(2, false, ProcessMessages::AllMessages); },
912 0x22 => { process_msg_events!(2, true, ProcessMessages::OneMessage); },
913 0x23 => { process_msg_events!(2, false, ProcessMessages::OneMessage); },
914 0x24 => { process_msg_events!(2, true, ProcessMessages::OnePendingMessage); },
915 0x25 => { process_msg_events!(2, false, ProcessMessages::OnePendingMessage); },
917 0x26 => { process_events!(2, true); },
918 0x27 => { process_events!(2, false); },
921 if !chan_a_disconnected {
922 nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
923 chan_a_disconnected = true;
924 drain_msg_events_on_disconnect!(0);
926 if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
927 node_a_ser.0.clear();
928 nodes[0].write(&mut node_a_ser).unwrap();
930 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a);
931 nodes[0] = new_node_a;
932 monitor_a = new_monitor_a;
935 if !chan_a_disconnected {
936 nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
937 chan_a_disconnected = true;
938 nodes[0].get_and_clear_pending_msg_events();
942 if !chan_b_disconnected {
943 nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
944 chan_b_disconnected = true;
945 nodes[2].get_and_clear_pending_msg_events();
949 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b);
950 nodes[1] = new_node_b;
951 monitor_b = new_monitor_b;
954 if !chan_b_disconnected {
955 nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
956 chan_b_disconnected = true;
957 drain_msg_events_on_disconnect!(2);
959 if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
960 node_c_ser.0.clear();
961 nodes[2].write(&mut node_c_ser).unwrap();
963 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c);
964 nodes[2] = new_node_c;
965 monitor_c = new_monitor_c;
968 // 1/10th the channel size:
969 0x30 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id); },
970 0x31 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id); },
971 0x32 => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id); },
972 0x33 => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id); },
973 0x34 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000_000, &mut payment_id); },
974 0x35 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000_000, &mut payment_id); },
976 0x38 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000_000, &mut payment_id); },
977 0x39 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000_000, &mut payment_id); },
978 0x3a => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000_000, &mut payment_id); },
979 0x3b => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000_000, &mut payment_id); },
980 0x3c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000_000, &mut payment_id); },
981 0x3d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000_000, &mut payment_id); },
983 0x40 => { send_payment(&nodes[0], &nodes[1], chan_a, 100_000, &mut payment_id); },
984 0x41 => { send_payment(&nodes[1], &nodes[0], chan_a, 100_000, &mut payment_id); },
985 0x42 => { send_payment(&nodes[1], &nodes[2], chan_b, 100_000, &mut payment_id); },
986 0x43 => { send_payment(&nodes[2], &nodes[1], chan_b, 100_000, &mut payment_id); },
987 0x44 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100_000, &mut payment_id); },
988 0x45 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100_000, &mut payment_id); },
990 0x48 => { send_payment(&nodes[0], &nodes[1], chan_a, 10_000, &mut payment_id); },
991 0x49 => { send_payment(&nodes[1], &nodes[0], chan_a, 10_000, &mut payment_id); },
992 0x4a => { send_payment(&nodes[1], &nodes[2], chan_b, 10_000, &mut payment_id); },
993 0x4b => { send_payment(&nodes[2], &nodes[1], chan_b, 10_000, &mut payment_id); },
994 0x4c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10_000, &mut payment_id); },
995 0x4d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10_000, &mut payment_id); },
997 0x50 => { send_payment(&nodes[0], &nodes[1], chan_a, 1_000, &mut payment_id); },
998 0x51 => { send_payment(&nodes[1], &nodes[0], chan_a, 1_000, &mut payment_id); },
999 0x52 => { send_payment(&nodes[1], &nodes[2], chan_b, 1_000, &mut payment_id); },
1000 0x53 => { send_payment(&nodes[2], &nodes[1], chan_b, 1_000, &mut payment_id); },
1001 0x54 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1_000, &mut payment_id); },
1002 0x55 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1_000, &mut payment_id); },
1004 0x58 => { send_payment(&nodes[0], &nodes[1], chan_a, 100, &mut payment_id); },
1005 0x59 => { send_payment(&nodes[1], &nodes[0], chan_a, 100, &mut payment_id); },
1006 0x5a => { send_payment(&nodes[1], &nodes[2], chan_b, 100, &mut payment_id); },
1007 0x5b => { send_payment(&nodes[2], &nodes[1], chan_b, 100, &mut payment_id); },
1008 0x5c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 100, &mut payment_id); },
1009 0x5d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 100, &mut payment_id); },
1011 0x60 => { send_payment(&nodes[0], &nodes[1], chan_a, 10, &mut payment_id); },
1012 0x61 => { send_payment(&nodes[1], &nodes[0], chan_a, 10, &mut payment_id); },
1013 0x62 => { send_payment(&nodes[1], &nodes[2], chan_b, 10, &mut payment_id); },
1014 0x63 => { send_payment(&nodes[2], &nodes[1], chan_b, 10, &mut payment_id); },
1015 0x64 => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 10, &mut payment_id); },
1016 0x65 => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 10, &mut payment_id); },
1018 0x68 => { send_payment(&nodes[0], &nodes[1], chan_a, 1, &mut payment_id); },
1019 0x69 => { send_payment(&nodes[1], &nodes[0], chan_a, 1, &mut payment_id); },
1020 0x6a => { send_payment(&nodes[1], &nodes[2], chan_b, 1, &mut payment_id); },
1021 0x6b => { send_payment(&nodes[2], &nodes[1], chan_b, 1, &mut payment_id); },
1022 0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
1023 0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },
1026 // Test that no channel is in a stuck state where neither party can send funds even
1027 // after we resolve all pending events.
1028 // First make sure there are no pending monitor updates, resetting the error state
1029 // and calling channel_monitor_updated for each monitor.
1030 *monitor_a.update_ret.lock().unwrap() = Ok(());
1031 *monitor_b.update_ret.lock().unwrap() = Ok(());
1032 *monitor_c.update_ret.lock().unwrap() = Ok(());
1034 if let Some((id, _)) = monitor_a.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1035 nodes[0].channel_monitor_updated(&chan_1_funding, *id);
1037 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_1_funding) {
1038 nodes[1].channel_monitor_updated(&chan_1_funding, *id);
1040 if let Some((id, _)) = monitor_b.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1041 nodes[1].channel_monitor_updated(&chan_2_funding, *id);
1043 if let Some((id, _)) = monitor_c.latest_monitors.lock().unwrap().get(&chan_2_funding) {
1044 nodes[2].channel_monitor_updated(&chan_2_funding, *id);
1047 // Next, make sure peers are all connected to each other
1048 if chan_a_disconnected {
1049 nodes[0].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
1050 nodes[1].peer_connected(&nodes[0].get_our_node_id(), &Init { features: InitFeatures::known() });
1051 chan_a_disconnected = false;
1053 if chan_b_disconnected {
1054 nodes[1].peer_connected(&nodes[2].get_our_node_id(), &Init { features: InitFeatures::known() });
1055 nodes[2].peer_connected(&nodes[1].get_our_node_id(), &Init { features: InitFeatures::known() });
1056 chan_b_disconnected = false;
1059 for i in 0..std::usize::MAX {
1060 if i == 100 { panic!("It may take may iterations to settle the state, but it should not take forever"); }
1061 // Then, make sure any current forwards make their way to their destination
1062 if process_msg_events!(0, false, ProcessMessages::AllMessages) { continue; }
1063 if process_msg_events!(1, false, ProcessMessages::AllMessages) { continue; }
1064 if process_msg_events!(2, false, ProcessMessages::AllMessages) { continue; }
1065 // ...making sure any pending PendingHTLCsForwardable events are handled and
1066 // payments claimed.
1067 if process_events!(0, false) { continue; }
1068 if process_events!(1, false) { continue; }
1069 if process_events!(2, false) { continue; }
1073 // Finally, make sure that at least one end of each channel can make a substantial payment.
1075 send_payment(&nodes[0], &nodes[1], chan_a, 10_000_000, &mut payment_id) ||
1076 send_payment(&nodes[1], &nodes[0], chan_a, 10_000_000, &mut payment_id));
1078 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
1079 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));
1081 _ => test_return!(),
1084 node_a_ser.0.clear();
1085 nodes[0].write(&mut node_a_ser).unwrap();
1086 monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
1087 node_b_ser.0.clear();
1088 nodes[1].write(&mut node_b_ser).unwrap();
1089 monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
1090 node_c_ser.0.clear();
1091 nodes[2].write(&mut node_c_ser).unwrap();
1092 monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
1096 pub fn chanmon_consistency_test<Out: test_logger::Output>(data: &[u8], out: Out) {
1101 pub extern "C" fn chanmon_consistency_run(data: *const u8, datalen: usize) {
1102 do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull{});