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::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
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};
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,
262 pub struct NodeCfg<'a> {
263 pub chain_source: &'a test_utils::TestChainSource,
264 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
265 pub fee_estimator: &'a test_utils::TestFeeEstimator,
266 pub chain_monitor: test_utils::TestChainMonitor<'a>,
267 pub keys_manager: &'a test_utils::TestKeysInterface,
268 pub logger: &'a test_utils::TestLogger,
269 pub network_graph: NetworkGraph<&'a test_utils::TestLogger>,
270 pub node_seed: [u8; 32],
271 pub features: InitFeatures,
274 pub struct Node<'a, 'b: 'a, 'c: 'b> {
275 pub chain_source: &'c test_utils::TestChainSource,
276 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
277 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
278 pub keys_manager: &'b test_utils::TestKeysInterface,
279 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
280 pub network_graph: &'b NetworkGraph<&'c test_utils::TestLogger>,
281 pub gossip_sync: P2PGossipSync<&'b NetworkGraph<&'c test_utils::TestLogger>, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
282 pub node_seed: [u8; 32],
283 pub network_payment_count: Rc<RefCell<u8>>,
284 pub network_chan_count: Rc<RefCell<u32>>,
285 pub logger: &'c test_utils::TestLogger,
286 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
287 pub connect_style: Rc<RefCell<ConnectStyle>>,
289 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
290 pub fn best_block_hash(&self) -> BlockHash {
291 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
293 pub fn best_block_info(&self) -> (BlockHash, u32) {
294 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
296 pub fn get_block_header(&self, height: u32) -> BlockHeader {
297 self.blocks.lock().unwrap()[height as usize].0.header
301 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
304 // Check that we processed all pending events
305 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
306 assert!(self.node.get_and_clear_pending_events().is_empty());
307 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
309 // Check that if we serialize the Router, we can deserialize it again.
311 let mut w = test_utils::TestVecWriter(Vec::new());
312 self.network_graph.write(&mut w).unwrap();
313 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
314 assert!(network_graph_deser == *self.network_graph);
315 let gossip_sync = P2PGossipSync::new(
316 &network_graph_deser, Some(self.chain_source), self.logger
318 let mut chan_progress = 0;
320 let orig_announcements = self.gossip_sync.get_next_channel_announcements(chan_progress, 255);
321 let deserialized_announcements = gossip_sync.get_next_channel_announcements(chan_progress, 255);
322 assert!(orig_announcements == deserialized_announcements);
323 chan_progress = match orig_announcements.last() {
324 Some(announcement) => announcement.0.contents.short_channel_id + 1,
328 let mut node_progress = None;
330 let orig_announcements = self.gossip_sync.get_next_node_announcements(node_progress.as_ref(), 255);
331 let deserialized_announcements = gossip_sync.get_next_node_announcements(node_progress.as_ref(), 255);
332 assert!(orig_announcements == deserialized_announcements);
333 node_progress = match orig_announcements.last() {
334 Some(announcement) => Some(announcement.contents.node_id),
340 // Check that if we serialize and then deserialize all our channel monitors we get the
341 // same set of outputs to watch for on chain as we have now. Note that if we write
342 // tests that fully close channels and remove the monitors at some point this may break.
343 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
344 let mut deserialized_monitors = Vec::new();
346 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
347 let mut w = test_utils::TestVecWriter(Vec::new());
348 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
349 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
350 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
351 deserialized_monitors.push(deserialized_monitor);
355 let broadcaster = test_utils::TestBroadcaster {
356 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
357 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
360 // Before using all the new monitors to check the watch outpoints, use the full set of
361 // them to ensure we can write and reload our ChannelManager.
363 let mut channel_monitors = HashMap::new();
364 for monitor in deserialized_monitors.iter_mut() {
365 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
368 let mut w = test_utils::TestVecWriter(Vec::new());
369 self.node.write(&mut w).unwrap();
370 <(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 {
371 default_config: *self.node.get_current_default_configuration(),
372 keys_manager: self.keys_manager,
373 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
374 chain_monitor: self.chain_monitor,
375 tx_broadcaster: &broadcaster,
376 logger: &self.logger,
381 let persister = test_utils::TestPersister::new();
382 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
383 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
384 for deserialized_monitor in deserialized_monitors.drain(..) {
385 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
389 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
390 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
395 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) {
396 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
399 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) {
400 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);
401 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
402 (announcement, as_update, bs_update, channel_id, tx)
406 /// Gets an RAA and CS which were sent in response to a commitment update
407 macro_rules! get_revoke_commit_msgs {
408 ($node: expr, $node_id: expr) => {
410 use $crate::util::events::MessageSendEvent;
411 let events = $node.node.get_and_clear_pending_msg_events();
412 assert_eq!(events.len(), 2);
414 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
415 assert_eq!(*node_id, $node_id);
418 _ => panic!("Unexpected event"),
420 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
421 assert_eq!(*node_id, $node_id);
422 assert!(updates.update_add_htlcs.is_empty());
423 assert!(updates.update_fulfill_htlcs.is_empty());
424 assert!(updates.update_fail_htlcs.is_empty());
425 assert!(updates.update_fail_malformed_htlcs.is_empty());
426 assert!(updates.update_fee.is_none());
427 updates.commitment_signed.clone()
429 _ => panic!("Unexpected event"),
435 /// Get an specific event message from the pending events queue.
437 macro_rules! get_event_msg {
438 ($node: expr, $event_type: path, $node_id: expr) => {
440 let events = $node.node.get_and_clear_pending_msg_events();
441 assert_eq!(events.len(), 1);
443 $event_type { ref node_id, ref msg } => {
444 assert_eq!(*node_id, $node_id);
447 _ => panic!("Unexpected event"),
453 /// Get an error message from the pending events queue.
455 macro_rules! get_err_msg {
456 ($node: expr, $node_id: expr) => {
458 let events = $node.node.get_and_clear_pending_msg_events();
459 assert_eq!(events.len(), 1);
461 $crate::util::events::MessageSendEvent::HandleError {
462 action: $crate::ln::msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
464 assert_eq!(*node_id, $node_id);
467 _ => panic!("Unexpected event"),
473 /// Get a specific event from the pending events queue.
475 macro_rules! get_event {
476 ($node: expr, $event_type: path) => {
478 let mut events = $node.node.get_and_clear_pending_events();
479 assert_eq!(events.len(), 1);
480 let ev = events.pop().unwrap();
482 $event_type { .. } => {
485 _ => panic!("Unexpected event"),
492 /// Gets an UpdateHTLCs MessageSendEvent
493 macro_rules! get_htlc_update_msgs {
494 ($node: expr, $node_id: expr) => {
496 let events = $node.node.get_and_clear_pending_msg_events();
497 assert_eq!(events.len(), 1);
499 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
500 assert_eq!(*node_id, $node_id);
503 _ => panic!("Unexpected event"),
510 macro_rules! get_channel_ref {
511 ($node: expr, $lock: ident, $channel_id: expr) => {
513 $lock = $node.node.channel_state.lock().unwrap();
514 $lock.by_id.get_mut(&$channel_id).unwrap()
520 macro_rules! get_feerate {
521 ($node: expr, $channel_id: expr) => {
524 let chan = get_channel_ref!($node, lock, $channel_id);
531 macro_rules! get_opt_anchors {
532 ($node: expr, $channel_id: expr) => {
535 let chan = get_channel_ref!($node, lock, $channel_id);
541 /// Returns a channel monitor given a channel id, making some naive assumptions
543 macro_rules! get_monitor {
544 ($node: expr, $channel_id: expr) => {
546 use bitcoin::hashes::Hash;
547 let mut monitor = None;
548 // Assume funding vout is either 0 or 1 blindly
550 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
551 $crate::chain::transaction::OutPoint {
552 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
564 /// Returns any local commitment transactions for the channel.
566 macro_rules! get_local_commitment_txn {
567 ($node: expr, $channel_id: expr) => {
569 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
574 /// Check the error from attempting a payment.
576 macro_rules! unwrap_send_err {
577 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
579 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
580 assert_eq!(fails.len(), 1);
586 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
587 assert_eq!(results.len(), 1);
589 Err($type) => { $check },
598 /// Check whether N channel monitor(s) have been added.
600 macro_rules! check_added_monitors {
601 ($node: expr, $count: expr) => {
603 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
604 assert_eq!(added_monitors.len(), $count);
605 added_monitors.clear();
610 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) {
611 let chan_id = *node.network_chan_count.borrow();
613 let events = node.node.get_and_clear_pending_events();
614 assert_eq!(events.len(), 1);
616 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
617 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
618 assert_eq!(*channel_value_satoshis, expected_chan_value);
619 assert_eq!(user_channel_id, expected_user_chan_id);
621 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
622 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
624 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
625 (*temporary_channel_id, tx, funding_outpoint)
627 _ => panic!("Unexpected event"),
630 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 {
631 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
632 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
634 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
635 check_added_monitors!(node_a, 0);
637 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
638 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
639 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
641 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
642 assert_eq!(added_monitors.len(), 1);
643 assert_eq!(added_monitors[0].0, funding_output);
644 added_monitors.clear();
647 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()));
649 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
650 assert_eq!(added_monitors.len(), 1);
651 assert_eq!(added_monitors[0].0, funding_output);
652 added_monitors.clear();
655 let events_4 = node_a.node.get_and_clear_pending_events();
656 assert_eq!(events_4.len(), 0);
658 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
659 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
660 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
662 // Ensure that funding_transaction_generated is idempotent.
663 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
664 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
665 check_added_monitors!(node_a, 0);
670 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 {
671 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
672 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
673 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
674 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
675 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
676 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
677 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
679 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
682 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) {
683 confirm_transaction_at(node_conf, tx, conf_height);
684 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
685 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()));
688 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]) {
690 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
691 assert_eq!(events_6.len(), 3);
692 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
693 assert_eq!(*node_id, node_recv.node.get_our_node_id());
695 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
696 assert_eq!(*node_id, node_recv.node.get_our_node_id());
698 } else { panic!("Unexpected event: {:?}", events_6[1]); };
699 ((match events_6[0] {
700 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
701 channel_id = msg.channel_id.clone();
702 assert_eq!(*node_id, node_recv.node.get_our_node_id());
705 _ => panic!("Unexpected event"),
706 }, match events_6[announcement_sigs_idx] {
707 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
708 assert_eq!(*node_id, node_recv.node.get_our_node_id());
711 _ => panic!("Unexpected event"),
715 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]) {
716 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
717 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
718 confirm_transaction_at(node_a, tx, conf_height);
719 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
720 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
723 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) {
724 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
725 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
729 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) {
730 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
731 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
732 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
734 let events_7 = node_b.node.get_and_clear_pending_msg_events();
735 assert_eq!(events_7.len(), 1);
736 let (announcement, bs_update) = match events_7[0] {
737 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
740 _ => panic!("Unexpected event"),
743 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
744 let events_8 = node_a.node.get_and_clear_pending_msg_events();
745 assert_eq!(events_8.len(), 1);
746 let as_update = match events_8[0] {
747 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
748 assert!(*announcement == *msg);
749 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
750 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
753 _ => panic!("Unexpected event"),
756 *node_a.network_chan_count.borrow_mut() += 1;
758 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
761 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) {
762 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
765 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) {
766 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
767 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
768 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
771 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) {
772 let mut no_announce_cfg = test_default_channel_config();
773 no_announce_cfg.channel_handshake_config.announced_channel = false;
774 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
775 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
776 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), a_flags, &open_channel);
777 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
778 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), b_flags, &accept_channel);
780 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
781 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
782 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()));
783 check_added_monitors!(nodes[b], 1);
785 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
786 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
787 check_added_monitors!(nodes[a], 1);
789 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
790 confirm_transaction_at(&nodes[a], &tx, conf_height);
791 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
792 confirm_transaction_at(&nodes[b], &tx, conf_height);
793 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
794 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
795 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()));
796 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
797 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
798 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
800 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
801 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
803 let mut found_a = false;
804 for chan in nodes[a].node.list_usable_channels() {
805 if chan.channel_id == as_channel_ready.channel_id {
808 assert!(!chan.is_public);
813 let mut found_b = false;
814 for chan in nodes[b].node.list_usable_channels() {
815 if chan.channel_id == as_channel_ready.channel_id {
818 assert!(!chan.is_public);
823 (as_channel_ready, tx)
826 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) {
827 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
828 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
829 assert!(a_events.len() >= 2);
831 // ann should be re-generated by broadcast_node_announcement - check that we have it.
832 let mut found_ann_1 = false;
833 for event in a_events.iter() {
835 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
836 if msg == ann { found_ann_1 = true; }
838 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
839 _ => panic!("Unexpected event {:?}", event),
842 assert!(found_ann_1);
844 let a_node_announcement = match a_events.last().unwrap() {
845 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
848 _ => panic!("Unexpected event"),
851 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
852 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
853 assert!(b_events.len() >= 2);
855 // ann should be re-generated by broadcast_node_announcement - check that we have it.
856 let mut found_ann_2 = false;
857 for event in b_events.iter() {
859 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
860 if msg == ann { found_ann_2 = true; }
862 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
863 _ => panic!("Unexpected event"),
866 assert!(found_ann_2);
868 let b_node_announcement = match b_events.last().unwrap() {
869 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
872 _ => panic!("Unexpected event"),
876 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
877 node.gossip_sync.handle_channel_update(upd_1).unwrap();
878 node.gossip_sync.handle_channel_update(upd_2).unwrap();
879 node.gossip_sync.handle_node_announcement(&a_node_announcement).unwrap();
880 node.gossip_sync.handle_node_announcement(&b_node_announcement).unwrap();
882 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
883 // forwarding info for local channels even if its not accepted in the network graph.
884 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
885 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
890 macro_rules! check_spends {
891 ($tx: expr, $($spends_txn: expr),*) => {
894 for outp in $spends_txn.output.iter() {
895 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Input tx output didn't meet dust limit");
898 for outp in $tx.output.iter() {
899 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Spending tx output didn't meet dust limit");
901 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
903 if out_point.txid == $spends_txn.txid() {
904 return $spends_txn.output.get(out_point.vout as usize).cloned()
909 let mut total_value_in = 0;
910 for input in $tx.input.iter() {
911 total_value_in += get_output(&input.previous_output).unwrap().value;
913 let mut total_value_out = 0;
914 for output in $tx.output.iter() {
915 total_value_out += output.value;
917 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
918 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
919 assert!(total_value_out + min_fee <= total_value_in);
920 $tx.verify(get_output).unwrap();
925 macro_rules! get_closing_signed_broadcast {
926 ($node: expr, $dest_pubkey: expr) => {
928 let events = $node.get_and_clear_pending_msg_events();
929 assert!(events.len() == 1 || events.len() == 2);
930 (match events[events.len() - 1] {
931 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
932 assert_eq!(msg.contents.flags & 2, 2);
935 _ => panic!("Unexpected event"),
936 }, if events.len() == 2 {
938 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
939 assert_eq!(*node_id, $dest_pubkey);
942 _ => panic!("Unexpected event"),
950 macro_rules! check_warn_msg {
951 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
952 let msg_events = $node.node.get_and_clear_pending_msg_events();
953 assert_eq!(msg_events.len(), 1);
954 match msg_events[0] {
955 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
956 assert_eq!(node_id, $recipient_node_id);
957 assert_eq!(msg.channel_id, $chan_id);
960 _ => panic!("Unexpected event"),
965 /// Check that a channel's closing channel update has been broadcasted, and optionally
966 /// check whether an error message event has occurred.
968 macro_rules! check_closed_broadcast {
969 ($node: expr, $with_error_msg: expr) => {{
970 use $crate::util::events::MessageSendEvent;
971 use $crate::ln::msgs::ErrorAction;
973 let msg_events = $node.node.get_and_clear_pending_msg_events();
974 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
975 match msg_events[0] {
976 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
977 assert_eq!(msg.contents.flags & 2, 2);
979 _ => panic!("Unexpected event"),
982 match msg_events[1] {
983 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
984 // TODO: Check node_id
987 _ => panic!("Unexpected event"),
993 /// Check that a channel's closing channel events has been issued
995 macro_rules! check_closed_event {
996 ($node: expr, $events: expr, $reason: expr) => {
997 check_closed_event!($node, $events, $reason, false);
999 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1000 use $crate::util::events::Event;
1002 let events = $node.node.get_and_clear_pending_events();
1003 assert_eq!(events.len(), $events);
1004 let expected_reason = $reason;
1005 let mut issues_discard_funding = false;
1006 for event in events {
1008 Event::ChannelClosed { ref reason, .. } => {
1009 assert_eq!(*reason, expected_reason);
1011 Event::DiscardFunding { .. } => {
1012 issues_discard_funding = true;
1014 _ => panic!("Unexpected event"),
1017 assert_eq!($is_check_discard_funding, issues_discard_funding);
1021 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) {
1022 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) };
1023 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) };
1026 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1027 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()));
1029 let events_1 = node_b.get_and_clear_pending_msg_events();
1030 assert!(events_1.len() >= 1);
1031 let shutdown_b = match events_1[0] {
1032 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1033 assert_eq!(node_id, &node_a.get_our_node_id());
1036 _ => panic!("Unexpected event"),
1039 let closing_signed_b = if !close_inbound_first {
1040 assert_eq!(events_1.len(), 1);
1043 Some(match events_1[1] {
1044 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1045 assert_eq!(node_id, &node_a.get_our_node_id());
1048 _ => panic!("Unexpected event"),
1052 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
1053 let (as_update, bs_update) = if close_inbound_first {
1054 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1055 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1057 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1058 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1059 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1060 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1062 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1063 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1064 assert!(none_a.is_none());
1065 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1066 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1067 (as_update, bs_update)
1069 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1071 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1072 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1074 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1075 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1076 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1078 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1079 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1080 assert!(none_b.is_none());
1081 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1082 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1083 (as_update, bs_update)
1085 assert_eq!(tx_a, tx_b);
1086 check_spends!(tx_a, funding_tx);
1088 (as_update, bs_update, tx_a)
1091 pub struct SendEvent {
1092 pub node_id: PublicKey,
1093 pub msgs: Vec<msgs::UpdateAddHTLC>,
1094 pub commitment_msg: msgs::CommitmentSigned,
1097 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1098 assert!(updates.update_fulfill_htlcs.is_empty());
1099 assert!(updates.update_fail_htlcs.is_empty());
1100 assert!(updates.update_fail_malformed_htlcs.is_empty());
1101 assert!(updates.update_fee.is_none());
1102 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1105 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1107 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1108 _ => panic!("Unexpected event type!"),
1112 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1113 let mut events = node.node.get_and_clear_pending_msg_events();
1114 assert_eq!(events.len(), 1);
1115 SendEvent::from_event(events.pop().unwrap())
1120 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1121 /// commitment update.
1122 macro_rules! commitment_signed_dance {
1123 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1125 check_added_monitors!($node_a, 0);
1126 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1127 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1128 check_added_monitors!($node_a, 1);
1129 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1132 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1134 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1135 check_added_monitors!($node_b, 0);
1136 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1137 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1138 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1139 check_added_monitors!($node_b, 1);
1140 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1141 let (bs_revoke_and_ack, extra_msg_option) = {
1142 let events = $node_b.node.get_and_clear_pending_msg_events();
1143 assert!(events.len() <= 2);
1145 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1146 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1149 _ => panic!("Unexpected event"),
1150 }, events.get(1).map(|e| e.clone()))
1152 check_added_monitors!($node_b, 1);
1153 if $fail_backwards {
1154 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1155 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1157 (extra_msg_option, bs_revoke_and_ack)
1160 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1162 check_added_monitors!($node_a, 0);
1163 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1164 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1165 check_added_monitors!($node_a, 1);
1166 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1167 assert!(extra_msg_option.is_none());
1171 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1173 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1174 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1175 check_added_monitors!($node_a, 1);
1179 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1181 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1184 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1186 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1187 if $fail_backwards {
1188 $crate::expect_pending_htlcs_forwardable!($node_a);
1189 check_added_monitors!($node_a, 1);
1191 let channel_state = $node_a.node.channel_state.lock().unwrap();
1192 assert_eq!(channel_state.pending_msg_events.len(), 1);
1193 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1194 assert_ne!(*node_id, $node_b.node.get_our_node_id());
1195 } else { panic!("Unexpected event"); }
1197 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1203 /// Get a payment preimage and hash.
1205 macro_rules! get_payment_preimage_hash {
1206 ($dest_node: expr) => {
1208 get_payment_preimage_hash!($dest_node, None)
1211 ($dest_node: expr, $min_value_msat: expr) => {
1213 use bitcoin::hashes::Hash as _;
1214 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1215 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1216 *payment_count += 1;
1217 let payment_hash = $crate::ln::PaymentHash(
1218 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1219 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1220 (payment_preimage, payment_hash, payment_secret)
1226 macro_rules! get_route {
1227 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1228 use $crate::chain::keysinterface::KeysInterface;
1229 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1230 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1231 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1232 $crate::routing::router::get_route(
1233 &$send_node.node.get_our_node_id(), &$payment_params, &$send_node.network_graph.read_only(),
1234 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1235 $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1242 macro_rules! get_route_and_payment_hash {
1243 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1244 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1245 .with_features($crate::ln::features::InvoiceFeatures::known());
1246 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1248 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1249 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1250 let route = $crate::get_route!($send_node, $payment_params, $recv_value, $cltv);
1251 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1256 /// Clears (and ignores) a PendingHTLCsForwardable event
1257 macro_rules! expect_pending_htlcs_forwardable_ignore {
1259 let events = $node.node.get_and_clear_pending_events();
1260 assert_eq!(events.len(), 1);
1262 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1263 _ => panic!("Unexpected event"),
1269 /// Handles a PendingHTLCsForwardable event
1270 macro_rules! expect_pending_htlcs_forwardable {
1272 $crate::expect_pending_htlcs_forwardable_ignore!($node);
1273 $node.node.process_pending_htlc_forwards();
1275 // Ensure process_pending_htlc_forwards is idempotent.
1276 $node.node.process_pending_htlc_forwards();
1281 macro_rules! expect_pending_htlcs_forwardable_from_events {
1282 ($node: expr, $events: expr, $ignore: expr) => {{
1283 assert_eq!($events.len(), 1);
1285 Event::PendingHTLCsForwardable { .. } => { },
1286 _ => panic!("Unexpected event"),
1289 $node.node.process_pending_htlc_forwards();
1291 // Ensure process_pending_htlc_forwards is idempotent.
1292 $node.node.process_pending_htlc_forwards();
1298 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1299 macro_rules! expect_payment_received {
1300 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1301 expect_payment_received!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None)
1303 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr) => {
1304 let events = $node.node.get_and_clear_pending_events();
1305 assert_eq!(events.len(), 1);
1307 $crate::util::events::Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1308 assert_eq!($expected_payment_hash, *payment_hash);
1309 assert_eq!($expected_recv_value, amount_msat);
1311 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1312 assert_eq!(&$expected_payment_preimage, payment_preimage);
1313 assert_eq!($expected_payment_secret, *payment_secret);
1318 _ => panic!("Unexpected event"),
1324 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1325 macro_rules! expect_payment_claimed {
1326 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1327 let events = $node.node.get_and_clear_pending_events();
1328 assert_eq!(events.len(), 1);
1330 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1331 assert_eq!($expected_payment_hash, *payment_hash);
1332 assert_eq!($expected_recv_value, amount_msat);
1334 _ => panic!("Unexpected event"),
1341 macro_rules! expect_payment_sent_without_paths {
1342 ($node: expr, $expected_payment_preimage: expr) => {
1343 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1345 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1346 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1351 macro_rules! expect_payment_sent {
1352 ($node: expr, $expected_payment_preimage: expr) => {
1353 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1355 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1356 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1358 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1359 use bitcoin::hashes::Hash as _;
1360 let events = $node.node.get_and_clear_pending_events();
1361 let expected_payment_hash = $crate::ln::PaymentHash(
1362 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1364 assert!(events.len() > 1);
1366 assert_eq!(events.len(), 1);
1368 let expected_payment_id = match events[0] {
1369 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1370 assert_eq!($expected_payment_preimage, *payment_preimage);
1371 assert_eq!(expected_payment_hash, *payment_hash);
1372 assert!(fee_paid_msat.is_some());
1373 if $expected_fee_msat_opt.is_some() {
1374 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1378 _ => panic!("Unexpected event"),
1381 for i in 1..events.len() {
1383 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1384 assert_eq!(payment_id, expected_payment_id);
1385 assert_eq!(payment_hash, Some(expected_payment_hash));
1387 _ => panic!("Unexpected event"),
1396 macro_rules! expect_payment_path_successful {
1398 let events = $node.node.get_and_clear_pending_events();
1399 assert_eq!(events.len(), 1);
1401 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1402 _ => panic!("Unexpected event"),
1407 macro_rules! expect_payment_forwarded {
1408 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1409 let events = $node.node.get_and_clear_pending_events();
1410 assert_eq!(events.len(), 1);
1412 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1413 assert_eq!(fee_earned_msat, $expected_fee);
1414 if fee_earned_msat.is_some() {
1415 // Is the event prev_channel_id in one of the channels between the two nodes?
1416 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()));
1418 // We check for force closures since a force closed channel is removed from the
1419 // node's channel list
1420 if !$downstream_force_closed {
1421 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()));
1423 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1425 _ => panic!("Unexpected event"),
1430 pub struct PaymentFailedConditions<'a> {
1431 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1432 pub(crate) expected_blamed_scid: Option<u64>,
1433 pub(crate) expected_blamed_chan_closed: Option<bool>,
1434 pub(crate) expected_mpp_parts_remain: bool,
1437 impl<'a> PaymentFailedConditions<'a> {
1438 pub fn new() -> Self {
1440 expected_htlc_error_data: None,
1441 expected_blamed_scid: None,
1442 expected_blamed_chan_closed: None,
1443 expected_mpp_parts_remain: false,
1446 pub fn mpp_parts_remain(mut self) -> Self {
1447 self.expected_mpp_parts_remain = true;
1450 pub fn blamed_scid(mut self, scid: u64) -> Self {
1451 self.expected_blamed_scid = Some(scid);
1454 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1455 self.expected_blamed_chan_closed = Some(closed);
1458 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1459 self.expected_htlc_error_data = Some((code, data));
1465 macro_rules! expect_payment_failed_with_update {
1466 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1467 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1468 &$node, $expected_payment_hash, $rejected_by_dest,
1469 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1470 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1475 macro_rules! expect_payment_failed {
1476 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1477 #[allow(unused_mut)]
1478 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1480 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1482 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $rejected_by_dest, conditions);
1486 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1487 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_rejected_by_dest: bool,
1488 conditions: PaymentFailedConditions<'e>
1490 let mut events = node.node.get_and_clear_pending_events();
1491 assert_eq!(events.len(), 1);
1492 let expected_payment_id = match events.pop().unwrap() {
1493 Event::PaymentPathFailed { payment_hash, rejected_by_dest, path, retry, payment_id, network_update, short_channel_id,
1497 error_data, .. } => {
1498 assert_eq!(payment_hash, expected_payment_hash, "unexpected payment_hash");
1499 assert_eq!(rejected_by_dest, expected_rejected_by_dest, "unexpected rejected_by_dest value");
1500 assert!(retry.is_some(), "expected retry.is_some()");
1501 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1502 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1503 if let Some(scid) = short_channel_id {
1504 assert!(retry.as_ref().unwrap().payment_params.previously_failed_channels.contains(&scid));
1509 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1510 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1511 if let Some((code, data)) = conditions.expected_htlc_error_data {
1512 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1513 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1517 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1518 match network_update {
1519 Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1520 if let Some(scid) = conditions.expected_blamed_scid {
1521 assert_eq!(msg.contents.short_channel_id, scid);
1523 const CHAN_DISABLED_FLAG: u8 = 2;
1524 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1526 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }) if chan_closed => {
1527 if let Some(scid) = conditions.expected_blamed_scid {
1528 assert_eq!(short_channel_id, scid);
1530 assert!(is_permanent);
1532 Some(_) => panic!("Unexpected update type"),
1533 None => panic!("Expected update"),
1539 _ => panic!("Unexpected event"),
1541 if !conditions.expected_mpp_parts_remain {
1542 node.node.abandon_payment(expected_payment_id);
1543 let events = node.node.get_and_clear_pending_events();
1544 assert_eq!(events.len(), 1);
1546 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1547 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1548 assert_eq!(*payment_id, expected_payment_id);
1550 _ => panic!("Unexpected second event"),
1555 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 {
1556 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1557 check_added_monitors!(origin_node, expected_paths.len());
1558 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1562 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>) {
1563 let mut payment_event = SendEvent::from_event(ev);
1564 let mut prev_node = origin_node;
1566 for (idx, &node) in expected_path.iter().enumerate() {
1567 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1569 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1570 check_added_monitors!(node, 0);
1571 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1573 expect_pending_htlcs_forwardable!(node);
1575 if idx == expected_path.len() - 1 && clear_recipient_events {
1576 let events_2 = node.node.get_and_clear_pending_events();
1577 if payment_received_expected {
1578 assert_eq!(events_2.len(), 1);
1580 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1581 assert_eq!(our_payment_hash, *payment_hash);
1583 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1584 assert_eq!(expected_preimage, *payment_preimage);
1585 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1587 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1588 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1589 assert!(our_payment_secret.is_none());
1592 assert_eq!(amount_msat, recv_value);
1594 _ => panic!("Unexpected event"),
1597 assert!(events_2.is_empty());
1599 } else if idx != expected_path.len() - 1 {
1600 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1601 assert_eq!(events_2.len(), 1);
1602 check_added_monitors!(node, 1);
1603 payment_event = SendEvent::from_event(events_2.remove(0));
1604 assert_eq!(payment_event.msgs.len(), 1);
1611 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>) {
1612 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_received_expected, true, expected_preimage);
1615 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) {
1616 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1617 assert_eq!(events.len(), expected_route.len());
1618 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1619 // Once we've gotten through all the HTLCs, the last one should result in a
1620 // PaymentReceived (but each previous one should not!), .
1621 let expect_payment = path_idx == expected_route.len() - 1;
1622 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1626 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) {
1627 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1628 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1629 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1632 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 {
1633 for path in expected_paths.iter() {
1634 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1636 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1638 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
1639 assert_eq!(claim_event.len(), 1);
1640 match claim_event[0] {
1641 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
1642 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
1643 assert_eq!(preimage, our_payment_preimage),
1644 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
1645 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
1649 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1651 let mut expected_total_fee_msat = 0;
1653 macro_rules! msgs_from_ev {
1656 &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 } } => {
1657 assert!(update_add_htlcs.is_empty());
1658 assert_eq!(update_fulfill_htlcs.len(), 1);
1659 assert!(update_fail_htlcs.is_empty());
1660 assert!(update_fail_malformed_htlcs.is_empty());
1661 assert!(update_fee.is_none());
1662 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1664 _ => panic!("Unexpected event"),
1668 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1669 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1670 assert_eq!(events.len(), expected_paths.len());
1671 for ev in events.iter() {
1672 per_path_msgs.push(msgs_from_ev!(ev));
1675 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1676 let mut next_msgs = Some(path_msgs);
1677 let mut expected_next_node = next_hop;
1679 macro_rules! last_update_fulfill_dance {
1680 ($node: expr, $prev_node: expr) => {
1682 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1683 check_added_monitors!($node, 0);
1684 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1685 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1689 macro_rules! mid_update_fulfill_dance {
1690 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
1692 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1694 let channel_state = $node.node.channel_state.lock().unwrap();
1695 let channel = channel_state
1696 .by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
1697 if let Some(prev_config) = channel.prev_config() {
1698 prev_config.forwarding_fee_base_msat
1700 channel.config().forwarding_fee_base_msat
1703 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
1704 expected_total_fee_msat += fee as u64;
1705 check_added_monitors!($node, 1);
1706 let new_next_msgs = if $new_msgs {
1707 let events = $node.node.get_and_clear_pending_msg_events();
1708 assert_eq!(events.len(), 1);
1709 let (res, nexthop) = msgs_from_ev!(&events[0]);
1710 expected_next_node = nexthop;
1713 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1716 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1717 next_msgs = new_next_msgs;
1722 let mut prev_node = expected_route.last().unwrap();
1723 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1724 assert_eq!(expected_next_node, node.node.get_our_node_id());
1725 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1726 if next_msgs.is_some() {
1727 // Since we are traversing in reverse, next_node is actually the previous node
1728 let next_node: &Node;
1729 if idx == expected_route.len() - 1 {
1730 next_node = origin_node;
1732 next_node = expected_route[expected_route.len() - 1 - idx - 1];
1734 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
1736 assert!(!update_next_msgs);
1737 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1739 if !skip_last && idx == expected_route.len() - 1 {
1740 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1747 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1751 // Ensure that claim_funds is idempotent.
1752 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1753 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1754 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1756 expected_total_fee_msat
1758 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) {
1759 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1761 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1765 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1766 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1769 pub const TEST_FINAL_CLTV: u32 = 70;
1771 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) {
1772 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1773 .with_features(InvoiceFeatures::known());
1774 let route = get_route!(origin_node, payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
1775 assert_eq!(route.paths.len(), 1);
1776 assert_eq!(route.paths[0].len(), expected_route.len());
1777 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1778 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1781 let res = send_along_route(origin_node, route, expected_route, recv_value);
1782 (res.0, res.1, res.2)
1785 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1786 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1787 .with_features(InvoiceFeatures::known());
1788 let network_graph = origin_node.network_graph.read_only();
1789 let scorer = test_utils::TestScorer::with_penalty(0);
1790 let seed = [0u8; 32];
1791 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1792 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1793 let route = get_route(
1794 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
1795 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
1796 assert_eq!(route.paths.len(), 1);
1797 assert_eq!(route.paths[0].len(), expected_route.len());
1798 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1799 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1802 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1803 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1804 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1807 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1808 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1809 claim_payment(&origin, expected_route, our_payment_preimage);
1812 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) {
1813 for path in expected_paths.iter() {
1814 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1816 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
1817 expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1819 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
1822 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) {
1823 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1824 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1826 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1827 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1828 assert_eq!(events.len(), expected_paths.len());
1829 for ev in events.iter() {
1830 let (update_fail, commitment_signed, node_id) = match ev {
1831 &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 } } => {
1832 assert!(update_add_htlcs.is_empty());
1833 assert!(update_fulfill_htlcs.is_empty());
1834 assert_eq!(update_fail_htlcs.len(), 1);
1835 assert!(update_fail_malformed_htlcs.is_empty());
1836 assert!(update_fee.is_none());
1837 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1839 _ => panic!("Unexpected event"),
1841 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1843 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1844 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()));
1846 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1847 let mut next_msgs = Some(path_msgs);
1848 let mut expected_next_node = next_hop;
1849 let mut prev_node = expected_route.last().unwrap();
1851 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1852 assert_eq!(expected_next_node, node.node.get_our_node_id());
1853 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1854 if next_msgs.is_some() {
1855 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1856 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1857 if !update_next_node {
1858 expect_pending_htlcs_forwardable!(node);
1861 let events = node.node.get_and_clear_pending_msg_events();
1862 if update_next_node {
1863 assert_eq!(events.len(), 1);
1865 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 } } => {
1866 assert!(update_add_htlcs.is_empty());
1867 assert!(update_fulfill_htlcs.is_empty());
1868 assert_eq!(update_fail_htlcs.len(), 1);
1869 assert!(update_fail_malformed_htlcs.is_empty());
1870 assert!(update_fee.is_none());
1871 expected_next_node = node_id.clone();
1872 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1874 _ => panic!("Unexpected event"),
1877 assert!(events.is_empty());
1879 if !skip_last && idx == expected_route.len() - 1 {
1880 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1887 let prev_node = expected_route.first().unwrap();
1888 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1889 check_added_monitors!(origin_node, 0);
1890 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1891 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1892 let events = origin_node.node.get_and_clear_pending_events();
1893 assert_eq!(events.len(), 1);
1894 let expected_payment_id = match events[0] {
1895 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, ref payment_id, .. } => {
1896 assert_eq!(payment_hash, our_payment_hash);
1897 assert!(rejected_by_dest);
1898 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1899 for (idx, hop) in expected_route.iter().enumerate() {
1900 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1904 _ => panic!("Unexpected event"),
1906 if i == expected_paths.len() - 1 {
1907 origin_node.node.abandon_payment(expected_payment_id);
1908 let events = origin_node.node.get_and_clear_pending_events();
1909 assert_eq!(events.len(), 1);
1911 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1912 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
1913 assert_eq!(*payment_id, expected_payment_id);
1915 _ => panic!("Unexpected second event"),
1921 // Ensure that fail_htlc_backwards is idempotent.
1922 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
1923 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
1924 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1925 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1928 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1929 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1932 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1933 let mut chan_mon_cfgs = Vec::new();
1934 for i in 0..node_count {
1935 let tx_broadcaster = test_utils::TestBroadcaster {
1936 txn_broadcasted: Mutex::new(Vec::new()),
1937 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
1939 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1940 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1941 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1942 let persister = test_utils::TestPersister::new();
1943 let seed = [i as u8; 32];
1944 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1946 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1952 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1953 let mut nodes = Vec::new();
1955 for i in 0..node_count {
1956 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);
1957 let seed = [i as u8; 32];
1958 nodes.push(NodeCfg {
1959 chain_source: &chanmon_cfgs[i].chain_source,
1960 logger: &chanmon_cfgs[i].logger,
1961 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1962 fee_estimator: &chanmon_cfgs[i].fee_estimator,
1964 keys_manager: &chanmon_cfgs[i].keys_manager,
1966 features: InitFeatures::known(),
1967 network_graph: NetworkGraph::new(chanmon_cfgs[i].chain_source.genesis_hash, &chanmon_cfgs[i].logger),
1974 pub fn test_default_channel_config() -> UserConfig {
1975 let mut default_config = UserConfig::default();
1976 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1977 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1978 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
1979 default_config.channel_handshake_config.announced_channel = true;
1980 default_config.channel_handshake_limits.force_announced_channel_preference = false;
1981 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1982 // It now defaults to 1, so we simply set it to the expected value here.
1983 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
1984 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1985 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1986 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
1990 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>> {
1991 let mut chanmgrs = Vec::new();
1992 for i in 0..node_count {
1993 let network = Network::Testnet;
1994 let params = ChainParameters {
1996 best_block: BestBlock::from_genesis(network),
1998 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1999 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
2000 chanmgrs.push(node);
2006 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>> {
2007 let mut nodes = Vec::new();
2008 let chan_count = Rc::new(RefCell::new(0));
2009 let payment_count = Rc::new(RefCell::new(0));
2010 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2012 for i in 0..node_count {
2013 let gossip_sync = P2PGossipSync::new(&cfgs[i].network_graph, None, cfgs[i].logger);
2015 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2016 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2017 node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, gossip_sync,
2018 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2019 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2020 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2021 connect_style: Rc::clone(&connect_style),
2025 for i in 0..node_count {
2026 for j in (i+1)..node_count {
2027 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone(), remote_network_address: None });
2028 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone(), remote_network_address: None });
2035 // Note that the following only works for CLTV values up to 128
2036 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2037 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
2039 #[derive(PartialEq)]
2040 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2041 /// Tests that the given node has broadcast transactions for the given Channel
2043 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2044 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2045 /// broadcast and the revoked outputs were claimed.
2047 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2048 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2050 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2052 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> {
2053 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2054 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2056 let mut res = Vec::with_capacity(2);
2057 node_txn.retain(|tx| {
2058 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2059 check_spends!(tx, chan.3);
2060 if commitment_tx.is_none() {
2061 res.push(tx.clone());
2066 if let Some(explicit_tx) = commitment_tx {
2067 res.push(explicit_tx.clone());
2070 assert_eq!(res.len(), 1);
2072 if has_htlc_tx != HTLCType::NONE {
2073 node_txn.retain(|tx| {
2074 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2075 check_spends!(tx, res[0]);
2076 if has_htlc_tx == HTLCType::TIMEOUT {
2077 assert!(tx.lock_time != 0);
2079 assert!(tx.lock_time == 0);
2081 res.push(tx.clone());
2085 assert!(res.len() == 2 || res.len() == 3);
2087 assert_eq!(res[1], res[2]);
2091 assert!(node_txn.is_empty());
2095 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2096 /// HTLC transaction.
2097 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2098 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2099 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2100 // for revoked htlc outputs
2101 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2102 node_txn.retain(|tx| {
2103 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2104 check_spends!(tx, revoked_tx);
2108 node_txn.retain(|tx| {
2109 check_spends!(tx, commitment_revoked_tx);
2112 assert!(node_txn.is_empty());
2115 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2116 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2118 assert!(node_txn.len() >= 1);
2119 assert_eq!(node_txn[0].input.len(), 1);
2120 let mut found_prev = false;
2122 for tx in prev_txn {
2123 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2124 check_spends!(node_txn[0], tx);
2125 let mut iter = node_txn[0].input[0].witness.iter();
2126 iter.next().expect("expected 3 witness items");
2127 iter.next().expect("expected 3 witness items");
2128 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2129 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2135 assert!(found_prev);
2137 let mut res = Vec::new();
2138 mem::swap(&mut *node_txn, &mut res);
2142 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) {
2143 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2144 assert_eq!(events_1.len(), 2);
2145 let as_update = match events_1[0] {
2146 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2149 _ => panic!("Unexpected event"),
2152 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2153 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2154 assert_eq!(msg.data, expected_error);
2155 if needs_err_handle {
2156 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2159 _ => panic!("Unexpected event"),
2162 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2163 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2164 let bs_update = match events_2[0] {
2165 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2168 _ => panic!("Unexpected event"),
2170 if !needs_err_handle {
2172 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2173 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2174 assert_eq!(msg.data, expected_error);
2176 _ => panic!("Unexpected event"),
2181 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2182 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2186 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2187 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2191 macro_rules! get_channel_value_stat {
2192 ($node: expr, $channel_id: expr) => {{
2193 let chan_lock = $node.node.channel_state.lock().unwrap();
2194 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
2195 chan.get_value_stat()
2199 macro_rules! get_chan_reestablish_msgs {
2200 ($src_node: expr, $dst_node: expr) => {
2202 let mut res = Vec::with_capacity(1);
2203 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2204 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2205 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2206 res.push(msg.clone());
2208 panic!("Unexpected event")
2216 macro_rules! handle_chan_reestablish_msgs {
2217 ($src_node: expr, $dst_node: expr) => {
2219 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2221 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2223 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2229 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2231 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2234 let mut revoke_and_ack = None;
2235 let mut commitment_update = None;
2236 let order = if let Some(ev) = msg_events.get(idx) {
2238 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2239 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2240 revoke_and_ack = Some(msg.clone());
2242 RAACommitmentOrder::RevokeAndACKFirst
2244 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2245 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2246 commitment_update = Some(updates.clone());
2248 RAACommitmentOrder::CommitmentFirst
2250 _ => RAACommitmentOrder::CommitmentFirst,
2253 RAACommitmentOrder::CommitmentFirst
2256 if let Some(ev) = msg_events.get(idx) {
2258 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2259 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2260 assert!(revoke_and_ack.is_none());
2261 revoke_and_ack = Some(msg.clone());
2264 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2265 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2266 assert!(commitment_update.is_none());
2267 commitment_update = Some(updates.clone());
2274 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2275 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2277 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2280 assert_eq!(msg_events.len(), idx);
2282 (channel_ready, revoke_and_ack, commitment_update, order)
2287 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2288 /// for claims/fails they are separated out.
2289 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)) {
2290 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2291 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2292 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2293 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2295 if send_channel_ready.0 {
2296 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2298 for reestablish in reestablish_1.iter() {
2299 assert_eq!(reestablish.next_remote_commitment_number, 0);
2302 if send_channel_ready.1 {
2303 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2305 for reestablish in reestablish_2.iter() {
2306 assert_eq!(reestablish.next_remote_commitment_number, 0);
2309 if send_channel_ready.0 || send_channel_ready.1 {
2310 // If we expect any channel_ready's, both sides better have set
2311 // next_holder_commitment_number to 1
2312 for reestablish in reestablish_1.iter() {
2313 assert_eq!(reestablish.next_local_commitment_number, 1);
2315 for reestablish in reestablish_2.iter() {
2316 assert_eq!(reestablish.next_local_commitment_number, 1);
2320 let mut resp_1 = Vec::new();
2321 for msg in reestablish_1 {
2322 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2323 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2325 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2326 check_added_monitors!(node_b, 1);
2328 check_added_monitors!(node_b, 0);
2331 let mut resp_2 = Vec::new();
2332 for msg in reestablish_2 {
2333 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2334 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2336 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2337 check_added_monitors!(node_a, 1);
2339 check_added_monitors!(node_a, 0);
2342 // We don't yet support both needing updates, as that would require a different commitment dance:
2343 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2344 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2345 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2346 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2348 for chan_msgs in resp_1.drain(..) {
2349 if send_channel_ready.0 {
2350 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2351 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2352 if !announcement_event.is_empty() {
2353 assert_eq!(announcement_event.len(), 1);
2354 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2355 //TODO: Test announcement_sigs re-sending
2356 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2359 assert!(chan_msgs.0.is_none());
2362 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2363 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2364 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2365 check_added_monitors!(node_a, 1);
2367 assert!(chan_msgs.1.is_none());
2369 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 {
2370 let commitment_update = chan_msgs.2.unwrap();
2371 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2372 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2374 assert!(commitment_update.update_add_htlcs.is_empty());
2376 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2377 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2378 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2379 for update_add in commitment_update.update_add_htlcs {
2380 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2382 for update_fulfill in commitment_update.update_fulfill_htlcs {
2383 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2385 for update_fail in commitment_update.update_fail_htlcs {
2386 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2389 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2390 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2392 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2393 check_added_monitors!(node_a, 1);
2394 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2395 // No commitment_signed so get_event_msg's assert(len == 1) passes
2396 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2397 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2398 check_added_monitors!(node_b, 1);
2401 assert!(chan_msgs.2.is_none());
2405 for chan_msgs in resp_2.drain(..) {
2406 if send_channel_ready.1 {
2407 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2408 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2409 if !announcement_event.is_empty() {
2410 assert_eq!(announcement_event.len(), 1);
2411 match announcement_event[0] {
2412 MessageSendEvent::SendChannelUpdate { .. } => {},
2413 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2414 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2418 assert!(chan_msgs.0.is_none());
2421 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2422 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2423 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2424 check_added_monitors!(node_b, 1);
2426 assert!(chan_msgs.1.is_none());
2428 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 {
2429 let commitment_update = chan_msgs.2.unwrap();
2430 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2431 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2433 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2434 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2435 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2436 for update_add in commitment_update.update_add_htlcs {
2437 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2439 for update_fulfill in commitment_update.update_fulfill_htlcs {
2440 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2442 for update_fail in commitment_update.update_fail_htlcs {
2443 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2446 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2447 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2449 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2450 check_added_monitors!(node_b, 1);
2451 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2452 // No commitment_signed so get_event_msg's assert(len == 1) passes
2453 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2454 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2455 check_added_monitors!(node_a, 1);
2458 assert!(chan_msgs.2.is_none());