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::key::PublicKey;
42 use core::cell::RefCell;
44 use sync::{Arc, Mutex};
47 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
49 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
50 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
51 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
52 confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
53 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
55 /// Mine a signle block containing the given transaction
56 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
57 let height = node.best_block_info().1 + 1;
58 confirm_transaction_at(node, tx, height);
60 /// Mine the given transaction at the given height, mining blocks as required to build to that
62 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
63 let first_connect_height = node.best_block_info().1 + 1;
64 assert!(first_connect_height <= conf_height);
65 if conf_height > first_connect_height {
66 connect_blocks(node, conf_height - first_connect_height);
68 let mut block = Block {
69 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: conf_height, bits: 42, nonce: 42 },
72 for _ in 0..*node.network_chan_count.borrow() { // Make sure we don't end up with channels at the same short id by offsetting by chan_count
73 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
75 block.txdata.push(tx.clone());
76 connect_block(node, &block);
79 /// The possible ways we may notify a ChannelManager of a new block
80 #[derive(Clone, Copy, PartialEq)]
81 pub enum ConnectStyle {
82 /// Calls best_block_updated first, detecting transactions in the block only after receiving the
83 /// header and height information.
85 /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
86 /// make a single best_block_updated call.
87 BestBlockFirstSkippingBlocks,
88 /// Calls transactions_confirmed first, detecting transactions in the block before updating the
89 /// header and height information.
91 /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
92 /// make a single best_block_updated call.
93 TransactionsFirstSkippingBlocks,
94 /// Provides the full block via the chain::Listen interface. In the current code this is
95 /// equivalent to TransactionsFirst with some additional assertions.
99 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
100 let skip_intermediaries = match *node.connect_style.borrow() {
101 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
105 let height = node.best_block_info().1 + 1;
106 let mut block = Block {
107 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: height, bits: 42, nonce: 42 },
112 do_connect_block(node, &block, skip_intermediaries);
114 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: height + i, bits: 42, nonce: 42 },
118 connect_block(node, &block);
119 block.header.block_hash()
122 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
123 do_connect_block(node, block, false);
126 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
127 // Ensure `get_claimable_balances`' self-tests never panic
128 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
129 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
133 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
134 call_claimable_balances(node);
135 let height = node.best_block_info().1 + 1;
136 if !skip_intermediaries {
137 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
138 match *node.connect_style.borrow() {
139 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
140 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
141 call_claimable_balances(node);
142 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
143 node.node.best_block_updated(&block.header, height);
144 node.node.transactions_confirmed(&block.header, &txdata, height);
146 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
147 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
148 call_claimable_balances(node);
149 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
150 node.node.transactions_confirmed(&block.header, &txdata, height);
151 node.node.best_block_updated(&block.header, height);
153 ConnectStyle::FullBlockViaListen => {
154 node.chain_monitor.chain_monitor.block_connected(&block, height);
155 node.node.block_connected(&block, height);
159 call_claimable_balances(node);
160 node.node.test_process_background_events();
161 node.blocks.lock().unwrap().push((block.header, height));
164 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
165 call_claimable_balances(node);
167 let orig_header = node.blocks.lock().unwrap().pop().unwrap();
168 assert!(orig_header.1 > 0); // Cannot disconnect genesis
169 let prev_header = node.blocks.lock().unwrap().last().unwrap().clone();
171 match *node.connect_style.borrow() {
172 ConnectStyle::FullBlockViaListen => {
173 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
174 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
176 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
178 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
179 node.node.best_block_updated(&prev_header.0, prev_header.1);
183 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
184 node.node.best_block_updated(&prev_header.0, prev_header.1);
187 call_claimable_balances(node);
191 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
192 let count = node.blocks.lock().unwrap().len() as u32 - 1;
193 disconnect_blocks(node, count);
196 pub struct TestChanMonCfg {
197 pub tx_broadcaster: test_utils::TestBroadcaster,
198 pub fee_estimator: test_utils::TestFeeEstimator,
199 pub chain_source: test_utils::TestChainSource,
200 pub persister: test_utils::TestPersister,
201 pub logger: test_utils::TestLogger,
202 pub keys_manager: test_utils::TestKeysInterface,
203 pub network_graph: NetworkGraph,
206 pub struct NodeCfg<'a> {
207 pub chain_source: &'a test_utils::TestChainSource,
208 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
209 pub fee_estimator: &'a test_utils::TestFeeEstimator,
210 pub chain_monitor: test_utils::TestChainMonitor<'a>,
211 pub keys_manager: &'a test_utils::TestKeysInterface,
212 pub logger: &'a test_utils::TestLogger,
213 pub network_graph: &'a NetworkGraph,
214 pub node_seed: [u8; 32],
215 pub features: InitFeatures,
218 pub struct Node<'a, 'b: 'a, 'c: 'b> {
219 pub chain_source: &'c test_utils::TestChainSource,
220 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
221 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
222 pub keys_manager: &'b test_utils::TestKeysInterface,
223 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
224 pub network_graph: &'c NetworkGraph,
225 pub net_graph_msg_handler: NetGraphMsgHandler<&'c NetworkGraph, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
226 pub node_seed: [u8; 32],
227 pub network_payment_count: Rc<RefCell<u8>>,
228 pub network_chan_count: Rc<RefCell<u32>>,
229 pub logger: &'c test_utils::TestLogger,
230 pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
231 pub connect_style: Rc<RefCell<ConnectStyle>>,
233 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
234 pub fn best_block_hash(&self) -> BlockHash {
235 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
237 pub fn best_block_info(&self) -> (BlockHash, u32) {
238 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
240 pub fn get_block_header(&self, height: u32) -> BlockHeader {
241 self.blocks.lock().unwrap()[height as usize].0
245 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
248 // Check that we processed all pending events
249 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
250 assert!(self.node.get_and_clear_pending_events().is_empty());
251 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
253 // Check that if we serialize the Router, we can deserialize it again.
255 let mut w = test_utils::TestVecWriter(Vec::new());
256 self.network_graph.write(&mut w).unwrap();
257 let network_graph_deser = <NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap();
258 assert!(network_graph_deser == *self.network_graph);
259 let net_graph_msg_handler = NetGraphMsgHandler::new(
260 &network_graph_deser, Some(self.chain_source), self.logger
262 let mut chan_progress = 0;
264 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
265 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
266 assert!(orig_announcements == deserialized_announcements);
267 chan_progress = match orig_announcements.last() {
268 Some(announcement) => announcement.0.contents.short_channel_id + 1,
272 let mut node_progress = None;
274 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
275 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
276 assert!(orig_announcements == deserialized_announcements);
277 node_progress = match orig_announcements.last() {
278 Some(announcement) => Some(announcement.contents.node_id),
284 // Check that if we serialize and then deserialize all our channel monitors we get the
285 // same set of outputs to watch for on chain as we have now. Note that if we write
286 // tests that fully close channels and remove the monitors at some point this may break.
287 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
288 let mut deserialized_monitors = Vec::new();
290 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
291 let mut w = test_utils::TestVecWriter(Vec::new());
292 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
293 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
294 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
295 deserialized_monitors.push(deserialized_monitor);
299 // Before using all the new monitors to check the watch outpoints, use the full set of
300 // them to ensure we can write and reload our ChannelManager.
302 let mut channel_monitors = HashMap::new();
303 for monitor in deserialized_monitors.iter_mut() {
304 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
307 let mut w = test_utils::TestVecWriter(Vec::new());
308 self.node.write(&mut w).unwrap();
309 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(w.0), ChannelManagerReadArgs {
310 default_config: *self.node.get_current_default_configuration(),
311 keys_manager: self.keys_manager,
312 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
313 chain_monitor: self.chain_monitor,
314 tx_broadcaster: &test_utils::TestBroadcaster {
315 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
316 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
318 logger: &self.logger,
323 let persister = test_utils::TestPersister::new();
324 let broadcaster = test_utils::TestBroadcaster {
325 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
326 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
328 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
329 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
330 for deserialized_monitor in deserialized_monitors.drain(..) {
331 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
335 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
336 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
341 pub fn create_chan_between_nodes<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
342 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
345 pub fn create_chan_between_nodes_with_value<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
346 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
347 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
348 (announcement, as_update, bs_update, channel_id, tx)
352 /// Gets an RAA and CS which were sent in response to a commitment update
353 macro_rules! get_revoke_commit_msgs {
354 ($node: expr, $node_id: expr) => {
356 use $crate::util::events::MessageSendEvent;
357 let events = $node.node.get_and_clear_pending_msg_events();
358 assert_eq!(events.len(), 2);
360 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
361 assert_eq!(*node_id, $node_id);
364 _ => panic!("Unexpected event"),
366 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
367 assert_eq!(*node_id, $node_id);
368 assert!(updates.update_add_htlcs.is_empty());
369 assert!(updates.update_fulfill_htlcs.is_empty());
370 assert!(updates.update_fail_htlcs.is_empty());
371 assert!(updates.update_fail_malformed_htlcs.is_empty());
372 assert!(updates.update_fee.is_none());
373 updates.commitment_signed.clone()
375 _ => panic!("Unexpected event"),
381 /// Get an specific event message from the pending events queue.
383 macro_rules! get_event_msg {
384 ($node: expr, $event_type: path, $node_id: expr) => {
386 let events = $node.node.get_and_clear_pending_msg_events();
387 assert_eq!(events.len(), 1);
389 $event_type { ref node_id, ref msg } => {
390 assert_eq!(*node_id, $node_id);
393 _ => panic!("Unexpected event"),
399 /// Get 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_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 channel_value_satoshis, ref output_script, user_channel_id } => {
563 assert_eq!(*channel_value_satoshis, expected_chan_value);
564 assert_eq!(user_channel_id, expected_user_chan_id);
566 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
567 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
569 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
570 (*temporary_channel_id, tx, funding_outpoint)
572 _ => panic!("Unexpected event"),
575 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 {
576 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
577 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
579 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_ok());
580 check_added_monitors!(node_a, 0);
582 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
583 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
584 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
586 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
587 assert_eq!(added_monitors.len(), 1);
588 assert_eq!(added_monitors[0].0, funding_output);
589 added_monitors.clear();
592 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()));
594 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
595 assert_eq!(added_monitors.len(), 1);
596 assert_eq!(added_monitors[0].0, funding_output);
597 added_monitors.clear();
600 let events_4 = node_a.node.get_and_clear_pending_events();
601 assert_eq!(events_4.len(), 0);
603 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
604 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
605 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
607 // Ensure that funding_transaction_generated is idempotent.
608 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_err());
609 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
610 check_added_monitors!(node_a, 0);
615 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 {
616 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
617 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
618 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
619 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
620 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
621 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
622 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
624 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
627 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) {
628 confirm_transaction_at(node_conf, tx, conf_height);
629 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
630 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()));
633 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]) {
635 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
636 assert_eq!(events_6.len(), 3);
637 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
638 assert_eq!(*node_id, node_recv.node.get_our_node_id());
640 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
641 assert_eq!(*node_id, node_recv.node.get_our_node_id());
643 } else { panic!("Unexpected event: {:?}", events_6[1]); };
644 ((match events_6[0] {
645 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
646 channel_id = msg.channel_id.clone();
647 assert_eq!(*node_id, node_recv.node.get_our_node_id());
650 _ => panic!("Unexpected event"),
651 }, match events_6[announcement_sigs_idx] {
652 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
653 assert_eq!(*node_id, node_recv.node.get_our_node_id());
656 _ => panic!("Unexpected event"),
660 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]) {
661 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
662 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
663 confirm_transaction_at(node_a, tx, conf_height);
664 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
665 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
668 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) {
669 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
670 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
674 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) {
675 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
676 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
677 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
679 let events_7 = node_b.node.get_and_clear_pending_msg_events();
680 assert_eq!(events_7.len(), 1);
681 let (announcement, bs_update) = match events_7[0] {
682 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
685 _ => panic!("Unexpected event"),
688 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
689 let events_8 = node_a.node.get_and_clear_pending_msg_events();
690 assert_eq!(events_8.len(), 1);
691 let as_update = match events_8[0] {
692 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
693 assert!(*announcement == *msg);
694 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
695 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
698 _ => panic!("Unexpected event"),
701 *node_a.network_chan_count.borrow_mut() += 1;
703 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
706 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) {
707 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
710 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) {
711 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
712 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
713 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
716 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) {
717 let mut no_announce_cfg = test_default_channel_config();
718 no_announce_cfg.channel_options.announced_channel = false;
719 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
720 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
721 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), a_flags, &open_channel);
722 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
723 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), b_flags, &accept_channel);
725 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], channel_value, 42);
726 nodes[a].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
727 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()));
728 check_added_monitors!(nodes[b], 1);
730 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
731 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
732 check_added_monitors!(nodes[a], 1);
734 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
735 confirm_transaction_at(&nodes[a], &tx, conf_height);
736 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
737 confirm_transaction_at(&nodes[b], &tx, conf_height);
738 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
739 let as_funding_locked = get_event_msg!(nodes[a], MessageSendEvent::SendFundingLocked, nodes[b].node.get_our_node_id());
740 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()));
741 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
742 nodes[b].node.handle_funding_locked(&nodes[a].node.get_our_node_id(), &as_funding_locked);
743 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
745 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
746 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
748 let mut found_a = false;
749 for chan in nodes[a].node.list_usable_channels() {
750 if chan.channel_id == as_funding_locked.channel_id {
753 assert!(!chan.is_public);
758 let mut found_b = false;
759 for chan in nodes[b].node.list_usable_channels() {
760 if chan.channel_id == as_funding_locked.channel_id {
763 assert!(!chan.is_public);
768 (as_funding_locked, tx)
771 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) {
772 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
773 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
774 assert!(a_events.len() >= 2);
776 // ann should be re-generated by broadcast_node_announcement - check that we have it.
777 let mut found_ann_1 = false;
778 for event in a_events.iter() {
780 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
781 if msg == ann { found_ann_1 = true; }
783 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
784 _ => panic!("Unexpected event {:?}", event),
787 assert!(found_ann_1);
789 let a_node_announcement = match a_events.last().unwrap() {
790 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
793 _ => panic!("Unexpected event"),
796 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
797 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
798 assert!(b_events.len() >= 2);
800 // ann should be re-generated by broadcast_node_announcement - check that we have it.
801 let mut found_ann_2 = false;
802 for event in b_events.iter() {
804 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
805 if msg == ann { found_ann_2 = true; }
807 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
808 _ => panic!("Unexpected event"),
811 assert!(found_ann_2);
813 let b_node_announcement = match b_events.last().unwrap() {
814 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
817 _ => panic!("Unexpected event"),
821 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
822 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
823 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
824 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
825 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
827 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
828 // forwarding info for local channels even if its not accepted in the network graph.
829 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
830 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
835 macro_rules! check_spends {
836 ($tx: expr, $($spends_txn: expr),*) => {
839 for outp in $spends_txn.output.iter() {
840 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Input tx output didn't meet dust limit");
843 for outp in $tx.output.iter() {
844 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Spending tx output didn't meet dust limit");
846 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
848 if out_point.txid == $spends_txn.txid() {
849 return $spends_txn.output.get(out_point.vout as usize).cloned()
854 let mut total_value_in = 0;
855 for input in $tx.input.iter() {
856 total_value_in += get_output(&input.previous_output).unwrap().value;
858 let mut total_value_out = 0;
859 for output in $tx.output.iter() {
860 total_value_out += output.value;
862 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
863 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
864 assert!(total_value_out + min_fee <= total_value_in);
865 $tx.verify(get_output).unwrap();
870 macro_rules! get_closing_signed_broadcast {
871 ($node: expr, $dest_pubkey: expr) => {
873 let events = $node.get_and_clear_pending_msg_events();
874 assert!(events.len() == 1 || events.len() == 2);
875 (match events[events.len() - 1] {
876 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
877 assert_eq!(msg.contents.flags & 2, 2);
880 _ => panic!("Unexpected event"),
881 }, if events.len() == 2 {
883 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
884 assert_eq!(*node_id, $dest_pubkey);
887 _ => panic!("Unexpected event"),
895 macro_rules! check_warn_msg {
896 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
897 let msg_events = $node.node.get_and_clear_pending_msg_events();
898 assert_eq!(msg_events.len(), 1);
899 match msg_events[0] {
900 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
901 assert_eq!(node_id, $recipient_node_id);
902 assert_eq!(msg.channel_id, $chan_id);
905 _ => panic!("Unexpected event"),
910 /// Check that a channel's closing channel update has been broadcasted, and optionally
911 /// check whether an error message event has occurred.
913 macro_rules! check_closed_broadcast {
914 ($node: expr, $with_error_msg: expr) => {{
915 use $crate::util::events::MessageSendEvent;
916 use $crate::ln::msgs::ErrorAction;
918 let msg_events = $node.node.get_and_clear_pending_msg_events();
919 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
920 match msg_events[0] {
921 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
922 assert_eq!(msg.contents.flags & 2, 2);
924 _ => panic!("Unexpected event"),
927 match msg_events[1] {
928 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
929 // TODO: Check node_id
932 _ => panic!("Unexpected event"),
938 /// Check that a channel's closing channel events has been issued
940 macro_rules! check_closed_event {
941 ($node: expr, $events: expr, $reason: expr) => {
942 check_closed_event!($node, $events, $reason, false);
944 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
945 use $crate::util::events::Event;
947 let events = $node.node.get_and_clear_pending_events();
948 assert_eq!(events.len(), $events);
949 let expected_reason = $reason;
950 let mut issues_discard_funding = false;
951 for event in events {
953 Event::ChannelClosed { ref reason, .. } => {
954 assert_eq!(*reason, expected_reason);
956 Event::DiscardFunding { .. } => {
957 issues_discard_funding = true;
959 _ => panic!("Unexpected event"),
962 assert_eq!($is_check_discard_funding, issues_discard_funding);
966 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) {
967 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) };
968 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) };
971 node_a.close_channel(channel_id).unwrap();
972 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()));
974 let events_1 = node_b.get_and_clear_pending_msg_events();
975 assert!(events_1.len() >= 1);
976 let shutdown_b = match events_1[0] {
977 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
978 assert_eq!(node_id, &node_a.get_our_node_id());
981 _ => panic!("Unexpected event"),
984 let closing_signed_b = if !close_inbound_first {
985 assert_eq!(events_1.len(), 1);
988 Some(match events_1[1] {
989 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
990 assert_eq!(node_id, &node_a.get_our_node_id());
993 _ => panic!("Unexpected event"),
997 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
998 let (as_update, bs_update) = if close_inbound_first {
999 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1000 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1002 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1003 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1004 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1005 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1007 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1008 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1009 assert!(none_a.is_none());
1010 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1011 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1012 (as_update, bs_update)
1014 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1016 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1017 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1019 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1020 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1021 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1023 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1024 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1025 assert!(none_b.is_none());
1026 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1027 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1028 (as_update, bs_update)
1030 assert_eq!(tx_a, tx_b);
1031 check_spends!(tx_a, funding_tx);
1033 (as_update, bs_update, tx_a)
1036 pub struct SendEvent {
1037 pub node_id: PublicKey,
1038 pub msgs: Vec<msgs::UpdateAddHTLC>,
1039 pub commitment_msg: msgs::CommitmentSigned,
1042 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1043 assert!(updates.update_fulfill_htlcs.is_empty());
1044 assert!(updates.update_fail_htlcs.is_empty());
1045 assert!(updates.update_fail_malformed_htlcs.is_empty());
1046 assert!(updates.update_fee.is_none());
1047 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1050 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1052 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1053 _ => panic!("Unexpected event type!"),
1057 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1058 let mut events = node.node.get_and_clear_pending_msg_events();
1059 assert_eq!(events.len(), 1);
1060 SendEvent::from_event(events.pop().unwrap())
1065 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1066 /// commitment update.
1067 macro_rules! commitment_signed_dance {
1068 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1070 check_added_monitors!($node_a, 0);
1071 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1072 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1073 check_added_monitors!($node_a, 1);
1074 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1077 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1079 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1080 check_added_monitors!($node_b, 0);
1081 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1082 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1083 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1084 check_added_monitors!($node_b, 1);
1085 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1086 let (bs_revoke_and_ack, extra_msg_option) = {
1087 let events = $node_b.node.get_and_clear_pending_msg_events();
1088 assert!(events.len() <= 2);
1090 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1091 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1094 _ => panic!("Unexpected event"),
1095 }, events.get(1).map(|e| e.clone()))
1097 check_added_monitors!($node_b, 1);
1098 if $fail_backwards {
1099 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1100 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1102 (extra_msg_option, bs_revoke_and_ack)
1105 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1107 check_added_monitors!($node_a, 0);
1108 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1109 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1110 check_added_monitors!($node_a, 1);
1111 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1112 assert!(extra_msg_option.is_none());
1116 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1118 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1119 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1120 check_added_monitors!($node_a, 1);
1124 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1126 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1129 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1131 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1132 if $fail_backwards {
1133 $crate::expect_pending_htlcs_forwardable!($node_a);
1134 check_added_monitors!($node_a, 1);
1136 let channel_state = $node_a.node.channel_state.lock().unwrap();
1137 assert_eq!(channel_state.pending_msg_events.len(), 1);
1138 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1139 assert_ne!(*node_id, $node_b.node.get_our_node_id());
1140 } else { panic!("Unexpected event"); }
1142 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1148 /// Get a payment preimage and hash.
1150 macro_rules! get_payment_preimage_hash {
1151 ($dest_node: expr) => {
1153 get_payment_preimage_hash!($dest_node, None)
1156 ($dest_node: expr, $min_value_msat: expr) => {
1158 use bitcoin::hashes::Hash as _;
1159 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1160 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1161 *payment_count += 1;
1162 let payment_hash = $crate::ln::PaymentHash(
1163 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1164 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1165 (payment_preimage, payment_hash, payment_secret)
1172 macro_rules! get_route_and_payment_hash {
1173 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1174 $crate::get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
1176 ($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
1177 use $crate::chain::keysinterface::KeysInterface;
1178 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1179 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1180 .with_features($crate::ln::features::InvoiceFeatures::known())
1181 .with_route_hints($last_hops);
1182 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1183 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1184 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1185 let route = $crate::routing::router::get_route(
1186 &$send_node.node.get_our_node_id(), &payment_params, &$send_node.network_graph.read_only(),
1187 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1188 $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1190 (route, payment_hash, payment_preimage, payment_secret)
1195 /// Clears (and ignores) a PendingHTLCsForwardable event
1196 macro_rules! expect_pending_htlcs_forwardable_ignore {
1198 let events = $node.node.get_and_clear_pending_events();
1199 assert_eq!(events.len(), 1);
1201 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1202 _ => panic!("Unexpected event"),
1208 /// Handles a PendingHTLCsForwardable event
1209 macro_rules! expect_pending_htlcs_forwardable {
1211 $crate::expect_pending_htlcs_forwardable_ignore!($node);
1212 $node.node.process_pending_htlc_forwards();
1214 // Ensure process_pending_htlc_forwards is idempotent.
1215 $node.node.process_pending_htlc_forwards();
1220 macro_rules! expect_pending_htlcs_forwardable_from_events {
1221 ($node: expr, $events: expr, $ignore: expr) => {{
1222 assert_eq!($events.len(), 1);
1224 Event::PendingHTLCsForwardable { .. } => { },
1225 _ => panic!("Unexpected event"),
1228 $node.node.process_pending_htlc_forwards();
1230 // Ensure process_pending_htlc_forwards is idempotent.
1231 $node.node.process_pending_htlc_forwards();
1237 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1238 macro_rules! expect_payment_received {
1239 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1240 expect_payment_received!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None)
1242 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr) => {
1243 let events = $node.node.get_and_clear_pending_events();
1244 assert_eq!(events.len(), 1);
1246 $crate::util::events::Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1247 assert_eq!($expected_payment_hash, *payment_hash);
1248 assert_eq!($expected_recv_value, amt);
1250 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1251 assert_eq!(&$expected_payment_preimage, payment_preimage);
1252 assert_eq!($expected_payment_secret, *payment_secret);
1257 _ => panic!("Unexpected event"),
1264 macro_rules! expect_payment_sent_without_paths {
1265 ($node: expr, $expected_payment_preimage: expr) => {
1266 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1268 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1269 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1274 macro_rules! expect_payment_sent {
1275 ($node: expr, $expected_payment_preimage: expr) => {
1276 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1278 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1279 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1281 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1282 use bitcoin::hashes::Hash as _;
1283 let events = $node.node.get_and_clear_pending_events();
1284 let expected_payment_hash = $crate::ln::PaymentHash(
1285 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1287 assert!(events.len() > 1);
1289 assert_eq!(events.len(), 1);
1291 let expected_payment_id = match events[0] {
1292 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1293 assert_eq!($expected_payment_preimage, *payment_preimage);
1294 assert_eq!(expected_payment_hash, *payment_hash);
1295 assert!(fee_paid_msat.is_some());
1296 if $expected_fee_msat_opt.is_some() {
1297 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1301 _ => panic!("Unexpected event"),
1304 for i in 1..events.len() {
1306 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1307 assert_eq!(payment_id, expected_payment_id);
1308 assert_eq!(payment_hash, Some(expected_payment_hash));
1310 _ => panic!("Unexpected event"),
1319 macro_rules! expect_payment_path_successful {
1321 let events = $node.node.get_and_clear_pending_events();
1322 assert_eq!(events.len(), 1);
1324 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1325 _ => panic!("Unexpected event"),
1330 macro_rules! expect_payment_forwarded {
1331 ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1332 let events = $node.node.get_and_clear_pending_events();
1333 assert_eq!(events.len(), 1);
1335 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1336 assert_eq!(fee_earned_msat, $expected_fee);
1337 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1339 _ => panic!("Unexpected event"),
1344 pub struct PaymentFailedConditions<'a> {
1345 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1346 pub(crate) expected_blamed_scid: Option<u64>,
1347 pub(crate) expected_blamed_chan_closed: Option<bool>,
1348 pub(crate) expected_mpp_parts_remain: bool,
1351 impl<'a> PaymentFailedConditions<'a> {
1352 pub fn new() -> Self {
1354 expected_htlc_error_data: None,
1355 expected_blamed_scid: None,
1356 expected_blamed_chan_closed: None,
1357 expected_mpp_parts_remain: false,
1360 pub fn mpp_parts_remain(mut self) -> Self {
1361 self.expected_mpp_parts_remain = true;
1364 pub fn blamed_scid(mut self, scid: u64) -> Self {
1365 self.expected_blamed_scid = Some(scid);
1368 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1369 self.expected_blamed_chan_closed = Some(closed);
1372 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1373 self.expected_htlc_error_data = Some((code, data));
1379 macro_rules! expect_payment_failed_with_update {
1380 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1381 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest,
1382 $crate::ln::functional_test_utils::PaymentFailedConditions::new().blamed_scid($scid).blamed_chan_closed($chan_closed));
1387 macro_rules! expect_payment_failed {
1388 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1389 #[allow(unused_mut)]
1390 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1392 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1394 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest, conditions);
1399 macro_rules! expect_payment_failed_conditions {
1400 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $conditions: expr) => {
1401 let events = $node.node.get_and_clear_pending_events();
1402 assert_eq!(events.len(), 1);
1403 let expected_payment_id = match events[0] {
1404 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data, ref path, ref retry, ref payment_id, ref network_update, .. } => {
1405 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1406 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1407 assert!(retry.is_some(), "expected retry.is_some()");
1408 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1409 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1411 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1412 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1413 if let Some((code, data)) = $conditions.expected_htlc_error_data {
1414 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1415 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1418 if let Some(chan_closed) = $conditions.expected_blamed_chan_closed {
1419 match network_update {
1420 &Some($crate::routing::network_graph::NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1421 if let Some(scid) = $conditions.expected_blamed_scid {
1422 assert_eq!(msg.contents.short_channel_id, scid);
1424 assert_eq!(msg.contents.flags & 2, 0);
1426 &Some($crate::routing::network_graph::NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if chan_closed => {
1427 if let Some(scid) = $conditions.expected_blamed_scid {
1428 assert_eq!(short_channel_id, scid);
1430 assert!(is_permanent);
1432 Some(_) => panic!("Unexpected update type"),
1433 None => panic!("Expected update"),
1439 _ => panic!("Unexpected event"),
1441 if !$conditions.expected_mpp_parts_remain {
1442 $node.node.abandon_payment(expected_payment_id);
1443 let events = $node.node.get_and_clear_pending_events();
1444 assert_eq!(events.len(), 1);
1446 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1447 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected second payment_hash");
1448 assert_eq!(*payment_id, expected_payment_id);
1450 _ => panic!("Unexpected second event"),
1456 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 {
1457 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1458 check_added_monitors!(origin_node, expected_paths.len());
1459 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1463 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>) {
1464 let mut payment_event = SendEvent::from_event(ev);
1465 let mut prev_node = origin_node;
1467 for (idx, &node) in expected_path.iter().enumerate() {
1468 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1470 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1471 check_added_monitors!(node, 0);
1472 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1474 expect_pending_htlcs_forwardable!(node);
1476 if idx == expected_path.len() - 1 {
1477 let events_2 = node.node.get_and_clear_pending_events();
1478 if payment_received_expected {
1479 assert_eq!(events_2.len(), 1);
1481 Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1482 assert_eq!(our_payment_hash, *payment_hash);
1484 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1485 assert_eq!(expected_preimage, *payment_preimage);
1486 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1488 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1489 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1490 assert!(our_payment_secret.is_none());
1493 assert_eq!(amt, recv_value);
1495 _ => panic!("Unexpected event"),
1498 assert!(events_2.is_empty());
1501 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1502 assert_eq!(events_2.len(), 1);
1503 check_added_monitors!(node, 1);
1504 payment_event = SendEvent::from_event(events_2.remove(0));
1505 assert_eq!(payment_event.msgs.len(), 1);
1512 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) {
1513 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1514 assert_eq!(events.len(), expected_route.len());
1515 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1516 // Once we've gotten through all the HTLCs, the last one should result in a
1517 // PaymentReceived (but each previous one should not!), .
1518 let expect_payment = path_idx == expected_route.len() - 1;
1519 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1523 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) {
1524 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1525 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1526 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1529 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 {
1530 for path in expected_paths.iter() {
1531 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1533 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1534 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1536 let mut expected_total_fee_msat = 0;
1538 macro_rules! msgs_from_ev {
1541 &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 } } => {
1542 assert!(update_add_htlcs.is_empty());
1543 assert_eq!(update_fulfill_htlcs.len(), 1);
1544 assert!(update_fail_htlcs.is_empty());
1545 assert!(update_fail_malformed_htlcs.is_empty());
1546 assert!(update_fee.is_none());
1547 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1549 _ => panic!("Unexpected event"),
1553 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1554 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1555 assert_eq!(events.len(), expected_paths.len());
1556 for ev in events.iter() {
1557 per_path_msgs.push(msgs_from_ev!(ev));
1560 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1561 let mut next_msgs = Some(path_msgs);
1562 let mut expected_next_node = next_hop;
1564 macro_rules! last_update_fulfill_dance {
1565 ($node: expr, $prev_node: expr) => {
1567 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1568 check_added_monitors!($node, 0);
1569 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1570 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1574 macro_rules! mid_update_fulfill_dance {
1575 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1577 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1578 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;
1579 expect_payment_forwarded!($node, Some(fee as u64), false);
1580 expected_total_fee_msat += fee as u64;
1581 check_added_monitors!($node, 1);
1582 let new_next_msgs = if $new_msgs {
1583 let events = $node.node.get_and_clear_pending_msg_events();
1584 assert_eq!(events.len(), 1);
1585 let (res, nexthop) = msgs_from_ev!(&events[0]);
1586 expected_next_node = nexthop;
1589 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1592 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1593 next_msgs = new_next_msgs;
1598 let mut prev_node = expected_route.last().unwrap();
1599 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1600 assert_eq!(expected_next_node, node.node.get_our_node_id());
1601 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1602 if next_msgs.is_some() {
1603 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1605 assert!(!update_next_msgs);
1606 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1608 if !skip_last && idx == expected_route.len() - 1 {
1609 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1616 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1620 // Ensure that claim_funds is idempotent.
1621 assert!(!expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1622 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1623 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1625 expected_total_fee_msat
1627 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) {
1628 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1630 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1634 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1635 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1638 pub const TEST_FINAL_CLTV: u32 = 70;
1640 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) {
1641 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1642 .with_features(InvoiceFeatures::known());
1643 let network_graph = origin_node.network_graph.read_only();
1644 let scorer = test_utils::TestScorer::with_penalty(0);
1645 let seed = [0u8; 32];
1646 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1647 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1648 let route = get_route(
1649 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
1650 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1651 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
1652 assert_eq!(route.paths.len(), 1);
1653 assert_eq!(route.paths[0].len(), expected_route.len());
1654 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1655 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1658 let res = send_along_route(origin_node, route, expected_route, recv_value);
1659 (res.0, res.1, res.2)
1662 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1663 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1664 .with_features(InvoiceFeatures::known());
1665 let network_graph = origin_node.network_graph.read_only();
1666 let scorer = test_utils::TestScorer::with_penalty(0);
1667 let seed = [0u8; 32];
1668 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1669 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1670 let route = get_route(
1671 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
1672 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
1673 assert_eq!(route.paths.len(), 1);
1674 assert_eq!(route.paths[0].len(), expected_route.len());
1675 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1676 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1679 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1680 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1681 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1684 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1685 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1686 claim_payment(&origin, expected_route, our_payment_preimage);
1689 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) {
1690 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1691 for path in expected_paths.iter() {
1692 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1694 assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1695 expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1696 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1698 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1699 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1700 assert_eq!(events.len(), expected_paths.len());
1701 for ev in events.iter() {
1702 let (update_fail, commitment_signed, node_id) = match ev {
1703 &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 } } => {
1704 assert!(update_add_htlcs.is_empty());
1705 assert!(update_fulfill_htlcs.is_empty());
1706 assert_eq!(update_fail_htlcs.len(), 1);
1707 assert!(update_fail_malformed_htlcs.is_empty());
1708 assert!(update_fee.is_none());
1709 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1711 _ => panic!("Unexpected event"),
1713 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1715 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1716 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()));
1718 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1719 let mut next_msgs = Some(path_msgs);
1720 let mut expected_next_node = next_hop;
1721 let mut prev_node = expected_route.last().unwrap();
1723 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1724 assert_eq!(expected_next_node, node.node.get_our_node_id());
1725 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1726 if next_msgs.is_some() {
1727 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1728 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1729 if !update_next_node {
1730 expect_pending_htlcs_forwardable!(node);
1733 let events = node.node.get_and_clear_pending_msg_events();
1734 if update_next_node {
1735 assert_eq!(events.len(), 1);
1737 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 } } => {
1738 assert!(update_add_htlcs.is_empty());
1739 assert!(update_fulfill_htlcs.is_empty());
1740 assert_eq!(update_fail_htlcs.len(), 1);
1741 assert!(update_fail_malformed_htlcs.is_empty());
1742 assert!(update_fee.is_none());
1743 expected_next_node = node_id.clone();
1744 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1746 _ => panic!("Unexpected event"),
1749 assert!(events.is_empty());
1751 if !skip_last && idx == expected_route.len() - 1 {
1752 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1759 let prev_node = expected_route.first().unwrap();
1760 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1761 check_added_monitors!(origin_node, 0);
1762 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1763 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1764 let events = origin_node.node.get_and_clear_pending_events();
1765 assert_eq!(events.len(), 1);
1766 let expected_payment_id = match events[0] {
1767 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, ref payment_id, .. } => {
1768 assert_eq!(payment_hash, our_payment_hash);
1769 assert!(rejected_by_dest);
1770 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1771 for (idx, hop) in expected_route.iter().enumerate() {
1772 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1776 _ => panic!("Unexpected event"),
1778 if i == expected_paths.len() - 1 {
1779 origin_node.node.abandon_payment(expected_payment_id);
1780 let events = origin_node.node.get_and_clear_pending_events();
1781 assert_eq!(events.len(), 1);
1783 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1784 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
1785 assert_eq!(*payment_id, expected_payment_id);
1787 _ => panic!("Unexpected second event"),
1793 // Ensure that fail_htlc_backwards is idempotent.
1794 assert!(!expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1795 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
1796 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1797 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1800 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1801 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1804 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1805 let mut chan_mon_cfgs = Vec::new();
1806 for i in 0..node_count {
1807 let tx_broadcaster = test_utils::TestBroadcaster {
1808 txn_broadcasted: Mutex::new(Vec::new()),
1809 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1811 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1812 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1813 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1814 let persister = test_utils::TestPersister::new();
1815 let seed = [i as u8; 32];
1816 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1817 let network_graph = NetworkGraph::new(chain_source.genesis_hash);
1819 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, network_graph });
1825 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1826 let mut nodes = Vec::new();
1828 for i in 0..node_count {
1829 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);
1830 let seed = [i as u8; 32];
1831 nodes.push(NodeCfg {
1832 chain_source: &chanmon_cfgs[i].chain_source,
1833 logger: &chanmon_cfgs[i].logger,
1834 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1835 fee_estimator: &chanmon_cfgs[i].fee_estimator,
1837 keys_manager: &chanmon_cfgs[i].keys_manager,
1839 features: InitFeatures::known(),
1840 network_graph: &chanmon_cfgs[i].network_graph,
1847 pub fn test_default_channel_config() -> UserConfig {
1848 let mut default_config = UserConfig::default();
1849 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1850 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1851 default_config.channel_options.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
1852 default_config.channel_options.announced_channel = true;
1853 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1854 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1855 // It now defaults to 1, so we simply set it to the expected value here.
1856 default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1857 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1858 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1859 default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1863 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>> {
1864 let mut chanmgrs = Vec::new();
1865 for i in 0..node_count {
1866 let network = Network::Testnet;
1867 let params = ChainParameters {
1869 best_block: BestBlock::from_genesis(network),
1871 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1872 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1873 chanmgrs.push(node);
1879 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>> {
1880 let mut nodes = Vec::new();
1881 let chan_count = Rc::new(RefCell::new(0));
1882 let payment_count = Rc::new(RefCell::new(0));
1883 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1885 for i in 0..node_count {
1886 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].network_graph, None, cfgs[i].logger);
1888 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
1889 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
1890 node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, net_graph_msg_handler,
1891 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1892 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1893 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1894 connect_style: Rc::clone(&connect_style),
1898 for i in 0..node_count {
1899 for j in (i+1)..node_count {
1900 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone(), remote_network_address: None });
1901 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone(), remote_network_address: None });
1908 // Note that the following only works for CLTV values up to 128
1909 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1910 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1912 #[derive(PartialEq)]
1913 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1914 /// Tests that the given node has broadcast transactions for the given Channel
1916 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1917 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1918 /// broadcast and the revoked outputs were claimed.
1920 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1921 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1923 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1925 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> {
1926 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1927 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1929 let mut res = Vec::with_capacity(2);
1930 node_txn.retain(|tx| {
1931 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1932 check_spends!(tx, chan.3);
1933 if commitment_tx.is_none() {
1934 res.push(tx.clone());
1939 if let Some(explicit_tx) = commitment_tx {
1940 res.push(explicit_tx.clone());
1943 assert_eq!(res.len(), 1);
1945 if has_htlc_tx != HTLCType::NONE {
1946 node_txn.retain(|tx| {
1947 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1948 check_spends!(tx, res[0]);
1949 if has_htlc_tx == HTLCType::TIMEOUT {
1950 assert!(tx.lock_time != 0);
1952 assert!(tx.lock_time == 0);
1954 res.push(tx.clone());
1958 assert!(res.len() == 2 || res.len() == 3);
1960 assert_eq!(res[1], res[2]);
1964 assert!(node_txn.is_empty());
1968 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1969 /// HTLC transaction.
1970 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1971 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1972 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1973 // for revoked htlc outputs
1974 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1975 node_txn.retain(|tx| {
1976 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1977 check_spends!(tx, revoked_tx);
1981 node_txn.retain(|tx| {
1982 check_spends!(tx, commitment_revoked_tx);
1985 assert!(node_txn.is_empty());
1988 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1989 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1991 assert!(node_txn.len() >= 1);
1992 assert_eq!(node_txn[0].input.len(), 1);
1993 let mut found_prev = false;
1995 for tx in prev_txn {
1996 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1997 check_spends!(node_txn[0], tx);
1998 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1999 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2005 assert!(found_prev);
2007 let mut res = Vec::new();
2008 mem::swap(&mut *node_txn, &mut res);
2012 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) {
2013 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2014 assert_eq!(events_1.len(), 2);
2015 let as_update = match events_1[0] {
2016 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2019 _ => panic!("Unexpected event"),
2022 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2023 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2024 assert_eq!(msg.data, expected_error);
2025 if needs_err_handle {
2026 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2029 _ => panic!("Unexpected event"),
2032 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2033 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2034 let bs_update = match events_2[0] {
2035 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2038 _ => panic!("Unexpected event"),
2040 if !needs_err_handle {
2042 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2043 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2044 assert_eq!(msg.data, expected_error);
2046 _ => panic!("Unexpected event"),
2051 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
2052 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
2056 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2057 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2061 macro_rules! get_channel_value_stat {
2062 ($node: expr, $channel_id: expr) => {{
2063 let chan_lock = $node.node.channel_state.lock().unwrap();
2064 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
2065 chan.get_value_stat()
2069 macro_rules! get_chan_reestablish_msgs {
2070 ($src_node: expr, $dst_node: expr) => {
2072 let mut res = Vec::with_capacity(1);
2073 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2074 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2075 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2076 res.push(msg.clone());
2078 panic!("Unexpected event")
2086 macro_rules! handle_chan_reestablish_msgs {
2087 ($src_node: expr, $dst_node: expr) => {
2089 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2091 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
2093 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2099 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2101 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2104 let mut revoke_and_ack = None;
2105 let mut commitment_update = None;
2106 let order = if let Some(ev) = msg_events.get(idx) {
2108 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2109 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2110 revoke_and_ack = Some(msg.clone());
2112 RAACommitmentOrder::RevokeAndACKFirst
2114 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2115 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2116 commitment_update = Some(updates.clone());
2118 RAACommitmentOrder::CommitmentFirst
2120 _ => RAACommitmentOrder::CommitmentFirst,
2123 RAACommitmentOrder::CommitmentFirst
2126 if let Some(ev) = msg_events.get(idx) {
2128 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2129 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2130 assert!(revoke_and_ack.is_none());
2131 revoke_and_ack = Some(msg.clone());
2134 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2135 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2136 assert!(commitment_update.is_none());
2137 commitment_update = Some(updates.clone());
2144 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2145 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2147 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2150 assert_eq!(msg_events.len(), idx);
2152 (funding_locked, revoke_and_ack, commitment_update, order)
2157 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2158 /// for claims/fails they are separated out.
2159 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)) {
2160 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2161 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2162 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2163 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2165 if send_funding_locked.0 {
2166 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
2168 for reestablish in reestablish_1.iter() {
2169 assert_eq!(reestablish.next_remote_commitment_number, 0);
2172 if send_funding_locked.1 {
2173 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
2175 for reestablish in reestablish_2.iter() {
2176 assert_eq!(reestablish.next_remote_commitment_number, 0);
2179 if send_funding_locked.0 || send_funding_locked.1 {
2180 // If we expect any funding_locked's, both sides better have set
2181 // next_holder_commitment_number to 1
2182 for reestablish in reestablish_1.iter() {
2183 assert_eq!(reestablish.next_local_commitment_number, 1);
2185 for reestablish in reestablish_2.iter() {
2186 assert_eq!(reestablish.next_local_commitment_number, 1);
2190 let mut resp_1 = Vec::new();
2191 for msg in reestablish_1 {
2192 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2193 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2195 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2196 check_added_monitors!(node_b, 1);
2198 check_added_monitors!(node_b, 0);
2201 let mut resp_2 = Vec::new();
2202 for msg in reestablish_2 {
2203 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2204 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2206 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2207 check_added_monitors!(node_a, 1);
2209 check_added_monitors!(node_a, 0);
2212 // We don't yet support both needing updates, as that would require a different commitment dance:
2213 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2214 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2215 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2216 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2218 for chan_msgs in resp_1.drain(..) {
2219 if send_funding_locked.0 {
2220 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2221 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2222 if !announcement_event.is_empty() {
2223 assert_eq!(announcement_event.len(), 1);
2224 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2225 //TODO: Test announcement_sigs re-sending
2226 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2229 assert!(chan_msgs.0.is_none());
2232 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2233 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2234 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2235 check_added_monitors!(node_a, 1);
2237 assert!(chan_msgs.1.is_none());
2239 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 {
2240 let commitment_update = chan_msgs.2.unwrap();
2241 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2242 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2244 assert!(commitment_update.update_add_htlcs.is_empty());
2246 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2247 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2248 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2249 for update_add in commitment_update.update_add_htlcs {
2250 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2252 for update_fulfill in commitment_update.update_fulfill_htlcs {
2253 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2255 for update_fail in commitment_update.update_fail_htlcs {
2256 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2259 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2260 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2262 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2263 check_added_monitors!(node_a, 1);
2264 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2265 // No commitment_signed so get_event_msg's assert(len == 1) passes
2266 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2267 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2268 check_added_monitors!(node_b, 1);
2271 assert!(chan_msgs.2.is_none());
2275 for chan_msgs in resp_2.drain(..) {
2276 if send_funding_locked.1 {
2277 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2278 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2279 if !announcement_event.is_empty() {
2280 assert_eq!(announcement_event.len(), 1);
2281 match announcement_event[0] {
2282 MessageSendEvent::SendChannelUpdate { .. } => {},
2283 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2284 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2288 assert!(chan_msgs.0.is_none());
2291 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2292 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2293 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2294 check_added_monitors!(node_b, 1);
2296 assert!(chan_msgs.1.is_none());
2298 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 {
2299 let commitment_update = chan_msgs.2.unwrap();
2300 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2301 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2303 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2304 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2305 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2306 for update_add in commitment_update.update_add_htlcs {
2307 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2309 for update_fulfill in commitment_update.update_fulfill_htlcs {
2310 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2312 for update_fail in commitment_update.update_fail_htlcs {
2313 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2316 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2317 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2319 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2320 check_added_monitors!(node_b, 1);
2321 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2322 // No commitment_signed so get_event_msg's assert(len == 1) passes
2323 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2324 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2325 check_added_monitors!(node_a, 1);
2328 assert!(chan_msgs.2.is_none());