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, keysinterface::KeysInterface};
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, MIN_CLTV_EXPIRY_DELTA};
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;
26 use util::test_utils::{panicking, 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::hash_types::BlockHash;
38 use bitcoin::hashes::sha256::Hash as Sha256;
39 use bitcoin::hashes::Hash as _;
41 use bitcoin::secp256k1::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.
55 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
56 /// output is the 1st output in the transaction.
57 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
58 let scid = confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
59 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
62 /// Mine a signle block containing the given transaction
63 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
64 let height = node.best_block_info().1 + 1;
65 confirm_transaction_at(node, tx, height);
67 /// Mine the given transaction at the given height, mining blocks as required to build to that
70 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
71 /// output is the 1st output in the transaction.
72 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
73 let first_connect_height = node.best_block_info().1 + 1;
74 assert!(first_connect_height <= conf_height);
75 if conf_height > first_connect_height {
76 connect_blocks(node, conf_height - first_connect_height);
78 let mut block = Block {
79 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: conf_height, bits: 42, nonce: 42 },
82 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
83 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
85 block.txdata.push(tx.clone());
86 connect_block(node, &block);
87 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
90 /// The possible ways we may notify a ChannelManager of a new block
91 #[derive(Clone, Copy, Debug, PartialEq)]
92 pub enum ConnectStyle {
93 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
94 /// the header and height information.
96 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
97 /// make a single `best_block_updated` call.
98 BestBlockFirstSkippingBlocks,
99 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
100 /// `transaction_unconfirmed` is called.
101 BestBlockFirstReorgsOnlyTip,
102 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
103 /// the header and height information.
105 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
106 /// make a single `best_block_updated` call.
107 TransactionsFirstSkippingBlocks,
108 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
109 /// `transaction_unconfirmed` is called.
110 TransactionsFirstReorgsOnlyTip,
111 /// Provides the full block via the `chain::Listen` interface. In the current code this is
112 /// equivalent to `TransactionsFirst` with some additional assertions.
117 fn random_style() -> ConnectStyle {
118 #[cfg(feature = "std")] {
119 use core::hash::{BuildHasher, Hasher};
120 // Get a random value using the only std API to do so - the DefaultHasher
121 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
122 let res = match rand_val % 7 {
123 0 => ConnectStyle::BestBlockFirst,
124 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
125 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
126 3 => ConnectStyle::TransactionsFirst,
127 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
128 5 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
129 6 => ConnectStyle::FullBlockViaListen,
132 eprintln!("Using Block Connection Style: {:?}", res);
135 #[cfg(not(feature = "std"))] {
136 ConnectStyle::FullBlockViaListen
141 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
142 let skip_intermediaries = match *node.connect_style.borrow() {
143 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
144 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
148 let height = node.best_block_info().1 + 1;
149 let mut block = Block {
150 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: height, bits: 42, nonce: 42 },
155 let prev_blockhash = block.header.block_hash();
156 do_connect_block(node, block, skip_intermediaries);
158 header: BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: Default::default(), time: height + i, bits: 42, nonce: 42 },
162 let hash = block.header.block_hash();
163 do_connect_block(node, block, false);
167 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
168 do_connect_block(node, block.clone(), false);
171 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
172 // Ensure `get_claimable_balances`' self-tests never panic
173 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
174 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
178 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
179 call_claimable_balances(node);
180 let height = node.best_block_info().1 + 1;
181 #[cfg(feature = "std")] {
182 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
184 if !skip_intermediaries {
185 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
186 match *node.connect_style.borrow() {
187 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
188 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
189 call_claimable_balances(node);
190 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
191 node.node.best_block_updated(&block.header, height);
192 node.node.transactions_confirmed(&block.header, &txdata, height);
194 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
195 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
196 call_claimable_balances(node);
197 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
198 node.node.transactions_confirmed(&block.header, &txdata, height);
199 node.node.best_block_updated(&block.header, height);
201 ConnectStyle::FullBlockViaListen => {
202 node.chain_monitor.chain_monitor.block_connected(&block, height);
203 node.node.block_connected(&block, height);
207 call_claimable_balances(node);
208 node.node.test_process_background_events();
209 node.blocks.lock().unwrap().push((block, height));
212 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
213 call_claimable_balances(node);
214 #[cfg(feature = "std")] {
215 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
218 let orig = node.blocks.lock().unwrap().pop().unwrap();
219 assert!(orig.1 > 0); // Cannot disconnect genesis
220 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
222 match *node.connect_style.borrow() {
223 ConnectStyle::FullBlockViaListen => {
224 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
225 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
227 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
229 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
230 node.node.best_block_updated(&prev.0.header, prev.1);
233 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
234 for tx in orig.0.txdata {
235 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
236 node.node.transaction_unconfirmed(&tx.txid());
240 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
241 node.node.best_block_updated(&prev.0.header, prev.1);
244 call_claimable_balances(node);
248 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
249 let count = node.blocks.lock().unwrap().len() as u32 - 1;
250 disconnect_blocks(node, count);
253 pub struct TestChanMonCfg {
254 pub tx_broadcaster: test_utils::TestBroadcaster,
255 pub fee_estimator: test_utils::TestFeeEstimator,
256 pub chain_source: test_utils::TestChainSource,
257 pub persister: test_utils::TestPersister,
258 pub logger: test_utils::TestLogger,
259 pub keys_manager: test_utils::TestKeysInterface,
260 pub network_graph: NetworkGraph,
263 pub struct NodeCfg<'a> {
264 pub chain_source: &'a test_utils::TestChainSource,
265 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
266 pub fee_estimator: &'a test_utils::TestFeeEstimator,
267 pub chain_monitor: test_utils::TestChainMonitor<'a>,
268 pub keys_manager: &'a test_utils::TestKeysInterface,
269 pub logger: &'a test_utils::TestLogger,
270 pub network_graph: &'a NetworkGraph,
271 pub node_seed: [u8; 32],
272 pub features: InitFeatures,
275 pub struct Node<'a, 'b: 'a, 'c: 'b> {
276 pub chain_source: &'c test_utils::TestChainSource,
277 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
278 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
279 pub keys_manager: &'b test_utils::TestKeysInterface,
280 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
281 pub network_graph: &'c NetworkGraph,
282 pub net_graph_msg_handler: NetGraphMsgHandler<&'c NetworkGraph, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
283 pub node_seed: [u8; 32],
284 pub network_payment_count: Rc<RefCell<u8>>,
285 pub network_chan_count: Rc<RefCell<u32>>,
286 pub logger: &'c test_utils::TestLogger,
287 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
288 pub connect_style: Rc<RefCell<ConnectStyle>>,
290 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
291 pub fn best_block_hash(&self) -> BlockHash {
292 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
294 pub fn best_block_info(&self) -> (BlockHash, u32) {
295 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
297 pub fn get_block_header(&self, height: u32) -> BlockHeader {
298 self.blocks.lock().unwrap()[height as usize].0.header
302 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
305 // Check that we processed all pending events
306 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
307 assert!(self.node.get_and_clear_pending_events().is_empty());
308 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
310 // Check that if we serialize the Router, we can deserialize it again.
312 let mut w = test_utils::TestVecWriter(Vec::new());
313 self.network_graph.write(&mut w).unwrap();
314 let network_graph_deser = <NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap();
315 assert!(network_graph_deser == *self.network_graph);
316 let net_graph_msg_handler = NetGraphMsgHandler::new(
317 &network_graph_deser, Some(self.chain_source), self.logger
319 let mut chan_progress = 0;
321 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
322 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
323 assert!(orig_announcements == deserialized_announcements);
324 chan_progress = match orig_announcements.last() {
325 Some(announcement) => announcement.0.contents.short_channel_id + 1,
329 let mut node_progress = None;
331 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
332 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
333 assert!(orig_announcements == deserialized_announcements);
334 node_progress = match orig_announcements.last() {
335 Some(announcement) => Some(announcement.contents.node_id),
341 // Check that if we serialize and then deserialize all our channel monitors we get the
342 // same set of outputs to watch for on chain as we have now. Note that if we write
343 // tests that fully close channels and remove the monitors at some point this may break.
344 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
345 let mut deserialized_monitors = Vec::new();
347 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
348 let mut w = test_utils::TestVecWriter(Vec::new());
349 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
350 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
351 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
352 deserialized_monitors.push(deserialized_monitor);
356 // Before using all the new monitors to check the watch outpoints, use the full set of
357 // them to ensure we can write and reload our ChannelManager.
359 let mut channel_monitors = HashMap::new();
360 for monitor in deserialized_monitors.iter_mut() {
361 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
364 let mut w = test_utils::TestVecWriter(Vec::new());
365 self.node.write(&mut w).unwrap();
366 <(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 {
367 default_config: *self.node.get_current_default_configuration(),
368 keys_manager: self.keys_manager,
369 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
370 chain_monitor: self.chain_monitor,
371 tx_broadcaster: &test_utils::TestBroadcaster {
372 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
373 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
375 logger: &self.logger,
380 let persister = test_utils::TestPersister::new();
381 let broadcaster = test_utils::TestBroadcaster {
382 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
383 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
385 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
386 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
387 for deserialized_monitor in deserialized_monitors.drain(..) {
388 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
392 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
393 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
398 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) {
399 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
402 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) {
403 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
404 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
405 (announcement, as_update, bs_update, channel_id, tx)
409 /// Gets an RAA and CS which were sent in response to a commitment update
410 macro_rules! get_revoke_commit_msgs {
411 ($node: expr, $node_id: expr) => {
413 use $crate::util::events::MessageSendEvent;
414 let events = $node.node.get_and_clear_pending_msg_events();
415 assert_eq!(events.len(), 2);
417 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
418 assert_eq!(*node_id, $node_id);
421 _ => panic!("Unexpected event"),
423 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
424 assert_eq!(*node_id, $node_id);
425 assert!(updates.update_add_htlcs.is_empty());
426 assert!(updates.update_fulfill_htlcs.is_empty());
427 assert!(updates.update_fail_htlcs.is_empty());
428 assert!(updates.update_fail_malformed_htlcs.is_empty());
429 assert!(updates.update_fee.is_none());
430 updates.commitment_signed.clone()
432 _ => panic!("Unexpected event"),
438 /// Get an specific event message from the pending events queue.
440 macro_rules! get_event_msg {
441 ($node: expr, $event_type: path, $node_id: expr) => {
443 let events = $node.node.get_and_clear_pending_msg_events();
444 assert_eq!(events.len(), 1);
446 $event_type { ref node_id, ref msg } => {
447 assert_eq!(*node_id, $node_id);
450 _ => panic!("Unexpected event"),
456 /// Get an error message from the pending events queue.
458 macro_rules! get_err_msg {
459 ($node: expr, $node_id: expr) => {
461 let events = $node.node.get_and_clear_pending_msg_events();
462 assert_eq!(events.len(), 1);
464 $crate::util::events::MessageSendEvent::HandleError {
465 action: $crate::ln::msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
467 assert_eq!(*node_id, $node_id);
470 _ => panic!("Unexpected event"),
476 /// Get a specific event from the pending events queue.
478 macro_rules! get_event {
479 ($node: expr, $event_type: path) => {
481 let mut events = $node.node.get_and_clear_pending_events();
482 assert_eq!(events.len(), 1);
483 let ev = events.pop().unwrap();
485 $event_type { .. } => {
488 _ => panic!("Unexpected event"),
495 /// Gets an UpdateHTLCs MessageSendEvent
496 macro_rules! get_htlc_update_msgs {
497 ($node: expr, $node_id: expr) => {
499 let events = $node.node.get_and_clear_pending_msg_events();
500 assert_eq!(events.len(), 1);
502 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
503 assert_eq!(*node_id, $node_id);
506 _ => panic!("Unexpected event"),
513 macro_rules! get_channel_ref {
514 ($node: expr, $lock: ident, $channel_id: expr) => {
516 $lock = $node.node.channel_state.lock().unwrap();
517 $lock.by_id.get_mut(&$channel_id).unwrap()
523 macro_rules! get_feerate {
524 ($node: expr, $channel_id: expr) => {
527 let chan = get_channel_ref!($node, lock, $channel_id);
534 macro_rules! get_opt_anchors {
535 ($node: expr, $channel_id: expr) => {
538 let chan = get_channel_ref!($node, lock, $channel_id);
544 /// Returns a channel monitor given a channel id, making some naive assumptions
546 macro_rules! get_monitor {
547 ($node: expr, $channel_id: expr) => {
549 use bitcoin::hashes::Hash;
550 let mut monitor = None;
551 // Assume funding vout is either 0 or 1 blindly
553 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
554 $crate::chain::transaction::OutPoint {
555 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
567 /// Returns any local commitment transactions for the channel.
569 macro_rules! get_local_commitment_txn {
570 ($node: expr, $channel_id: expr) => {
572 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
577 /// Check the error from attempting a payment.
579 macro_rules! unwrap_send_err {
580 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
582 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
583 assert_eq!(fails.len(), 1);
589 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
590 assert_eq!(results.len(), 1);
592 Err($type) => { $check },
601 /// Check whether N channel monitor(s) have been added.
603 macro_rules! check_added_monitors {
604 ($node: expr, $count: expr) => {
606 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
607 assert_eq!(added_monitors.len(), $count);
608 added_monitors.clear();
613 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u64) -> ([u8; 32], Transaction, OutPoint) {
614 let chan_id = *node.network_chan_count.borrow();
616 let events = node.node.get_and_clear_pending_events();
617 assert_eq!(events.len(), 1);
619 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
620 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
621 assert_eq!(*channel_value_satoshis, expected_chan_value);
622 assert_eq!(user_channel_id, expected_user_chan_id);
624 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
625 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
627 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
628 (*temporary_channel_id, tx, funding_outpoint)
630 _ => panic!("Unexpected event"),
633 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 {
634 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
635 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
637 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
638 check_added_monitors!(node_a, 0);
640 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
641 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
642 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
644 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
645 assert_eq!(added_monitors.len(), 1);
646 assert_eq!(added_monitors[0].0, funding_output);
647 added_monitors.clear();
650 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()));
652 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
653 assert_eq!(added_monitors.len(), 1);
654 assert_eq!(added_monitors[0].0, funding_output);
655 added_monitors.clear();
658 let events_4 = node_a.node.get_and_clear_pending_events();
659 assert_eq!(events_4.len(), 0);
661 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
662 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
663 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
665 // Ensure that funding_transaction_generated is idempotent.
666 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
667 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
668 check_added_monitors!(node_a, 0);
673 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 {
674 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
675 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
676 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
677 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
678 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
679 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
680 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
682 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
685 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) {
686 confirm_transaction_at(node_conf, tx, conf_height);
687 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
688 node_recv.node.handle_channel_ready(&node_conf.node.get_our_node_id(), &get_event_msg!(node_conf, MessageSendEvent::SendChannelReady, node_recv.node.get_our_node_id()));
691 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::ChannelReady, msgs::AnnouncementSignatures), [u8; 32]) {
693 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
694 assert_eq!(events_6.len(), 3);
695 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
696 assert_eq!(*node_id, node_recv.node.get_our_node_id());
698 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
699 assert_eq!(*node_id, node_recv.node.get_our_node_id());
701 } else { panic!("Unexpected event: {:?}", events_6[1]); };
702 ((match events_6[0] {
703 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
704 channel_id = msg.channel_id.clone();
705 assert_eq!(*node_id, node_recv.node.get_our_node_id());
708 _ => panic!("Unexpected event"),
709 }, match events_6[announcement_sigs_idx] {
710 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
711 assert_eq!(*node_id, node_recv.node.get_our_node_id());
714 _ => panic!("Unexpected event"),
718 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::ChannelReady, msgs::AnnouncementSignatures), [u8; 32]) {
719 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
720 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
721 confirm_transaction_at(node_a, tx, conf_height);
722 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
723 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
726 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::ChannelReady, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
727 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
728 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
732 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::ChannelReady, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
733 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
734 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
735 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
737 let events_7 = node_b.node.get_and_clear_pending_msg_events();
738 assert_eq!(events_7.len(), 1);
739 let (announcement, bs_update) = match events_7[0] {
740 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
743 _ => panic!("Unexpected event"),
746 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
747 let events_8 = node_a.node.get_and_clear_pending_msg_events();
748 assert_eq!(events_8.len(), 1);
749 let as_update = match events_8[0] {
750 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
751 assert!(*announcement == *msg);
752 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
753 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
756 _ => panic!("Unexpected event"),
759 *node_a.network_chan_count.borrow_mut() += 1;
761 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
764 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) {
765 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
768 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) {
769 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
770 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
771 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
774 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::ChannelReady, Transaction) {
775 let mut no_announce_cfg = test_default_channel_config();
776 no_announce_cfg.channel_options.announced_channel = false;
777 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
778 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
779 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), a_flags, &open_channel);
780 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
781 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), b_flags, &accept_channel);
783 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
784 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
785 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()));
786 check_added_monitors!(nodes[b], 1);
788 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
789 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
790 check_added_monitors!(nodes[a], 1);
792 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
793 confirm_transaction_at(&nodes[a], &tx, conf_height);
794 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
795 confirm_transaction_at(&nodes[b], &tx, conf_height);
796 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
797 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
798 nodes[a].node.handle_channel_ready(&nodes[b].node.get_our_node_id(), &get_event_msg!(nodes[b], MessageSendEvent::SendChannelReady, nodes[a].node.get_our_node_id()));
799 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
800 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
801 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
803 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
804 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
806 let mut found_a = false;
807 for chan in nodes[a].node.list_usable_channels() {
808 if chan.channel_id == as_channel_ready.channel_id {
811 assert!(!chan.is_public);
816 let mut found_b = false;
817 for chan in nodes[b].node.list_usable_channels() {
818 if chan.channel_id == as_channel_ready.channel_id {
821 assert!(!chan.is_public);
826 (as_channel_ready, tx)
829 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) {
830 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
831 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
832 assert!(a_events.len() >= 2);
834 // ann should be re-generated by broadcast_node_announcement - check that we have it.
835 let mut found_ann_1 = false;
836 for event in a_events.iter() {
838 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
839 if msg == ann { found_ann_1 = true; }
841 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
842 _ => panic!("Unexpected event {:?}", event),
845 assert!(found_ann_1);
847 let a_node_announcement = match a_events.last().unwrap() {
848 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
851 _ => panic!("Unexpected event"),
854 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
855 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
856 assert!(b_events.len() >= 2);
858 // ann should be re-generated by broadcast_node_announcement - check that we have it.
859 let mut found_ann_2 = false;
860 for event in b_events.iter() {
862 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
863 if msg == ann { found_ann_2 = true; }
865 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
866 _ => panic!("Unexpected event"),
869 assert!(found_ann_2);
871 let b_node_announcement = match b_events.last().unwrap() {
872 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
875 _ => panic!("Unexpected event"),
879 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
880 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
881 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
882 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
883 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
885 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
886 // forwarding info for local channels even if its not accepted in the network graph.
887 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
888 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
893 macro_rules! check_spends {
894 ($tx: expr, $($spends_txn: expr),*) => {
897 for outp in $spends_txn.output.iter() {
898 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Input tx output didn't meet dust limit");
901 for outp in $tx.output.iter() {
902 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Spending tx output didn't meet dust limit");
904 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
906 if out_point.txid == $spends_txn.txid() {
907 return $spends_txn.output.get(out_point.vout as usize).cloned()
912 let mut total_value_in = 0;
913 for input in $tx.input.iter() {
914 total_value_in += get_output(&input.previous_output).unwrap().value;
916 let mut total_value_out = 0;
917 for output in $tx.output.iter() {
918 total_value_out += output.value;
920 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
921 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
922 assert!(total_value_out + min_fee <= total_value_in);
923 $tx.verify(get_output).unwrap();
928 macro_rules! get_closing_signed_broadcast {
929 ($node: expr, $dest_pubkey: expr) => {
931 let events = $node.get_and_clear_pending_msg_events();
932 assert!(events.len() == 1 || events.len() == 2);
933 (match events[events.len() - 1] {
934 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
935 assert_eq!(msg.contents.flags & 2, 2);
938 _ => panic!("Unexpected event"),
939 }, if events.len() == 2 {
941 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
942 assert_eq!(*node_id, $dest_pubkey);
945 _ => panic!("Unexpected event"),
953 macro_rules! check_warn_msg {
954 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
955 let msg_events = $node.node.get_and_clear_pending_msg_events();
956 assert_eq!(msg_events.len(), 1);
957 match msg_events[0] {
958 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
959 assert_eq!(node_id, $recipient_node_id);
960 assert_eq!(msg.channel_id, $chan_id);
963 _ => panic!("Unexpected event"),
968 /// Check that a channel's closing channel update has been broadcasted, and optionally
969 /// check whether an error message event has occurred.
971 macro_rules! check_closed_broadcast {
972 ($node: expr, $with_error_msg: expr) => {{
973 use $crate::util::events::MessageSendEvent;
974 use $crate::ln::msgs::ErrorAction;
976 let msg_events = $node.node.get_and_clear_pending_msg_events();
977 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
978 match msg_events[0] {
979 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
980 assert_eq!(msg.contents.flags & 2, 2);
982 _ => panic!("Unexpected event"),
985 match msg_events[1] {
986 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
987 // TODO: Check node_id
990 _ => panic!("Unexpected event"),
996 /// Check that a channel's closing channel events has been issued
998 macro_rules! check_closed_event {
999 ($node: expr, $events: expr, $reason: expr) => {
1000 check_closed_event!($node, $events, $reason, false);
1002 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1003 use $crate::util::events::Event;
1005 let events = $node.node.get_and_clear_pending_events();
1006 assert_eq!(events.len(), $events);
1007 let expected_reason = $reason;
1008 let mut issues_discard_funding = false;
1009 for event in events {
1011 Event::ChannelClosed { ref reason, .. } => {
1012 assert_eq!(*reason, expected_reason);
1014 Event::DiscardFunding { .. } => {
1015 issues_discard_funding = true;
1017 _ => panic!("Unexpected event"),
1020 assert_eq!($is_check_discard_funding, issues_discard_funding);
1024 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) {
1025 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) };
1026 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) };
1029 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1030 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()));
1032 let events_1 = node_b.get_and_clear_pending_msg_events();
1033 assert!(events_1.len() >= 1);
1034 let shutdown_b = match events_1[0] {
1035 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1036 assert_eq!(node_id, &node_a.get_our_node_id());
1039 _ => panic!("Unexpected event"),
1042 let closing_signed_b = if !close_inbound_first {
1043 assert_eq!(events_1.len(), 1);
1046 Some(match events_1[1] {
1047 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1048 assert_eq!(node_id, &node_a.get_our_node_id());
1051 _ => panic!("Unexpected event"),
1055 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
1056 let (as_update, bs_update) = if close_inbound_first {
1057 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1058 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1060 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1061 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1062 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1063 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1065 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1066 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1067 assert!(none_a.is_none());
1068 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1069 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1070 (as_update, bs_update)
1072 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1074 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1075 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1077 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1078 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1079 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1081 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1082 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1083 assert!(none_b.is_none());
1084 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1085 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1086 (as_update, bs_update)
1088 assert_eq!(tx_a, tx_b);
1089 check_spends!(tx_a, funding_tx);
1091 (as_update, bs_update, tx_a)
1094 pub struct SendEvent {
1095 pub node_id: PublicKey,
1096 pub msgs: Vec<msgs::UpdateAddHTLC>,
1097 pub commitment_msg: msgs::CommitmentSigned,
1100 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1101 assert!(updates.update_fulfill_htlcs.is_empty());
1102 assert!(updates.update_fail_htlcs.is_empty());
1103 assert!(updates.update_fail_malformed_htlcs.is_empty());
1104 assert!(updates.update_fee.is_none());
1105 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1108 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1110 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1111 _ => panic!("Unexpected event type!"),
1115 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1116 let mut events = node.node.get_and_clear_pending_msg_events();
1117 assert_eq!(events.len(), 1);
1118 SendEvent::from_event(events.pop().unwrap())
1123 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1124 /// commitment update.
1125 macro_rules! commitment_signed_dance {
1126 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1128 check_added_monitors!($node_a, 0);
1129 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1130 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1131 check_added_monitors!($node_a, 1);
1132 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1135 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1137 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1138 check_added_monitors!($node_b, 0);
1139 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1140 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1141 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1142 check_added_monitors!($node_b, 1);
1143 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1144 let (bs_revoke_and_ack, extra_msg_option) = {
1145 let events = $node_b.node.get_and_clear_pending_msg_events();
1146 assert!(events.len() <= 2);
1148 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1149 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1152 _ => panic!("Unexpected event"),
1153 }, events.get(1).map(|e| e.clone()))
1155 check_added_monitors!($node_b, 1);
1156 if $fail_backwards {
1157 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1158 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1160 (extra_msg_option, bs_revoke_and_ack)
1163 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1165 check_added_monitors!($node_a, 0);
1166 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1167 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1168 check_added_monitors!($node_a, 1);
1169 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1170 assert!(extra_msg_option.is_none());
1174 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1176 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1177 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1178 check_added_monitors!($node_a, 1);
1182 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1184 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1187 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1189 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1190 if $fail_backwards {
1191 $crate::expect_pending_htlcs_forwardable!($node_a);
1192 check_added_monitors!($node_a, 1);
1194 let channel_state = $node_a.node.channel_state.lock().unwrap();
1195 assert_eq!(channel_state.pending_msg_events.len(), 1);
1196 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1197 assert_ne!(*node_id, $node_b.node.get_our_node_id());
1198 } else { panic!("Unexpected event"); }
1200 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1206 /// Get a payment preimage and hash.
1208 macro_rules! get_payment_preimage_hash {
1209 ($dest_node: expr) => {
1211 get_payment_preimage_hash!($dest_node, None)
1214 ($dest_node: expr, $min_value_msat: expr) => {
1216 use bitcoin::hashes::Hash as _;
1217 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1218 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1219 *payment_count += 1;
1220 let payment_hash = $crate::ln::PaymentHash(
1221 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1222 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1223 (payment_preimage, payment_hash, payment_secret)
1229 macro_rules! get_route {
1230 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1231 use $crate::chain::keysinterface::KeysInterface;
1232 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1233 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1234 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1235 $crate::routing::router::get_route(
1236 &$send_node.node.get_our_node_id(), &$payment_params, &$send_node.network_graph.read_only(),
1237 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1238 $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1245 macro_rules! get_route_and_payment_hash {
1246 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1247 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1248 .with_features($crate::ln::features::InvoiceFeatures::known());
1249 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1251 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1252 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1253 let route = $crate::get_route!($send_node, $payment_params, $recv_value, $cltv);
1254 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1259 /// Clears (and ignores) a PendingHTLCsForwardable event
1260 macro_rules! expect_pending_htlcs_forwardable_ignore {
1262 let events = $node.node.get_and_clear_pending_events();
1263 assert_eq!(events.len(), 1);
1265 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1266 _ => panic!("Unexpected event"),
1272 /// Handles a PendingHTLCsForwardable event
1273 macro_rules! expect_pending_htlcs_forwardable {
1275 $crate::expect_pending_htlcs_forwardable_ignore!($node);
1276 $node.node.process_pending_htlc_forwards();
1278 // Ensure process_pending_htlc_forwards is idempotent.
1279 $node.node.process_pending_htlc_forwards();
1284 macro_rules! expect_pending_htlcs_forwardable_from_events {
1285 ($node: expr, $events: expr, $ignore: expr) => {{
1286 assert_eq!($events.len(), 1);
1288 Event::PendingHTLCsForwardable { .. } => { },
1289 _ => panic!("Unexpected event"),
1292 $node.node.process_pending_htlc_forwards();
1294 // Ensure process_pending_htlc_forwards is idempotent.
1295 $node.node.process_pending_htlc_forwards();
1301 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1302 macro_rules! expect_payment_received {
1303 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1304 expect_payment_received!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None)
1306 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr) => {
1307 let events = $node.node.get_and_clear_pending_events();
1308 assert_eq!(events.len(), 1);
1310 $crate::util::events::Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1311 assert_eq!($expected_payment_hash, *payment_hash);
1312 assert_eq!($expected_recv_value, amount_msat);
1314 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1315 assert_eq!(&$expected_payment_preimage, payment_preimage);
1316 assert_eq!($expected_payment_secret, *payment_secret);
1321 _ => panic!("Unexpected event"),
1327 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1328 macro_rules! expect_payment_claimed {
1329 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1330 let events = $node.node.get_and_clear_pending_events();
1331 assert_eq!(events.len(), 1);
1333 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1334 assert_eq!($expected_payment_hash, *payment_hash);
1335 assert_eq!($expected_recv_value, amount_msat);
1337 _ => panic!("Unexpected event"),
1344 macro_rules! expect_payment_sent_without_paths {
1345 ($node: expr, $expected_payment_preimage: expr) => {
1346 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1348 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1349 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1354 macro_rules! expect_payment_sent {
1355 ($node: expr, $expected_payment_preimage: expr) => {
1356 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1358 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1359 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1361 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1362 use bitcoin::hashes::Hash as _;
1363 let events = $node.node.get_and_clear_pending_events();
1364 let expected_payment_hash = $crate::ln::PaymentHash(
1365 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1367 assert!(events.len() > 1);
1369 assert_eq!(events.len(), 1);
1371 let expected_payment_id = match events[0] {
1372 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1373 assert_eq!($expected_payment_preimage, *payment_preimage);
1374 assert_eq!(expected_payment_hash, *payment_hash);
1375 assert!(fee_paid_msat.is_some());
1376 if $expected_fee_msat_opt.is_some() {
1377 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1381 _ => panic!("Unexpected event"),
1384 for i in 1..events.len() {
1386 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1387 assert_eq!(payment_id, expected_payment_id);
1388 assert_eq!(payment_hash, Some(expected_payment_hash));
1390 _ => panic!("Unexpected event"),
1399 macro_rules! expect_payment_path_successful {
1401 let events = $node.node.get_and_clear_pending_events();
1402 assert_eq!(events.len(), 1);
1404 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1405 _ => panic!("Unexpected event"),
1410 macro_rules! expect_payment_forwarded {
1411 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1412 let events = $node.node.get_and_clear_pending_events();
1413 assert_eq!(events.len(), 1);
1415 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1416 assert_eq!(fee_earned_msat, $expected_fee);
1417 if fee_earned_msat.is_some() {
1418 // Is the event prev_channel_id in one of the channels between the two nodes?
1419 assert!($node.node.list_channels().iter().any(|x| x.counterparty.node_id == $prev_node.node.get_our_node_id() && x.channel_id == prev_channel_id.unwrap()));
1421 // We check for force closures since a force closed channel is removed from the
1422 // node's channel list
1423 if !$downstream_force_closed {
1424 assert!($node.node.list_channels().iter().any(|x| x.counterparty.node_id == $next_node.node.get_our_node_id() && x.channel_id == next_channel_id.unwrap()));
1426 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1428 _ => panic!("Unexpected event"),
1433 pub struct PaymentFailedConditions<'a> {
1434 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1435 pub(crate) expected_blamed_scid: Option<u64>,
1436 pub(crate) expected_blamed_chan_closed: Option<bool>,
1437 pub(crate) expected_mpp_parts_remain: bool,
1440 impl<'a> PaymentFailedConditions<'a> {
1441 pub fn new() -> Self {
1443 expected_htlc_error_data: None,
1444 expected_blamed_scid: None,
1445 expected_blamed_chan_closed: None,
1446 expected_mpp_parts_remain: false,
1449 pub fn mpp_parts_remain(mut self) -> Self {
1450 self.expected_mpp_parts_remain = true;
1453 pub fn blamed_scid(mut self, scid: u64) -> Self {
1454 self.expected_blamed_scid = Some(scid);
1457 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1458 self.expected_blamed_chan_closed = Some(closed);
1461 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1462 self.expected_htlc_error_data = Some((code, data));
1468 macro_rules! expect_payment_failed_with_update {
1469 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1470 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest,
1471 $crate::ln::functional_test_utils::PaymentFailedConditions::new().blamed_scid($scid).blamed_chan_closed($chan_closed));
1476 macro_rules! expect_payment_failed {
1477 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1478 #[allow(unused_mut)]
1479 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1481 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1483 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest, conditions);
1488 macro_rules! expect_payment_failed_conditions {
1489 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $conditions: expr) => {
1490 let events = $node.node.get_and_clear_pending_events();
1491 assert_eq!(events.len(), 1);
1492 let expected_payment_id = match events[0] {
1493 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data, ref path, ref retry, ref payment_id, ref network_update, .. } => {
1494 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1495 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1496 assert!(retry.is_some(), "expected retry.is_some()");
1497 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1498 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1500 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1501 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1502 if let Some((code, data)) = $conditions.expected_htlc_error_data {
1503 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1504 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1507 if let Some(chan_closed) = $conditions.expected_blamed_chan_closed {
1508 match network_update {
1509 &Some($crate::routing::network_graph::NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1510 if let Some(scid) = $conditions.expected_blamed_scid {
1511 assert_eq!(msg.contents.short_channel_id, scid);
1513 assert_eq!(msg.contents.flags & 2, 0);
1515 &Some($crate::routing::network_graph::NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if chan_closed => {
1516 if let Some(scid) = $conditions.expected_blamed_scid {
1517 assert_eq!(short_channel_id, scid);
1519 assert!(is_permanent);
1521 Some(_) => panic!("Unexpected update type"),
1522 None => panic!("Expected update"),
1528 _ => panic!("Unexpected event"),
1530 if !$conditions.expected_mpp_parts_remain {
1531 $node.node.abandon_payment(expected_payment_id);
1532 let events = $node.node.get_and_clear_pending_events();
1533 assert_eq!(events.len(), 1);
1535 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1536 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected second payment_hash");
1537 assert_eq!(*payment_id, expected_payment_id);
1539 _ => panic!("Unexpected second event"),
1545 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 {
1546 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1547 check_added_monitors!(origin_node, expected_paths.len());
1548 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1552 pub fn do_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, clear_recipient_events: bool, expected_preimage: Option<PaymentPreimage>) {
1553 let mut payment_event = SendEvent::from_event(ev);
1554 let mut prev_node = origin_node;
1556 for (idx, &node) in expected_path.iter().enumerate() {
1557 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1559 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1560 check_added_monitors!(node, 0);
1561 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1563 expect_pending_htlcs_forwardable!(node);
1565 if idx == expected_path.len() - 1 && clear_recipient_events {
1566 let events_2 = node.node.get_and_clear_pending_events();
1567 if payment_received_expected {
1568 assert_eq!(events_2.len(), 1);
1570 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1571 assert_eq!(our_payment_hash, *payment_hash);
1573 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1574 assert_eq!(expected_preimage, *payment_preimage);
1575 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1577 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1578 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1579 assert!(our_payment_secret.is_none());
1582 assert_eq!(amount_msat, recv_value);
1584 _ => panic!("Unexpected event"),
1587 assert!(events_2.is_empty());
1589 } else if idx != expected_path.len() - 1 {
1590 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1591 assert_eq!(events_2.len(), 1);
1592 check_added_monitors!(node, 1);
1593 payment_event = SendEvent::from_event(events_2.remove(0));
1594 assert_eq!(payment_event.msgs.len(), 1);
1601 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>) {
1602 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_received_expected, true, expected_preimage);
1605 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) {
1606 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1607 assert_eq!(events.len(), expected_route.len());
1608 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1609 // Once we've gotten through all the HTLCs, the last one should result in a
1610 // PaymentReceived (but each previous one should not!), .
1611 let expect_payment = path_idx == expected_route.len() - 1;
1612 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1616 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) {
1617 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1618 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1619 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1622 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 {
1623 for path in expected_paths.iter() {
1624 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1626 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1628 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
1629 assert_eq!(claim_event.len(), 1);
1630 match claim_event[0] {
1631 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
1632 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
1633 assert_eq!(preimage, our_payment_preimage),
1634 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
1635 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
1639 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1641 let mut expected_total_fee_msat = 0;
1643 macro_rules! msgs_from_ev {
1646 &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 } } => {
1647 assert!(update_add_htlcs.is_empty());
1648 assert_eq!(update_fulfill_htlcs.len(), 1);
1649 assert!(update_fail_htlcs.is_empty());
1650 assert!(update_fail_malformed_htlcs.is_empty());
1651 assert!(update_fee.is_none());
1652 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1654 _ => panic!("Unexpected event"),
1658 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1659 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1660 assert_eq!(events.len(), expected_paths.len());
1661 for ev in events.iter() {
1662 per_path_msgs.push(msgs_from_ev!(ev));
1665 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1666 let mut next_msgs = Some(path_msgs);
1667 let mut expected_next_node = next_hop;
1669 macro_rules! last_update_fulfill_dance {
1670 ($node: expr, $prev_node: expr) => {
1672 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1673 check_added_monitors!($node, 0);
1674 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1675 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1679 macro_rules! mid_update_fulfill_dance {
1680 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
1682 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1683 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;
1684 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
1685 expected_total_fee_msat += fee as u64;
1686 check_added_monitors!($node, 1);
1687 let new_next_msgs = if $new_msgs {
1688 let events = $node.node.get_and_clear_pending_msg_events();
1689 assert_eq!(events.len(), 1);
1690 let (res, nexthop) = msgs_from_ev!(&events[0]);
1691 expected_next_node = nexthop;
1694 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1697 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1698 next_msgs = new_next_msgs;
1703 let mut prev_node = expected_route.last().unwrap();
1704 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1705 assert_eq!(expected_next_node, node.node.get_our_node_id());
1706 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1707 if next_msgs.is_some() {
1708 // Since we are traversing in reverse, next_node is actually the previous node
1709 let next_node: &Node;
1710 if idx == expected_route.len() - 1 {
1711 next_node = origin_node;
1713 next_node = expected_route[expected_route.len() - 1 - idx - 1];
1715 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
1717 assert!(!update_next_msgs);
1718 assert!(node.node.get_and_clear_pending_msg_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 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1732 // Ensure that claim_funds is idempotent.
1733 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1734 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1735 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1737 expected_total_fee_msat
1739 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) {
1740 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1742 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1746 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1747 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1750 pub const TEST_FINAL_CLTV: u32 = 70;
1752 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) {
1753 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1754 .with_features(InvoiceFeatures::known());
1755 let route = get_route!(origin_node, payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
1756 assert_eq!(route.paths.len(), 1);
1757 assert_eq!(route.paths[0].len(), expected_route.len());
1758 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1759 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1762 let res = send_along_route(origin_node, route, expected_route, recv_value);
1763 (res.0, res.1, res.2)
1766 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1767 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1768 .with_features(InvoiceFeatures::known());
1769 let network_graph = origin_node.network_graph.read_only();
1770 let scorer = test_utils::TestScorer::with_penalty(0);
1771 let seed = [0u8; 32];
1772 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1773 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1774 let route = get_route(
1775 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
1776 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
1777 assert_eq!(route.paths.len(), 1);
1778 assert_eq!(route.paths[0].len(), expected_route.len());
1779 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1780 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1783 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1784 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1785 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1788 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1789 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1790 claim_payment(&origin, expected_route, our_payment_preimage);
1793 pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
1794 for path in expected_paths.iter() {
1795 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1797 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
1798 expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1800 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
1803 pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
1804 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1805 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1807 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1808 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1809 assert_eq!(events.len(), expected_paths.len());
1810 for ev in events.iter() {
1811 let (update_fail, commitment_signed, node_id) = match ev {
1812 &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 } } => {
1813 assert!(update_add_htlcs.is_empty());
1814 assert!(update_fulfill_htlcs.is_empty());
1815 assert_eq!(update_fail_htlcs.len(), 1);
1816 assert!(update_fail_malformed_htlcs.is_empty());
1817 assert!(update_fee.is_none());
1818 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1820 _ => panic!("Unexpected event"),
1822 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1824 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1825 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()));
1827 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1828 let mut next_msgs = Some(path_msgs);
1829 let mut expected_next_node = next_hop;
1830 let mut prev_node = expected_route.last().unwrap();
1832 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1833 assert_eq!(expected_next_node, node.node.get_our_node_id());
1834 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1835 if next_msgs.is_some() {
1836 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1837 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1838 if !update_next_node {
1839 expect_pending_htlcs_forwardable!(node);
1842 let events = node.node.get_and_clear_pending_msg_events();
1843 if update_next_node {
1844 assert_eq!(events.len(), 1);
1846 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 } } => {
1847 assert!(update_add_htlcs.is_empty());
1848 assert!(update_fulfill_htlcs.is_empty());
1849 assert_eq!(update_fail_htlcs.len(), 1);
1850 assert!(update_fail_malformed_htlcs.is_empty());
1851 assert!(update_fee.is_none());
1852 expected_next_node = node_id.clone();
1853 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1855 _ => panic!("Unexpected event"),
1858 assert!(events.is_empty());
1860 if !skip_last && idx == expected_route.len() - 1 {
1861 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1868 let prev_node = expected_route.first().unwrap();
1869 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1870 check_added_monitors!(origin_node, 0);
1871 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1872 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1873 let events = origin_node.node.get_and_clear_pending_events();
1874 assert_eq!(events.len(), 1);
1875 let expected_payment_id = match events[0] {
1876 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, ref payment_id, .. } => {
1877 assert_eq!(payment_hash, our_payment_hash);
1878 assert!(rejected_by_dest);
1879 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1880 for (idx, hop) in expected_route.iter().enumerate() {
1881 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1885 _ => panic!("Unexpected event"),
1887 if i == expected_paths.len() - 1 {
1888 origin_node.node.abandon_payment(expected_payment_id);
1889 let events = origin_node.node.get_and_clear_pending_events();
1890 assert_eq!(events.len(), 1);
1892 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1893 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
1894 assert_eq!(*payment_id, expected_payment_id);
1896 _ => panic!("Unexpected second event"),
1902 // Ensure that fail_htlc_backwards is idempotent.
1903 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
1904 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
1905 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1906 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1909 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1910 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1913 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1914 let mut chan_mon_cfgs = Vec::new();
1915 for i in 0..node_count {
1916 let tx_broadcaster = test_utils::TestBroadcaster {
1917 txn_broadcasted: Mutex::new(Vec::new()),
1918 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
1920 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1921 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1922 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1923 let persister = test_utils::TestPersister::new();
1924 let seed = [i as u8; 32];
1925 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1926 let network_graph = NetworkGraph::new(chain_source.genesis_hash);
1928 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, network_graph });
1934 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1935 let mut nodes = Vec::new();
1937 for i in 0..node_count {
1938 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);
1939 let seed = [i as u8; 32];
1940 nodes.push(NodeCfg {
1941 chain_source: &chanmon_cfgs[i].chain_source,
1942 logger: &chanmon_cfgs[i].logger,
1943 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1944 fee_estimator: &chanmon_cfgs[i].fee_estimator,
1946 keys_manager: &chanmon_cfgs[i].keys_manager,
1948 features: InitFeatures::known(),
1949 network_graph: &chanmon_cfgs[i].network_graph,
1956 pub fn test_default_channel_config() -> UserConfig {
1957 let mut default_config = UserConfig::default();
1958 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1959 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1960 default_config.channel_options.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
1961 default_config.channel_options.announced_channel = true;
1962 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1963 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1964 // It now defaults to 1, so we simply set it to the expected value here.
1965 default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1966 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1967 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1968 default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1972 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>> {
1973 let mut chanmgrs = Vec::new();
1974 for i in 0..node_count {
1975 let network = Network::Testnet;
1976 let params = ChainParameters {
1978 best_block: BestBlock::from_genesis(network),
1980 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1981 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1982 chanmgrs.push(node);
1988 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>> {
1989 let mut nodes = Vec::new();
1990 let chan_count = Rc::new(RefCell::new(0));
1991 let payment_count = Rc::new(RefCell::new(0));
1992 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
1994 for i in 0..node_count {
1995 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].network_graph, None, cfgs[i].logger);
1997 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
1998 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
1999 node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, net_graph_msg_handler,
2000 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2001 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2002 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2003 connect_style: Rc::clone(&connect_style),
2007 for i in 0..node_count {
2008 for j in (i+1)..node_count {
2009 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone(), remote_network_address: None });
2010 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone(), remote_network_address: None });
2017 // Note that the following only works for CLTV values up to 128
2018 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2019 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
2021 #[derive(PartialEq)]
2022 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2023 /// Tests that the given node has broadcast transactions for the given Channel
2025 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2026 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2027 /// broadcast and the revoked outputs were claimed.
2029 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2030 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2032 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2034 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> {
2035 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2036 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2038 let mut res = Vec::with_capacity(2);
2039 node_txn.retain(|tx| {
2040 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2041 check_spends!(tx, chan.3);
2042 if commitment_tx.is_none() {
2043 res.push(tx.clone());
2048 if let Some(explicit_tx) = commitment_tx {
2049 res.push(explicit_tx.clone());
2052 assert_eq!(res.len(), 1);
2054 if has_htlc_tx != HTLCType::NONE {
2055 node_txn.retain(|tx| {
2056 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2057 check_spends!(tx, res[0]);
2058 if has_htlc_tx == HTLCType::TIMEOUT {
2059 assert!(tx.lock_time != 0);
2061 assert!(tx.lock_time == 0);
2063 res.push(tx.clone());
2067 assert!(res.len() == 2 || res.len() == 3);
2069 assert_eq!(res[1], res[2]);
2073 assert!(node_txn.is_empty());
2077 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2078 /// HTLC transaction.
2079 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2080 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2081 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2082 // for revoked htlc outputs
2083 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2084 node_txn.retain(|tx| {
2085 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2086 check_spends!(tx, revoked_tx);
2090 node_txn.retain(|tx| {
2091 check_spends!(tx, commitment_revoked_tx);
2094 assert!(node_txn.is_empty());
2097 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2098 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2100 assert!(node_txn.len() >= 1);
2101 assert_eq!(node_txn[0].input.len(), 1);
2102 let mut found_prev = false;
2104 for tx in prev_txn {
2105 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2106 check_spends!(node_txn[0], tx);
2107 let mut iter = node_txn[0].input[0].witness.iter();
2108 iter.next().expect("expected 3 witness items");
2109 iter.next().expect("expected 3 witness items");
2110 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2111 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2117 assert!(found_prev);
2119 let mut res = Vec::new();
2120 mem::swap(&mut *node_txn, &mut res);
2124 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) {
2125 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2126 assert_eq!(events_1.len(), 2);
2127 let as_update = match events_1[0] {
2128 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2131 _ => panic!("Unexpected event"),
2134 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2135 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2136 assert_eq!(msg.data, expected_error);
2137 if needs_err_handle {
2138 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2141 _ => panic!("Unexpected event"),
2144 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2145 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2146 let bs_update = match events_2[0] {
2147 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2150 _ => panic!("Unexpected event"),
2152 if !needs_err_handle {
2154 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2155 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2156 assert_eq!(msg.data, expected_error);
2158 _ => panic!("Unexpected event"),
2163 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
2164 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
2168 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2169 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2173 macro_rules! get_channel_value_stat {
2174 ($node: expr, $channel_id: expr) => {{
2175 let chan_lock = $node.node.channel_state.lock().unwrap();
2176 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
2177 chan.get_value_stat()
2181 macro_rules! get_chan_reestablish_msgs {
2182 ($src_node: expr, $dst_node: expr) => {
2184 let mut res = Vec::with_capacity(1);
2185 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2186 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2187 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2188 res.push(msg.clone());
2190 panic!("Unexpected event")
2198 macro_rules! handle_chan_reestablish_msgs {
2199 ($src_node: expr, $dst_node: expr) => {
2201 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2203 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2205 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2211 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2213 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2216 let mut revoke_and_ack = None;
2217 let mut commitment_update = None;
2218 let order = if let Some(ev) = msg_events.get(idx) {
2220 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2221 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2222 revoke_and_ack = Some(msg.clone());
2224 RAACommitmentOrder::RevokeAndACKFirst
2226 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2227 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2228 commitment_update = Some(updates.clone());
2230 RAACommitmentOrder::CommitmentFirst
2232 _ => RAACommitmentOrder::CommitmentFirst,
2235 RAACommitmentOrder::CommitmentFirst
2238 if let Some(ev) = msg_events.get(idx) {
2240 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2241 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2242 assert!(revoke_and_ack.is_none());
2243 revoke_and_ack = Some(msg.clone());
2246 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2247 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2248 assert!(commitment_update.is_none());
2249 commitment_update = Some(updates.clone());
2256 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2257 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2259 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2262 assert_eq!(msg_events.len(), idx);
2264 (channel_ready, revoke_and_ack, commitment_update, order)
2269 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2270 /// for claims/fails they are separated out.
2271 pub fn reconnect_nodes<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, send_channel_ready: (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)) {
2272 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2273 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2274 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2275 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2277 if send_channel_ready.0 {
2278 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2280 for reestablish in reestablish_1.iter() {
2281 assert_eq!(reestablish.next_remote_commitment_number, 0);
2284 if send_channel_ready.1 {
2285 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2287 for reestablish in reestablish_2.iter() {
2288 assert_eq!(reestablish.next_remote_commitment_number, 0);
2291 if send_channel_ready.0 || send_channel_ready.1 {
2292 // If we expect any channel_ready's, both sides better have set
2293 // next_holder_commitment_number to 1
2294 for reestablish in reestablish_1.iter() {
2295 assert_eq!(reestablish.next_local_commitment_number, 1);
2297 for reestablish in reestablish_2.iter() {
2298 assert_eq!(reestablish.next_local_commitment_number, 1);
2302 let mut resp_1 = Vec::new();
2303 for msg in reestablish_1 {
2304 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2305 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2307 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2308 check_added_monitors!(node_b, 1);
2310 check_added_monitors!(node_b, 0);
2313 let mut resp_2 = Vec::new();
2314 for msg in reestablish_2 {
2315 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2316 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2318 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2319 check_added_monitors!(node_a, 1);
2321 check_added_monitors!(node_a, 0);
2324 // We don't yet support both needing updates, as that would require a different commitment dance:
2325 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2326 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2327 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2328 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2330 for chan_msgs in resp_1.drain(..) {
2331 if send_channel_ready.0 {
2332 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2333 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2334 if !announcement_event.is_empty() {
2335 assert_eq!(announcement_event.len(), 1);
2336 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2337 //TODO: Test announcement_sigs re-sending
2338 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2341 assert!(chan_msgs.0.is_none());
2344 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2345 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2346 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2347 check_added_monitors!(node_a, 1);
2349 assert!(chan_msgs.1.is_none());
2351 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 {
2352 let commitment_update = chan_msgs.2.unwrap();
2353 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2354 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2356 assert!(commitment_update.update_add_htlcs.is_empty());
2358 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2359 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2360 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2361 for update_add in commitment_update.update_add_htlcs {
2362 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2364 for update_fulfill in commitment_update.update_fulfill_htlcs {
2365 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2367 for update_fail in commitment_update.update_fail_htlcs {
2368 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2371 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2372 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2374 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2375 check_added_monitors!(node_a, 1);
2376 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2377 // No commitment_signed so get_event_msg's assert(len == 1) passes
2378 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2379 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2380 check_added_monitors!(node_b, 1);
2383 assert!(chan_msgs.2.is_none());
2387 for chan_msgs in resp_2.drain(..) {
2388 if send_channel_ready.1 {
2389 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2390 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2391 if !announcement_event.is_empty() {
2392 assert_eq!(announcement_event.len(), 1);
2393 match announcement_event[0] {
2394 MessageSendEvent::SendChannelUpdate { .. } => {},
2395 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2396 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2400 assert!(chan_msgs.0.is_none());
2403 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2404 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2405 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2406 check_added_monitors!(node_b, 1);
2408 assert!(chan_msgs.1.is_none());
2410 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 {
2411 let commitment_update = chan_msgs.2.unwrap();
2412 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2413 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2415 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2416 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2417 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2418 for update_add in commitment_update.update_add_htlcs {
2419 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2421 for update_fulfill in commitment_update.update_fulfill_htlcs {
2422 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2424 for update_fail in commitment_update.update_fail_htlcs {
2425 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2428 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2429 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2431 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2432 check_added_monitors!(node_b, 1);
2433 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2434 // No commitment_signed so get_event_msg's assert(len == 1) passes
2435 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2436 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2437 check_added_monitors!(node_a, 1);
2440 assert!(chan_msgs.2.is_none());