1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
11 //! nodes for functional tests.
13 use chain::{BestBlock, Confirm, Listen, Watch};
14 use chain::channelmonitor::ChannelMonitor;
15 use chain::transaction::OutPoint;
16 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
17 use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, PaymentId};
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 do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
127 let height = node.best_block_info().1 + 1;
128 if !skip_intermediaries {
129 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
130 match *node.connect_style.borrow() {
131 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
132 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
133 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
134 node.node.best_block_updated(&block.header, height);
135 node.node.transactions_confirmed(&block.header, &txdata, height);
137 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
138 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
139 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
140 node.node.transactions_confirmed(&block.header, &txdata, height);
141 node.node.best_block_updated(&block.header, height);
143 ConnectStyle::FullBlockViaListen => {
144 node.chain_monitor.chain_monitor.block_connected(&block, height);
145 node.node.block_connected(&block, height);
149 node.node.test_process_background_events();
150 node.blocks.lock().unwrap().push((block.header, height));
153 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
155 let orig_header = node.blocks.lock().unwrap().pop().unwrap();
156 assert!(orig_header.1 > 0); // Cannot disconnect genesis
157 let prev_header = node.blocks.lock().unwrap().last().unwrap().clone();
159 match *node.connect_style.borrow() {
160 ConnectStyle::FullBlockViaListen => {
161 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
162 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
164 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
166 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
167 node.node.best_block_updated(&prev_header.0, prev_header.1);
171 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
172 node.node.best_block_updated(&prev_header.0, prev_header.1);
178 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
179 let count = node.blocks.lock().unwrap().len() as u32 - 1;
180 disconnect_blocks(node, count);
183 pub struct TestChanMonCfg {
184 pub tx_broadcaster: test_utils::TestBroadcaster,
185 pub fee_estimator: test_utils::TestFeeEstimator,
186 pub chain_source: test_utils::TestChainSource,
187 pub persister: test_utils::TestPersister,
188 pub logger: test_utils::TestLogger,
189 pub keys_manager: test_utils::TestKeysInterface,
190 pub network_graph: NetworkGraph,
193 pub struct NodeCfg<'a> {
194 pub chain_source: &'a test_utils::TestChainSource,
195 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
196 pub fee_estimator: &'a test_utils::TestFeeEstimator,
197 pub chain_monitor: test_utils::TestChainMonitor<'a>,
198 pub keys_manager: &'a test_utils::TestKeysInterface,
199 pub logger: &'a test_utils::TestLogger,
200 pub network_graph: &'a NetworkGraph,
201 pub node_seed: [u8; 32],
202 pub features: InitFeatures,
205 pub struct Node<'a, 'b: 'a, 'c: 'b> {
206 pub chain_source: &'c test_utils::TestChainSource,
207 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
208 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
209 pub keys_manager: &'b test_utils::TestKeysInterface,
210 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
211 pub network_graph: &'c NetworkGraph,
212 pub net_graph_msg_handler: NetGraphMsgHandler<&'c NetworkGraph, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
213 pub node_seed: [u8; 32],
214 pub network_payment_count: Rc<RefCell<u8>>,
215 pub network_chan_count: Rc<RefCell<u32>>,
216 pub logger: &'c test_utils::TestLogger,
217 pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
218 pub connect_style: Rc<RefCell<ConnectStyle>>,
220 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
221 pub fn best_block_hash(&self) -> BlockHash {
222 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
224 pub fn best_block_info(&self) -> (BlockHash, u32) {
225 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
227 pub fn get_block_header(&self, height: u32) -> BlockHeader {
228 self.blocks.lock().unwrap()[height as usize].0
232 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
235 // Check that we processed all pending events
236 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
237 assert!(self.node.get_and_clear_pending_events().is_empty());
238 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
240 // Check that if we serialize the Router, we can deserialize it again.
242 let mut w = test_utils::TestVecWriter(Vec::new());
243 self.network_graph.write(&mut w).unwrap();
244 let network_graph_deser = <NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap();
245 assert!(network_graph_deser == *self.network_graph);
246 let net_graph_msg_handler = NetGraphMsgHandler::new(
247 &network_graph_deser, Some(self.chain_source), self.logger
249 let mut chan_progress = 0;
251 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
252 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
253 assert!(orig_announcements == deserialized_announcements);
254 chan_progress = match orig_announcements.last() {
255 Some(announcement) => announcement.0.contents.short_channel_id + 1,
259 let mut node_progress = None;
261 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
262 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
263 assert!(orig_announcements == deserialized_announcements);
264 node_progress = match orig_announcements.last() {
265 Some(announcement) => Some(announcement.contents.node_id),
271 // Check that if we serialize and then deserialize all our channel monitors we get the
272 // same set of outputs to watch for on chain as we have now. Note that if we write
273 // tests that fully close channels and remove the monitors at some point this may break.
274 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
275 let mut deserialized_monitors = Vec::new();
277 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
278 let mut w = test_utils::TestVecWriter(Vec::new());
279 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
280 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
281 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
282 deserialized_monitors.push(deserialized_monitor);
286 // Before using all the new monitors to check the watch outpoints, use the full set of
287 // them to ensure we can write and reload our ChannelManager.
289 let mut channel_monitors = HashMap::new();
290 for monitor in deserialized_monitors.iter_mut() {
291 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
294 let mut w = test_utils::TestVecWriter(Vec::new());
295 self.node.write(&mut w).unwrap();
296 <(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 {
297 default_config: *self.node.get_current_default_configuration(),
298 keys_manager: self.keys_manager,
299 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
300 chain_monitor: self.chain_monitor,
301 tx_broadcaster: &test_utils::TestBroadcaster {
302 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
303 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
305 logger: &self.logger,
310 let persister = test_utils::TestPersister::new();
311 let broadcaster = test_utils::TestBroadcaster {
312 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
313 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
315 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
316 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
317 for deserialized_monitor in deserialized_monitors.drain(..) {
318 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
322 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
323 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
328 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) {
329 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
332 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) {
333 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);
334 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
335 (announcement, as_update, bs_update, channel_id, tx)
339 /// Gets an RAA and CS which were sent in response to a commitment update
340 macro_rules! get_revoke_commit_msgs {
341 ($node: expr, $node_id: expr) => {
343 use $crate::util::events::MessageSendEvent;
344 let events = $node.node.get_and_clear_pending_msg_events();
345 assert_eq!(events.len(), 2);
347 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
348 assert_eq!(*node_id, $node_id);
351 _ => panic!("Unexpected event"),
353 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
354 assert_eq!(*node_id, $node_id);
355 assert!(updates.update_add_htlcs.is_empty());
356 assert!(updates.update_fulfill_htlcs.is_empty());
357 assert!(updates.update_fail_htlcs.is_empty());
358 assert!(updates.update_fail_malformed_htlcs.is_empty());
359 assert!(updates.update_fee.is_none());
360 updates.commitment_signed.clone()
362 _ => panic!("Unexpected event"),
368 /// Get an specific event message from the pending events queue.
370 macro_rules! get_event_msg {
371 ($node: expr, $event_type: path, $node_id: expr) => {
373 let events = $node.node.get_and_clear_pending_msg_events();
374 assert_eq!(events.len(), 1);
376 $event_type { ref node_id, ref msg } => {
377 assert_eq!(*node_id, $node_id);
380 _ => panic!("Unexpected event"),
386 /// Get a specific event from the pending events queue.
388 macro_rules! get_event {
389 ($node: expr, $event_type: path) => {
391 let mut events = $node.node.get_and_clear_pending_events();
392 assert_eq!(events.len(), 1);
393 let ev = events.pop().unwrap();
395 $event_type { .. } => {
398 _ => panic!("Unexpected event"),
405 /// Gets an UpdateHTLCs MessageSendEvent
406 macro_rules! get_htlc_update_msgs {
407 ($node: expr, $node_id: expr) => {
409 let events = $node.node.get_and_clear_pending_msg_events();
410 assert_eq!(events.len(), 1);
412 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
413 assert_eq!(*node_id, $node_id);
416 _ => panic!("Unexpected event"),
423 macro_rules! get_channel_ref {
424 ($node: expr, $lock: ident, $channel_id: expr) => {
426 $lock = $node.node.channel_state.lock().unwrap();
427 $lock.by_id.get_mut(&$channel_id).unwrap()
433 macro_rules! get_feerate {
434 ($node: expr, $channel_id: expr) => {
437 let chan = get_channel_ref!($node, lock, $channel_id);
444 macro_rules! get_opt_anchors {
445 ($node: expr, $channel_id: expr) => {
448 let chan = get_channel_ref!($node, lock, $channel_id);
454 /// Returns a channel monitor given a channel id, making some naive assumptions
456 macro_rules! get_monitor {
457 ($node: expr, $channel_id: expr) => {
459 use bitcoin::hashes::Hash;
460 let mut monitor = None;
461 // Assume funding vout is either 0 or 1 blindly
463 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
464 $crate::chain::transaction::OutPoint {
465 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
477 /// Returns any local commitment transactions for the channel.
479 macro_rules! get_local_commitment_txn {
480 ($node: expr, $channel_id: expr) => {
482 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
487 /// Check the error from attempting a payment.
489 macro_rules! unwrap_send_err {
490 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
492 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
493 assert_eq!(fails.len(), 1);
499 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
500 assert_eq!(results.len(), 1);
502 Err($type) => { $check },
511 /// Check whether N channel monitor(s) have been added.
513 macro_rules! check_added_monitors {
514 ($node: expr, $count: expr) => {
516 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
517 assert_eq!(added_monitors.len(), $count);
518 added_monitors.clear();
523 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) {
524 let chan_id = *node.network_chan_count.borrow();
526 let events = node.node.get_and_clear_pending_events();
527 assert_eq!(events.len(), 1);
529 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
530 assert_eq!(*channel_value_satoshis, expected_chan_value);
531 assert_eq!(user_channel_id, expected_user_chan_id);
533 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
534 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
536 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
537 (*temporary_channel_id, tx, funding_outpoint)
539 _ => panic!("Unexpected event"),
542 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 {
543 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
544 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
546 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_ok());
547 check_added_monitors!(node_a, 0);
549 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
550 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
551 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
553 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
554 assert_eq!(added_monitors.len(), 1);
555 assert_eq!(added_monitors[0].0, funding_output);
556 added_monitors.clear();
559 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()));
561 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
562 assert_eq!(added_monitors.len(), 1);
563 assert_eq!(added_monitors[0].0, funding_output);
564 added_monitors.clear();
567 let events_4 = node_a.node.get_and_clear_pending_events();
568 assert_eq!(events_4.len(), 0);
570 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
571 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
572 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
574 // Ensure that funding_transaction_generated is idempotent.
575 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_err());
576 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
577 check_added_monitors!(node_a, 0);
582 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 {
583 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
584 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
585 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
586 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
587 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
588 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
589 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
591 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
594 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) {
595 confirm_transaction_at(node_conf, tx, conf_height);
596 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
597 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()));
600 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]) {
602 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
603 assert_eq!(events_6.len(), 3);
604 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
605 assert_eq!(*node_id, node_recv.node.get_our_node_id());
607 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
608 assert_eq!(*node_id, node_recv.node.get_our_node_id());
610 } else { panic!("Unexpected event: {:?}", events_6[1]); };
611 ((match events_6[0] {
612 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
613 channel_id = msg.channel_id.clone();
614 assert_eq!(*node_id, node_recv.node.get_our_node_id());
617 _ => panic!("Unexpected event"),
618 }, match events_6[announcement_sigs_idx] {
619 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
620 assert_eq!(*node_id, node_recv.node.get_our_node_id());
623 _ => panic!("Unexpected event"),
627 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]) {
628 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
629 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
630 confirm_transaction_at(node_a, tx, conf_height);
631 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
632 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
635 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) {
636 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
637 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
641 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) {
642 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
643 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
644 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
646 let events_7 = node_b.node.get_and_clear_pending_msg_events();
647 assert_eq!(events_7.len(), 1);
648 let (announcement, bs_update) = match events_7[0] {
649 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
652 _ => panic!("Unexpected event"),
655 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
656 let events_8 = node_a.node.get_and_clear_pending_msg_events();
657 assert_eq!(events_8.len(), 1);
658 let as_update = match events_8[0] {
659 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
660 assert!(*announcement == *msg);
661 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
662 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
665 _ => panic!("Unexpected event"),
668 *node_a.network_chan_count.borrow_mut() += 1;
670 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
673 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) {
674 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
677 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) {
678 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
679 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
680 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
683 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) {
684 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
685 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
686 assert!(a_events.len() >= 2);
688 // ann should be re-generated by broadcast_node_announcement - check that we have it.
689 let mut found_ann_1 = false;
690 for event in a_events.iter() {
692 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
693 if msg == ann { found_ann_1 = true; }
695 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
696 _ => panic!("Unexpected event {:?}", event),
699 assert!(found_ann_1);
701 let a_node_announcement = match a_events.last().unwrap() {
702 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
705 _ => panic!("Unexpected event"),
708 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
709 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
710 assert!(b_events.len() >= 2);
712 // ann should be re-generated by broadcast_node_announcement - check that we have it.
713 let mut found_ann_2 = false;
714 for event in b_events.iter() {
716 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
717 if msg == ann { found_ann_2 = true; }
719 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
720 _ => panic!("Unexpected event"),
723 assert!(found_ann_2);
725 let b_node_announcement = match b_events.last().unwrap() {
726 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
729 _ => panic!("Unexpected event"),
733 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
734 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
735 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
736 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
737 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
742 macro_rules! check_spends {
743 ($tx: expr, $($spends_txn: expr),*) => {
746 for outp in $spends_txn.output.iter() {
747 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Input tx output didn't meet dust limit");
750 for outp in $tx.output.iter() {
751 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Spending tx output didn't meet dust limit");
753 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
755 if out_point.txid == $spends_txn.txid() {
756 return $spends_txn.output.get(out_point.vout as usize).cloned()
761 let mut total_value_in = 0;
762 for input in $tx.input.iter() {
763 total_value_in += get_output(&input.previous_output).unwrap().value;
765 let mut total_value_out = 0;
766 for output in $tx.output.iter() {
767 total_value_out += output.value;
769 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
770 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
771 assert!(total_value_out + min_fee <= total_value_in);
772 $tx.verify(get_output).unwrap();
777 macro_rules! get_closing_signed_broadcast {
778 ($node: expr, $dest_pubkey: expr) => {
780 let events = $node.get_and_clear_pending_msg_events();
781 assert!(events.len() == 1 || events.len() == 2);
782 (match events[events.len() - 1] {
783 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
784 assert_eq!(msg.contents.flags & 2, 2);
787 _ => panic!("Unexpected event"),
788 }, if events.len() == 2 {
790 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
791 assert_eq!(*node_id, $dest_pubkey);
794 _ => panic!("Unexpected event"),
802 macro_rules! check_warn_msg {
803 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
804 let msg_events = $node.node.get_and_clear_pending_msg_events();
805 assert_eq!(msg_events.len(), 1);
806 match msg_events[0] {
807 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
808 assert_eq!(node_id, $recipient_node_id);
809 assert_eq!(msg.channel_id, $chan_id);
812 _ => panic!("Unexpected event"),
817 /// Check that a channel's closing channel update has been broadcasted, and optionally
818 /// check whether an error message event has occurred.
820 macro_rules! check_closed_broadcast {
821 ($node: expr, $with_error_msg: expr) => {{
822 use $crate::util::events::MessageSendEvent;
823 use $crate::ln::msgs::ErrorAction;
825 let msg_events = $node.node.get_and_clear_pending_msg_events();
826 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
827 match msg_events[0] {
828 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
829 assert_eq!(msg.contents.flags & 2, 2);
831 _ => panic!("Unexpected event"),
834 match msg_events[1] {
835 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
836 // TODO: Check node_id
839 _ => panic!("Unexpected event"),
845 /// Check that a channel's closing channel events has been issued
847 macro_rules! check_closed_event {
848 ($node: expr, $events: expr, $reason: expr) => {
849 check_closed_event!($node, $events, $reason, false);
851 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
852 use $crate::util::events::Event;
854 let events = $node.node.get_and_clear_pending_events();
855 assert_eq!(events.len(), $events);
856 let expected_reason = $reason;
857 let mut issues_discard_funding = false;
858 for event in events {
860 Event::ChannelClosed { ref reason, .. } => {
861 assert_eq!(*reason, expected_reason);
863 Event::DiscardFunding { .. } => {
864 issues_discard_funding = true;
866 _ => panic!("Unexpected event"),
869 assert_eq!($is_check_discard_funding, issues_discard_funding);
873 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) {
874 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) };
875 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) };
878 node_a.close_channel(channel_id).unwrap();
879 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()));
881 let events_1 = node_b.get_and_clear_pending_msg_events();
882 assert!(events_1.len() >= 1);
883 let shutdown_b = match events_1[0] {
884 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
885 assert_eq!(node_id, &node_a.get_our_node_id());
888 _ => panic!("Unexpected event"),
891 let closing_signed_b = if !close_inbound_first {
892 assert_eq!(events_1.len(), 1);
895 Some(match events_1[1] {
896 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
897 assert_eq!(node_id, &node_a.get_our_node_id());
900 _ => panic!("Unexpected event"),
904 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
905 let (as_update, bs_update) = if close_inbound_first {
906 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
907 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
909 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
910 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
911 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
912 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
914 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
915 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
916 assert!(none_a.is_none());
917 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
918 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
919 (as_update, bs_update)
921 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
923 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
924 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
926 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
927 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
928 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
930 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
931 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
932 assert!(none_b.is_none());
933 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
934 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
935 (as_update, bs_update)
937 assert_eq!(tx_a, tx_b);
938 check_spends!(tx_a, funding_tx);
940 (as_update, bs_update, tx_a)
943 pub struct SendEvent {
944 pub node_id: PublicKey,
945 pub msgs: Vec<msgs::UpdateAddHTLC>,
946 pub commitment_msg: msgs::CommitmentSigned,
949 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
950 assert!(updates.update_fulfill_htlcs.is_empty());
951 assert!(updates.update_fail_htlcs.is_empty());
952 assert!(updates.update_fail_malformed_htlcs.is_empty());
953 assert!(updates.update_fee.is_none());
954 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
957 pub fn from_event(event: MessageSendEvent) -> SendEvent {
959 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
960 _ => panic!("Unexpected event type!"),
964 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
965 let mut events = node.node.get_and_clear_pending_msg_events();
966 assert_eq!(events.len(), 1);
967 SendEvent::from_event(events.pop().unwrap())
972 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
973 /// commitment update.
974 macro_rules! commitment_signed_dance {
975 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
977 check_added_monitors!($node_a, 0);
978 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
979 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
980 check_added_monitors!($node_a, 1);
981 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
984 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
986 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
987 check_added_monitors!($node_b, 0);
988 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
989 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
990 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
991 check_added_monitors!($node_b, 1);
992 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
993 let (bs_revoke_and_ack, extra_msg_option) = {
994 let events = $node_b.node.get_and_clear_pending_msg_events();
995 assert!(events.len() <= 2);
997 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
998 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1001 _ => panic!("Unexpected event"),
1002 }, events.get(1).map(|e| e.clone()))
1004 check_added_monitors!($node_b, 1);
1005 if $fail_backwards {
1006 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1007 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1009 (extra_msg_option, bs_revoke_and_ack)
1012 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1014 check_added_monitors!($node_a, 0);
1015 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1016 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1017 check_added_monitors!($node_a, 1);
1018 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1019 assert!(extra_msg_option.is_none());
1023 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1025 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1026 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1027 check_added_monitors!($node_a, 1);
1031 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1033 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1036 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1038 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1039 if $fail_backwards {
1040 $crate::expect_pending_htlcs_forwardable!($node_a);
1041 check_added_monitors!($node_a, 1);
1043 let channel_state = $node_a.node.channel_state.lock().unwrap();
1044 assert_eq!(channel_state.pending_msg_events.len(), 1);
1045 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1046 assert_ne!(*node_id, $node_b.node.get_our_node_id());
1047 } else { panic!("Unexpected event"); }
1049 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1055 /// Get a payment preimage and hash.
1057 macro_rules! get_payment_preimage_hash {
1058 ($dest_node: expr) => {
1060 get_payment_preimage_hash!($dest_node, None)
1063 ($dest_node: expr, $min_value_msat: expr) => {
1065 use bitcoin::hashes::Hash as _;
1066 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1067 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1068 *payment_count += 1;
1069 let payment_hash = $crate::ln::PaymentHash(
1070 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1071 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1072 (payment_preimage, payment_hash, payment_secret)
1079 macro_rules! get_route_and_payment_hash {
1080 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1081 $crate::get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
1083 ($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
1084 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1085 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1086 .with_features($crate::ln::features::InvoiceFeatures::known())
1087 .with_route_hints($last_hops);
1088 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1089 let route = $crate::routing::router::get_route(
1090 &$send_node.node.get_our_node_id(), &payment_params, $send_node.network_graph,
1091 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1092 $recv_value, $cltv, $send_node.logger, &scorer
1094 (route, payment_hash, payment_preimage, payment_secret)
1099 /// Clears (and ignores) a PendingHTLCsForwardable event
1100 macro_rules! expect_pending_htlcs_forwardable_ignore {
1102 let events = $node.node.get_and_clear_pending_events();
1103 assert_eq!(events.len(), 1);
1105 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1106 _ => panic!("Unexpected event"),
1112 /// Handles a PendingHTLCsForwardable event
1113 macro_rules! expect_pending_htlcs_forwardable {
1115 $crate::expect_pending_htlcs_forwardable_ignore!($node);
1116 $node.node.process_pending_htlc_forwards();
1118 // Ensure process_pending_htlc_forwards is idempotent.
1119 $node.node.process_pending_htlc_forwards();
1124 macro_rules! expect_pending_htlcs_forwardable_from_events {
1125 ($node: expr, $events: expr, $ignore: expr) => {{
1126 assert_eq!($events.len(), 1);
1128 Event::PendingHTLCsForwardable { .. } => { },
1129 _ => panic!("Unexpected event"),
1132 $node.node.process_pending_htlc_forwards();
1134 // Ensure process_pending_htlc_forwards is idempotent.
1135 $node.node.process_pending_htlc_forwards();
1141 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1142 macro_rules! expect_payment_received {
1143 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1144 expect_payment_received!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None)
1146 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr) => {
1147 let events = $node.node.get_and_clear_pending_events();
1148 assert_eq!(events.len(), 1);
1150 $crate::util::events::Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1151 assert_eq!($expected_payment_hash, *payment_hash);
1152 assert_eq!($expected_recv_value, amt);
1154 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1155 assert_eq!(&$expected_payment_preimage, payment_preimage);
1156 assert_eq!($expected_payment_secret, *payment_secret);
1161 _ => panic!("Unexpected event"),
1168 macro_rules! expect_payment_sent_without_paths {
1169 ($node: expr, $expected_payment_preimage: expr) => {
1170 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1172 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1173 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1178 macro_rules! expect_payment_sent {
1179 ($node: expr, $expected_payment_preimage: expr) => {
1180 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1182 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1183 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1185 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1186 use bitcoin::hashes::Hash as _;
1187 let events = $node.node.get_and_clear_pending_events();
1188 let expected_payment_hash = $crate::ln::PaymentHash(
1189 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1191 assert!(events.len() > 1);
1193 assert_eq!(events.len(), 1);
1195 let expected_payment_id = match events[0] {
1196 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1197 assert_eq!($expected_payment_preimage, *payment_preimage);
1198 assert_eq!(expected_payment_hash, *payment_hash);
1199 assert!(fee_paid_msat.is_some());
1200 if $expected_fee_msat_opt.is_some() {
1201 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1205 _ => panic!("Unexpected event"),
1208 for i in 1..events.len() {
1210 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1211 assert_eq!(payment_id, expected_payment_id);
1212 assert_eq!(payment_hash, Some(expected_payment_hash));
1214 _ => panic!("Unexpected event"),
1223 macro_rules! expect_payment_path_successful {
1225 let events = $node.node.get_and_clear_pending_events();
1226 assert_eq!(events.len(), 1);
1228 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1229 _ => panic!("Unexpected event"),
1234 macro_rules! expect_payment_forwarded {
1235 ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1236 let events = $node.node.get_and_clear_pending_events();
1237 assert_eq!(events.len(), 1);
1239 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1240 assert_eq!(fee_earned_msat, $expected_fee);
1241 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1243 _ => panic!("Unexpected event"),
1248 pub struct PaymentFailedConditions<'a> {
1249 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1250 pub(crate) expected_blamed_scid: Option<u64>,
1251 pub(crate) expected_blamed_chan_closed: Option<bool>,
1252 pub(crate) expected_mpp_parts_remain: bool,
1255 impl<'a> PaymentFailedConditions<'a> {
1256 pub fn new() -> Self {
1258 expected_htlc_error_data: None,
1259 expected_blamed_scid: None,
1260 expected_blamed_chan_closed: None,
1261 expected_mpp_parts_remain: false,
1264 pub fn mpp_parts_remain(mut self) -> Self {
1265 self.expected_mpp_parts_remain = true;
1268 pub fn blamed_scid(mut self, scid: u64) -> Self {
1269 self.expected_blamed_scid = Some(scid);
1272 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1273 self.expected_blamed_chan_closed = Some(closed);
1276 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1277 self.expected_htlc_error_data = Some((code, data));
1283 macro_rules! expect_payment_failed_with_update {
1284 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1285 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest,
1286 $crate::ln::functional_test_utils::PaymentFailedConditions::new().blamed_scid($scid).blamed_chan_closed($chan_closed));
1291 macro_rules! expect_payment_failed {
1292 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1293 #[allow(unused_mut)]
1294 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1296 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1298 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest, conditions);
1303 macro_rules! expect_payment_failed_conditions {
1304 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $conditions: expr) => {
1305 let events = $node.node.get_and_clear_pending_events();
1306 assert_eq!(events.len(), 1);
1307 let expected_payment_id = match events[0] {
1308 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data, ref path, ref retry, ref payment_id, ref network_update, .. } => {
1309 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1310 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1311 assert!(retry.is_some(), "expected retry.is_some()");
1312 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1313 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1315 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1316 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1317 if let Some((code, data)) = $conditions.expected_htlc_error_data {
1318 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1319 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1322 if let Some(chan_closed) = $conditions.expected_blamed_chan_closed {
1323 match network_update {
1324 &Some($crate::routing::network_graph::NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1325 if let Some(scid) = $conditions.expected_blamed_scid {
1326 assert_eq!(msg.contents.short_channel_id, scid);
1328 assert_eq!(msg.contents.flags & 2, 0);
1330 &Some($crate::routing::network_graph::NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if chan_closed => {
1331 if let Some(scid) = $conditions.expected_blamed_scid {
1332 assert_eq!(short_channel_id, scid);
1334 assert!(is_permanent);
1336 Some(_) => panic!("Unexpected update type"),
1337 None => panic!("Expected update"),
1343 _ => panic!("Unexpected event"),
1345 if !$conditions.expected_mpp_parts_remain {
1346 $node.node.abandon_payment(expected_payment_id);
1347 let events = $node.node.get_and_clear_pending_events();
1348 assert_eq!(events.len(), 1);
1350 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1351 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected second payment_hash");
1352 assert_eq!(*payment_id, expected_payment_id);
1354 _ => panic!("Unexpected second event"),
1360 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 {
1361 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1362 check_added_monitors!(origin_node, expected_paths.len());
1363 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1367 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>) {
1368 let mut payment_event = SendEvent::from_event(ev);
1369 let mut prev_node = origin_node;
1371 for (idx, &node) in expected_path.iter().enumerate() {
1372 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1374 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1375 check_added_monitors!(node, 0);
1376 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1378 expect_pending_htlcs_forwardable!(node);
1380 if idx == expected_path.len() - 1 {
1381 let events_2 = node.node.get_and_clear_pending_events();
1382 if payment_received_expected {
1383 assert_eq!(events_2.len(), 1);
1385 Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1386 assert_eq!(our_payment_hash, *payment_hash);
1388 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1389 assert_eq!(expected_preimage, *payment_preimage);
1390 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1392 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1393 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1394 assert!(our_payment_secret.is_none());
1397 assert_eq!(amt, recv_value);
1399 _ => panic!("Unexpected event"),
1402 assert!(events_2.is_empty());
1405 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1406 assert_eq!(events_2.len(), 1);
1407 check_added_monitors!(node, 1);
1408 payment_event = SendEvent::from_event(events_2.remove(0));
1409 assert_eq!(payment_event.msgs.len(), 1);
1416 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) {
1417 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1418 assert_eq!(events.len(), expected_route.len());
1419 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1420 // Once we've gotten through all the HTLCs, the last one should result in a
1421 // PaymentReceived (but each previous one should not!), .
1422 let expect_payment = path_idx == expected_route.len() - 1;
1423 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1427 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) {
1428 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1429 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1430 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1433 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 {
1434 for path in expected_paths.iter() {
1435 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1437 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1438 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1440 let mut expected_total_fee_msat = 0;
1442 macro_rules! msgs_from_ev {
1445 &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 } } => {
1446 assert!(update_add_htlcs.is_empty());
1447 assert_eq!(update_fulfill_htlcs.len(), 1);
1448 assert!(update_fail_htlcs.is_empty());
1449 assert!(update_fail_malformed_htlcs.is_empty());
1450 assert!(update_fee.is_none());
1451 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1453 _ => panic!("Unexpected event"),
1457 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1458 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1459 assert_eq!(events.len(), expected_paths.len());
1460 for ev in events.iter() {
1461 per_path_msgs.push(msgs_from_ev!(ev));
1464 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1465 let mut next_msgs = Some(path_msgs);
1466 let mut expected_next_node = next_hop;
1468 macro_rules! last_update_fulfill_dance {
1469 ($node: expr, $prev_node: expr) => {
1471 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1472 check_added_monitors!($node, 0);
1473 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1474 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1478 macro_rules! mid_update_fulfill_dance {
1479 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1481 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1482 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;
1483 expect_payment_forwarded!($node, Some(fee as u64), false);
1484 expected_total_fee_msat += fee as u64;
1485 check_added_monitors!($node, 1);
1486 let new_next_msgs = if $new_msgs {
1487 let events = $node.node.get_and_clear_pending_msg_events();
1488 assert_eq!(events.len(), 1);
1489 let (res, nexthop) = msgs_from_ev!(&events[0]);
1490 expected_next_node = nexthop;
1493 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1496 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1497 next_msgs = new_next_msgs;
1502 let mut prev_node = expected_route.last().unwrap();
1503 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1504 assert_eq!(expected_next_node, node.node.get_our_node_id());
1505 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1506 if next_msgs.is_some() {
1507 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1509 assert!(!update_next_msgs);
1510 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1512 if !skip_last && idx == expected_route.len() - 1 {
1513 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1520 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1524 // Ensure that claim_funds is idempotent.
1525 assert!(!expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1526 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1527 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1529 expected_total_fee_msat
1531 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) {
1532 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1534 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1538 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1539 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1542 pub const TEST_FINAL_CLTV: u32 = 70;
1544 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) {
1545 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1546 .with_features(InvoiceFeatures::known());
1547 let scorer = test_utils::TestScorer::with_penalty(0);
1548 let route = get_route(
1549 &origin_node.node.get_our_node_id(), &payment_params, &origin_node.network_graph,
1550 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1551 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1552 assert_eq!(route.paths.len(), 1);
1553 assert_eq!(route.paths[0].len(), expected_route.len());
1554 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1555 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1558 let res = send_along_route(origin_node, route, expected_route, recv_value);
1559 (res.0, res.1, res.2)
1562 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1563 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1564 .with_features(InvoiceFeatures::known());
1565 let scorer = test_utils::TestScorer::with_penalty(0);
1566 let route = get_route(
1567 &origin_node.node.get_our_node_id(), &payment_params, origin_node.network_graph,
1568 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1569 assert_eq!(route.paths.len(), 1);
1570 assert_eq!(route.paths[0].len(), expected_route.len());
1571 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1572 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1575 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1576 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1577 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1580 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1581 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1582 claim_payment(&origin, expected_route, our_payment_preimage);
1585 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) {
1586 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1587 for path in expected_paths.iter() {
1588 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1590 assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1591 expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1592 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1594 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1595 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1596 assert_eq!(events.len(), expected_paths.len());
1597 for ev in events.iter() {
1598 let (update_fail, commitment_signed, node_id) = match ev {
1599 &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 } } => {
1600 assert!(update_add_htlcs.is_empty());
1601 assert!(update_fulfill_htlcs.is_empty());
1602 assert_eq!(update_fail_htlcs.len(), 1);
1603 assert!(update_fail_malformed_htlcs.is_empty());
1604 assert!(update_fee.is_none());
1605 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1607 _ => panic!("Unexpected event"),
1609 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1611 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1612 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()));
1614 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1615 let mut next_msgs = Some(path_msgs);
1616 let mut expected_next_node = next_hop;
1617 let mut prev_node = expected_route.last().unwrap();
1619 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1620 assert_eq!(expected_next_node, node.node.get_our_node_id());
1621 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1622 if next_msgs.is_some() {
1623 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1624 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1625 if !update_next_node {
1626 expect_pending_htlcs_forwardable!(node);
1629 let events = node.node.get_and_clear_pending_msg_events();
1630 if update_next_node {
1631 assert_eq!(events.len(), 1);
1633 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 } } => {
1634 assert!(update_add_htlcs.is_empty());
1635 assert!(update_fulfill_htlcs.is_empty());
1636 assert_eq!(update_fail_htlcs.len(), 1);
1637 assert!(update_fail_malformed_htlcs.is_empty());
1638 assert!(update_fee.is_none());
1639 expected_next_node = node_id.clone();
1640 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1642 _ => panic!("Unexpected event"),
1645 assert!(events.is_empty());
1647 if !skip_last && idx == expected_route.len() - 1 {
1648 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1655 let prev_node = expected_route.first().unwrap();
1656 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1657 check_added_monitors!(origin_node, 0);
1658 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1659 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1660 let events = origin_node.node.get_and_clear_pending_events();
1661 assert_eq!(events.len(), 1);
1662 let expected_payment_id = match events[0] {
1663 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, ref payment_id, .. } => {
1664 assert_eq!(payment_hash, our_payment_hash);
1665 assert!(rejected_by_dest);
1666 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1667 for (idx, hop) in expected_route.iter().enumerate() {
1668 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1672 _ => panic!("Unexpected event"),
1674 if i == expected_paths.len() - 1 {
1675 origin_node.node.abandon_payment(expected_payment_id);
1676 let events = origin_node.node.get_and_clear_pending_events();
1677 assert_eq!(events.len(), 1);
1679 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1680 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
1681 assert_eq!(*payment_id, expected_payment_id);
1683 _ => panic!("Unexpected second event"),
1689 // Ensure that fail_htlc_backwards is idempotent.
1690 assert!(!expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1691 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
1692 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1693 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1696 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1697 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1700 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1701 let mut chan_mon_cfgs = Vec::new();
1702 for i in 0..node_count {
1703 let tx_broadcaster = test_utils::TestBroadcaster {
1704 txn_broadcasted: Mutex::new(Vec::new()),
1705 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1707 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1708 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1709 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1710 let persister = test_utils::TestPersister::new();
1711 let seed = [i as u8; 32];
1712 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1713 let network_graph = NetworkGraph::new(chain_source.genesis_hash);
1715 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, network_graph });
1721 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1722 let mut nodes = Vec::new();
1724 for i in 0..node_count {
1725 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);
1726 let seed = [i as u8; 32];
1727 nodes.push(NodeCfg {
1728 chain_source: &chanmon_cfgs[i].chain_source,
1729 logger: &chanmon_cfgs[i].logger,
1730 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1731 fee_estimator: &chanmon_cfgs[i].fee_estimator,
1733 keys_manager: &chanmon_cfgs[i].keys_manager,
1735 features: InitFeatures::known(),
1736 network_graph: &chanmon_cfgs[i].network_graph,
1743 pub fn test_default_channel_config() -> UserConfig {
1744 let mut default_config = UserConfig::default();
1745 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1746 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1747 default_config.channel_options.cltv_expiry_delta = 6*6;
1748 default_config.channel_options.announced_channel = true;
1749 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1750 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1751 // It now defaults to 1, so we simply set it to the expected value here.
1752 default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1753 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1754 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1755 default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1759 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>> {
1760 let mut chanmgrs = Vec::new();
1761 for i in 0..node_count {
1762 let network = Network::Testnet;
1763 let params = ChainParameters {
1765 best_block: BestBlock::from_genesis(network),
1767 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1768 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1769 chanmgrs.push(node);
1775 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>> {
1776 let mut nodes = Vec::new();
1777 let chan_count = Rc::new(RefCell::new(0));
1778 let payment_count = Rc::new(RefCell::new(0));
1779 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1781 for i in 0..node_count {
1782 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].network_graph, None, cfgs[i].logger);
1784 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
1785 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
1786 node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, net_graph_msg_handler,
1787 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1788 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1789 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1790 connect_style: Rc::clone(&connect_style),
1794 for i in 0..node_count {
1795 for j in (i+1)..node_count {
1796 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1797 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1804 // Note that the following only works for CLTV values up to 128
1805 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1806 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1808 #[derive(PartialEq)]
1809 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1810 /// Tests that the given node has broadcast transactions for the given Channel
1812 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1813 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1814 /// broadcast and the revoked outputs were claimed.
1816 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1817 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1819 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1821 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> {
1822 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1823 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1825 let mut res = Vec::with_capacity(2);
1826 node_txn.retain(|tx| {
1827 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1828 check_spends!(tx, chan.3);
1829 if commitment_tx.is_none() {
1830 res.push(tx.clone());
1835 if let Some(explicit_tx) = commitment_tx {
1836 res.push(explicit_tx.clone());
1839 assert_eq!(res.len(), 1);
1841 if has_htlc_tx != HTLCType::NONE {
1842 node_txn.retain(|tx| {
1843 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1844 check_spends!(tx, res[0]);
1845 if has_htlc_tx == HTLCType::TIMEOUT {
1846 assert!(tx.lock_time != 0);
1848 assert!(tx.lock_time == 0);
1850 res.push(tx.clone());
1854 assert!(res.len() == 2 || res.len() == 3);
1856 assert_eq!(res[1], res[2]);
1860 assert!(node_txn.is_empty());
1864 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1865 /// HTLC transaction.
1866 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1867 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1868 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1869 // for revoked htlc outputs
1870 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1871 node_txn.retain(|tx| {
1872 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1873 check_spends!(tx, revoked_tx);
1877 node_txn.retain(|tx| {
1878 check_spends!(tx, commitment_revoked_tx);
1881 assert!(node_txn.is_empty());
1884 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1885 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1887 assert!(node_txn.len() >= 1);
1888 assert_eq!(node_txn[0].input.len(), 1);
1889 let mut found_prev = false;
1891 for tx in prev_txn {
1892 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1893 check_spends!(node_txn[0], tx);
1894 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1895 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1901 assert!(found_prev);
1903 let mut res = Vec::new();
1904 mem::swap(&mut *node_txn, &mut res);
1908 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) {
1909 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1910 assert_eq!(events_1.len(), 2);
1911 let as_update = match events_1[0] {
1912 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1915 _ => panic!("Unexpected event"),
1918 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1919 assert_eq!(node_id, nodes[b].node.get_our_node_id());
1920 assert_eq!(msg.data, expected_error);
1921 if needs_err_handle {
1922 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1925 _ => panic!("Unexpected event"),
1928 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1929 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1930 let bs_update = match events_2[0] {
1931 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1934 _ => panic!("Unexpected event"),
1936 if !needs_err_handle {
1938 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1939 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1940 assert_eq!(msg.data, expected_error);
1942 _ => panic!("Unexpected event"),
1947 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1948 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1952 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1953 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
1957 macro_rules! get_channel_value_stat {
1958 ($node: expr, $channel_id: expr) => {{
1959 let chan_lock = $node.node.channel_state.lock().unwrap();
1960 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1961 chan.get_value_stat()
1965 macro_rules! get_chan_reestablish_msgs {
1966 ($src_node: expr, $dst_node: expr) => {
1968 let mut res = Vec::with_capacity(1);
1969 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1970 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1971 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1972 res.push(msg.clone());
1974 panic!("Unexpected event")
1982 macro_rules! handle_chan_reestablish_msgs {
1983 ($src_node: expr, $dst_node: expr) => {
1985 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1987 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1989 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1995 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
1997 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2000 let mut revoke_and_ack = None;
2001 let mut commitment_update = None;
2002 let order = if let Some(ev) = msg_events.get(idx) {
2004 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2005 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2006 revoke_and_ack = Some(msg.clone());
2008 RAACommitmentOrder::RevokeAndACKFirst
2010 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2011 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2012 commitment_update = Some(updates.clone());
2014 RAACommitmentOrder::CommitmentFirst
2016 _ => RAACommitmentOrder::CommitmentFirst,
2019 RAACommitmentOrder::CommitmentFirst
2022 if let Some(ev) = msg_events.get(idx) {
2024 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2025 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2026 assert!(revoke_and_ack.is_none());
2027 revoke_and_ack = Some(msg.clone());
2030 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2031 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2032 assert!(commitment_update.is_none());
2033 commitment_update = Some(updates.clone());
2040 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2041 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2043 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2046 assert_eq!(msg_events.len(), idx);
2048 (funding_locked, revoke_and_ack, commitment_update, order)
2053 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2054 /// for claims/fails they are separated out.
2055 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)) {
2056 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2057 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2058 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2059 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2061 if send_funding_locked.0 {
2062 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
2064 for reestablish in reestablish_1.iter() {
2065 assert_eq!(reestablish.next_remote_commitment_number, 0);
2068 if send_funding_locked.1 {
2069 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
2071 for reestablish in reestablish_2.iter() {
2072 assert_eq!(reestablish.next_remote_commitment_number, 0);
2075 if send_funding_locked.0 || send_funding_locked.1 {
2076 // If we expect any funding_locked's, both sides better have set
2077 // next_holder_commitment_number to 1
2078 for reestablish in reestablish_1.iter() {
2079 assert_eq!(reestablish.next_local_commitment_number, 1);
2081 for reestablish in reestablish_2.iter() {
2082 assert_eq!(reestablish.next_local_commitment_number, 1);
2086 let mut resp_1 = Vec::new();
2087 for msg in reestablish_1 {
2088 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2089 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2091 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2092 check_added_monitors!(node_b, 1);
2094 check_added_monitors!(node_b, 0);
2097 let mut resp_2 = Vec::new();
2098 for msg in reestablish_2 {
2099 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2100 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2102 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2103 check_added_monitors!(node_a, 1);
2105 check_added_monitors!(node_a, 0);
2108 // We don't yet support both needing updates, as that would require a different commitment dance:
2109 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2110 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2111 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2112 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2114 for chan_msgs in resp_1.drain(..) {
2115 if send_funding_locked.0 {
2116 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2117 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2118 if !announcement_event.is_empty() {
2119 assert_eq!(announcement_event.len(), 1);
2120 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2121 //TODO: Test announcement_sigs re-sending
2122 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2125 assert!(chan_msgs.0.is_none());
2128 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2129 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2130 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2131 check_added_monitors!(node_a, 1);
2133 assert!(chan_msgs.1.is_none());
2135 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 {
2136 let commitment_update = chan_msgs.2.unwrap();
2137 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2138 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2140 assert!(commitment_update.update_add_htlcs.is_empty());
2142 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2143 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2144 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2145 for update_add in commitment_update.update_add_htlcs {
2146 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2148 for update_fulfill in commitment_update.update_fulfill_htlcs {
2149 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2151 for update_fail in commitment_update.update_fail_htlcs {
2152 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2155 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2156 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2158 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2159 check_added_monitors!(node_a, 1);
2160 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2161 // No commitment_signed so get_event_msg's assert(len == 1) passes
2162 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2163 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2164 check_added_monitors!(node_b, 1);
2167 assert!(chan_msgs.2.is_none());
2171 for chan_msgs in resp_2.drain(..) {
2172 if send_funding_locked.1 {
2173 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2174 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2175 if !announcement_event.is_empty() {
2176 assert_eq!(announcement_event.len(), 1);
2177 match announcement_event[0] {
2178 MessageSendEvent::SendChannelUpdate { .. } => {},
2179 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2180 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2184 assert!(chan_msgs.0.is_none());
2187 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2188 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2189 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2190 check_added_monitors!(node_b, 1);
2192 assert!(chan_msgs.1.is_none());
2194 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 {
2195 let commitment_update = chan_msgs.2.unwrap();
2196 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2197 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2199 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2200 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2201 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2202 for update_add in commitment_update.update_add_htlcs {
2203 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2205 for update_fulfill in commitment_update.update_fulfill_htlcs {
2206 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2208 for update_fail in commitment_update.update_fail_htlcs {
2209 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2212 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2213 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2215 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2216 check_added_monitors!(node_b, 1);
2217 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2218 // No commitment_signed so get_event_msg's assert(len == 1) passes
2219 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2220 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2221 check_added_monitors!(node_a, 1);
2224 assert!(chan_msgs.2.is_none());