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};
18 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
19 use routing::router::{Route, get_route};
20 use routing::scorer::Scorer;
21 use ln::features::{InitFeatures, InvoiceFeatures};
23 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
24 use util::enforcing_trait_impls::EnforcingSigner;
26 use util::test_utils::TestChainMonitor;
27 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
28 use util::errors::APIError;
29 use util::config::UserConfig;
30 use util::ser::{ReadableArgs, Writeable, Readable};
32 use bitcoin::blockdata::block::{Block, BlockHeader};
33 use bitcoin::blockdata::constants::genesis_block;
34 use bitcoin::blockdata::transaction::{Transaction, TxOut};
35 use bitcoin::network::constants::Network;
37 use bitcoin::hashes::sha256::Hash as Sha256;
38 use bitcoin::hashes::Hash;
39 use bitcoin::hash_types::BlockHash;
41 use bitcoin::secp256k1::key::PublicKey;
45 use core::cell::RefCell;
47 use sync::{Arc, Mutex};
50 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
52 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
53 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
54 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
55 confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
56 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
58 /// Mine a signle block containing the given transaction
59 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
60 let height = node.best_block_info().1 + 1;
61 confirm_transaction_at(node, tx, height);
63 /// Mine the given transaction at the given height, mining blocks as required to build to that
65 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
66 let first_connect_height = node.best_block_info().1 + 1;
67 assert!(first_connect_height <= conf_height);
68 if conf_height > first_connect_height {
69 connect_blocks(node, conf_height - first_connect_height);
71 let mut block = Block {
72 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: conf_height, bits: 42, nonce: 42 },
75 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
76 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
78 block.txdata.push(tx.clone());
79 connect_block(node, &block);
82 /// The possible ways we may notify a ChannelManager of a new block
83 #[derive(Clone, Copy, PartialEq)]
84 pub enum ConnectStyle {
85 /// Calls best_block_updated first, detecting transactions in the block only after receiving the
86 /// header and height information.
88 /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
89 /// make a single best_block_updated call.
90 BestBlockFirstSkippingBlocks,
91 /// Calls transactions_confirmed first, detecting transactions in the block before updating the
92 /// header and height information.
94 /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
95 /// make a single best_block_updated call.
96 TransactionsFirstSkippingBlocks,
97 /// Provides the full block via the chain::Listen interface. In the current code this is
98 /// equivalent to TransactionsFirst with some additional assertions.
102 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
103 let skip_intermediaries = match *node.connect_style.borrow() {
104 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
108 let height = node.best_block_info().1 + 1;
109 let mut block = Block {
110 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: height, bits: 42, nonce: 42 },
115 do_connect_block(node, &block, skip_intermediaries);
117 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: height + i, bits: 42, nonce: 42 },
121 connect_block(node, &block);
122 block.header.block_hash()
125 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
126 do_connect_block(node, block, false);
129 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
130 let height = node.best_block_info().1 + 1;
131 if !skip_intermediaries {
132 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
133 match *node.connect_style.borrow() {
134 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
135 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
136 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
137 node.node.best_block_updated(&block.header, height);
138 node.node.transactions_confirmed(&block.header, &txdata, height);
140 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
141 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
142 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
143 node.node.transactions_confirmed(&block.header, &txdata, height);
144 node.node.best_block_updated(&block.header, height);
146 ConnectStyle::FullBlockViaListen => {
147 node.chain_monitor.chain_monitor.block_connected(&block, height);
148 node.node.block_connected(&block, height);
152 node.node.test_process_background_events();
153 node.blocks.lock().unwrap().push((block.header, height));
156 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
158 let orig_header = node.blocks.lock().unwrap().pop().unwrap();
159 assert!(orig_header.1 > 0); // Cannot disconnect genesis
160 let prev_header = node.blocks.lock().unwrap().last().unwrap().clone();
162 match *node.connect_style.borrow() {
163 ConnectStyle::FullBlockViaListen => {
164 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
165 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
167 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
169 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
170 node.node.best_block_updated(&prev_header.0, prev_header.1);
174 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
175 node.node.best_block_updated(&prev_header.0, prev_header.1);
181 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
182 let count = node.blocks.lock().unwrap().len() as u32 - 1;
183 disconnect_blocks(node, count);
186 pub struct TestChanMonCfg {
187 pub tx_broadcaster: test_utils::TestBroadcaster,
188 pub fee_estimator: test_utils::TestFeeEstimator,
189 pub chain_source: test_utils::TestChainSource,
190 pub persister: test_utils::TestPersister,
191 pub logger: test_utils::TestLogger,
192 pub keys_manager: test_utils::TestKeysInterface,
195 pub struct NodeCfg<'a> {
196 pub chain_source: &'a test_utils::TestChainSource,
197 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
198 pub fee_estimator: &'a test_utils::TestFeeEstimator,
199 pub chain_monitor: test_utils::TestChainMonitor<'a>,
200 pub keys_manager: &'a test_utils::TestKeysInterface,
201 pub logger: &'a test_utils::TestLogger,
202 pub node_seed: [u8; 32],
203 pub features: InitFeatures,
206 pub struct Node<'a, 'b: 'a, 'c: 'b> {
207 pub chain_source: &'c test_utils::TestChainSource,
208 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
209 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
210 pub keys_manager: &'b test_utils::TestKeysInterface,
211 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
212 pub net_graph_msg_handler: NetGraphMsgHandler<&'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
213 pub node_seed: [u8; 32],
214 pub network_payment_count: Rc<RefCell<u8>>,
215 pub network_chan_count: Rc<RefCell<u32>>,
216 pub logger: &'c test_utils::TestLogger,
217 pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
218 pub connect_style: Rc<RefCell<ConnectStyle>>,
220 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
221 pub fn best_block_hash(&self) -> BlockHash {
222 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
224 pub fn best_block_info(&self) -> (BlockHash, u32) {
225 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
227 pub fn get_block_header(&self, height: u32) -> BlockHeader {
228 self.blocks.lock().unwrap()[height as usize].0
232 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
234 if !::std::thread::panicking() {
235 // Check that we processed all pending events
236 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
237 assert!(self.node.get_and_clear_pending_events().is_empty());
238 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
240 // Check that if we serialize the Router, we can deserialize it again.
242 let mut w = test_utils::TestVecWriter(Vec::new());
243 let network_graph_ser = &self.net_graph_msg_handler.network_graph;
244 network_graph_ser.write(&mut w).unwrap();
245 let network_graph_deser = <NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap();
246 assert!(network_graph_deser == self.net_graph_msg_handler.network_graph);
247 let net_graph_msg_handler = NetGraphMsgHandler::new(
248 network_graph_deser, Some(self.chain_source), self.logger
250 let mut chan_progress = 0;
252 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
253 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
254 assert!(orig_announcements == deserialized_announcements);
255 chan_progress = match orig_announcements.last() {
256 Some(announcement) => announcement.0.contents.short_channel_id + 1,
260 let mut node_progress = None;
262 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
263 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
264 assert!(orig_announcements == deserialized_announcements);
265 node_progress = match orig_announcements.last() {
266 Some(announcement) => Some(announcement.contents.node_id),
272 // Check that if we serialize and then deserialize all our channel monitors we get the
273 // same set of outputs to watch for on chain as we have now. Note that if we write
274 // tests that fully close channels and remove the monitors at some point this may break.
275 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
276 let mut deserialized_monitors = Vec::new();
278 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
279 let mut w = test_utils::TestVecWriter(Vec::new());
280 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
281 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
282 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
283 deserialized_monitors.push(deserialized_monitor);
287 // Before using all the new monitors to check the watch outpoints, use the full set of
288 // them to ensure we can write and reload our ChannelManager.
290 let mut channel_monitors = HashMap::new();
291 for monitor in deserialized_monitors.iter_mut() {
292 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
295 let mut w = test_utils::TestVecWriter(Vec::new());
296 self.node.write(&mut w).unwrap();
297 <(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 {
298 default_config: *self.node.get_current_default_configuration(),
299 keys_manager: self.keys_manager,
300 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
301 chain_monitor: self.chain_monitor,
302 tx_broadcaster: &test_utils::TestBroadcaster {
303 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
304 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
306 logger: &self.logger,
311 let persister = test_utils::TestPersister::new();
312 let broadcaster = test_utils::TestBroadcaster {
313 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
314 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
316 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
317 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
318 for deserialized_monitor in deserialized_monitors.drain(..) {
319 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
323 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
324 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
329 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) {
330 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
333 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) {
334 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);
335 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
336 (announcement, as_update, bs_update, channel_id, tx)
339 macro_rules! get_revoke_commit_msgs {
340 ($node: expr, $node_id: expr) => {
342 let events = $node.node.get_and_clear_pending_msg_events();
343 assert_eq!(events.len(), 2);
345 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
346 assert_eq!(*node_id, $node_id);
349 _ => panic!("Unexpected event"),
351 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
352 assert_eq!(*node_id, $node_id);
353 assert!(updates.update_add_htlcs.is_empty());
354 assert!(updates.update_fulfill_htlcs.is_empty());
355 assert!(updates.update_fail_htlcs.is_empty());
356 assert!(updates.update_fail_malformed_htlcs.is_empty());
357 assert!(updates.update_fee.is_none());
358 updates.commitment_signed.clone()
360 _ => panic!("Unexpected event"),
366 /// Get an specific event message from the pending events queue.
368 macro_rules! get_event_msg {
369 ($node: expr, $event_type: path, $node_id: expr) => {
371 let events = $node.node.get_and_clear_pending_msg_events();
372 assert_eq!(events.len(), 1);
374 $event_type { ref node_id, ref msg } => {
375 assert_eq!(*node_id, $node_id);
378 _ => panic!("Unexpected event"),
384 /// Get a specific event from the pending events queue.
386 macro_rules! get_event {
387 ($node: expr, $event_type: path) => {
389 let mut events = $node.node.get_and_clear_pending_events();
390 assert_eq!(events.len(), 1);
391 let ev = events.pop().unwrap();
393 $event_type { .. } => {
396 _ => panic!("Unexpected event"),
403 macro_rules! get_htlc_update_msgs {
404 ($node: expr, $node_id: expr) => {
406 let events = $node.node.get_and_clear_pending_msg_events();
407 assert_eq!(events.len(), 1);
409 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
410 assert_eq!(*node_id, $node_id);
413 _ => panic!("Unexpected event"),
420 macro_rules! get_channel_ref {
421 ($node: expr, $lock: ident, $channel_id: expr) => {
423 $lock = $node.node.channel_state.lock().unwrap();
424 $lock.by_id.get_mut(&$channel_id).unwrap()
430 macro_rules! get_feerate {
431 ($node: expr, $channel_id: expr) => {
434 let chan = get_channel_ref!($node, lock, $channel_id);
440 /// Returns a channel monitor given a channel id, making some naive assumptions
442 macro_rules! get_monitor {
443 ($node: expr, $channel_id: expr) => {
445 use bitcoin::hashes::Hash;
446 let mut monitor = None;
447 // Assume funding vout is either 0 or 1 blindly
449 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
450 $crate::chain::transaction::OutPoint {
451 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
463 /// Returns any local commitment transactions for the channel.
465 macro_rules! get_local_commitment_txn {
466 ($node: expr, $channel_id: expr) => {
468 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
473 /// Check the error from attempting a payment.
475 macro_rules! unwrap_send_err {
476 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
478 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
479 assert_eq!(fails.len(), 1);
485 &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
486 assert_eq!(fails.len(), 1);
488 Err($type) => { $check },
497 /// Check whether N channel monitor(s) have been added.
499 macro_rules! check_added_monitors {
500 ($node: expr, $count: expr) => {
502 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
503 assert_eq!(added_monitors.len(), $count);
504 added_monitors.clear();
509 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) {
510 let chan_id = *node.network_chan_count.borrow();
512 let events = node.node.get_and_clear_pending_events();
513 assert_eq!(events.len(), 1);
515 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
516 assert_eq!(*channel_value_satoshis, expected_chan_value);
517 assert_eq!(user_channel_id, expected_user_chan_id);
519 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
520 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
522 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
523 (*temporary_channel_id, tx, funding_outpoint)
525 _ => panic!("Unexpected event"),
529 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 {
530 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
531 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
532 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
534 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
536 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
537 check_added_monitors!(node_a, 0);
539 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
541 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
542 assert_eq!(added_monitors.len(), 1);
543 assert_eq!(added_monitors[0].0, funding_output);
544 added_monitors.clear();
547 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()));
549 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
550 assert_eq!(added_monitors.len(), 1);
551 assert_eq!(added_monitors[0].0, funding_output);
552 added_monitors.clear();
555 let events_4 = node_a.node.get_and_clear_pending_events();
556 assert_eq!(events_4.len(), 0);
558 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
559 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
560 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
565 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) {
566 confirm_transaction_at(node_conf, tx, conf_height);
567 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
568 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()));
571 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]) {
573 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
574 assert_eq!(events_6.len(), 2);
575 ((match events_6[0] {
576 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
577 channel_id = msg.channel_id.clone();
578 assert_eq!(*node_id, node_recv.node.get_our_node_id());
581 _ => panic!("Unexpected event"),
582 }, match events_6[1] {
583 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
584 assert_eq!(*node_id, node_recv.node.get_our_node_id());
587 _ => panic!("Unexpected event"),
591 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]) {
592 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
593 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
594 confirm_transaction_at(node_a, tx, conf_height);
595 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
596 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
599 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) {
600 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
601 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
605 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) {
606 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
607 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
608 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
610 let events_7 = node_b.node.get_and_clear_pending_msg_events();
611 assert_eq!(events_7.len(), 1);
612 let (announcement, bs_update) = match events_7[0] {
613 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
616 _ => panic!("Unexpected event"),
619 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
620 let events_8 = node_a.node.get_and_clear_pending_msg_events();
621 assert_eq!(events_8.len(), 1);
622 let as_update = match events_8[0] {
623 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
624 assert!(*announcement == *msg);
625 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
626 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
629 _ => panic!("Unexpected event"),
632 *node_a.network_chan_count.borrow_mut() += 1;
634 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
637 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) {
638 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
641 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) {
642 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
643 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
644 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
647 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) {
648 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
649 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
650 assert!(a_events.len() >= 2);
652 // ann should be re-generated by broadcast_node_announcement - check that we have it.
653 let mut found_ann_1 = false;
654 for event in a_events.iter() {
656 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
657 if msg == ann { found_ann_1 = true; }
659 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
660 _ => panic!("Unexpected event {:?}", event),
663 assert!(found_ann_1);
665 let a_node_announcement = match a_events.last().unwrap() {
666 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
669 _ => panic!("Unexpected event"),
672 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
673 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
674 assert!(b_events.len() >= 2);
676 // ann should be re-generated by broadcast_node_announcement - check that we have it.
677 let mut found_ann_2 = false;
678 for event in b_events.iter() {
680 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
681 if msg == ann { found_ann_2 = true; }
683 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
684 _ => panic!("Unexpected event"),
687 assert!(found_ann_2);
689 let b_node_announcement = match b_events.last().unwrap() {
690 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
693 _ => panic!("Unexpected event"),
697 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
698 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
699 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
700 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
701 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
705 macro_rules! check_spends {
706 ($tx: expr, $($spends_txn: expr),*) => {
708 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
710 if out_point.txid == $spends_txn.txid() {
711 return $spends_txn.output.get(out_point.vout as usize).cloned()
716 let mut total_value_in = 0;
717 for input in $tx.input.iter() {
718 total_value_in += get_output(&input.previous_output).unwrap().value;
720 let mut total_value_out = 0;
721 for output in $tx.output.iter() {
722 total_value_out += output.value;
724 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
725 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
726 assert!(total_value_out + min_fee <= total_value_in);
727 $tx.verify(get_output).unwrap();
732 macro_rules! get_closing_signed_broadcast {
733 ($node: expr, $dest_pubkey: expr) => {
735 let events = $node.get_and_clear_pending_msg_events();
736 assert!(events.len() == 1 || events.len() == 2);
737 (match events[events.len() - 1] {
738 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
739 assert_eq!(msg.contents.flags & 2, 2);
742 _ => panic!("Unexpected event"),
743 }, if events.len() == 2 {
745 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
746 assert_eq!(*node_id, $dest_pubkey);
749 _ => panic!("Unexpected event"),
756 /// Check that a channel's closing channel update has been broadcasted, and optionally
757 /// check whether an error message event has occurred.
759 macro_rules! check_closed_broadcast {
760 ($node: expr, $with_error_msg: expr) => {{
761 let msg_events = $node.node.get_and_clear_pending_msg_events();
762 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
763 match msg_events[0] {
764 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
765 assert_eq!(msg.contents.flags & 2, 2);
767 _ => panic!("Unexpected event"),
770 match msg_events[1] {
771 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
772 // TODO: Check node_id
775 _ => panic!("Unexpected event"),
781 /// Check that a channel's closing channel events has been issued
783 macro_rules! check_closed_event {
784 ($node: expr, $events: expr, $reason: expr) => {
785 check_closed_event!($node, $events, $reason, false);
787 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
788 let events = $node.node.get_and_clear_pending_events();
789 assert_eq!(events.len(), $events);
790 let expected_reason = $reason;
791 let mut issues_discard_funding = false;
792 for event in events {
794 Event::ChannelClosed { ref reason, .. } => {
795 assert_eq!(*reason, expected_reason);
797 Event::DiscardFunding { .. } => {
798 issues_discard_funding = true;
800 _ => panic!("Unexpected event"),
803 assert_eq!($is_check_discard_funding, issues_discard_funding);
807 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) {
808 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) };
809 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) };
812 node_a.close_channel(channel_id).unwrap();
813 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()));
815 let events_1 = node_b.get_and_clear_pending_msg_events();
816 assert!(events_1.len() >= 1);
817 let shutdown_b = match events_1[0] {
818 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
819 assert_eq!(node_id, &node_a.get_our_node_id());
822 _ => panic!("Unexpected event"),
825 let closing_signed_b = if !close_inbound_first {
826 assert_eq!(events_1.len(), 1);
829 Some(match events_1[1] {
830 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
831 assert_eq!(node_id, &node_a.get_our_node_id());
834 _ => panic!("Unexpected event"),
838 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
839 let (as_update, bs_update) = if close_inbound_first {
840 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
841 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
843 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
844 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
845 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
846 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
848 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
849 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
850 assert!(none_a.is_none());
851 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
852 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
853 (as_update, bs_update)
855 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
857 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
858 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
860 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
861 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
862 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
864 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
865 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
866 assert!(none_b.is_none());
867 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
868 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
869 (as_update, bs_update)
871 assert_eq!(tx_a, tx_b);
872 check_spends!(tx_a, funding_tx);
874 (as_update, bs_update, tx_a)
877 pub struct SendEvent {
878 pub node_id: PublicKey,
879 pub msgs: Vec<msgs::UpdateAddHTLC>,
880 pub commitment_msg: msgs::CommitmentSigned,
883 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
884 assert!(updates.update_fulfill_htlcs.is_empty());
885 assert!(updates.update_fail_htlcs.is_empty());
886 assert!(updates.update_fail_malformed_htlcs.is_empty());
887 assert!(updates.update_fee.is_none());
888 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
891 pub fn from_event(event: MessageSendEvent) -> SendEvent {
893 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
894 _ => panic!("Unexpected event type!"),
898 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
899 let mut events = node.node.get_and_clear_pending_msg_events();
900 assert_eq!(events.len(), 1);
901 SendEvent::from_event(events.pop().unwrap())
905 macro_rules! commitment_signed_dance {
906 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
908 check_added_monitors!($node_a, 0);
909 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
910 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
911 check_added_monitors!($node_a, 1);
912 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
915 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
917 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
918 check_added_monitors!($node_b, 0);
919 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
920 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
921 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
922 check_added_monitors!($node_b, 1);
923 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
924 let (bs_revoke_and_ack, extra_msg_option) = {
925 let events = $node_b.node.get_and_clear_pending_msg_events();
926 assert!(events.len() <= 2);
928 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
929 assert_eq!(*node_id, $node_a.node.get_our_node_id());
932 _ => panic!("Unexpected event"),
933 }, events.get(1).map(|e| e.clone()))
935 check_added_monitors!($node_b, 1);
937 assert!($node_a.node.get_and_clear_pending_events().is_empty());
938 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
940 (extra_msg_option, bs_revoke_and_ack)
943 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
945 check_added_monitors!($node_a, 0);
946 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
947 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
948 check_added_monitors!($node_a, 1);
949 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
950 assert!(extra_msg_option.is_none());
954 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
956 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
957 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
958 check_added_monitors!($node_a, 1);
962 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
964 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
967 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
969 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
971 expect_pending_htlcs_forwardable!($node_a);
972 check_added_monitors!($node_a, 1);
974 let channel_state = $node_a.node.channel_state.lock().unwrap();
975 assert_eq!(channel_state.pending_msg_events.len(), 1);
976 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
977 assert_ne!(*node_id, $node_b.node.get_our_node_id());
978 } else { panic!("Unexpected event"); }
980 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
986 /// Get a payment preimage and hash.
988 macro_rules! get_payment_preimage_hash {
989 ($dest_node: expr) => {
991 get_payment_preimage_hash!($dest_node, None)
994 ($dest_node: expr, $min_value_msat: expr) => {
996 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
997 let payment_preimage = PaymentPreimage([*payment_count; 32]);
999 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1000 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200, 0).unwrap();
1001 (payment_preimage, payment_hash, payment_secret)
1007 macro_rules! get_route_and_payment_hash {
1008 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1009 get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
1011 ($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
1012 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node, Some($recv_value));
1013 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
1014 let scorer = ::routing::scorer::Scorer::new(0);
1015 let route = ::routing::router::get_route(
1016 &$send_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
1017 &$recv_node.node.get_our_node_id(), Some(::ln::features::InvoiceFeatures::known()),
1018 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1019 &$last_hops, $recv_value, $cltv, $send_node.logger, &scorer
1021 (route, payment_hash, payment_preimage, payment_secret)
1025 macro_rules! expect_pending_htlcs_forwardable_ignore {
1027 let events = $node.node.get_and_clear_pending_events();
1028 assert_eq!(events.len(), 1);
1030 Event::PendingHTLCsForwardable { .. } => { },
1031 _ => panic!("Unexpected event"),
1036 macro_rules! expect_pending_htlcs_forwardable {
1038 expect_pending_htlcs_forwardable_ignore!($node);
1039 $node.node.process_pending_htlc_forwards();
1044 macro_rules! expect_pending_htlcs_forwardable_from_events {
1045 ($node: expr, $events: expr, $ignore: expr) => {{
1046 assert_eq!($events.len(), 1);
1048 Event::PendingHTLCsForwardable { .. } => { },
1049 _ => panic!("Unexpected event"),
1052 $node.node.process_pending_htlc_forwards();
1057 #[cfg(any(test, feature = "unstable"))]
1058 macro_rules! expect_payment_received {
1059 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1060 let events = $node.node.get_and_clear_pending_events();
1061 assert_eq!(events.len(), 1);
1063 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1064 assert_eq!($expected_payment_hash, *payment_hash);
1065 assert_eq!($expected_recv_value, amt);
1067 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1068 assert!(payment_preimage.is_none());
1069 assert_eq!($expected_payment_secret, *payment_secret);
1074 _ => panic!("Unexpected event"),
1079 macro_rules! expect_payment_sent {
1080 ($node: expr, $expected_payment_preimage: expr) => {
1081 let events = $node.node.get_and_clear_pending_events();
1082 let expected_payment_hash = PaymentHash(Sha256::hash(&$expected_payment_preimage.0).into_inner());
1083 assert_eq!(events.len(), 1);
1085 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
1086 assert_eq!($expected_payment_preimage, *payment_preimage);
1087 assert_eq!(expected_payment_hash, *payment_hash);
1089 _ => panic!("Unexpected event"),
1094 macro_rules! expect_payment_forwarded {
1095 ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1096 let events = $node.node.get_and_clear_pending_events();
1097 assert_eq!(events.len(), 1);
1099 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1100 assert_eq!(fee_earned_msat, $expected_fee);
1101 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1103 _ => panic!("Unexpected event"),
1109 macro_rules! expect_payment_failed_with_update {
1110 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1111 let events = $node.node.get_and_clear_pending_events();
1112 assert_eq!(events.len(), 1);
1114 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref network_update, ref error_code, ref error_data, .. } => {
1115 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1116 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1117 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1118 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1119 match network_update {
1120 &Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !$chan_closed => {
1121 assert_eq!(msg.contents.short_channel_id, $scid);
1122 assert_eq!(msg.contents.flags & 2, 0);
1124 &Some(NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if $chan_closed => {
1125 assert_eq!(short_channel_id, $scid);
1126 assert!(is_permanent);
1128 Some(_) => panic!("Unexpected update type"),
1129 None => panic!("Expected update"),
1132 _ => panic!("Unexpected event"),
1138 macro_rules! expect_payment_failed {
1139 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1140 let events = $node.node.get_and_clear_pending_events();
1141 assert_eq!(events.len(), 1);
1143 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, network_update: _, ref error_code, ref error_data, .. } => {
1144 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1145 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1146 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1147 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1149 assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
1150 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
1153 _ => panic!("Unexpected event"),
1158 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) {
1159 origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1160 check_added_monitors!(origin_node, expected_paths.len());
1161 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1164 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>) {
1165 let mut payment_event = SendEvent::from_event(ev);
1166 let mut prev_node = origin_node;
1168 for (idx, &node) in expected_path.iter().enumerate() {
1169 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1171 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1172 check_added_monitors!(node, 0);
1173 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1175 expect_pending_htlcs_forwardable!(node);
1177 if idx == expected_path.len() - 1 {
1178 let events_2 = node.node.get_and_clear_pending_events();
1179 if payment_received_expected {
1180 assert_eq!(events_2.len(), 1);
1182 Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1183 assert_eq!(our_payment_hash, *payment_hash);
1185 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1186 assert_eq!(expected_preimage, *payment_preimage);
1187 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1189 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1190 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1191 assert!(our_payment_secret.is_none());
1194 assert_eq!(amt, recv_value);
1196 _ => panic!("Unexpected event"),
1199 assert!(events_2.is_empty());
1202 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1203 assert_eq!(events_2.len(), 1);
1204 check_added_monitors!(node, 1);
1205 payment_event = SendEvent::from_event(events_2.remove(0));
1206 assert_eq!(payment_event.msgs.len(), 1);
1213 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) {
1214 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1215 assert_eq!(events.len(), expected_route.len());
1216 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1217 // Once we've gotten through all the HTLCs, the last one should result in a
1218 // PaymentReceived (but each previous one should not!), .
1219 let expect_payment = path_idx == expected_route.len() - 1;
1220 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1224 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) {
1225 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1226 send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1227 (our_payment_preimage, our_payment_hash, our_payment_secret)
1230 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) {
1231 for path in expected_paths.iter() {
1232 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1234 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1235 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1237 macro_rules! msgs_from_ev {
1240 &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 } } => {
1241 assert!(update_add_htlcs.is_empty());
1242 assert_eq!(update_fulfill_htlcs.len(), 1);
1243 assert!(update_fail_htlcs.is_empty());
1244 assert!(update_fail_malformed_htlcs.is_empty());
1245 assert!(update_fee.is_none());
1246 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1248 _ => panic!("Unexpected event"),
1252 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1253 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1254 assert_eq!(events.len(), expected_paths.len());
1255 for ev in events.iter() {
1256 per_path_msgs.push(msgs_from_ev!(ev));
1259 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1260 let mut next_msgs = Some(path_msgs);
1261 let mut expected_next_node = next_hop;
1263 macro_rules! last_update_fulfill_dance {
1264 ($node: expr, $prev_node: expr) => {
1266 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1267 check_added_monitors!($node, 0);
1268 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1269 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1273 macro_rules! mid_update_fulfill_dance {
1274 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1276 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1277 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;
1278 expect_payment_forwarded!($node, Some(fee as u64), false);
1279 check_added_monitors!($node, 1);
1280 let new_next_msgs = if $new_msgs {
1281 let events = $node.node.get_and_clear_pending_msg_events();
1282 assert_eq!(events.len(), 1);
1283 let (res, nexthop) = msgs_from_ev!(&events[0]);
1284 expected_next_node = nexthop;
1287 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1290 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1291 next_msgs = new_next_msgs;
1296 let mut prev_node = expected_route.last().unwrap();
1297 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1298 assert_eq!(expected_next_node, node.node.get_our_node_id());
1299 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1300 if next_msgs.is_some() {
1301 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1303 assert!(!update_next_msgs);
1304 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1306 if !skip_last && idx == expected_route.len() - 1 {
1307 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1314 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1318 expect_payment_sent!(origin_node, our_payment_preimage);
1322 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1323 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1326 pub const TEST_FINAL_CLTV: u32 = 70;
1328 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) {
1329 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1330 let scorer = Scorer::new(0);
1331 let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
1332 &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()),
1333 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()), &[],
1334 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1335 assert_eq!(route.paths.len(), 1);
1336 assert_eq!(route.paths[0].len(), expected_route.len());
1337 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1338 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1341 send_along_route(origin_node, route, expected_route, recv_value)
1344 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1345 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1346 let scorer = Scorer::new(0);
1347 let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1348 assert_eq!(route.paths.len(), 1);
1349 assert_eq!(route.paths[0].len(), expected_route.len());
1350 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1351 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1354 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1355 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1356 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1359 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1360 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1361 claim_payment(&origin, expected_route, our_payment_preimage);
1364 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) {
1365 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1366 for path in expected_paths.iter() {
1367 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1369 assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1370 expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1371 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1373 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1374 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1375 assert_eq!(events.len(), expected_paths.len());
1376 for ev in events.iter() {
1377 let (update_fail, commitment_signed, node_id) = match ev {
1378 &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 } } => {
1379 assert!(update_add_htlcs.is_empty());
1380 assert!(update_fulfill_htlcs.is_empty());
1381 assert_eq!(update_fail_htlcs.len(), 1);
1382 assert!(update_fail_malformed_htlcs.is_empty());
1383 assert!(update_fee.is_none());
1384 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1386 _ => panic!("Unexpected event"),
1388 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1390 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1391 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()));
1393 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1394 let mut next_msgs = Some(path_msgs);
1395 let mut expected_next_node = next_hop;
1396 let mut prev_node = expected_route.last().unwrap();
1398 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1399 assert_eq!(expected_next_node, node.node.get_our_node_id());
1400 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1401 if next_msgs.is_some() {
1402 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1403 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1404 if !update_next_node {
1405 expect_pending_htlcs_forwardable!(node);
1408 let events = node.node.get_and_clear_pending_msg_events();
1409 if update_next_node {
1410 assert_eq!(events.len(), 1);
1412 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 } } => {
1413 assert!(update_add_htlcs.is_empty());
1414 assert!(update_fulfill_htlcs.is_empty());
1415 assert_eq!(update_fail_htlcs.len(), 1);
1416 assert!(update_fail_malformed_htlcs.is_empty());
1417 assert!(update_fee.is_none());
1418 expected_next_node = node_id.clone();
1419 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1421 _ => panic!("Unexpected event"),
1424 assert!(events.is_empty());
1426 if !skip_last && idx == expected_route.len() - 1 {
1427 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1434 let prev_node = expected_route.first().unwrap();
1435 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1436 check_added_monitors!(origin_node, 0);
1437 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1438 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1439 let events = origin_node.node.get_and_clear_pending_events();
1440 assert_eq!(events.len(), 1);
1442 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, .. } => {
1443 assert_eq!(payment_hash, our_payment_hash);
1444 assert!(rejected_by_dest);
1445 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1446 for (idx, hop) in expected_route.iter().enumerate() {
1447 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1450 _ => panic!("Unexpected event"),
1456 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1457 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1460 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1461 let mut chan_mon_cfgs = Vec::new();
1462 for i in 0..node_count {
1463 let tx_broadcaster = test_utils::TestBroadcaster {
1464 txn_broadcasted: Mutex::new(Vec::new()),
1465 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1467 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1468 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1469 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1470 let persister = test_utils::TestPersister::new();
1471 let seed = [i as u8; 32];
1472 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1474 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1480 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1481 let mut nodes = Vec::new();
1483 for i in 0..node_count {
1484 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);
1485 let seed = [i as u8; 32];
1486 nodes.push(NodeCfg {
1487 chain_source: &chanmon_cfgs[i].chain_source,
1488 logger: &chanmon_cfgs[i].logger,
1489 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1490 fee_estimator: &chanmon_cfgs[i].fee_estimator,
1492 keys_manager: &chanmon_cfgs[i].keys_manager,
1494 features: InitFeatures::known(),
1501 pub fn test_default_channel_config() -> UserConfig {
1502 let mut default_config = UserConfig::default();
1503 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1504 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1505 default_config.channel_options.cltv_expiry_delta = 6*6;
1506 default_config.channel_options.announced_channel = true;
1507 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1508 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1509 // It now defaults to 1, so we simply set it to the expected value here.
1510 default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1511 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1512 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1513 default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1517 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>> {
1518 let mut chanmgrs = Vec::new();
1519 for i in 0..node_count {
1520 let network = Network::Testnet;
1521 let params = ChainParameters {
1523 best_block: BestBlock::from_genesis(network),
1525 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1526 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1527 chanmgrs.push(node);
1533 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>> {
1534 let mut nodes = Vec::new();
1535 let chan_count = Rc::new(RefCell::new(0));
1536 let payment_count = Rc::new(RefCell::new(0));
1537 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1539 for i in 0..node_count {
1540 let network_graph = NetworkGraph::new(cfgs[i].chain_source.genesis_hash);
1541 let net_graph_msg_handler = NetGraphMsgHandler::new(network_graph, None, cfgs[i].logger);
1542 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1543 tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1544 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1545 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1546 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1547 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1548 connect_style: Rc::clone(&connect_style),
1552 for i in 0..node_count {
1553 for j in (i+1)..node_count {
1554 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1555 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1562 // Note that the following only works for CLTV values up to 128
1563 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1564 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1566 #[derive(PartialEq)]
1567 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1568 /// Tests that the given node has broadcast transactions for the given Channel
1570 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1571 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1572 /// broadcast and the revoked outputs were claimed.
1574 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1575 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1577 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1579 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> {
1580 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1581 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1583 let mut res = Vec::with_capacity(2);
1584 node_txn.retain(|tx| {
1585 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1586 check_spends!(tx, chan.3);
1587 if commitment_tx.is_none() {
1588 res.push(tx.clone());
1593 if let Some(explicit_tx) = commitment_tx {
1594 res.push(explicit_tx.clone());
1597 assert_eq!(res.len(), 1);
1599 if has_htlc_tx != HTLCType::NONE {
1600 node_txn.retain(|tx| {
1601 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1602 check_spends!(tx, res[0]);
1603 if has_htlc_tx == HTLCType::TIMEOUT {
1604 assert!(tx.lock_time != 0);
1606 assert!(tx.lock_time == 0);
1608 res.push(tx.clone());
1612 assert!(res.len() == 2 || res.len() == 3);
1614 assert_eq!(res[1], res[2]);
1618 assert!(node_txn.is_empty());
1622 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1623 /// HTLC transaction.
1624 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1625 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1626 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1627 // for revoked htlc outputs
1628 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1629 node_txn.retain(|tx| {
1630 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1631 check_spends!(tx, revoked_tx);
1635 node_txn.retain(|tx| {
1636 check_spends!(tx, commitment_revoked_tx);
1639 assert!(node_txn.is_empty());
1642 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1643 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1645 assert!(node_txn.len() >= 1);
1646 assert_eq!(node_txn[0].input.len(), 1);
1647 let mut found_prev = false;
1649 for tx in prev_txn {
1650 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1651 check_spends!(node_txn[0], tx);
1652 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1653 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1659 assert!(found_prev);
1661 let mut res = Vec::new();
1662 mem::swap(&mut *node_txn, &mut res);
1666 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) {
1667 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1668 assert_eq!(events_1.len(), 2);
1669 let as_update = match events_1[0] {
1670 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1673 _ => panic!("Unexpected event"),
1676 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1677 assert_eq!(node_id, nodes[b].node.get_our_node_id());
1678 assert_eq!(msg.data, expected_error);
1679 if needs_err_handle {
1680 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1683 _ => panic!("Unexpected event"),
1686 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1687 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1688 let bs_update = match events_2[0] {
1689 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1692 _ => panic!("Unexpected event"),
1694 if !needs_err_handle {
1696 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1697 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1698 assert_eq!(msg.data, expected_error);
1700 _ => panic!("Unexpected event"),
1705 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1706 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1710 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1711 handle_announce_close_broadcast_events(nodes, a, b, false, "Commitment or closing transaction was confirmed on chain.");
1715 macro_rules! get_channel_value_stat {
1716 ($node: expr, $channel_id: expr) => {{
1717 let chan_lock = $node.node.channel_state.lock().unwrap();
1718 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1719 chan.get_value_stat()
1723 macro_rules! get_chan_reestablish_msgs {
1724 ($src_node: expr, $dst_node: expr) => {
1726 let mut res = Vec::with_capacity(1);
1727 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1728 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1729 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1730 res.push(msg.clone());
1732 panic!("Unexpected event")
1740 macro_rules! handle_chan_reestablish_msgs {
1741 ($src_node: expr, $dst_node: expr) => {
1743 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1745 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1747 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1753 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
1755 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1758 let mut revoke_and_ack = None;
1759 let mut commitment_update = None;
1760 let order = if let Some(ev) = msg_events.get(idx) {
1762 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1763 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1764 revoke_and_ack = Some(msg.clone());
1766 RAACommitmentOrder::RevokeAndACKFirst
1768 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1769 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1770 commitment_update = Some(updates.clone());
1772 RAACommitmentOrder::CommitmentFirst
1774 &MessageSendEvent::SendChannelUpdate { .. } => RAACommitmentOrder::CommitmentFirst,
1775 _ => panic!("Unexpected event"),
1778 RAACommitmentOrder::CommitmentFirst
1781 if let Some(ev) = msg_events.get(idx) {
1783 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1784 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1785 assert!(revoke_and_ack.is_none());
1786 revoke_and_ack = Some(msg.clone());
1789 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1790 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1791 assert!(commitment_update.is_none());
1792 commitment_update = Some(updates.clone());
1795 &MessageSendEvent::SendChannelUpdate { .. } => {},
1796 _ => panic!("Unexpected event"),
1800 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
1801 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1802 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1805 (funding_locked, revoke_and_ack, commitment_update, order)
1810 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1811 /// for claims/fails they are separated out.
1812 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)) {
1813 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1814 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1815 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1816 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1818 if send_funding_locked.0 {
1819 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1821 for reestablish in reestablish_1.iter() {
1822 assert_eq!(reestablish.next_remote_commitment_number, 0);
1825 if send_funding_locked.1 {
1826 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1828 for reestablish in reestablish_2.iter() {
1829 assert_eq!(reestablish.next_remote_commitment_number, 0);
1832 if send_funding_locked.0 || send_funding_locked.1 {
1833 // If we expect any funding_locked's, both sides better have set
1834 // next_holder_commitment_number to 1
1835 for reestablish in reestablish_1.iter() {
1836 assert_eq!(reestablish.next_local_commitment_number, 1);
1838 for reestablish in reestablish_2.iter() {
1839 assert_eq!(reestablish.next_local_commitment_number, 1);
1843 let mut resp_1 = Vec::new();
1844 for msg in reestablish_1 {
1845 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1846 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1848 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1849 check_added_monitors!(node_b, 1);
1851 check_added_monitors!(node_b, 0);
1854 let mut resp_2 = Vec::new();
1855 for msg in reestablish_2 {
1856 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1857 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1859 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1860 check_added_monitors!(node_a, 1);
1862 check_added_monitors!(node_a, 0);
1865 // We don't yet support both needing updates, as that would require a different commitment dance:
1866 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
1867 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1868 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
1869 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1871 for chan_msgs in resp_1.drain(..) {
1872 if send_funding_locked.0 {
1873 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1874 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1875 if !announcement_event.is_empty() {
1876 assert_eq!(announcement_event.len(), 1);
1877 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1878 //TODO: Test announcement_sigs re-sending
1879 } else { panic!("Unexpected event!"); }
1882 assert!(chan_msgs.0.is_none());
1885 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1886 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1887 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1888 check_added_monitors!(node_a, 1);
1890 assert!(chan_msgs.1.is_none());
1892 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 {
1893 let commitment_update = chan_msgs.2.unwrap();
1894 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1895 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1897 assert!(commitment_update.update_add_htlcs.is_empty());
1899 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1900 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
1901 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1902 for update_add in commitment_update.update_add_htlcs {
1903 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1905 for update_fulfill in commitment_update.update_fulfill_htlcs {
1906 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1908 for update_fail in commitment_update.update_fail_htlcs {
1909 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1912 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1913 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1915 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1916 check_added_monitors!(node_a, 1);
1917 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1918 // No commitment_signed so get_event_msg's assert(len == 1) passes
1919 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1920 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1921 check_added_monitors!(node_b, 1);
1924 assert!(chan_msgs.2.is_none());
1928 for chan_msgs in resp_2.drain(..) {
1929 if send_funding_locked.1 {
1930 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1931 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1932 if !announcement_event.is_empty() {
1933 assert_eq!(announcement_event.len(), 1);
1934 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1935 //TODO: Test announcement_sigs re-sending
1936 } else { panic!("Unexpected event!"); }
1939 assert!(chan_msgs.0.is_none());
1942 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1943 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1944 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1945 check_added_monitors!(node_b, 1);
1947 assert!(chan_msgs.1.is_none());
1949 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 {
1950 let commitment_update = chan_msgs.2.unwrap();
1951 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1952 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1954 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
1955 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
1956 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1957 for update_add in commitment_update.update_add_htlcs {
1958 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1960 for update_fulfill in commitment_update.update_fulfill_htlcs {
1961 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1963 for update_fail in commitment_update.update_fail_htlcs {
1964 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1967 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1968 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1970 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1971 check_added_monitors!(node_b, 1);
1972 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1973 // No commitment_signed so get_event_msg's assert(len == 1) passes
1974 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1975 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1976 check_added_monitors!(node_a, 1);
1979 assert!(chan_msgs.2.is_none());