1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
11 //! nodes for functional tests.
13 use chain::{BestBlock, Confirm, Listen, Watch, keysinterface::KeysInterface};
14 use chain::channelmonitor::ChannelMonitor;
15 use chain::transaction::OutPoint;
16 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
17 use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, PaymentId, MIN_CLTV_EXPIRY_DELTA};
18 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
19 use routing::router::{PaymentParameters, Route, get_route};
20 use ln::features::{InitFeatures, InvoiceFeatures};
22 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
23 use util::enforcing_trait_impls::EnforcingSigner;
25 use util::test_utils::{panicking, TestChainMonitor};
26 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
27 use util::errors::APIError;
28 use util::config::UserConfig;
29 use util::ser::{ReadableArgs, Writeable, Readable};
31 use bitcoin::blockdata::block::{Block, BlockHeader};
32 use bitcoin::blockdata::constants::genesis_block;
33 use bitcoin::blockdata::transaction::{Transaction, TxOut};
34 use bitcoin::network::constants::Network;
36 use bitcoin::hash_types::BlockHash;
38 use bitcoin::secp256k1::PublicKey;
42 use core::cell::RefCell;
44 use sync::{Arc, Mutex};
47 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
49 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
50 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
51 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
52 confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
53 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
55 /// Mine a signle block containing the given transaction
56 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
57 let height = node.best_block_info().1 + 1;
58 confirm_transaction_at(node, tx, height);
60 /// Mine the given transaction at the given height, mining blocks as required to build to that
62 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
63 let first_connect_height = node.best_block_info().1 + 1;
64 assert!(first_connect_height <= conf_height);
65 if conf_height > first_connect_height {
66 connect_blocks(node, conf_height - first_connect_height);
68 let mut block = Block {
69 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: conf_height, bits: 42, nonce: 42 },
72 for _ in 0..*node.network_chan_count.borrow() { // Make sure we don't end up with channels at the same short id by offsetting by chan_count
73 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
75 block.txdata.push(tx.clone());
76 connect_block(node, &block);
79 /// The possible ways we may notify a ChannelManager of a new block
80 #[derive(Clone, Copy, PartialEq)]
81 pub enum ConnectStyle {
82 /// Calls best_block_updated first, detecting transactions in the block only after receiving the
83 /// header and height information.
85 /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
86 /// make a single best_block_updated call.
87 BestBlockFirstSkippingBlocks,
88 /// Calls transactions_confirmed first, detecting transactions in the block before updating the
89 /// header and height information.
91 /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
92 /// make a single best_block_updated call.
93 TransactionsFirstSkippingBlocks,
94 /// Provides the full block via the chain::Listen interface. In the current code this is
95 /// equivalent to TransactionsFirst with some additional assertions.
99 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
100 let skip_intermediaries = match *node.connect_style.borrow() {
101 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
105 let height = node.best_block_info().1 + 1;
106 let mut block = Block {
107 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: height, bits: 42, nonce: 42 },
112 do_connect_block(node, &block, skip_intermediaries);
114 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: height + i, bits: 42, nonce: 42 },
118 connect_block(node, &block);
119 block.header.block_hash()
122 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
123 do_connect_block(node, block, false);
126 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
127 // Ensure `get_claimable_balances`' self-tests never panic
128 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
129 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
133 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
134 call_claimable_balances(node);
135 let height = node.best_block_info().1 + 1;
136 if !skip_intermediaries {
137 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
138 match *node.connect_style.borrow() {
139 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
140 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
141 call_claimable_balances(node);
142 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
143 node.node.best_block_updated(&block.header, height);
144 node.node.transactions_confirmed(&block.header, &txdata, height);
146 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
147 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
148 call_claimable_balances(node);
149 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
150 node.node.transactions_confirmed(&block.header, &txdata, height);
151 node.node.best_block_updated(&block.header, height);
153 ConnectStyle::FullBlockViaListen => {
154 node.chain_monitor.chain_monitor.block_connected(&block, height);
155 node.node.block_connected(&block, height);
159 call_claimable_balances(node);
160 node.node.test_process_background_events();
161 node.blocks.lock().unwrap().push((block.header, height));
164 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
165 call_claimable_balances(node);
167 let orig_header = node.blocks.lock().unwrap().pop().unwrap();
168 assert!(orig_header.1 > 0); // Cannot disconnect genesis
169 let prev_header = node.blocks.lock().unwrap().last().unwrap().clone();
171 match *node.connect_style.borrow() {
172 ConnectStyle::FullBlockViaListen => {
173 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
174 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
176 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
178 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
179 node.node.best_block_updated(&prev_header.0, prev_header.1);
183 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
184 node.node.best_block_updated(&prev_header.0, prev_header.1);
187 call_claimable_balances(node);
191 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
192 let count = node.blocks.lock().unwrap().len() as u32 - 1;
193 disconnect_blocks(node, count);
196 pub struct TestChanMonCfg {
197 pub tx_broadcaster: test_utils::TestBroadcaster,
198 pub fee_estimator: test_utils::TestFeeEstimator,
199 pub chain_source: test_utils::TestChainSource,
200 pub persister: test_utils::TestPersister,
201 pub logger: test_utils::TestLogger,
202 pub keys_manager: test_utils::TestKeysInterface,
203 pub network_graph: NetworkGraph,
206 pub struct NodeCfg<'a> {
207 pub chain_source: &'a test_utils::TestChainSource,
208 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
209 pub fee_estimator: &'a test_utils::TestFeeEstimator,
210 pub chain_monitor: test_utils::TestChainMonitor<'a>,
211 pub keys_manager: &'a test_utils::TestKeysInterface,
212 pub logger: &'a test_utils::TestLogger,
213 pub network_graph: &'a NetworkGraph,
214 pub node_seed: [u8; 32],
215 pub features: InitFeatures,
218 pub struct Node<'a, 'b: 'a, 'c: 'b> {
219 pub chain_source: &'c test_utils::TestChainSource,
220 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
221 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
222 pub keys_manager: &'b test_utils::TestKeysInterface,
223 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
224 pub network_graph: &'c NetworkGraph,
225 pub net_graph_msg_handler: NetGraphMsgHandler<&'c NetworkGraph, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
226 pub node_seed: [u8; 32],
227 pub network_payment_count: Rc<RefCell<u8>>,
228 pub network_chan_count: Rc<RefCell<u32>>,
229 pub logger: &'c test_utils::TestLogger,
230 pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
231 pub connect_style: Rc<RefCell<ConnectStyle>>,
233 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
234 pub fn best_block_hash(&self) -> BlockHash {
235 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
237 pub fn best_block_info(&self) -> (BlockHash, u32) {
238 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
240 pub fn get_block_header(&self, height: u32) -> BlockHeader {
241 self.blocks.lock().unwrap()[height as usize].0
245 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
248 // Check that we processed all pending events
249 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
250 assert!(self.node.get_and_clear_pending_events().is_empty());
251 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
253 // Check that if we serialize the Router, we can deserialize it again.
255 let mut w = test_utils::TestVecWriter(Vec::new());
256 self.network_graph.write(&mut w).unwrap();
257 let network_graph_deser = <NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap();
258 assert!(network_graph_deser == *self.network_graph);
259 let net_graph_msg_handler = NetGraphMsgHandler::new(
260 &network_graph_deser, Some(self.chain_source), self.logger
262 let mut chan_progress = 0;
264 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
265 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
266 assert!(orig_announcements == deserialized_announcements);
267 chan_progress = match orig_announcements.last() {
268 Some(announcement) => announcement.0.contents.short_channel_id + 1,
272 let mut node_progress = None;
274 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
275 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
276 assert!(orig_announcements == deserialized_announcements);
277 node_progress = match orig_announcements.last() {
278 Some(announcement) => Some(announcement.contents.node_id),
284 // Check that if we serialize and then deserialize all our channel monitors we get the
285 // same set of outputs to watch for on chain as we have now. Note that if we write
286 // tests that fully close channels and remove the monitors at some point this may break.
287 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
288 let mut deserialized_monitors = Vec::new();
290 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
291 let mut w = test_utils::TestVecWriter(Vec::new());
292 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
293 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
294 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
295 deserialized_monitors.push(deserialized_monitor);
299 // Before using all the new monitors to check the watch outpoints, use the full set of
300 // them to ensure we can write and reload our ChannelManager.
302 let mut channel_monitors = HashMap::new();
303 for monitor in deserialized_monitors.iter_mut() {
304 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
307 let mut w = test_utils::TestVecWriter(Vec::new());
308 self.node.write(&mut w).unwrap();
309 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(w.0), ChannelManagerReadArgs {
310 default_config: *self.node.get_current_default_configuration(),
311 keys_manager: self.keys_manager,
312 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
313 chain_monitor: self.chain_monitor,
314 tx_broadcaster: &test_utils::TestBroadcaster {
315 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
316 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
318 logger: &self.logger,
323 let persister = test_utils::TestPersister::new();
324 let broadcaster = test_utils::TestBroadcaster {
325 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
326 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
328 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
329 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
330 for deserialized_monitor in deserialized_monitors.drain(..) {
331 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
335 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
336 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
341 pub fn create_chan_between_nodes<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
342 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
345 pub fn create_chan_between_nodes_with_value<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
346 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
347 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
348 (announcement, as_update, bs_update, channel_id, tx)
352 /// Gets an RAA and CS which were sent in response to a commitment update
353 macro_rules! get_revoke_commit_msgs {
354 ($node: expr, $node_id: expr) => {
356 use $crate::util::events::MessageSendEvent;
357 let events = $node.node.get_and_clear_pending_msg_events();
358 assert_eq!(events.len(), 2);
360 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
361 assert_eq!(*node_id, $node_id);
364 _ => panic!("Unexpected event"),
366 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
367 assert_eq!(*node_id, $node_id);
368 assert!(updates.update_add_htlcs.is_empty());
369 assert!(updates.update_fulfill_htlcs.is_empty());
370 assert!(updates.update_fail_htlcs.is_empty());
371 assert!(updates.update_fail_malformed_htlcs.is_empty());
372 assert!(updates.update_fee.is_none());
373 updates.commitment_signed.clone()
375 _ => panic!("Unexpected event"),
381 /// Get an specific event message from the pending events queue.
383 macro_rules! get_event_msg {
384 ($node: expr, $event_type: path, $node_id: expr) => {
386 let events = $node.node.get_and_clear_pending_msg_events();
387 assert_eq!(events.len(), 1);
389 $event_type { ref node_id, ref msg } => {
390 assert_eq!(*node_id, $node_id);
393 _ => panic!("Unexpected event"),
399 /// Get an error message from the pending events queue.
401 macro_rules! get_err_msg {
402 ($node: expr, $node_id: expr) => {
404 let events = $node.node.get_and_clear_pending_msg_events();
405 assert_eq!(events.len(), 1);
407 $crate::util::events::MessageSendEvent::HandleError {
408 action: $crate::ln::msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
410 assert_eq!(*node_id, $node_id);
413 _ => panic!("Unexpected event"),
419 /// Get a specific event from the pending events queue.
421 macro_rules! get_event {
422 ($node: expr, $event_type: path) => {
424 let mut events = $node.node.get_and_clear_pending_events();
425 assert_eq!(events.len(), 1);
426 let ev = events.pop().unwrap();
428 $event_type { .. } => {
431 _ => panic!("Unexpected event"),
438 /// Gets an UpdateHTLCs MessageSendEvent
439 macro_rules! get_htlc_update_msgs {
440 ($node: expr, $node_id: expr) => {
442 let events = $node.node.get_and_clear_pending_msg_events();
443 assert_eq!(events.len(), 1);
445 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
446 assert_eq!(*node_id, $node_id);
449 _ => panic!("Unexpected event"),
456 macro_rules! get_channel_ref {
457 ($node: expr, $lock: ident, $channel_id: expr) => {
459 $lock = $node.node.channel_state.lock().unwrap();
460 $lock.by_id.get_mut(&$channel_id).unwrap()
466 macro_rules! get_feerate {
467 ($node: expr, $channel_id: expr) => {
470 let chan = get_channel_ref!($node, lock, $channel_id);
477 macro_rules! get_opt_anchors {
478 ($node: expr, $channel_id: expr) => {
481 let chan = get_channel_ref!($node, lock, $channel_id);
487 /// Returns a channel monitor given a channel id, making some naive assumptions
489 macro_rules! get_monitor {
490 ($node: expr, $channel_id: expr) => {
492 use bitcoin::hashes::Hash;
493 let mut monitor = None;
494 // Assume funding vout is either 0 or 1 blindly
496 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
497 $crate::chain::transaction::OutPoint {
498 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
510 /// Returns any local commitment transactions for the channel.
512 macro_rules! get_local_commitment_txn {
513 ($node: expr, $channel_id: expr) => {
515 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
520 /// Check the error from attempting a payment.
522 macro_rules! unwrap_send_err {
523 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
525 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
526 assert_eq!(fails.len(), 1);
532 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
533 assert_eq!(results.len(), 1);
535 Err($type) => { $check },
544 /// Check whether N channel monitor(s) have been added.
546 macro_rules! check_added_monitors {
547 ($node: expr, $count: expr) => {
549 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
550 assert_eq!(added_monitors.len(), $count);
551 added_monitors.clear();
556 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) {
557 let chan_id = *node.network_chan_count.borrow();
559 let events = node.node.get_and_clear_pending_events();
560 assert_eq!(events.len(), 1);
562 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
563 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
564 assert_eq!(*channel_value_satoshis, expected_chan_value);
565 assert_eq!(user_channel_id, expected_user_chan_id);
567 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
568 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
570 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
571 (*temporary_channel_id, tx, funding_outpoint)
573 _ => panic!("Unexpected event"),
576 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 {
577 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
578 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
580 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_ok());
581 check_added_monitors!(node_a, 0);
583 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
584 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
585 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
587 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
588 assert_eq!(added_monitors.len(), 1);
589 assert_eq!(added_monitors[0].0, funding_output);
590 added_monitors.clear();
593 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()));
595 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
596 assert_eq!(added_monitors.len(), 1);
597 assert_eq!(added_monitors[0].0, funding_output);
598 added_monitors.clear();
601 let events_4 = node_a.node.get_and_clear_pending_events();
602 assert_eq!(events_4.len(), 0);
604 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
605 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
606 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
608 // Ensure that funding_transaction_generated is idempotent.
609 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_err());
610 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
611 check_added_monitors!(node_a, 0);
616 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 {
617 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
618 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
619 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
620 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
621 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
622 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
623 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
625 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
628 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) {
629 confirm_transaction_at(node_conf, tx, conf_height);
630 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
631 node_recv.node.handle_funding_locked(&node_conf.node.get_our_node_id(), &get_event_msg!(node_conf, MessageSendEvent::SendFundingLocked, node_recv.node.get_our_node_id()));
634 pub fn create_chan_between_nodes_with_value_confirm_second<'a, 'b, 'c>(node_recv: &Node<'a, 'b, 'c>, node_conf: &Node<'a, 'b, 'c>) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
636 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
637 assert_eq!(events_6.len(), 3);
638 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
639 assert_eq!(*node_id, node_recv.node.get_our_node_id());
641 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
642 assert_eq!(*node_id, node_recv.node.get_our_node_id());
644 } else { panic!("Unexpected event: {:?}", events_6[1]); };
645 ((match events_6[0] {
646 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
647 channel_id = msg.channel_id.clone();
648 assert_eq!(*node_id, node_recv.node.get_our_node_id());
651 _ => panic!("Unexpected event"),
652 }, match events_6[announcement_sigs_idx] {
653 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
654 assert_eq!(*node_id, node_recv.node.get_our_node_id());
657 _ => panic!("Unexpected event"),
661 pub fn create_chan_between_nodes_with_value_confirm<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
662 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
663 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
664 confirm_transaction_at(node_a, tx, conf_height);
665 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
666 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
669 pub fn create_chan_between_nodes_with_value_a<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
670 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
671 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
675 pub fn create_chan_between_nodes_with_value_b<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, as_funding_msgs: &(msgs::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
676 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
677 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
678 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
680 let events_7 = node_b.node.get_and_clear_pending_msg_events();
681 assert_eq!(events_7.len(), 1);
682 let (announcement, bs_update) = match events_7[0] {
683 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
686 _ => panic!("Unexpected event"),
689 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
690 let events_8 = node_a.node.get_and_clear_pending_msg_events();
691 assert_eq!(events_8.len(), 1);
692 let as_update = match events_8[0] {
693 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
694 assert!(*announcement == *msg);
695 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
696 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
699 _ => panic!("Unexpected event"),
702 *node_a.network_chan_count.borrow_mut() += 1;
704 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
707 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) {
708 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
711 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) {
712 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
713 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
714 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
717 pub fn create_unannounced_chan_between_nodes_with_value<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::FundingLocked, Transaction) {
718 let mut no_announce_cfg = test_default_channel_config();
719 no_announce_cfg.channel_options.announced_channel = false;
720 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
721 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
722 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), a_flags, &open_channel);
723 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
724 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), b_flags, &accept_channel);
726 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
727 nodes[a].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
728 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()));
729 check_added_monitors!(nodes[b], 1);
731 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
732 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
733 check_added_monitors!(nodes[a], 1);
735 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
736 confirm_transaction_at(&nodes[a], &tx, conf_height);
737 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
738 confirm_transaction_at(&nodes[b], &tx, conf_height);
739 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
740 let as_funding_locked = get_event_msg!(nodes[a], MessageSendEvent::SendFundingLocked, nodes[b].node.get_our_node_id());
741 nodes[a].node.handle_funding_locked(&nodes[b].node.get_our_node_id(), &get_event_msg!(nodes[b], MessageSendEvent::SendFundingLocked, nodes[a].node.get_our_node_id()));
742 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
743 nodes[b].node.handle_funding_locked(&nodes[a].node.get_our_node_id(), &as_funding_locked);
744 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
746 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
747 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
749 let mut found_a = false;
750 for chan in nodes[a].node.list_usable_channels() {
751 if chan.channel_id == as_funding_locked.channel_id {
754 assert!(!chan.is_public);
759 let mut found_b = false;
760 for chan in nodes[b].node.list_usable_channels() {
761 if chan.channel_id == as_funding_locked.channel_id {
764 assert!(!chan.is_public);
769 (as_funding_locked, tx)
772 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) {
773 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
774 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
775 assert!(a_events.len() >= 2);
777 // ann should be re-generated by broadcast_node_announcement - check that we have it.
778 let mut found_ann_1 = false;
779 for event in a_events.iter() {
781 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
782 if msg == ann { found_ann_1 = true; }
784 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
785 _ => panic!("Unexpected event {:?}", event),
788 assert!(found_ann_1);
790 let a_node_announcement = match a_events.last().unwrap() {
791 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
794 _ => panic!("Unexpected event"),
797 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
798 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
799 assert!(b_events.len() >= 2);
801 // ann should be re-generated by broadcast_node_announcement - check that we have it.
802 let mut found_ann_2 = false;
803 for event in b_events.iter() {
805 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
806 if msg == ann { found_ann_2 = true; }
808 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
809 _ => panic!("Unexpected event"),
812 assert!(found_ann_2);
814 let b_node_announcement = match b_events.last().unwrap() {
815 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
818 _ => panic!("Unexpected event"),
822 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
823 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
824 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
825 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
826 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
828 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
829 // forwarding info for local channels even if its not accepted in the network graph.
830 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
831 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
836 macro_rules! check_spends {
837 ($tx: expr, $($spends_txn: expr),*) => {
840 for outp in $spends_txn.output.iter() {
841 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Input tx output didn't meet dust limit");
844 for outp in $tx.output.iter() {
845 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Spending tx output didn't meet dust limit");
847 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
849 if out_point.txid == $spends_txn.txid() {
850 return $spends_txn.output.get(out_point.vout as usize).cloned()
855 let mut total_value_in = 0;
856 for input in $tx.input.iter() {
857 total_value_in += get_output(&input.previous_output).unwrap().value;
859 let mut total_value_out = 0;
860 for output in $tx.output.iter() {
861 total_value_out += output.value;
863 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
864 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
865 assert!(total_value_out + min_fee <= total_value_in);
866 $tx.verify(get_output).unwrap();
871 macro_rules! get_closing_signed_broadcast {
872 ($node: expr, $dest_pubkey: expr) => {
874 let events = $node.get_and_clear_pending_msg_events();
875 assert!(events.len() == 1 || events.len() == 2);
876 (match events[events.len() - 1] {
877 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
878 assert_eq!(msg.contents.flags & 2, 2);
881 _ => panic!("Unexpected event"),
882 }, if events.len() == 2 {
884 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
885 assert_eq!(*node_id, $dest_pubkey);
888 _ => panic!("Unexpected event"),
896 macro_rules! check_warn_msg {
897 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
898 let msg_events = $node.node.get_and_clear_pending_msg_events();
899 assert_eq!(msg_events.len(), 1);
900 match msg_events[0] {
901 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
902 assert_eq!(node_id, $recipient_node_id);
903 assert_eq!(msg.channel_id, $chan_id);
906 _ => panic!("Unexpected event"),
911 /// Check that a channel's closing channel update has been broadcasted, and optionally
912 /// check whether an error message event has occurred.
914 macro_rules! check_closed_broadcast {
915 ($node: expr, $with_error_msg: expr) => {{
916 use $crate::util::events::MessageSendEvent;
917 use $crate::ln::msgs::ErrorAction;
919 let msg_events = $node.node.get_and_clear_pending_msg_events();
920 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
921 match msg_events[0] {
922 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
923 assert_eq!(msg.contents.flags & 2, 2);
925 _ => panic!("Unexpected event"),
928 match msg_events[1] {
929 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
930 // TODO: Check node_id
933 _ => panic!("Unexpected event"),
939 /// Check that a channel's closing channel events has been issued
941 macro_rules! check_closed_event {
942 ($node: expr, $events: expr, $reason: expr) => {
943 check_closed_event!($node, $events, $reason, false);
945 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
946 use $crate::util::events::Event;
948 let events = $node.node.get_and_clear_pending_events();
949 assert_eq!(events.len(), $events);
950 let expected_reason = $reason;
951 let mut issues_discard_funding = false;
952 for event in events {
954 Event::ChannelClosed { ref reason, .. } => {
955 assert_eq!(*reason, expected_reason);
957 Event::DiscardFunding { .. } => {
958 issues_discard_funding = true;
960 _ => panic!("Unexpected event"),
963 assert_eq!($is_check_discard_funding, issues_discard_funding);
967 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) {
968 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) };
969 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) };
972 node_a.close_channel(channel_id).unwrap();
973 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()));
975 let events_1 = node_b.get_and_clear_pending_msg_events();
976 assert!(events_1.len() >= 1);
977 let shutdown_b = match events_1[0] {
978 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
979 assert_eq!(node_id, &node_a.get_our_node_id());
982 _ => panic!("Unexpected event"),
985 let closing_signed_b = if !close_inbound_first {
986 assert_eq!(events_1.len(), 1);
989 Some(match events_1[1] {
990 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
991 assert_eq!(node_id, &node_a.get_our_node_id());
994 _ => panic!("Unexpected event"),
998 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
999 let (as_update, bs_update) = if close_inbound_first {
1000 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1001 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1003 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1004 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1005 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1006 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1008 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1009 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1010 assert!(none_a.is_none());
1011 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1012 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1013 (as_update, bs_update)
1015 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1017 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1018 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1020 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1021 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1022 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1024 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1025 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1026 assert!(none_b.is_none());
1027 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1028 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1029 (as_update, bs_update)
1031 assert_eq!(tx_a, tx_b);
1032 check_spends!(tx_a, funding_tx);
1034 (as_update, bs_update, tx_a)
1037 pub struct SendEvent {
1038 pub node_id: PublicKey,
1039 pub msgs: Vec<msgs::UpdateAddHTLC>,
1040 pub commitment_msg: msgs::CommitmentSigned,
1043 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1044 assert!(updates.update_fulfill_htlcs.is_empty());
1045 assert!(updates.update_fail_htlcs.is_empty());
1046 assert!(updates.update_fail_malformed_htlcs.is_empty());
1047 assert!(updates.update_fee.is_none());
1048 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1051 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1053 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1054 _ => panic!("Unexpected event type!"),
1058 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1059 let mut events = node.node.get_and_clear_pending_msg_events();
1060 assert_eq!(events.len(), 1);
1061 SendEvent::from_event(events.pop().unwrap())
1066 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1067 /// commitment update.
1068 macro_rules! commitment_signed_dance {
1069 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1071 check_added_monitors!($node_a, 0);
1072 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1073 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1074 check_added_monitors!($node_a, 1);
1075 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1078 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1080 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1081 check_added_monitors!($node_b, 0);
1082 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1083 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1084 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1085 check_added_monitors!($node_b, 1);
1086 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1087 let (bs_revoke_and_ack, extra_msg_option) = {
1088 let events = $node_b.node.get_and_clear_pending_msg_events();
1089 assert!(events.len() <= 2);
1091 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1092 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1095 _ => panic!("Unexpected event"),
1096 }, events.get(1).map(|e| e.clone()))
1098 check_added_monitors!($node_b, 1);
1099 if $fail_backwards {
1100 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1101 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1103 (extra_msg_option, bs_revoke_and_ack)
1106 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1108 check_added_monitors!($node_a, 0);
1109 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1110 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1111 check_added_monitors!($node_a, 1);
1112 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1113 assert!(extra_msg_option.is_none());
1117 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1119 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1120 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1121 check_added_monitors!($node_a, 1);
1125 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1127 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1130 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1132 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1133 if $fail_backwards {
1134 $crate::expect_pending_htlcs_forwardable!($node_a);
1135 check_added_monitors!($node_a, 1);
1137 let channel_state = $node_a.node.channel_state.lock().unwrap();
1138 assert_eq!(channel_state.pending_msg_events.len(), 1);
1139 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1140 assert_ne!(*node_id, $node_b.node.get_our_node_id());
1141 } else { panic!("Unexpected event"); }
1143 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1149 /// Get a payment preimage and hash.
1151 macro_rules! get_payment_preimage_hash {
1152 ($dest_node: expr) => {
1154 get_payment_preimage_hash!($dest_node, None)
1157 ($dest_node: expr, $min_value_msat: expr) => {
1159 use bitcoin::hashes::Hash as _;
1160 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1161 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1162 *payment_count += 1;
1163 let payment_hash = $crate::ln::PaymentHash(
1164 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1165 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1166 (payment_preimage, payment_hash, payment_secret)
1172 macro_rules! get_route {
1173 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1174 use $crate::chain::keysinterface::KeysInterface;
1175 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1176 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1177 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1178 $crate::routing::router::get_route(
1179 &$send_node.node.get_our_node_id(), &$payment_params, &$send_node.network_graph.read_only(),
1180 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1181 $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1188 macro_rules! get_route_and_payment_hash {
1189 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1190 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1191 .with_features($crate::ln::features::InvoiceFeatures::known());
1192 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1194 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1195 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1196 let route = $crate::get_route!($send_node, $payment_params, $recv_value, $cltv);
1197 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1202 /// Clears (and ignores) a PendingHTLCsForwardable event
1203 macro_rules! expect_pending_htlcs_forwardable_ignore {
1205 let events = $node.node.get_and_clear_pending_events();
1206 assert_eq!(events.len(), 1);
1208 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1209 _ => panic!("Unexpected event"),
1215 /// Handles a PendingHTLCsForwardable event
1216 macro_rules! expect_pending_htlcs_forwardable {
1218 $crate::expect_pending_htlcs_forwardable_ignore!($node);
1219 $node.node.process_pending_htlc_forwards();
1221 // Ensure process_pending_htlc_forwards is idempotent.
1222 $node.node.process_pending_htlc_forwards();
1227 macro_rules! expect_pending_htlcs_forwardable_from_events {
1228 ($node: expr, $events: expr, $ignore: expr) => {{
1229 assert_eq!($events.len(), 1);
1231 Event::PendingHTLCsForwardable { .. } => { },
1232 _ => panic!("Unexpected event"),
1235 $node.node.process_pending_htlc_forwards();
1237 // Ensure process_pending_htlc_forwards is idempotent.
1238 $node.node.process_pending_htlc_forwards();
1244 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1245 macro_rules! expect_payment_received {
1246 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1247 expect_payment_received!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None)
1249 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr) => {
1250 let events = $node.node.get_and_clear_pending_events();
1251 assert_eq!(events.len(), 1);
1253 $crate::util::events::Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1254 assert_eq!($expected_payment_hash, *payment_hash);
1255 assert_eq!($expected_recv_value, amt);
1257 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1258 assert_eq!(&$expected_payment_preimage, payment_preimage);
1259 assert_eq!($expected_payment_secret, *payment_secret);
1264 _ => panic!("Unexpected event"),
1271 macro_rules! expect_payment_sent_without_paths {
1272 ($node: expr, $expected_payment_preimage: expr) => {
1273 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1275 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1276 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1281 macro_rules! expect_payment_sent {
1282 ($node: expr, $expected_payment_preimage: expr) => {
1283 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1285 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1286 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1288 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1289 use bitcoin::hashes::Hash as _;
1290 let events = $node.node.get_and_clear_pending_events();
1291 let expected_payment_hash = $crate::ln::PaymentHash(
1292 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1294 assert!(events.len() > 1);
1296 assert_eq!(events.len(), 1);
1298 let expected_payment_id = match events[0] {
1299 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1300 assert_eq!($expected_payment_preimage, *payment_preimage);
1301 assert_eq!(expected_payment_hash, *payment_hash);
1302 assert!(fee_paid_msat.is_some());
1303 if $expected_fee_msat_opt.is_some() {
1304 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1308 _ => panic!("Unexpected event"),
1311 for i in 1..events.len() {
1313 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1314 assert_eq!(payment_id, expected_payment_id);
1315 assert_eq!(payment_hash, Some(expected_payment_hash));
1317 _ => panic!("Unexpected event"),
1326 macro_rules! expect_payment_path_successful {
1328 let events = $node.node.get_and_clear_pending_events();
1329 assert_eq!(events.len(), 1);
1331 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1332 _ => panic!("Unexpected event"),
1337 macro_rules! expect_payment_forwarded {
1338 ($node: expr, $source_node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1339 let events = $node.node.get_and_clear_pending_events();
1340 assert_eq!(events.len(), 1);
1342 Event::PaymentForwarded { fee_earned_msat, source_channel_id, claim_from_onchain_tx } => {
1343 assert_eq!(fee_earned_msat, $expected_fee);
1344 if fee_earned_msat.is_some() {
1345 // Is the event channel_id in one of the channels between the two nodes?
1346 assert!($node.node.list_channels().iter().any(|x| x.counterparty.node_id == $source_node.node.get_our_node_id() && x.channel_id == source_channel_id.unwrap()));
1348 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1350 _ => panic!("Unexpected event"),
1355 pub struct PaymentFailedConditions<'a> {
1356 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1357 pub(crate) expected_blamed_scid: Option<u64>,
1358 pub(crate) expected_blamed_chan_closed: Option<bool>,
1359 pub(crate) expected_mpp_parts_remain: bool,
1362 impl<'a> PaymentFailedConditions<'a> {
1363 pub fn new() -> Self {
1365 expected_htlc_error_data: None,
1366 expected_blamed_scid: None,
1367 expected_blamed_chan_closed: None,
1368 expected_mpp_parts_remain: false,
1371 pub fn mpp_parts_remain(mut self) -> Self {
1372 self.expected_mpp_parts_remain = true;
1375 pub fn blamed_scid(mut self, scid: u64) -> Self {
1376 self.expected_blamed_scid = Some(scid);
1379 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1380 self.expected_blamed_chan_closed = Some(closed);
1383 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1384 self.expected_htlc_error_data = Some((code, data));
1390 macro_rules! expect_payment_failed_with_update {
1391 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1392 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest,
1393 $crate::ln::functional_test_utils::PaymentFailedConditions::new().blamed_scid($scid).blamed_chan_closed($chan_closed));
1398 macro_rules! expect_payment_failed {
1399 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1400 #[allow(unused_mut)]
1401 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1403 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1405 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest, conditions);
1410 macro_rules! expect_payment_failed_conditions {
1411 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $conditions: expr) => {
1412 let events = $node.node.get_and_clear_pending_events();
1413 assert_eq!(events.len(), 1);
1414 let expected_payment_id = match events[0] {
1415 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data, ref path, ref retry, ref payment_id, ref network_update, .. } => {
1416 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1417 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1418 assert!(retry.is_some(), "expected retry.is_some()");
1419 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1420 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1422 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1423 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1424 if let Some((code, data)) = $conditions.expected_htlc_error_data {
1425 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1426 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1429 if let Some(chan_closed) = $conditions.expected_blamed_chan_closed {
1430 match network_update {
1431 &Some($crate::routing::network_graph::NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1432 if let Some(scid) = $conditions.expected_blamed_scid {
1433 assert_eq!(msg.contents.short_channel_id, scid);
1435 assert_eq!(msg.contents.flags & 2, 0);
1437 &Some($crate::routing::network_graph::NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if chan_closed => {
1438 if let Some(scid) = $conditions.expected_blamed_scid {
1439 assert_eq!(short_channel_id, scid);
1441 assert!(is_permanent);
1443 Some(_) => panic!("Unexpected update type"),
1444 None => panic!("Expected update"),
1450 _ => panic!("Unexpected event"),
1452 if !$conditions.expected_mpp_parts_remain {
1453 $node.node.abandon_payment(expected_payment_id);
1454 let events = $node.node.get_and_clear_pending_events();
1455 assert_eq!(events.len(), 1);
1457 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1458 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected second payment_hash");
1459 assert_eq!(*payment_id, expected_payment_id);
1461 _ => panic!("Unexpected second event"),
1467 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 {
1468 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1469 check_added_monitors!(origin_node, expected_paths.len());
1470 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1474 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>) {
1475 let mut payment_event = SendEvent::from_event(ev);
1476 let mut prev_node = origin_node;
1478 for (idx, &node) in expected_path.iter().enumerate() {
1479 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1481 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1482 check_added_monitors!(node, 0);
1483 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1485 expect_pending_htlcs_forwardable!(node);
1487 if idx == expected_path.len() - 1 {
1488 let events_2 = node.node.get_and_clear_pending_events();
1489 if payment_received_expected {
1490 assert_eq!(events_2.len(), 1);
1492 Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1493 assert_eq!(our_payment_hash, *payment_hash);
1495 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1496 assert_eq!(expected_preimage, *payment_preimage);
1497 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1499 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1500 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1501 assert!(our_payment_secret.is_none());
1504 assert_eq!(amt, recv_value);
1506 _ => panic!("Unexpected event"),
1509 assert!(events_2.is_empty());
1512 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1513 assert_eq!(events_2.len(), 1);
1514 check_added_monitors!(node, 1);
1515 payment_event = SendEvent::from_event(events_2.remove(0));
1516 assert_eq!(payment_event.msgs.len(), 1);
1523 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) {
1524 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1525 assert_eq!(events.len(), expected_route.len());
1526 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1527 // Once we've gotten through all the HTLCs, the last one should result in a
1528 // PaymentReceived (but each previous one should not!), .
1529 let expect_payment = path_idx == expected_route.len() - 1;
1530 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1534 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) {
1535 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1536 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1537 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1540 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 {
1541 for path in expected_paths.iter() {
1542 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1544 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1545 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1547 let mut expected_total_fee_msat = 0;
1549 macro_rules! msgs_from_ev {
1552 &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 } } => {
1553 assert!(update_add_htlcs.is_empty());
1554 assert_eq!(update_fulfill_htlcs.len(), 1);
1555 assert!(update_fail_htlcs.is_empty());
1556 assert!(update_fail_malformed_htlcs.is_empty());
1557 assert!(update_fee.is_none());
1558 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1560 _ => panic!("Unexpected event"),
1564 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1565 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1566 assert_eq!(events.len(), expected_paths.len());
1567 for ev in events.iter() {
1568 per_path_msgs.push(msgs_from_ev!(ev));
1571 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1572 let mut next_msgs = Some(path_msgs);
1573 let mut expected_next_node = next_hop;
1575 macro_rules! last_update_fulfill_dance {
1576 ($node: expr, $prev_node: expr) => {
1578 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1579 check_added_monitors!($node, 0);
1580 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1581 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1585 macro_rules! mid_update_fulfill_dance {
1586 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
1588 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1589 let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
1590 expect_payment_forwarded!($node, $next_node, Some(fee as u64), false);
1591 expected_total_fee_msat += fee as u64;
1592 check_added_monitors!($node, 1);
1593 let new_next_msgs = if $new_msgs {
1594 let events = $node.node.get_and_clear_pending_msg_events();
1595 assert_eq!(events.len(), 1);
1596 let (res, nexthop) = msgs_from_ev!(&events[0]);
1597 expected_next_node = nexthop;
1600 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1603 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1604 next_msgs = new_next_msgs;
1609 let mut prev_node = expected_route.last().unwrap();
1610 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1611 assert_eq!(expected_next_node, node.node.get_our_node_id());
1612 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1613 if next_msgs.is_some() {
1614 // Since we are traversing in reverse, next_node is actually the previous node
1615 let next_node: &Node;
1616 if idx == expected_route.len() - 1 {
1617 next_node = origin_node;
1619 next_node = expected_route[expected_route.len() - 1 - idx - 1];
1621 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
1623 assert!(!update_next_msgs);
1624 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1626 if !skip_last && idx == expected_route.len() - 1 {
1627 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1634 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1638 // Ensure that claim_funds is idempotent.
1639 assert!(!expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1640 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1641 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1643 expected_total_fee_msat
1645 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) {
1646 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1648 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1652 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1653 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1656 pub const TEST_FINAL_CLTV: u32 = 70;
1658 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) {
1659 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1660 .with_features(InvoiceFeatures::known());
1661 let route = get_route!(origin_node, payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
1662 assert_eq!(route.paths.len(), 1);
1663 assert_eq!(route.paths[0].len(), expected_route.len());
1664 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1665 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1668 let res = send_along_route(origin_node, route, expected_route, recv_value);
1669 (res.0, res.1, res.2)
1672 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1673 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1674 .with_features(InvoiceFeatures::known());
1675 let network_graph = origin_node.network_graph.read_only();
1676 let scorer = test_utils::TestScorer::with_penalty(0);
1677 let seed = [0u8; 32];
1678 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1679 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1680 let route = get_route(
1681 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
1682 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
1683 assert_eq!(route.paths.len(), 1);
1684 assert_eq!(route.paths[0].len(), expected_route.len());
1685 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1686 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1689 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1690 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1691 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1694 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1695 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1696 claim_payment(&origin, expected_route, our_payment_preimage);
1699 pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
1700 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1701 for path in expected_paths.iter() {
1702 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1704 assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1705 expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1706 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1708 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1709 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1710 assert_eq!(events.len(), expected_paths.len());
1711 for ev in events.iter() {
1712 let (update_fail, commitment_signed, node_id) = match ev {
1713 &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 } } => {
1714 assert!(update_add_htlcs.is_empty());
1715 assert!(update_fulfill_htlcs.is_empty());
1716 assert_eq!(update_fail_htlcs.len(), 1);
1717 assert!(update_fail_malformed_htlcs.is_empty());
1718 assert!(update_fee.is_none());
1719 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1721 _ => panic!("Unexpected event"),
1723 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1725 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1726 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()));
1728 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1729 let mut next_msgs = Some(path_msgs);
1730 let mut expected_next_node = next_hop;
1731 let mut prev_node = expected_route.last().unwrap();
1733 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1734 assert_eq!(expected_next_node, node.node.get_our_node_id());
1735 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1736 if next_msgs.is_some() {
1737 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1738 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1739 if !update_next_node {
1740 expect_pending_htlcs_forwardable!(node);
1743 let events = node.node.get_and_clear_pending_msg_events();
1744 if update_next_node {
1745 assert_eq!(events.len(), 1);
1747 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 } } => {
1748 assert!(update_add_htlcs.is_empty());
1749 assert!(update_fulfill_htlcs.is_empty());
1750 assert_eq!(update_fail_htlcs.len(), 1);
1751 assert!(update_fail_malformed_htlcs.is_empty());
1752 assert!(update_fee.is_none());
1753 expected_next_node = node_id.clone();
1754 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1756 _ => panic!("Unexpected event"),
1759 assert!(events.is_empty());
1761 if !skip_last && idx == expected_route.len() - 1 {
1762 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1769 let prev_node = expected_route.first().unwrap();
1770 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1771 check_added_monitors!(origin_node, 0);
1772 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1773 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1774 let events = origin_node.node.get_and_clear_pending_events();
1775 assert_eq!(events.len(), 1);
1776 let expected_payment_id = match events[0] {
1777 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, ref payment_id, .. } => {
1778 assert_eq!(payment_hash, our_payment_hash);
1779 assert!(rejected_by_dest);
1780 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1781 for (idx, hop) in expected_route.iter().enumerate() {
1782 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1786 _ => panic!("Unexpected event"),
1788 if i == expected_paths.len() - 1 {
1789 origin_node.node.abandon_payment(expected_payment_id);
1790 let events = origin_node.node.get_and_clear_pending_events();
1791 assert_eq!(events.len(), 1);
1793 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1794 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
1795 assert_eq!(*payment_id, expected_payment_id);
1797 _ => panic!("Unexpected second event"),
1803 // Ensure that fail_htlc_backwards is idempotent.
1804 assert!(!expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1805 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
1806 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1807 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1810 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1811 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1814 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1815 let mut chan_mon_cfgs = Vec::new();
1816 for i in 0..node_count {
1817 let tx_broadcaster = test_utils::TestBroadcaster {
1818 txn_broadcasted: Mutex::new(Vec::new()),
1819 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1821 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1822 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1823 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1824 let persister = test_utils::TestPersister::new();
1825 let seed = [i as u8; 32];
1826 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1827 let network_graph = NetworkGraph::new(chain_source.genesis_hash);
1829 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, network_graph });
1835 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1836 let mut nodes = Vec::new();
1838 for i in 0..node_count {
1839 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);
1840 let seed = [i as u8; 32];
1841 nodes.push(NodeCfg {
1842 chain_source: &chanmon_cfgs[i].chain_source,
1843 logger: &chanmon_cfgs[i].logger,
1844 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1845 fee_estimator: &chanmon_cfgs[i].fee_estimator,
1847 keys_manager: &chanmon_cfgs[i].keys_manager,
1849 features: InitFeatures::known(),
1850 network_graph: &chanmon_cfgs[i].network_graph,
1857 pub fn test_default_channel_config() -> UserConfig {
1858 let mut default_config = UserConfig::default();
1859 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1860 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1861 default_config.channel_options.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
1862 default_config.channel_options.announced_channel = true;
1863 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1864 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1865 // It now defaults to 1, so we simply set it to the expected value here.
1866 default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1867 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1868 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1869 default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1873 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>> {
1874 let mut chanmgrs = Vec::new();
1875 for i in 0..node_count {
1876 let network = Network::Testnet;
1877 let params = ChainParameters {
1879 best_block: BestBlock::from_genesis(network),
1881 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1882 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1883 chanmgrs.push(node);
1889 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>> {
1890 let mut nodes = Vec::new();
1891 let chan_count = Rc::new(RefCell::new(0));
1892 let payment_count = Rc::new(RefCell::new(0));
1893 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1895 for i in 0..node_count {
1896 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].network_graph, None, cfgs[i].logger);
1898 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
1899 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
1900 node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, net_graph_msg_handler,
1901 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1902 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1903 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1904 connect_style: Rc::clone(&connect_style),
1908 for i in 0..node_count {
1909 for j in (i+1)..node_count {
1910 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone(), remote_network_address: None });
1911 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone(), remote_network_address: None });
1918 // Note that the following only works for CLTV values up to 128
1919 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1920 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1922 #[derive(PartialEq)]
1923 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1924 /// Tests that the given node has broadcast transactions for the given Channel
1926 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1927 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1928 /// broadcast and the revoked outputs were claimed.
1930 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1931 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1933 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1935 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> {
1936 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1937 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1939 let mut res = Vec::with_capacity(2);
1940 node_txn.retain(|tx| {
1941 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1942 check_spends!(tx, chan.3);
1943 if commitment_tx.is_none() {
1944 res.push(tx.clone());
1949 if let Some(explicit_tx) = commitment_tx {
1950 res.push(explicit_tx.clone());
1953 assert_eq!(res.len(), 1);
1955 if has_htlc_tx != HTLCType::NONE {
1956 node_txn.retain(|tx| {
1957 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1958 check_spends!(tx, res[0]);
1959 if has_htlc_tx == HTLCType::TIMEOUT {
1960 assert!(tx.lock_time != 0);
1962 assert!(tx.lock_time == 0);
1964 res.push(tx.clone());
1968 assert!(res.len() == 2 || res.len() == 3);
1970 assert_eq!(res[1], res[2]);
1974 assert!(node_txn.is_empty());
1978 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1979 /// HTLC transaction.
1980 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1981 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1982 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1983 // for revoked htlc outputs
1984 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1985 node_txn.retain(|tx| {
1986 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1987 check_spends!(tx, revoked_tx);
1991 node_txn.retain(|tx| {
1992 check_spends!(tx, commitment_revoked_tx);
1995 assert!(node_txn.is_empty());
1998 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1999 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2001 assert!(node_txn.len() >= 1);
2002 assert_eq!(node_txn[0].input.len(), 1);
2003 let mut found_prev = false;
2005 for tx in prev_txn {
2006 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2007 check_spends!(node_txn[0], tx);
2008 let mut iter = node_txn[0].input[0].witness.iter();
2009 iter.next().expect("expected 3 witness items");
2010 iter.next().expect("expected 3 witness items");
2011 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2012 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2018 assert!(found_prev);
2020 let mut res = Vec::new();
2021 mem::swap(&mut *node_txn, &mut res);
2025 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) {
2026 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2027 assert_eq!(events_1.len(), 2);
2028 let as_update = match events_1[0] {
2029 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2032 _ => panic!("Unexpected event"),
2035 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2036 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2037 assert_eq!(msg.data, expected_error);
2038 if needs_err_handle {
2039 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2042 _ => panic!("Unexpected event"),
2045 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2046 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2047 let bs_update = match events_2[0] {
2048 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2051 _ => panic!("Unexpected event"),
2053 if !needs_err_handle {
2055 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2056 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2057 assert_eq!(msg.data, expected_error);
2059 _ => panic!("Unexpected event"),
2064 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
2065 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
2069 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2070 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2074 macro_rules! get_channel_value_stat {
2075 ($node: expr, $channel_id: expr) => {{
2076 let chan_lock = $node.node.channel_state.lock().unwrap();
2077 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
2078 chan.get_value_stat()
2082 macro_rules! get_chan_reestablish_msgs {
2083 ($src_node: expr, $dst_node: expr) => {
2085 let mut res = Vec::with_capacity(1);
2086 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2087 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2088 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2089 res.push(msg.clone());
2091 panic!("Unexpected event")
2099 macro_rules! handle_chan_reestablish_msgs {
2100 ($src_node: expr, $dst_node: expr) => {
2102 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2104 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
2106 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2112 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2114 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2117 let mut revoke_and_ack = None;
2118 let mut commitment_update = None;
2119 let order = if let Some(ev) = msg_events.get(idx) {
2121 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2122 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2123 revoke_and_ack = Some(msg.clone());
2125 RAACommitmentOrder::RevokeAndACKFirst
2127 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2128 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2129 commitment_update = Some(updates.clone());
2131 RAACommitmentOrder::CommitmentFirst
2133 _ => RAACommitmentOrder::CommitmentFirst,
2136 RAACommitmentOrder::CommitmentFirst
2139 if let Some(ev) = msg_events.get(idx) {
2141 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2142 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2143 assert!(revoke_and_ack.is_none());
2144 revoke_and_ack = Some(msg.clone());
2147 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2148 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2149 assert!(commitment_update.is_none());
2150 commitment_update = Some(updates.clone());
2157 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2158 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2160 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2163 assert_eq!(msg_events.len(), idx);
2165 (funding_locked, revoke_and_ack, commitment_update, order)
2170 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2171 /// for claims/fails they are separated out.
2172 pub fn reconnect_nodes<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, send_funding_locked: (bool, bool), pending_htlc_adds: (i64, i64), pending_htlc_claims: (usize, usize), pending_htlc_fails: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool)) {
2173 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2174 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2175 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2176 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2178 if send_funding_locked.0 {
2179 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
2181 for reestablish in reestablish_1.iter() {
2182 assert_eq!(reestablish.next_remote_commitment_number, 0);
2185 if send_funding_locked.1 {
2186 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
2188 for reestablish in reestablish_2.iter() {
2189 assert_eq!(reestablish.next_remote_commitment_number, 0);
2192 if send_funding_locked.0 || send_funding_locked.1 {
2193 // If we expect any funding_locked's, both sides better have set
2194 // next_holder_commitment_number to 1
2195 for reestablish in reestablish_1.iter() {
2196 assert_eq!(reestablish.next_local_commitment_number, 1);
2198 for reestablish in reestablish_2.iter() {
2199 assert_eq!(reestablish.next_local_commitment_number, 1);
2203 let mut resp_1 = Vec::new();
2204 for msg in reestablish_1 {
2205 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2206 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2208 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2209 check_added_monitors!(node_b, 1);
2211 check_added_monitors!(node_b, 0);
2214 let mut resp_2 = Vec::new();
2215 for msg in reestablish_2 {
2216 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2217 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2219 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2220 check_added_monitors!(node_a, 1);
2222 check_added_monitors!(node_a, 0);
2225 // We don't yet support both needing updates, as that would require a different commitment dance:
2226 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2227 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2228 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2229 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2231 for chan_msgs in resp_1.drain(..) {
2232 if send_funding_locked.0 {
2233 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2234 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2235 if !announcement_event.is_empty() {
2236 assert_eq!(announcement_event.len(), 1);
2237 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2238 //TODO: Test announcement_sigs re-sending
2239 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2242 assert!(chan_msgs.0.is_none());
2245 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2246 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2247 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2248 check_added_monitors!(node_a, 1);
2250 assert!(chan_msgs.1.is_none());
2252 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 {
2253 let commitment_update = chan_msgs.2.unwrap();
2254 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2255 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2257 assert!(commitment_update.update_add_htlcs.is_empty());
2259 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2260 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2261 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2262 for update_add in commitment_update.update_add_htlcs {
2263 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2265 for update_fulfill in commitment_update.update_fulfill_htlcs {
2266 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2268 for update_fail in commitment_update.update_fail_htlcs {
2269 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2272 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2273 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2275 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2276 check_added_monitors!(node_a, 1);
2277 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2278 // No commitment_signed so get_event_msg's assert(len == 1) passes
2279 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2280 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2281 check_added_monitors!(node_b, 1);
2284 assert!(chan_msgs.2.is_none());
2288 for chan_msgs in resp_2.drain(..) {
2289 if send_funding_locked.1 {
2290 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2291 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2292 if !announcement_event.is_empty() {
2293 assert_eq!(announcement_event.len(), 1);
2294 match announcement_event[0] {
2295 MessageSendEvent::SendChannelUpdate { .. } => {},
2296 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2297 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2301 assert!(chan_msgs.0.is_none());
2304 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2305 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2306 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2307 check_added_monitors!(node_b, 1);
2309 assert!(chan_msgs.1.is_none());
2311 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 {
2312 let commitment_update = chan_msgs.2.unwrap();
2313 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2314 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2316 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2317 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2318 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2319 for update_add in commitment_update.update_add_htlcs {
2320 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2322 for update_fulfill in commitment_update.update_fulfill_htlcs {
2323 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2325 for update_fail in commitment_update.update_fail_htlcs {
2326 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2329 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2330 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2332 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2333 check_added_monitors!(node_b, 1);
2334 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2335 // No commitment_signed so get_event_msg's assert(len == 1) passes
2336 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2337 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2338 check_added_monitors!(node_a, 1);
2341 assert!(chan_msgs.2.is_none());