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 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
11 //! nodes for functional tests.
13 use chain::{BestBlock, Confirm, Listen, Watch};
14 use chain::channelmonitor::ChannelMonitor;
15 use chain::transaction::OutPoint;
16 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
17 use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, PaymentId};
18 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
19 use routing::router::{PaymentParameters, Route, get_route};
20 use ln::features::{InitFeatures, InvoiceFeatures};
22 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
23 use util::enforcing_trait_impls::EnforcingSigner;
25 use util::test_utils::{panicking, TestChainMonitor};
26 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
27 use util::errors::APIError;
28 use util::config::UserConfig;
29 use util::ser::{ReadableArgs, Writeable, Readable};
31 use bitcoin::blockdata::block::{Block, BlockHeader};
32 use bitcoin::blockdata::constants::genesis_block;
33 use bitcoin::blockdata::transaction::{Transaction, TxOut};
34 use bitcoin::network::constants::Network;
36 use bitcoin::hash_types::BlockHash;
38 use bitcoin::secp256k1::key::PublicKey;
42 use core::cell::RefCell;
44 use sync::{Arc, Mutex};
47 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
49 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
50 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
51 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
52 confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
53 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
55 /// Mine a signle block containing the given transaction
56 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
57 let height = node.best_block_info().1 + 1;
58 confirm_transaction_at(node, tx, height);
60 /// Mine the given transaction at the given height, mining blocks as required to build to that
62 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
63 let first_connect_height = node.best_block_info().1 + 1;
64 assert!(first_connect_height <= conf_height);
65 if conf_height > first_connect_height {
66 connect_blocks(node, conf_height - first_connect_height);
68 let mut block = Block {
69 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: conf_height, bits: 42, nonce: 42 },
72 for _ in 0..*node.network_chan_count.borrow() { // Make sure we don't end up with channels at the same short id by offsetting by chan_count
73 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
75 block.txdata.push(tx.clone());
76 connect_block(node, &block);
79 /// The possible ways we may notify a ChannelManager of a new block
80 #[derive(Clone, Copy, PartialEq)]
81 pub enum ConnectStyle {
82 /// Calls best_block_updated first, detecting transactions in the block only after receiving the
83 /// header and height information.
85 /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
86 /// make a single best_block_updated call.
87 BestBlockFirstSkippingBlocks,
88 /// Calls transactions_confirmed first, detecting transactions in the block before updating the
89 /// header and height information.
91 /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
92 /// make a single best_block_updated call.
93 TransactionsFirstSkippingBlocks,
94 /// Provides the full block via the chain::Listen interface. In the current code this is
95 /// equivalent to TransactionsFirst with some additional assertions.
99 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
100 let skip_intermediaries = match *node.connect_style.borrow() {
101 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
105 let height = node.best_block_info().1 + 1;
106 let mut block = Block {
107 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: height, bits: 42, nonce: 42 },
112 do_connect_block(node, &block, skip_intermediaries);
114 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: height + i, bits: 42, nonce: 42 },
118 connect_block(node, &block);
119 block.header.block_hash()
122 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
123 do_connect_block(node, block, false);
126 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
127 // Ensure `get_claimable_balances`' self-tests never panic
128 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
129 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
133 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
134 call_claimable_balances(node);
135 let height = node.best_block_info().1 + 1;
136 if !skip_intermediaries {
137 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
138 match *node.connect_style.borrow() {
139 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
140 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
141 call_claimable_balances(node);
142 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
143 node.node.best_block_updated(&block.header, height);
144 node.node.transactions_confirmed(&block.header, &txdata, height);
146 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
147 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
148 call_claimable_balances(node);
149 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
150 node.node.transactions_confirmed(&block.header, &txdata, height);
151 node.node.best_block_updated(&block.header, height);
153 ConnectStyle::FullBlockViaListen => {
154 node.chain_monitor.chain_monitor.block_connected(&block, height);
155 node.node.block_connected(&block, height);
159 call_claimable_balances(node);
160 node.node.test_process_background_events();
161 node.blocks.lock().unwrap().push((block.header, height));
164 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
165 call_claimable_balances(node);
167 let orig_header = node.blocks.lock().unwrap().pop().unwrap();
168 assert!(orig_header.1 > 0); // Cannot disconnect genesis
169 let prev_header = node.blocks.lock().unwrap().last().unwrap().clone();
171 match *node.connect_style.borrow() {
172 ConnectStyle::FullBlockViaListen => {
173 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
174 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
176 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
178 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
179 node.node.best_block_updated(&prev_header.0, prev_header.1);
183 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
184 node.node.best_block_updated(&prev_header.0, prev_header.1);
187 call_claimable_balances(node);
191 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
192 let count = node.blocks.lock().unwrap().len() as u32 - 1;
193 disconnect_blocks(node, count);
196 pub struct TestChanMonCfg {
197 pub tx_broadcaster: test_utils::TestBroadcaster,
198 pub fee_estimator: test_utils::TestFeeEstimator,
199 pub chain_source: test_utils::TestChainSource,
200 pub persister: test_utils::TestPersister,
201 pub logger: test_utils::TestLogger,
202 pub keys_manager: test_utils::TestKeysInterface,
203 pub network_graph: NetworkGraph,
206 pub struct NodeCfg<'a> {
207 pub chain_source: &'a test_utils::TestChainSource,
208 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
209 pub fee_estimator: &'a test_utils::TestFeeEstimator,
210 pub chain_monitor: test_utils::TestChainMonitor<'a>,
211 pub keys_manager: &'a test_utils::TestKeysInterface,
212 pub logger: &'a test_utils::TestLogger,
213 pub network_graph: &'a NetworkGraph,
214 pub node_seed: [u8; 32],
215 pub features: InitFeatures,
218 pub struct Node<'a, 'b: 'a, 'c: 'b> {
219 pub chain_source: &'c test_utils::TestChainSource,
220 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
221 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
222 pub keys_manager: &'b test_utils::TestKeysInterface,
223 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
224 pub network_graph: &'c NetworkGraph,
225 pub net_graph_msg_handler: NetGraphMsgHandler<&'c NetworkGraph, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
226 pub node_seed: [u8; 32],
227 pub network_payment_count: Rc<RefCell<u8>>,
228 pub network_chan_count: Rc<RefCell<u32>>,
229 pub logger: &'c test_utils::TestLogger,
230 pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
231 pub connect_style: Rc<RefCell<ConnectStyle>>,
233 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
234 pub fn best_block_hash(&self) -> BlockHash {
235 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
237 pub fn best_block_info(&self) -> (BlockHash, u32) {
238 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
240 pub fn get_block_header(&self, height: u32) -> BlockHeader {
241 self.blocks.lock().unwrap()[height as usize].0
245 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
248 // Check that we processed all pending events
249 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
250 assert!(self.node.get_and_clear_pending_events().is_empty());
251 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
253 // Check that if we serialize the Router, we can deserialize it again.
255 let mut w = test_utils::TestVecWriter(Vec::new());
256 self.network_graph.write(&mut w).unwrap();
257 let network_graph_deser = <NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap();
258 assert!(network_graph_deser == *self.network_graph);
259 let net_graph_msg_handler = NetGraphMsgHandler::new(
260 &network_graph_deser, Some(self.chain_source), self.logger
262 let mut chan_progress = 0;
264 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
265 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
266 assert!(orig_announcements == deserialized_announcements);
267 chan_progress = match orig_announcements.last() {
268 Some(announcement) => announcement.0.contents.short_channel_id + 1,
272 let mut node_progress = None;
274 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
275 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
276 assert!(orig_announcements == deserialized_announcements);
277 node_progress = match orig_announcements.last() {
278 Some(announcement) => Some(announcement.contents.node_id),
284 // Check that if we serialize and then deserialize all our channel monitors we get the
285 // same set of outputs to watch for on chain as we have now. Note that if we write
286 // tests that fully close channels and remove the monitors at some point this may break.
287 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
288 let mut deserialized_monitors = Vec::new();
290 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
291 let mut w = test_utils::TestVecWriter(Vec::new());
292 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
293 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
294 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
295 deserialized_monitors.push(deserialized_monitor);
299 // Before using all the new monitors to check the watch outpoints, use the full set of
300 // them to ensure we can write and reload our ChannelManager.
302 let mut channel_monitors = HashMap::new();
303 for monitor in deserialized_monitors.iter_mut() {
304 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
307 let mut w = test_utils::TestVecWriter(Vec::new());
308 self.node.write(&mut w).unwrap();
309 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(w.0), ChannelManagerReadArgs {
310 default_config: *self.node.get_current_default_configuration(),
311 keys_manager: self.keys_manager,
312 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
313 chain_monitor: self.chain_monitor,
314 tx_broadcaster: &test_utils::TestBroadcaster {
315 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
316 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
318 logger: &self.logger,
323 let persister = test_utils::TestPersister::new();
324 let broadcaster = test_utils::TestBroadcaster {
325 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
326 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
328 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
329 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
330 for deserialized_monitor in deserialized_monitors.drain(..) {
331 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
335 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
336 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
341 pub fn create_chan_between_nodes<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
342 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
345 pub fn create_chan_between_nodes_with_value<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
346 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
347 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
348 (announcement, as_update, bs_update, channel_id, tx)
352 /// Gets an RAA and CS which were sent in response to a commitment update
353 macro_rules! get_revoke_commit_msgs {
354 ($node: expr, $node_id: expr) => {
356 use $crate::util::events::MessageSendEvent;
357 let events = $node.node.get_and_clear_pending_msg_events();
358 assert_eq!(events.len(), 2);
360 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
361 assert_eq!(*node_id, $node_id);
364 _ => panic!("Unexpected event"),
366 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
367 assert_eq!(*node_id, $node_id);
368 assert!(updates.update_add_htlcs.is_empty());
369 assert!(updates.update_fulfill_htlcs.is_empty());
370 assert!(updates.update_fail_htlcs.is_empty());
371 assert!(updates.update_fail_malformed_htlcs.is_empty());
372 assert!(updates.update_fee.is_none());
373 updates.commitment_signed.clone()
375 _ => panic!("Unexpected event"),
381 /// Get an specific event message from the pending events queue.
383 macro_rules! get_event_msg {
384 ($node: expr, $event_type: path, $node_id: expr) => {
386 let events = $node.node.get_and_clear_pending_msg_events();
387 assert_eq!(events.len(), 1);
389 $event_type { ref node_id, ref msg } => {
390 assert_eq!(*node_id, $node_id);
393 _ => panic!("Unexpected event"),
399 /// Get a specific event from the pending events queue.
401 macro_rules! get_event {
402 ($node: expr, $event_type: path) => {
404 let mut events = $node.node.get_and_clear_pending_events();
405 assert_eq!(events.len(), 1);
406 let ev = events.pop().unwrap();
408 $event_type { .. } => {
411 _ => panic!("Unexpected event"),
418 /// Gets an UpdateHTLCs MessageSendEvent
419 macro_rules! get_htlc_update_msgs {
420 ($node: expr, $node_id: expr) => {
422 let events = $node.node.get_and_clear_pending_msg_events();
423 assert_eq!(events.len(), 1);
425 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
426 assert_eq!(*node_id, $node_id);
429 _ => panic!("Unexpected event"),
436 macro_rules! get_channel_ref {
437 ($node: expr, $lock: ident, $channel_id: expr) => {
439 $lock = $node.node.channel_state.lock().unwrap();
440 $lock.by_id.get_mut(&$channel_id).unwrap()
446 macro_rules! get_feerate {
447 ($node: expr, $channel_id: expr) => {
450 let chan = get_channel_ref!($node, lock, $channel_id);
457 macro_rules! get_opt_anchors {
458 ($node: expr, $channel_id: expr) => {
461 let chan = get_channel_ref!($node, lock, $channel_id);
467 /// Returns a channel monitor given a channel id, making some naive assumptions
469 macro_rules! get_monitor {
470 ($node: expr, $channel_id: expr) => {
472 use bitcoin::hashes::Hash;
473 let mut monitor = None;
474 // Assume funding vout is either 0 or 1 blindly
476 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
477 $crate::chain::transaction::OutPoint {
478 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
490 /// Returns any local commitment transactions for the channel.
492 macro_rules! get_local_commitment_txn {
493 ($node: expr, $channel_id: expr) => {
495 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
500 /// Check the error from attempting a payment.
502 macro_rules! unwrap_send_err {
503 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
505 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
506 assert_eq!(fails.len(), 1);
512 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
513 assert_eq!(results.len(), 1);
515 Err($type) => { $check },
524 /// Check whether N channel monitor(s) have been added.
526 macro_rules! check_added_monitors {
527 ($node: expr, $count: expr) => {
529 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
530 assert_eq!(added_monitors.len(), $count);
531 added_monitors.clear();
536 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, expected_chan_value: u64, expected_user_chan_id: u64) -> ([u8; 32], Transaction, OutPoint) {
537 let chan_id = *node.network_chan_count.borrow();
539 let events = node.node.get_and_clear_pending_events();
540 assert_eq!(events.len(), 1);
542 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
543 assert_eq!(*channel_value_satoshis, expected_chan_value);
544 assert_eq!(user_channel_id, expected_user_chan_id);
546 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
547 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
549 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
550 (*temporary_channel_id, tx, funding_outpoint)
552 _ => panic!("Unexpected event"),
555 pub fn sign_funding_transaction<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, channel_value: u64, expected_temporary_channel_id: [u8; 32]) -> Transaction {
556 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
557 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
559 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_ok());
560 check_added_monitors!(node_a, 0);
562 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
563 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
564 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
566 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
567 assert_eq!(added_monitors.len(), 1);
568 assert_eq!(added_monitors[0].0, funding_output);
569 added_monitors.clear();
572 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id()));
574 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
575 assert_eq!(added_monitors.len(), 1);
576 assert_eq!(added_monitors[0].0, funding_output);
577 added_monitors.clear();
580 let events_4 = node_a.node.get_and_clear_pending_events();
581 assert_eq!(events_4.len(), 0);
583 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
584 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
585 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
587 // Ensure that funding_transaction_generated is idempotent.
588 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_err());
589 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
590 check_added_monitors!(node_a, 0);
595 pub fn create_chan_between_nodes_with_value_init<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> Transaction {
596 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
597 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
598 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
599 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
600 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
601 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
602 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
604 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
607 pub fn create_chan_between_nodes_with_value_confirm_first<'a, 'b, 'c, 'd>(node_recv: &'a Node<'b, 'c, 'c>, node_conf: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
608 confirm_transaction_at(node_conf, tx, conf_height);
609 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
610 node_recv.node.handle_funding_locked(&node_conf.node.get_our_node_id(), &get_event_msg!(node_conf, MessageSendEvent::SendFundingLocked, node_recv.node.get_our_node_id()));
613 pub fn create_chan_between_nodes_with_value_confirm_second<'a, 'b, 'c>(node_recv: &Node<'a, 'b, 'c>, node_conf: &Node<'a, 'b, 'c>) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
615 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
616 assert_eq!(events_6.len(), 3);
617 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
618 assert_eq!(*node_id, node_recv.node.get_our_node_id());
620 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
621 assert_eq!(*node_id, node_recv.node.get_our_node_id());
623 } else { panic!("Unexpected event: {:?}", events_6[1]); };
624 ((match events_6[0] {
625 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
626 channel_id = msg.channel_id.clone();
627 assert_eq!(*node_id, node_recv.node.get_our_node_id());
630 _ => panic!("Unexpected event"),
631 }, match events_6[announcement_sigs_idx] {
632 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
633 assert_eq!(*node_id, node_recv.node.get_our_node_id());
636 _ => panic!("Unexpected event"),
640 pub fn create_chan_between_nodes_with_value_confirm<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
641 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
642 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
643 confirm_transaction_at(node_a, tx, conf_height);
644 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
645 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
648 pub fn create_chan_between_nodes_with_value_a<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
649 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
650 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
654 pub fn create_chan_between_nodes_with_value_b<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, as_funding_msgs: &(msgs::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
655 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
656 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
657 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
659 let events_7 = node_b.node.get_and_clear_pending_msg_events();
660 assert_eq!(events_7.len(), 1);
661 let (announcement, bs_update) = match events_7[0] {
662 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
665 _ => panic!("Unexpected event"),
668 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
669 let events_8 = node_a.node.get_and_clear_pending_msg_events();
670 assert_eq!(events_8.len(), 1);
671 let as_update = match events_8[0] {
672 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
673 assert!(*announcement == *msg);
674 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
675 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
678 _ => panic!("Unexpected event"),
681 *node_a.network_chan_count.borrow_mut() += 1;
683 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
686 pub fn create_announced_chan_between_nodes<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
687 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
690 pub fn create_announced_chan_between_nodes_with_value<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
691 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
692 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
693 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
696 pub fn create_unannounced_chan_between_nodes_with_value<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::FundingLocked, Transaction) {
697 let mut no_announce_cfg = test_default_channel_config();
698 no_announce_cfg.channel_options.announced_channel = false;
699 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
700 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
701 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), a_flags, &open_channel);
702 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
703 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), b_flags, &accept_channel);
705 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], channel_value, 42);
706 nodes[a].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
707 nodes[b].node.handle_funding_created(&nodes[a].node.get_our_node_id(), &get_event_msg!(nodes[a], MessageSendEvent::SendFundingCreated, nodes[b].node.get_our_node_id()));
708 check_added_monitors!(nodes[b], 1);
710 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
711 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
712 check_added_monitors!(nodes[a], 1);
714 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
715 confirm_transaction_at(&nodes[a], &tx, conf_height);
716 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
717 confirm_transaction_at(&nodes[b], &tx, conf_height);
718 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
719 let as_funding_locked = get_event_msg!(nodes[a], MessageSendEvent::SendFundingLocked, nodes[b].node.get_our_node_id());
720 nodes[a].node.handle_funding_locked(&nodes[b].node.get_our_node_id(), &get_event_msg!(nodes[b], MessageSendEvent::SendFundingLocked, nodes[a].node.get_our_node_id()));
721 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
722 nodes[b].node.handle_funding_locked(&nodes[a].node.get_our_node_id(), &as_funding_locked);
723 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
725 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
726 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
728 let mut found_a = false;
729 for chan in nodes[a].node.list_usable_channels() {
730 if chan.channel_id == as_funding_locked.channel_id {
733 assert!(!chan.is_public);
738 let mut found_b = false;
739 for chan in nodes[b].node.list_usable_channels() {
740 if chan.channel_id == as_funding_locked.channel_id {
743 assert!(!chan.is_public);
748 (as_funding_locked, tx)
751 pub fn update_nodes_with_chan_announce<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize, ann: &msgs::ChannelAnnouncement, upd_1: &msgs::ChannelUpdate, upd_2: &msgs::ChannelUpdate) {
752 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
753 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
754 assert!(a_events.len() >= 2);
756 // ann should be re-generated by broadcast_node_announcement - check that we have it.
757 let mut found_ann_1 = false;
758 for event in a_events.iter() {
760 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
761 if msg == ann { found_ann_1 = true; }
763 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
764 _ => panic!("Unexpected event {:?}", event),
767 assert!(found_ann_1);
769 let a_node_announcement = match a_events.last().unwrap() {
770 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
773 _ => panic!("Unexpected event"),
776 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
777 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
778 assert!(b_events.len() >= 2);
780 // ann should be re-generated by broadcast_node_announcement - check that we have it.
781 let mut found_ann_2 = false;
782 for event in b_events.iter() {
784 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
785 if msg == ann { found_ann_2 = true; }
787 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
788 _ => panic!("Unexpected event"),
791 assert!(found_ann_2);
793 let b_node_announcement = match b_events.last().unwrap() {
794 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
797 _ => panic!("Unexpected event"),
801 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
802 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
803 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
804 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
805 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
807 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
808 // forwarding info for local channels even if its not accepted in the network graph.
809 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
810 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
815 macro_rules! check_spends {
816 ($tx: expr, $($spends_txn: expr),*) => {
819 for outp in $spends_txn.output.iter() {
820 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Input tx output didn't meet dust limit");
823 for outp in $tx.output.iter() {
824 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Spending tx output didn't meet dust limit");
826 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
828 if out_point.txid == $spends_txn.txid() {
829 return $spends_txn.output.get(out_point.vout as usize).cloned()
834 let mut total_value_in = 0;
835 for input in $tx.input.iter() {
836 total_value_in += get_output(&input.previous_output).unwrap().value;
838 let mut total_value_out = 0;
839 for output in $tx.output.iter() {
840 total_value_out += output.value;
842 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
843 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
844 assert!(total_value_out + min_fee <= total_value_in);
845 $tx.verify(get_output).unwrap();
850 macro_rules! get_closing_signed_broadcast {
851 ($node: expr, $dest_pubkey: expr) => {
853 let events = $node.get_and_clear_pending_msg_events();
854 assert!(events.len() == 1 || events.len() == 2);
855 (match events[events.len() - 1] {
856 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
857 assert_eq!(msg.contents.flags & 2, 2);
860 _ => panic!("Unexpected event"),
861 }, if events.len() == 2 {
863 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
864 assert_eq!(*node_id, $dest_pubkey);
867 _ => panic!("Unexpected event"),
875 macro_rules! check_warn_msg {
876 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
877 let msg_events = $node.node.get_and_clear_pending_msg_events();
878 assert_eq!(msg_events.len(), 1);
879 match msg_events[0] {
880 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
881 assert_eq!(node_id, $recipient_node_id);
882 assert_eq!(msg.channel_id, $chan_id);
885 _ => panic!("Unexpected event"),
890 /// Check that a channel's closing channel update has been broadcasted, and optionally
891 /// check whether an error message event has occurred.
893 macro_rules! check_closed_broadcast {
894 ($node: expr, $with_error_msg: expr) => {{
895 use $crate::util::events::MessageSendEvent;
896 use $crate::ln::msgs::ErrorAction;
898 let msg_events = $node.node.get_and_clear_pending_msg_events();
899 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
900 match msg_events[0] {
901 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
902 assert_eq!(msg.contents.flags & 2, 2);
904 _ => panic!("Unexpected event"),
907 match msg_events[1] {
908 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
909 // TODO: Check node_id
912 _ => panic!("Unexpected event"),
918 /// Check that a channel's closing channel events has been issued
920 macro_rules! check_closed_event {
921 ($node: expr, $events: expr, $reason: expr) => {
922 check_closed_event!($node, $events, $reason, false);
924 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
925 use $crate::util::events::Event;
927 let events = $node.node.get_and_clear_pending_events();
928 assert_eq!(events.len(), $events);
929 let expected_reason = $reason;
930 let mut issues_discard_funding = false;
931 for event in events {
933 Event::ChannelClosed { ref reason, .. } => {
934 assert_eq!(*reason, expected_reason);
936 Event::DiscardFunding { .. } => {
937 issues_discard_funding = true;
939 _ => panic!("Unexpected event"),
942 assert_eq!($is_check_discard_funding, issues_discard_funding);
946 pub fn close_channel<'a, 'b, 'c>(outbound_node: &Node<'a, 'b, 'c>, inbound_node: &Node<'a, 'b, 'c>, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
947 let (node_a, broadcaster_a, struct_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster, inbound_node) } else { (&outbound_node.node, &outbound_node.tx_broadcaster, outbound_node) };
948 let (node_b, broadcaster_b, struct_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster, outbound_node) } else { (&inbound_node.node, &inbound_node.tx_broadcaster, inbound_node) };
951 node_a.close_channel(channel_id).unwrap();
952 node_b.handle_shutdown(&node_a.get_our_node_id(), &InitFeatures::known(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
954 let events_1 = node_b.get_and_clear_pending_msg_events();
955 assert!(events_1.len() >= 1);
956 let shutdown_b = match events_1[0] {
957 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
958 assert_eq!(node_id, &node_a.get_our_node_id());
961 _ => panic!("Unexpected event"),
964 let closing_signed_b = if !close_inbound_first {
965 assert_eq!(events_1.len(), 1);
968 Some(match events_1[1] {
969 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
970 assert_eq!(node_id, &node_a.get_our_node_id());
973 _ => panic!("Unexpected event"),
977 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
978 let (as_update, bs_update) = if close_inbound_first {
979 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
980 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
982 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
983 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
984 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
985 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
987 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
988 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
989 assert!(none_a.is_none());
990 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
991 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
992 (as_update, bs_update)
994 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
996 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
997 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
999 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1000 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1001 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1003 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1004 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1005 assert!(none_b.is_none());
1006 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1007 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1008 (as_update, bs_update)
1010 assert_eq!(tx_a, tx_b);
1011 check_spends!(tx_a, funding_tx);
1013 (as_update, bs_update, tx_a)
1016 pub struct SendEvent {
1017 pub node_id: PublicKey,
1018 pub msgs: Vec<msgs::UpdateAddHTLC>,
1019 pub commitment_msg: msgs::CommitmentSigned,
1022 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1023 assert!(updates.update_fulfill_htlcs.is_empty());
1024 assert!(updates.update_fail_htlcs.is_empty());
1025 assert!(updates.update_fail_malformed_htlcs.is_empty());
1026 assert!(updates.update_fee.is_none());
1027 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1030 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1032 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1033 _ => panic!("Unexpected event type!"),
1037 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1038 let mut events = node.node.get_and_clear_pending_msg_events();
1039 assert_eq!(events.len(), 1);
1040 SendEvent::from_event(events.pop().unwrap())
1045 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1046 /// commitment update.
1047 macro_rules! commitment_signed_dance {
1048 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1050 check_added_monitors!($node_a, 0);
1051 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1052 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1053 check_added_monitors!($node_a, 1);
1054 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1057 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1059 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1060 check_added_monitors!($node_b, 0);
1061 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1062 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1063 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1064 check_added_monitors!($node_b, 1);
1065 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1066 let (bs_revoke_and_ack, extra_msg_option) = {
1067 let events = $node_b.node.get_and_clear_pending_msg_events();
1068 assert!(events.len() <= 2);
1070 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1071 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1074 _ => panic!("Unexpected event"),
1075 }, events.get(1).map(|e| e.clone()))
1077 check_added_monitors!($node_b, 1);
1078 if $fail_backwards {
1079 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1080 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1082 (extra_msg_option, bs_revoke_and_ack)
1085 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1087 check_added_monitors!($node_a, 0);
1088 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1089 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1090 check_added_monitors!($node_a, 1);
1091 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1092 assert!(extra_msg_option.is_none());
1096 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1098 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1099 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1100 check_added_monitors!($node_a, 1);
1104 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1106 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1109 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1111 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1112 if $fail_backwards {
1113 $crate::expect_pending_htlcs_forwardable!($node_a);
1114 check_added_monitors!($node_a, 1);
1116 let channel_state = $node_a.node.channel_state.lock().unwrap();
1117 assert_eq!(channel_state.pending_msg_events.len(), 1);
1118 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1119 assert_ne!(*node_id, $node_b.node.get_our_node_id());
1120 } else { panic!("Unexpected event"); }
1122 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1128 /// Get a payment preimage and hash.
1130 macro_rules! get_payment_preimage_hash {
1131 ($dest_node: expr) => {
1133 get_payment_preimage_hash!($dest_node, None)
1136 ($dest_node: expr, $min_value_msat: expr) => {
1138 use bitcoin::hashes::Hash as _;
1139 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1140 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1141 *payment_count += 1;
1142 let payment_hash = $crate::ln::PaymentHash(
1143 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1144 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1145 (payment_preimage, payment_hash, payment_secret)
1152 macro_rules! get_route_and_payment_hash {
1153 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1154 $crate::get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
1156 ($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
1157 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1158 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1159 .with_features($crate::ln::features::InvoiceFeatures::known())
1160 .with_route_hints($last_hops);
1161 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1162 let route = $crate::routing::router::get_route(
1163 &$send_node.node.get_our_node_id(), &payment_params, $send_node.network_graph,
1164 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1165 $recv_value, $cltv, $send_node.logger, &scorer
1167 (route, payment_hash, payment_preimage, payment_secret)
1172 /// Clears (and ignores) a PendingHTLCsForwardable event
1173 macro_rules! expect_pending_htlcs_forwardable_ignore {
1175 let events = $node.node.get_and_clear_pending_events();
1176 assert_eq!(events.len(), 1);
1178 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1179 _ => panic!("Unexpected event"),
1185 /// Handles a PendingHTLCsForwardable event
1186 macro_rules! expect_pending_htlcs_forwardable {
1188 $crate::expect_pending_htlcs_forwardable_ignore!($node);
1189 $node.node.process_pending_htlc_forwards();
1191 // Ensure process_pending_htlc_forwards is idempotent.
1192 $node.node.process_pending_htlc_forwards();
1197 macro_rules! expect_pending_htlcs_forwardable_from_events {
1198 ($node: expr, $events: expr, $ignore: expr) => {{
1199 assert_eq!($events.len(), 1);
1201 Event::PendingHTLCsForwardable { .. } => { },
1202 _ => panic!("Unexpected event"),
1205 $node.node.process_pending_htlc_forwards();
1207 // Ensure process_pending_htlc_forwards is idempotent.
1208 $node.node.process_pending_htlc_forwards();
1214 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1215 macro_rules! expect_payment_received {
1216 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1217 expect_payment_received!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None)
1219 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr) => {
1220 let events = $node.node.get_and_clear_pending_events();
1221 assert_eq!(events.len(), 1);
1223 $crate::util::events::Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1224 assert_eq!($expected_payment_hash, *payment_hash);
1225 assert_eq!($expected_recv_value, amt);
1227 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1228 assert_eq!(&$expected_payment_preimage, payment_preimage);
1229 assert_eq!($expected_payment_secret, *payment_secret);
1234 _ => panic!("Unexpected event"),
1241 macro_rules! expect_payment_sent_without_paths {
1242 ($node: expr, $expected_payment_preimage: expr) => {
1243 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1245 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1246 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1251 macro_rules! expect_payment_sent {
1252 ($node: expr, $expected_payment_preimage: expr) => {
1253 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1255 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1256 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1258 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1259 use bitcoin::hashes::Hash as _;
1260 let events = $node.node.get_and_clear_pending_events();
1261 let expected_payment_hash = $crate::ln::PaymentHash(
1262 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1264 assert!(events.len() > 1);
1266 assert_eq!(events.len(), 1);
1268 let expected_payment_id = match events[0] {
1269 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1270 assert_eq!($expected_payment_preimage, *payment_preimage);
1271 assert_eq!(expected_payment_hash, *payment_hash);
1272 assert!(fee_paid_msat.is_some());
1273 if $expected_fee_msat_opt.is_some() {
1274 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1278 _ => panic!("Unexpected event"),
1281 for i in 1..events.len() {
1283 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1284 assert_eq!(payment_id, expected_payment_id);
1285 assert_eq!(payment_hash, Some(expected_payment_hash));
1287 _ => panic!("Unexpected event"),
1296 macro_rules! expect_payment_path_successful {
1298 let events = $node.node.get_and_clear_pending_events();
1299 assert_eq!(events.len(), 1);
1301 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1302 _ => panic!("Unexpected event"),
1307 macro_rules! expect_payment_forwarded {
1308 ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1309 let events = $node.node.get_and_clear_pending_events();
1310 assert_eq!(events.len(), 1);
1312 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1313 assert_eq!(fee_earned_msat, $expected_fee);
1314 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1316 _ => panic!("Unexpected event"),
1321 pub struct PaymentFailedConditions<'a> {
1322 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1323 pub(crate) expected_blamed_scid: Option<u64>,
1324 pub(crate) expected_blamed_chan_closed: Option<bool>,
1325 pub(crate) expected_mpp_parts_remain: bool,
1328 impl<'a> PaymentFailedConditions<'a> {
1329 pub fn new() -> Self {
1331 expected_htlc_error_data: None,
1332 expected_blamed_scid: None,
1333 expected_blamed_chan_closed: None,
1334 expected_mpp_parts_remain: false,
1337 pub fn mpp_parts_remain(mut self) -> Self {
1338 self.expected_mpp_parts_remain = true;
1341 pub fn blamed_scid(mut self, scid: u64) -> Self {
1342 self.expected_blamed_scid = Some(scid);
1345 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1346 self.expected_blamed_chan_closed = Some(closed);
1349 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1350 self.expected_htlc_error_data = Some((code, data));
1356 macro_rules! expect_payment_failed_with_update {
1357 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1358 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest,
1359 $crate::ln::functional_test_utils::PaymentFailedConditions::new().blamed_scid($scid).blamed_chan_closed($chan_closed));
1364 macro_rules! expect_payment_failed {
1365 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1366 #[allow(unused_mut)]
1367 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1369 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1371 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest, conditions);
1376 macro_rules! expect_payment_failed_conditions {
1377 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $conditions: expr) => {
1378 let events = $node.node.get_and_clear_pending_events();
1379 assert_eq!(events.len(), 1);
1380 let expected_payment_id = match events[0] {
1381 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data, ref path, ref retry, ref payment_id, ref network_update, .. } => {
1382 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1383 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1384 assert!(retry.is_some(), "expected retry.is_some()");
1385 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1386 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1388 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1389 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1390 if let Some((code, data)) = $conditions.expected_htlc_error_data {
1391 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1392 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1395 if let Some(chan_closed) = $conditions.expected_blamed_chan_closed {
1396 match network_update {
1397 &Some($crate::routing::network_graph::NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1398 if let Some(scid) = $conditions.expected_blamed_scid {
1399 assert_eq!(msg.contents.short_channel_id, scid);
1401 assert_eq!(msg.contents.flags & 2, 0);
1403 &Some($crate::routing::network_graph::NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if chan_closed => {
1404 if let Some(scid) = $conditions.expected_blamed_scid {
1405 assert_eq!(short_channel_id, scid);
1407 assert!(is_permanent);
1409 Some(_) => panic!("Unexpected update type"),
1410 None => panic!("Expected update"),
1416 _ => panic!("Unexpected event"),
1418 if !$conditions.expected_mpp_parts_remain {
1419 $node.node.abandon_payment(expected_payment_id);
1420 let events = $node.node.get_and_clear_pending_events();
1421 assert_eq!(events.len(), 1);
1423 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1424 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected second payment_hash");
1425 assert_eq!(*payment_id, expected_payment_id);
1427 _ => panic!("Unexpected second event"),
1433 pub fn send_along_route_with_secret<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, route: Route, expected_paths: &[&[&Node<'a, 'b, 'c>]], recv_value: u64, our_payment_hash: PaymentHash, our_payment_secret: PaymentSecret) -> PaymentId {
1434 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1435 check_added_monitors!(origin_node, expected_paths.len());
1436 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1440 pub fn pass_along_path<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], recv_value: u64, our_payment_hash: PaymentHash, our_payment_secret: Option<PaymentSecret>, ev: MessageSendEvent, payment_received_expected: bool, expected_preimage: Option<PaymentPreimage>) {
1441 let mut payment_event = SendEvent::from_event(ev);
1442 let mut prev_node = origin_node;
1444 for (idx, &node) in expected_path.iter().enumerate() {
1445 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1447 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1448 check_added_monitors!(node, 0);
1449 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1451 expect_pending_htlcs_forwardable!(node);
1453 if idx == expected_path.len() - 1 {
1454 let events_2 = node.node.get_and_clear_pending_events();
1455 if payment_received_expected {
1456 assert_eq!(events_2.len(), 1);
1458 Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1459 assert_eq!(our_payment_hash, *payment_hash);
1461 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1462 assert_eq!(expected_preimage, *payment_preimage);
1463 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1465 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1466 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1467 assert!(our_payment_secret.is_none());
1470 assert_eq!(amt, recv_value);
1472 _ => panic!("Unexpected event"),
1475 assert!(events_2.is_empty());
1478 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1479 assert_eq!(events_2.len(), 1);
1480 check_added_monitors!(node, 1);
1481 payment_event = SendEvent::from_event(events_2.remove(0));
1482 assert_eq!(payment_event.msgs.len(), 1);
1489 pub fn pass_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&[&Node<'a, 'b, 'c>]], recv_value: u64, our_payment_hash: PaymentHash, our_payment_secret: PaymentSecret) {
1490 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1491 assert_eq!(events.len(), expected_route.len());
1492 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1493 // Once we've gotten through all the HTLCs, the last one should result in a
1494 // PaymentReceived (but each previous one should not!), .
1495 let expect_payment = path_idx == expected_route.len() - 1;
1496 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1500 pub fn send_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, route: Route, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret, PaymentId) {
1501 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1502 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1503 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1506 pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_preimage: PaymentPreimage) -> u64 {
1507 for path in expected_paths.iter() {
1508 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1510 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1511 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1513 let mut expected_total_fee_msat = 0;
1515 macro_rules! msgs_from_ev {
1518 &MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
1519 assert!(update_add_htlcs.is_empty());
1520 assert_eq!(update_fulfill_htlcs.len(), 1);
1521 assert!(update_fail_htlcs.is_empty());
1522 assert!(update_fail_malformed_htlcs.is_empty());
1523 assert!(update_fee.is_none());
1524 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1526 _ => panic!("Unexpected event"),
1530 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1531 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1532 assert_eq!(events.len(), expected_paths.len());
1533 for ev in events.iter() {
1534 per_path_msgs.push(msgs_from_ev!(ev));
1537 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1538 let mut next_msgs = Some(path_msgs);
1539 let mut expected_next_node = next_hop;
1541 macro_rules! last_update_fulfill_dance {
1542 ($node: expr, $prev_node: expr) => {
1544 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1545 check_added_monitors!($node, 0);
1546 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1547 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1551 macro_rules! mid_update_fulfill_dance {
1552 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1554 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1555 let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
1556 expect_payment_forwarded!($node, Some(fee as u64), false);
1557 expected_total_fee_msat += fee as u64;
1558 check_added_monitors!($node, 1);
1559 let new_next_msgs = if $new_msgs {
1560 let events = $node.node.get_and_clear_pending_msg_events();
1561 assert_eq!(events.len(), 1);
1562 let (res, nexthop) = msgs_from_ev!(&events[0]);
1563 expected_next_node = nexthop;
1566 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1569 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1570 next_msgs = new_next_msgs;
1575 let mut prev_node = expected_route.last().unwrap();
1576 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1577 assert_eq!(expected_next_node, node.node.get_our_node_id());
1578 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1579 if next_msgs.is_some() {
1580 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1582 assert!(!update_next_msgs);
1583 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1585 if !skip_last && idx == expected_route.len() - 1 {
1586 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1593 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1597 // Ensure that claim_funds is idempotent.
1598 assert!(!expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1599 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1600 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1602 expected_total_fee_msat
1604 pub fn claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_preimage: PaymentPreimage) {
1605 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1607 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1611 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1612 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1615 pub const TEST_FINAL_CLTV: u32 = 70;
1617 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1618 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1619 .with_features(InvoiceFeatures::known());
1620 let scorer = test_utils::TestScorer::with_penalty(0);
1621 let route = get_route(
1622 &origin_node.node.get_our_node_id(), &payment_params, &origin_node.network_graph,
1623 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1624 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1625 assert_eq!(route.paths.len(), 1);
1626 assert_eq!(route.paths[0].len(), expected_route.len());
1627 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1628 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1631 let res = send_along_route(origin_node, route, expected_route, recv_value);
1632 (res.0, res.1, res.2)
1635 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1636 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1637 .with_features(InvoiceFeatures::known());
1638 let scorer = test_utils::TestScorer::with_penalty(0);
1639 let route = get_route(
1640 &origin_node.node.get_our_node_id(), &payment_params, origin_node.network_graph,
1641 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1642 assert_eq!(route.paths.len(), 1);
1643 assert_eq!(route.paths[0].len(), expected_route.len());
1644 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1645 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1648 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1649 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1650 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1653 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1654 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1655 claim_payment(&origin, expected_route, our_payment_preimage);
1658 pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
1659 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1660 for path in expected_paths.iter() {
1661 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1663 assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1664 expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1665 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1667 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1668 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1669 assert_eq!(events.len(), expected_paths.len());
1670 for ev in events.iter() {
1671 let (update_fail, commitment_signed, node_id) = match ev {
1672 &MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
1673 assert!(update_add_htlcs.is_empty());
1674 assert!(update_fulfill_htlcs.is_empty());
1675 assert_eq!(update_fail_htlcs.len(), 1);
1676 assert!(update_fail_malformed_htlcs.is_empty());
1677 assert!(update_fee.is_none());
1678 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1680 _ => panic!("Unexpected event"),
1682 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1684 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1685 expected_paths.sort_unstable_by(|path_a, path_b| path_a[path_a.len() - 2].node.get_our_node_id().cmp(&path_b[path_b.len() - 2].node.get_our_node_id()));
1687 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1688 let mut next_msgs = Some(path_msgs);
1689 let mut expected_next_node = next_hop;
1690 let mut prev_node = expected_route.last().unwrap();
1692 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1693 assert_eq!(expected_next_node, node.node.get_our_node_id());
1694 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1695 if next_msgs.is_some() {
1696 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1697 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1698 if !update_next_node {
1699 expect_pending_htlcs_forwardable!(node);
1702 let events = node.node.get_and_clear_pending_msg_events();
1703 if update_next_node {
1704 assert_eq!(events.len(), 1);
1706 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
1707 assert!(update_add_htlcs.is_empty());
1708 assert!(update_fulfill_htlcs.is_empty());
1709 assert_eq!(update_fail_htlcs.len(), 1);
1710 assert!(update_fail_malformed_htlcs.is_empty());
1711 assert!(update_fee.is_none());
1712 expected_next_node = node_id.clone();
1713 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1715 _ => panic!("Unexpected event"),
1718 assert!(events.is_empty());
1720 if !skip_last && idx == expected_route.len() - 1 {
1721 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1728 let prev_node = expected_route.first().unwrap();
1729 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1730 check_added_monitors!(origin_node, 0);
1731 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1732 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1733 let events = origin_node.node.get_and_clear_pending_events();
1734 assert_eq!(events.len(), 1);
1735 let expected_payment_id = match events[0] {
1736 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, ref payment_id, .. } => {
1737 assert_eq!(payment_hash, our_payment_hash);
1738 assert!(rejected_by_dest);
1739 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1740 for (idx, hop) in expected_route.iter().enumerate() {
1741 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1745 _ => panic!("Unexpected event"),
1747 if i == expected_paths.len() - 1 {
1748 origin_node.node.abandon_payment(expected_payment_id);
1749 let events = origin_node.node.get_and_clear_pending_events();
1750 assert_eq!(events.len(), 1);
1752 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1753 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
1754 assert_eq!(*payment_id, expected_payment_id);
1756 _ => panic!("Unexpected second event"),
1762 // Ensure that fail_htlc_backwards is idempotent.
1763 assert!(!expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1764 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
1765 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1766 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1769 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1770 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1773 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1774 let mut chan_mon_cfgs = Vec::new();
1775 for i in 0..node_count {
1776 let tx_broadcaster = test_utils::TestBroadcaster {
1777 txn_broadcasted: Mutex::new(Vec::new()),
1778 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1780 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1781 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1782 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1783 let persister = test_utils::TestPersister::new();
1784 let seed = [i as u8; 32];
1785 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1786 let network_graph = NetworkGraph::new(chain_source.genesis_hash);
1788 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, network_graph });
1794 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1795 let mut nodes = Vec::new();
1797 for i in 0..node_count {
1798 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[i].chain_source), &chanmon_cfgs[i].tx_broadcaster, &chanmon_cfgs[i].logger, &chanmon_cfgs[i].fee_estimator, &chanmon_cfgs[i].persister, &chanmon_cfgs[i].keys_manager);
1799 let seed = [i as u8; 32];
1800 nodes.push(NodeCfg {
1801 chain_source: &chanmon_cfgs[i].chain_source,
1802 logger: &chanmon_cfgs[i].logger,
1803 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1804 fee_estimator: &chanmon_cfgs[i].fee_estimator,
1806 keys_manager: &chanmon_cfgs[i].keys_manager,
1808 features: InitFeatures::known(),
1809 network_graph: &chanmon_cfgs[i].network_graph,
1816 pub fn test_default_channel_config() -> UserConfig {
1817 let mut default_config = UserConfig::default();
1818 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1819 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1820 default_config.channel_options.cltv_expiry_delta = 6*6;
1821 default_config.channel_options.announced_channel = true;
1822 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1823 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1824 // It now defaults to 1, so we simply set it to the expected value here.
1825 default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1826 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1827 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1828 default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1832 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg<'b>>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<EnforcingSigner, &'a TestChainMonitor<'b>, &'b test_utils::TestBroadcaster, &'a test_utils::TestKeysInterface, &'b test_utils::TestFeeEstimator, &'b test_utils::TestLogger>> {
1833 let mut chanmgrs = Vec::new();
1834 for i in 0..node_count {
1835 let network = Network::Testnet;
1836 let params = ChainParameters {
1838 best_block: BestBlock::from_genesis(network),
1840 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1841 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1842 chanmgrs.push(node);
1848 pub fn create_network<'a, 'b: 'a, 'c: 'b>(node_count: usize, cfgs: &'b Vec<NodeCfg<'c>>, chan_mgrs: &'a Vec<ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>>) -> Vec<Node<'a, 'b, 'c>> {
1849 let mut nodes = Vec::new();
1850 let chan_count = Rc::new(RefCell::new(0));
1851 let payment_count = Rc::new(RefCell::new(0));
1852 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1854 for i in 0..node_count {
1855 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].network_graph, None, cfgs[i].logger);
1857 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
1858 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
1859 node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, net_graph_msg_handler,
1860 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1861 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1862 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1863 connect_style: Rc::clone(&connect_style),
1867 for i in 0..node_count {
1868 for j in (i+1)..node_count {
1869 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1870 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1877 // Note that the following only works for CLTV values up to 128
1878 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1879 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1881 #[derive(PartialEq)]
1882 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1883 /// Tests that the given node has broadcast transactions for the given Channel
1885 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1886 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1887 /// broadcast and the revoked outputs were claimed.
1889 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1890 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1892 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1894 pub fn test_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
1895 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1896 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1898 let mut res = Vec::with_capacity(2);
1899 node_txn.retain(|tx| {
1900 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1901 check_spends!(tx, chan.3);
1902 if commitment_tx.is_none() {
1903 res.push(tx.clone());
1908 if let Some(explicit_tx) = commitment_tx {
1909 res.push(explicit_tx.clone());
1912 assert_eq!(res.len(), 1);
1914 if has_htlc_tx != HTLCType::NONE {
1915 node_txn.retain(|tx| {
1916 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1917 check_spends!(tx, res[0]);
1918 if has_htlc_tx == HTLCType::TIMEOUT {
1919 assert!(tx.lock_time != 0);
1921 assert!(tx.lock_time == 0);
1923 res.push(tx.clone());
1927 assert!(res.len() == 2 || res.len() == 3);
1929 assert_eq!(res[1], res[2]);
1933 assert!(node_txn.is_empty());
1937 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1938 /// HTLC transaction.
1939 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1940 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1941 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1942 // for revoked htlc outputs
1943 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1944 node_txn.retain(|tx| {
1945 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1946 check_spends!(tx, revoked_tx);
1950 node_txn.retain(|tx| {
1951 check_spends!(tx, commitment_revoked_tx);
1954 assert!(node_txn.is_empty());
1957 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1958 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1960 assert!(node_txn.len() >= 1);
1961 assert_eq!(node_txn[0].input.len(), 1);
1962 let mut found_prev = false;
1964 for tx in prev_txn {
1965 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1966 check_spends!(node_txn[0], tx);
1967 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1968 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1974 assert!(found_prev);
1976 let mut res = Vec::new();
1977 mem::swap(&mut *node_txn, &mut res);
1981 pub fn handle_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize, needs_err_handle: bool, expected_error: &str) {
1982 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1983 assert_eq!(events_1.len(), 2);
1984 let as_update = match events_1[0] {
1985 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1988 _ => panic!("Unexpected event"),
1991 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1992 assert_eq!(node_id, nodes[b].node.get_our_node_id());
1993 assert_eq!(msg.data, expected_error);
1994 if needs_err_handle {
1995 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1998 _ => panic!("Unexpected event"),
2001 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2002 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2003 let bs_update = match events_2[0] {
2004 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2007 _ => panic!("Unexpected event"),
2009 if !needs_err_handle {
2011 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2012 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2013 assert_eq!(msg.data, expected_error);
2015 _ => panic!("Unexpected event"),
2020 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
2021 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
2025 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2026 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2030 macro_rules! get_channel_value_stat {
2031 ($node: expr, $channel_id: expr) => {{
2032 let chan_lock = $node.node.channel_state.lock().unwrap();
2033 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
2034 chan.get_value_stat()
2038 macro_rules! get_chan_reestablish_msgs {
2039 ($src_node: expr, $dst_node: expr) => {
2041 let mut res = Vec::with_capacity(1);
2042 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2043 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2044 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2045 res.push(msg.clone());
2047 panic!("Unexpected event")
2055 macro_rules! handle_chan_reestablish_msgs {
2056 ($src_node: expr, $dst_node: expr) => {
2058 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2060 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
2062 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2068 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2070 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2073 let mut revoke_and_ack = None;
2074 let mut commitment_update = None;
2075 let order = if let Some(ev) = msg_events.get(idx) {
2077 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2078 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2079 revoke_and_ack = Some(msg.clone());
2081 RAACommitmentOrder::RevokeAndACKFirst
2083 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2084 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2085 commitment_update = Some(updates.clone());
2087 RAACommitmentOrder::CommitmentFirst
2089 _ => RAACommitmentOrder::CommitmentFirst,
2092 RAACommitmentOrder::CommitmentFirst
2095 if let Some(ev) = msg_events.get(idx) {
2097 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2098 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2099 assert!(revoke_and_ack.is_none());
2100 revoke_and_ack = Some(msg.clone());
2103 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2104 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2105 assert!(commitment_update.is_none());
2106 commitment_update = Some(updates.clone());
2113 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2114 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2116 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2119 assert_eq!(msg_events.len(), idx);
2121 (funding_locked, revoke_and_ack, commitment_update, order)
2126 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2127 /// for claims/fails they are separated out.
2128 pub fn reconnect_nodes<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, send_funding_locked: (bool, bool), pending_htlc_adds: (i64, i64), pending_htlc_claims: (usize, usize), pending_htlc_fails: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool)) {
2129 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2130 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2131 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2132 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2134 if send_funding_locked.0 {
2135 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
2137 for reestablish in reestablish_1.iter() {
2138 assert_eq!(reestablish.next_remote_commitment_number, 0);
2141 if send_funding_locked.1 {
2142 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
2144 for reestablish in reestablish_2.iter() {
2145 assert_eq!(reestablish.next_remote_commitment_number, 0);
2148 if send_funding_locked.0 || send_funding_locked.1 {
2149 // If we expect any funding_locked's, both sides better have set
2150 // next_holder_commitment_number to 1
2151 for reestablish in reestablish_1.iter() {
2152 assert_eq!(reestablish.next_local_commitment_number, 1);
2154 for reestablish in reestablish_2.iter() {
2155 assert_eq!(reestablish.next_local_commitment_number, 1);
2159 let mut resp_1 = Vec::new();
2160 for msg in reestablish_1 {
2161 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2162 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2164 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2165 check_added_monitors!(node_b, 1);
2167 check_added_monitors!(node_b, 0);
2170 let mut resp_2 = Vec::new();
2171 for msg in reestablish_2 {
2172 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2173 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2175 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2176 check_added_monitors!(node_a, 1);
2178 check_added_monitors!(node_a, 0);
2181 // We don't yet support both needing updates, as that would require a different commitment dance:
2182 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2183 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2184 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2185 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2187 for chan_msgs in resp_1.drain(..) {
2188 if send_funding_locked.0 {
2189 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2190 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2191 if !announcement_event.is_empty() {
2192 assert_eq!(announcement_event.len(), 1);
2193 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2194 //TODO: Test announcement_sigs re-sending
2195 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2198 assert!(chan_msgs.0.is_none());
2201 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2202 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2203 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2204 check_added_monitors!(node_a, 1);
2206 assert!(chan_msgs.1.is_none());
2208 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2209 let commitment_update = chan_msgs.2.unwrap();
2210 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2211 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2213 assert!(commitment_update.update_add_htlcs.is_empty());
2215 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2216 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2217 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2218 for update_add in commitment_update.update_add_htlcs {
2219 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2221 for update_fulfill in commitment_update.update_fulfill_htlcs {
2222 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2224 for update_fail in commitment_update.update_fail_htlcs {
2225 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2228 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2229 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2231 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2232 check_added_monitors!(node_a, 1);
2233 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2234 // No commitment_signed so get_event_msg's assert(len == 1) passes
2235 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2236 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2237 check_added_monitors!(node_b, 1);
2240 assert!(chan_msgs.2.is_none());
2244 for chan_msgs in resp_2.drain(..) {
2245 if send_funding_locked.1 {
2246 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2247 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2248 if !announcement_event.is_empty() {
2249 assert_eq!(announcement_event.len(), 1);
2250 match announcement_event[0] {
2251 MessageSendEvent::SendChannelUpdate { .. } => {},
2252 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2253 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2257 assert!(chan_msgs.0.is_none());
2260 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2261 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2262 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2263 check_added_monitors!(node_b, 1);
2265 assert!(chan_msgs.1.is_none());
2267 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2268 let commitment_update = chan_msgs.2.unwrap();
2269 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2270 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2272 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2273 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2274 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2275 for update_add in commitment_update.update_add_htlcs {
2276 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2278 for update_fulfill in commitment_update.update_fulfill_htlcs {
2279 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2281 for update_fail in commitment_update.update_fail_htlcs {
2282 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2285 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2286 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2288 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2289 check_added_monitors!(node_b, 1);
2290 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2291 // No commitment_signed so get_event_msg's assert(len == 1) passes
2292 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2293 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2294 check_added_monitors!(node_a, 1);
2297 assert!(chan_msgs.2.is_none());