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::{Payee, 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::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::hashes::sha256::Hash as Sha256;
37 use bitcoin::hashes::Hash;
38 use bitcoin::hash_types::BlockHash;
40 use bitcoin::secp256k1::key::PublicKey;
44 use core::cell::RefCell;
46 use sync::{Arc, Mutex};
49 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
51 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
52 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
53 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
54 confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
55 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
57 /// Mine a signle block containing the given transaction
58 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
59 let height = node.best_block_info().1 + 1;
60 confirm_transaction_at(node, tx, height);
62 /// Mine the given transaction at the given height, mining blocks as required to build to that
64 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
65 let first_connect_height = node.best_block_info().1 + 1;
66 assert!(first_connect_height <= conf_height);
67 if conf_height > first_connect_height {
68 connect_blocks(node, conf_height - first_connect_height);
70 let mut block = Block {
71 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: conf_height, bits: 42, nonce: 42 },
74 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
75 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
77 block.txdata.push(tx.clone());
78 connect_block(node, &block);
81 /// The possible ways we may notify a ChannelManager of a new block
82 #[derive(Clone, Copy, PartialEq)]
83 pub enum ConnectStyle {
84 /// Calls best_block_updated first, detecting transactions in the block only after receiving the
85 /// header and height information.
87 /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
88 /// make a single best_block_updated call.
89 BestBlockFirstSkippingBlocks,
90 /// Calls transactions_confirmed first, detecting transactions in the block before updating the
91 /// header and height information.
93 /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
94 /// make a single best_block_updated call.
95 TransactionsFirstSkippingBlocks,
96 /// Provides the full block via the chain::Listen interface. In the current code this is
97 /// equivalent to TransactionsFirst with some additional assertions.
101 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
102 let skip_intermediaries = match *node.connect_style.borrow() {
103 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
107 let height = node.best_block_info().1 + 1;
108 let mut block = Block {
109 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: height, bits: 42, nonce: 42 },
114 do_connect_block(node, &block, skip_intermediaries);
116 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: height + i, bits: 42, nonce: 42 },
120 connect_block(node, &block);
121 block.header.block_hash()
124 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
125 do_connect_block(node, block, false);
128 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
129 let height = node.best_block_info().1 + 1;
130 if !skip_intermediaries {
131 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
132 match *node.connect_style.borrow() {
133 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
134 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
135 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
136 node.node.best_block_updated(&block.header, height);
137 node.node.transactions_confirmed(&block.header, &txdata, height);
139 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
140 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
141 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
142 node.node.transactions_confirmed(&block.header, &txdata, height);
143 node.node.best_block_updated(&block.header, height);
145 ConnectStyle::FullBlockViaListen => {
146 node.chain_monitor.chain_monitor.block_connected(&block, height);
147 node.node.block_connected(&block, height);
151 node.node.test_process_background_events();
152 node.blocks.lock().unwrap().push((block.header, height));
155 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
157 let orig_header = node.blocks.lock().unwrap().pop().unwrap();
158 assert!(orig_header.1 > 0); // Cannot disconnect genesis
159 let prev_header = node.blocks.lock().unwrap().last().unwrap().clone();
161 match *node.connect_style.borrow() {
162 ConnectStyle::FullBlockViaListen => {
163 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
164 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
166 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
168 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
169 node.node.best_block_updated(&prev_header.0, prev_header.1);
173 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
174 node.node.best_block_updated(&prev_header.0, prev_header.1);
180 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
181 let count = node.blocks.lock().unwrap().len() as u32 - 1;
182 disconnect_blocks(node, count);
185 pub struct TestChanMonCfg {
186 pub tx_broadcaster: test_utils::TestBroadcaster,
187 pub fee_estimator: test_utils::TestFeeEstimator,
188 pub chain_source: test_utils::TestChainSource,
189 pub persister: test_utils::TestPersister,
190 pub logger: test_utils::TestLogger,
191 pub keys_manager: test_utils::TestKeysInterface,
192 pub network_graph: NetworkGraph,
195 pub struct NodeCfg<'a> {
196 pub chain_source: &'a test_utils::TestChainSource,
197 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
198 pub fee_estimator: &'a test_utils::TestFeeEstimator,
199 pub chain_monitor: test_utils::TestChainMonitor<'a>,
200 pub keys_manager: &'a test_utils::TestKeysInterface,
201 pub logger: &'a test_utils::TestLogger,
202 pub network_graph: &'a NetworkGraph,
203 pub node_seed: [u8; 32],
204 pub features: InitFeatures,
207 pub struct Node<'a, 'b: 'a, 'c: 'b> {
208 pub chain_source: &'c test_utils::TestChainSource,
209 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
210 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
211 pub keys_manager: &'b test_utils::TestKeysInterface,
212 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
213 pub network_graph: &'c NetworkGraph,
214 pub net_graph_msg_handler: NetGraphMsgHandler<&'c NetworkGraph, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
215 pub node_seed: [u8; 32],
216 pub network_payment_count: Rc<RefCell<u8>>,
217 pub network_chan_count: Rc<RefCell<u32>>,
218 pub logger: &'c test_utils::TestLogger,
219 pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
220 pub connect_style: Rc<RefCell<ConnectStyle>>,
222 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
223 pub fn best_block_hash(&self) -> BlockHash {
224 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
226 pub fn best_block_info(&self) -> (BlockHash, u32) {
227 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
229 pub fn get_block_header(&self, height: u32) -> BlockHeader {
230 self.blocks.lock().unwrap()[height as usize].0
234 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
236 if !::std::thread::panicking() {
237 // Check that we processed all pending events
238 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
239 assert!(self.node.get_and_clear_pending_events().is_empty());
240 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
242 // Check that if we serialize the Router, we can deserialize it again.
244 let mut w = test_utils::TestVecWriter(Vec::new());
245 self.network_graph.write(&mut w).unwrap();
246 let network_graph_deser = <NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap();
247 assert!(network_graph_deser == *self.network_graph);
248 let net_graph_msg_handler = NetGraphMsgHandler::new(
249 &network_graph_deser, Some(self.chain_source), self.logger
251 let mut chan_progress = 0;
253 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
254 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
255 assert!(orig_announcements == deserialized_announcements);
256 chan_progress = match orig_announcements.last() {
257 Some(announcement) => announcement.0.contents.short_channel_id + 1,
261 let mut node_progress = None;
263 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
264 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
265 assert!(orig_announcements == deserialized_announcements);
266 node_progress = match orig_announcements.last() {
267 Some(announcement) => Some(announcement.contents.node_id),
273 // Check that if we serialize and then deserialize all our channel monitors we get the
274 // same set of outputs to watch for on chain as we have now. Note that if we write
275 // tests that fully close channels and remove the monitors at some point this may break.
276 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
277 let mut deserialized_monitors = Vec::new();
279 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
280 let mut w = test_utils::TestVecWriter(Vec::new());
281 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
282 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
283 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
284 deserialized_monitors.push(deserialized_monitor);
288 // Before using all the new monitors to check the watch outpoints, use the full set of
289 // them to ensure we can write and reload our ChannelManager.
291 let mut channel_monitors = HashMap::new();
292 for monitor in deserialized_monitors.iter_mut() {
293 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
296 let mut w = test_utils::TestVecWriter(Vec::new());
297 self.node.write(&mut w).unwrap();
298 <(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 {
299 default_config: *self.node.get_current_default_configuration(),
300 keys_manager: self.keys_manager,
301 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
302 chain_monitor: self.chain_monitor,
303 tx_broadcaster: &test_utils::TestBroadcaster {
304 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
305 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
307 logger: &self.logger,
312 let persister = test_utils::TestPersister::new();
313 let broadcaster = test_utils::TestBroadcaster {
314 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
315 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
317 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
318 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
319 for deserialized_monitor in deserialized_monitors.drain(..) {
320 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
324 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
325 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
330 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) {
331 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
334 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) {
335 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);
336 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
337 (announcement, as_update, bs_update, channel_id, tx)
340 macro_rules! get_revoke_commit_msgs {
341 ($node: expr, $node_id: expr) => {
343 let events = $node.node.get_and_clear_pending_msg_events();
344 assert_eq!(events.len(), 2);
346 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
347 assert_eq!(*node_id, $node_id);
350 _ => panic!("Unexpected event"),
352 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
353 assert_eq!(*node_id, $node_id);
354 assert!(updates.update_add_htlcs.is_empty());
355 assert!(updates.update_fulfill_htlcs.is_empty());
356 assert!(updates.update_fail_htlcs.is_empty());
357 assert!(updates.update_fail_malformed_htlcs.is_empty());
358 assert!(updates.update_fee.is_none());
359 updates.commitment_signed.clone()
361 _ => panic!("Unexpected event"),
367 /// Get an specific event message from the pending events queue.
369 macro_rules! get_event_msg {
370 ($node: expr, $event_type: path, $node_id: expr) => {
372 let events = $node.node.get_and_clear_pending_msg_events();
373 assert_eq!(events.len(), 1);
375 $event_type { ref node_id, ref msg } => {
376 assert_eq!(*node_id, $node_id);
379 _ => panic!("Unexpected event"),
385 /// Get a specific event from the pending events queue.
387 macro_rules! get_event {
388 ($node: expr, $event_type: path) => {
390 let mut events = $node.node.get_and_clear_pending_events();
391 assert_eq!(events.len(), 1);
392 let ev = events.pop().unwrap();
394 $event_type { .. } => {
397 _ => panic!("Unexpected event"),
404 macro_rules! get_htlc_update_msgs {
405 ($node: expr, $node_id: expr) => {
407 let events = $node.node.get_and_clear_pending_msg_events();
408 assert_eq!(events.len(), 1);
410 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
411 assert_eq!(*node_id, $node_id);
414 _ => panic!("Unexpected event"),
421 macro_rules! get_channel_ref {
422 ($node: expr, $lock: ident, $channel_id: expr) => {
424 $lock = $node.node.channel_state.lock().unwrap();
425 $lock.by_id.get_mut(&$channel_id).unwrap()
431 macro_rules! get_feerate {
432 ($node: expr, $channel_id: expr) => {
435 let chan = get_channel_ref!($node, lock, $channel_id);
441 /// Returns a channel monitor given a channel id, making some naive assumptions
443 macro_rules! get_monitor {
444 ($node: expr, $channel_id: expr) => {
446 use bitcoin::hashes::Hash;
447 let mut monitor = None;
448 // Assume funding vout is either 0 or 1 blindly
450 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
451 $crate::chain::transaction::OutPoint {
452 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
464 /// Returns any local commitment transactions for the channel.
466 macro_rules! get_local_commitment_txn {
467 ($node: expr, $channel_id: expr) => {
469 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
474 /// Check the error from attempting a payment.
476 macro_rules! unwrap_send_err {
477 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
479 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
480 assert_eq!(fails.len(), 1);
486 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
487 assert_eq!(results.len(), 1);
489 Err($type) => { $check },
498 /// Check whether N channel monitor(s) have been added.
500 macro_rules! check_added_monitors {
501 ($node: expr, $count: expr) => {
503 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
504 assert_eq!(added_monitors.len(), $count);
505 added_monitors.clear();
510 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) {
511 let chan_id = *node.network_chan_count.borrow();
513 let events = node.node.get_and_clear_pending_events();
514 assert_eq!(events.len(), 1);
516 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
517 assert_eq!(*channel_value_satoshis, expected_chan_value);
518 assert_eq!(user_channel_id, expected_user_chan_id);
520 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
521 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
523 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
524 (*temporary_channel_id, tx, funding_outpoint)
526 _ => panic!("Unexpected event"),
530 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 {
531 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
532 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
533 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
535 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
536 assert_eq!(temporary_channel_id, create_chan_id);
538 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
539 check_added_monitors!(node_a, 0);
541 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
543 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
544 assert_eq!(added_monitors.len(), 1);
545 assert_eq!(added_monitors[0].0, funding_output);
546 added_monitors.clear();
549 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()));
551 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
552 assert_eq!(added_monitors.len(), 1);
553 assert_eq!(added_monitors[0].0, funding_output);
554 added_monitors.clear();
557 let events_4 = node_a.node.get_and_clear_pending_events();
558 assert_eq!(events_4.len(), 0);
560 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
561 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
562 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
567 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) {
568 confirm_transaction_at(node_conf, tx, conf_height);
569 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
570 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()));
573 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]) {
575 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
576 assert_eq!(events_6.len(), 2);
577 ((match events_6[0] {
578 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
579 channel_id = msg.channel_id.clone();
580 assert_eq!(*node_id, node_recv.node.get_our_node_id());
583 _ => panic!("Unexpected event"),
584 }, match events_6[1] {
585 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
586 assert_eq!(*node_id, node_recv.node.get_our_node_id());
589 _ => panic!("Unexpected event"),
593 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]) {
594 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
595 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
596 confirm_transaction_at(node_a, tx, conf_height);
597 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
598 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
601 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) {
602 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
603 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
607 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) {
608 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
609 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
610 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
612 let events_7 = node_b.node.get_and_clear_pending_msg_events();
613 assert_eq!(events_7.len(), 1);
614 let (announcement, bs_update) = match events_7[0] {
615 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
618 _ => panic!("Unexpected event"),
621 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
622 let events_8 = node_a.node.get_and_clear_pending_msg_events();
623 assert_eq!(events_8.len(), 1);
624 let as_update = match events_8[0] {
625 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
626 assert!(*announcement == *msg);
627 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
628 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
631 _ => panic!("Unexpected event"),
634 *node_a.network_chan_count.borrow_mut() += 1;
636 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
639 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) {
640 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
643 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) {
644 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
645 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
646 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
649 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) {
650 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
651 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
652 assert!(a_events.len() >= 2);
654 // ann should be re-generated by broadcast_node_announcement - check that we have it.
655 let mut found_ann_1 = false;
656 for event in a_events.iter() {
658 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
659 if msg == ann { found_ann_1 = true; }
661 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
662 _ => panic!("Unexpected event {:?}", event),
665 assert!(found_ann_1);
667 let a_node_announcement = match a_events.last().unwrap() {
668 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
671 _ => panic!("Unexpected event"),
674 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
675 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
676 assert!(b_events.len() >= 2);
678 // ann should be re-generated by broadcast_node_announcement - check that we have it.
679 let mut found_ann_2 = false;
680 for event in b_events.iter() {
682 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
683 if msg == ann { found_ann_2 = true; }
685 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
686 _ => panic!("Unexpected event"),
689 assert!(found_ann_2);
691 let b_node_announcement = match b_events.last().unwrap() {
692 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
695 _ => panic!("Unexpected event"),
699 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
700 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
701 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
702 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
703 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
707 macro_rules! check_spends {
708 ($tx: expr, $($spends_txn: expr),*) => {
711 for outp in $spends_txn.output.iter() {
712 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Input tx output didn't meet dust limit");
715 for outp in $tx.output.iter() {
716 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Spending tx output didn't meet dust limit");
718 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
720 if out_point.txid == $spends_txn.txid() {
721 return $spends_txn.output.get(out_point.vout as usize).cloned()
726 let mut total_value_in = 0;
727 for input in $tx.input.iter() {
728 total_value_in += get_output(&input.previous_output).unwrap().value;
730 let mut total_value_out = 0;
731 for output in $tx.output.iter() {
732 total_value_out += output.value;
734 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
735 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
736 assert!(total_value_out + min_fee <= total_value_in);
737 $tx.verify(get_output).unwrap();
742 macro_rules! get_closing_signed_broadcast {
743 ($node: expr, $dest_pubkey: expr) => {
745 let events = $node.get_and_clear_pending_msg_events();
746 assert!(events.len() == 1 || events.len() == 2);
747 (match events[events.len() - 1] {
748 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
749 assert_eq!(msg.contents.flags & 2, 2);
752 _ => panic!("Unexpected event"),
753 }, if events.len() == 2 {
755 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
756 assert_eq!(*node_id, $dest_pubkey);
759 _ => panic!("Unexpected event"),
766 /// Check that a channel's closing channel update has been broadcasted, and optionally
767 /// check whether an error message event has occurred.
769 macro_rules! check_closed_broadcast {
770 ($node: expr, $with_error_msg: expr) => {{
771 let msg_events = $node.node.get_and_clear_pending_msg_events();
772 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
773 match msg_events[0] {
774 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
775 assert_eq!(msg.contents.flags & 2, 2);
777 _ => panic!("Unexpected event"),
780 match msg_events[1] {
781 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
782 // TODO: Check node_id
785 _ => panic!("Unexpected event"),
791 /// Check that a channel's closing channel events has been issued
793 macro_rules! check_closed_event {
794 ($node: expr, $events: expr, $reason: expr) => {
795 check_closed_event!($node, $events, $reason, false);
797 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
798 let events = $node.node.get_and_clear_pending_events();
799 assert_eq!(events.len(), $events);
800 let expected_reason = $reason;
801 let mut issues_discard_funding = false;
802 for event in events {
804 Event::ChannelClosed { ref reason, .. } => {
805 assert_eq!(*reason, expected_reason);
807 Event::DiscardFunding { .. } => {
808 issues_discard_funding = true;
810 _ => panic!("Unexpected event"),
813 assert_eq!($is_check_discard_funding, issues_discard_funding);
817 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) {
818 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) };
819 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) };
822 node_a.close_channel(channel_id).unwrap();
823 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()));
825 let events_1 = node_b.get_and_clear_pending_msg_events();
826 assert!(events_1.len() >= 1);
827 let shutdown_b = match events_1[0] {
828 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
829 assert_eq!(node_id, &node_a.get_our_node_id());
832 _ => panic!("Unexpected event"),
835 let closing_signed_b = if !close_inbound_first {
836 assert_eq!(events_1.len(), 1);
839 Some(match events_1[1] {
840 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
841 assert_eq!(node_id, &node_a.get_our_node_id());
844 _ => panic!("Unexpected event"),
848 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
849 let (as_update, bs_update) = if close_inbound_first {
850 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
851 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
853 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
854 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
855 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
856 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
858 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
859 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
860 assert!(none_a.is_none());
861 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
862 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
863 (as_update, bs_update)
865 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
867 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
868 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
870 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
871 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
872 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
874 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
875 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
876 assert!(none_b.is_none());
877 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
878 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
879 (as_update, bs_update)
881 assert_eq!(tx_a, tx_b);
882 check_spends!(tx_a, funding_tx);
884 (as_update, bs_update, tx_a)
887 pub struct SendEvent {
888 pub node_id: PublicKey,
889 pub msgs: Vec<msgs::UpdateAddHTLC>,
890 pub commitment_msg: msgs::CommitmentSigned,
893 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
894 assert!(updates.update_fulfill_htlcs.is_empty());
895 assert!(updates.update_fail_htlcs.is_empty());
896 assert!(updates.update_fail_malformed_htlcs.is_empty());
897 assert!(updates.update_fee.is_none());
898 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
901 pub fn from_event(event: MessageSendEvent) -> SendEvent {
903 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
904 _ => panic!("Unexpected event type!"),
908 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
909 let mut events = node.node.get_and_clear_pending_msg_events();
910 assert_eq!(events.len(), 1);
911 SendEvent::from_event(events.pop().unwrap())
915 macro_rules! commitment_signed_dance {
916 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
918 check_added_monitors!($node_a, 0);
919 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
920 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
921 check_added_monitors!($node_a, 1);
922 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
925 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
927 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
928 check_added_monitors!($node_b, 0);
929 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
930 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
931 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
932 check_added_monitors!($node_b, 1);
933 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
934 let (bs_revoke_and_ack, extra_msg_option) = {
935 let events = $node_b.node.get_and_clear_pending_msg_events();
936 assert!(events.len() <= 2);
938 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
939 assert_eq!(*node_id, $node_a.node.get_our_node_id());
942 _ => panic!("Unexpected event"),
943 }, events.get(1).map(|e| e.clone()))
945 check_added_monitors!($node_b, 1);
947 assert!($node_a.node.get_and_clear_pending_events().is_empty());
948 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
950 (extra_msg_option, bs_revoke_and_ack)
953 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
955 check_added_monitors!($node_a, 0);
956 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
957 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
958 check_added_monitors!($node_a, 1);
959 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
960 assert!(extra_msg_option.is_none());
964 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
966 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
967 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
968 check_added_monitors!($node_a, 1);
972 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
974 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
977 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
979 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
981 expect_pending_htlcs_forwardable!($node_a);
982 check_added_monitors!($node_a, 1);
984 let channel_state = $node_a.node.channel_state.lock().unwrap();
985 assert_eq!(channel_state.pending_msg_events.len(), 1);
986 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
987 assert_ne!(*node_id, $node_b.node.get_our_node_id());
988 } else { panic!("Unexpected event"); }
990 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
996 /// Get a payment preimage and hash.
998 macro_rules! get_payment_preimage_hash {
999 ($dest_node: expr) => {
1001 get_payment_preimage_hash!($dest_node, None)
1004 ($dest_node: expr, $min_value_msat: expr) => {
1006 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1007 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1008 *payment_count += 1;
1009 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1010 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1011 (payment_preimage, payment_hash, payment_secret)
1017 macro_rules! get_route_and_payment_hash {
1018 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1019 get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
1021 ($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
1022 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node, Some($recv_value));
1023 let payee = $crate::routing::router::Payee::from_node_id($recv_node.node.get_our_node_id())
1024 .with_features($crate::ln::features::InvoiceFeatures::known())
1025 .with_route_hints($last_hops);
1026 let scorer = ::util::test_utils::TestScorer::with_fixed_penalty(0);
1027 let route = ::routing::router::get_route(
1028 &$send_node.node.get_our_node_id(), &payee, $send_node.network_graph,
1029 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1030 $recv_value, $cltv, $send_node.logger, &scorer
1032 (route, payment_hash, payment_preimage, payment_secret)
1036 macro_rules! expect_pending_htlcs_forwardable_ignore {
1038 let events = $node.node.get_and_clear_pending_events();
1039 assert_eq!(events.len(), 1);
1041 Event::PendingHTLCsForwardable { .. } => { },
1042 _ => panic!("Unexpected event"),
1047 macro_rules! expect_pending_htlcs_forwardable {
1049 expect_pending_htlcs_forwardable_ignore!($node);
1050 $node.node.process_pending_htlc_forwards();
1055 macro_rules! expect_pending_htlcs_forwardable_from_events {
1056 ($node: expr, $events: expr, $ignore: expr) => {{
1057 assert_eq!($events.len(), 1);
1059 Event::PendingHTLCsForwardable { .. } => { },
1060 _ => panic!("Unexpected event"),
1063 $node.node.process_pending_htlc_forwards();
1068 #[cfg(any(test, feature = "unstable"))]
1069 macro_rules! expect_payment_received {
1070 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1071 let events = $node.node.get_and_clear_pending_events();
1072 assert_eq!(events.len(), 1);
1074 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1075 assert_eq!($expected_payment_hash, *payment_hash);
1076 assert_eq!($expected_recv_value, amt);
1078 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1079 assert!(payment_preimage.is_none());
1080 assert_eq!($expected_payment_secret, *payment_secret);
1085 _ => panic!("Unexpected event"),
1091 macro_rules! expect_payment_sent_without_paths {
1092 ($node: expr, $expected_payment_preimage: expr) => {
1093 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1095 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1096 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1100 macro_rules! expect_payment_sent {
1101 ($node: expr, $expected_payment_preimage: expr) => {
1102 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1104 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1105 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1107 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
1108 let events = $node.node.get_and_clear_pending_events();
1109 let expected_payment_hash = PaymentHash(Sha256::hash(&$expected_payment_preimage.0).into_inner());
1111 assert!(events.len() > 1);
1113 assert_eq!(events.len(), 1);
1115 let expected_payment_id = match events[0] {
1116 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1117 assert_eq!($expected_payment_preimage, *payment_preimage);
1118 assert_eq!(expected_payment_hash, *payment_hash);
1119 assert!(fee_paid_msat.is_some());
1120 if $expected_fee_msat_opt.is_some() {
1121 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1125 _ => panic!("Unexpected event"),
1128 for i in 1..events.len() {
1130 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1131 assert_eq!(payment_id, expected_payment_id);
1132 assert_eq!(payment_hash, Some(expected_payment_hash));
1134 _ => panic!("Unexpected event"),
1142 macro_rules! expect_payment_path_successful {
1144 let events = $node.node.get_and_clear_pending_events();
1145 assert_eq!(events.len(), 1);
1147 Event::PaymentPathSuccessful { .. } => {},
1148 _ => panic!("Unexpected event"),
1153 macro_rules! expect_payment_forwarded {
1154 ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1155 let events = $node.node.get_and_clear_pending_events();
1156 assert_eq!(events.len(), 1);
1158 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1159 assert_eq!(fee_earned_msat, $expected_fee);
1160 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1162 _ => panic!("Unexpected event"),
1168 macro_rules! expect_payment_failed_with_update {
1169 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1170 let events = $node.node.get_and_clear_pending_events();
1171 assert_eq!(events.len(), 1);
1173 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref network_update, ref error_code, ref error_data, ref path, ref retry, .. } => {
1174 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1175 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1176 assert!(retry.is_some(), "expected retry.is_some()");
1177 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1178 assert_eq!(retry.as_ref().unwrap().payee.pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1179 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1180 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1181 match network_update {
1182 &Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !$chan_closed => {
1183 assert_eq!(msg.contents.short_channel_id, $scid);
1184 assert_eq!(msg.contents.flags & 2, 0);
1186 &Some(NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if $chan_closed => {
1187 assert_eq!(short_channel_id, $scid);
1188 assert!(is_permanent);
1190 Some(_) => panic!("Unexpected update type"),
1191 None => panic!("Expected update"),
1194 _ => panic!("Unexpected event"),
1200 macro_rules! expect_payment_failed {
1201 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1202 let events = $node.node.get_and_clear_pending_events();
1203 assert_eq!(events.len(), 1);
1205 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, network_update: _, ref error_code, ref error_data, ref path, ref retry, .. } => {
1206 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1207 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1208 assert!(retry.is_some(), "expected retry.is_some()");
1209 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1210 assert_eq!(retry.as_ref().unwrap().payee.pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1211 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1212 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1214 assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
1215 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
1218 _ => panic!("Unexpected event"),
1223 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 {
1224 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1225 check_added_monitors!(origin_node, expected_paths.len());
1226 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1230 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>) {
1231 let mut payment_event = SendEvent::from_event(ev);
1232 let mut prev_node = origin_node;
1234 for (idx, &node) in expected_path.iter().enumerate() {
1235 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1237 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1238 check_added_monitors!(node, 0);
1239 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1241 expect_pending_htlcs_forwardable!(node);
1243 if idx == expected_path.len() - 1 {
1244 let events_2 = node.node.get_and_clear_pending_events();
1245 if payment_received_expected {
1246 assert_eq!(events_2.len(), 1);
1248 Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1249 assert_eq!(our_payment_hash, *payment_hash);
1251 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1252 assert_eq!(expected_preimage, *payment_preimage);
1253 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1255 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1256 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1257 assert!(our_payment_secret.is_none());
1260 assert_eq!(amt, recv_value);
1262 _ => panic!("Unexpected event"),
1265 assert!(events_2.is_empty());
1268 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1269 assert_eq!(events_2.len(), 1);
1270 check_added_monitors!(node, 1);
1271 payment_event = SendEvent::from_event(events_2.remove(0));
1272 assert_eq!(payment_event.msgs.len(), 1);
1279 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) {
1280 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1281 assert_eq!(events.len(), expected_route.len());
1282 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1283 // Once we've gotten through all the HTLCs, the last one should result in a
1284 // PaymentReceived (but each previous one should not!), .
1285 let expect_payment = path_idx == expected_route.len() - 1;
1286 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1290 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) {
1291 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1292 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1293 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1296 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 {
1297 for path in expected_paths.iter() {
1298 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1300 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1301 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1303 let mut expected_total_fee_msat = 0;
1305 macro_rules! msgs_from_ev {
1308 &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 } } => {
1309 assert!(update_add_htlcs.is_empty());
1310 assert_eq!(update_fulfill_htlcs.len(), 1);
1311 assert!(update_fail_htlcs.is_empty());
1312 assert!(update_fail_malformed_htlcs.is_empty());
1313 assert!(update_fee.is_none());
1314 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1316 _ => panic!("Unexpected event"),
1320 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1321 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1322 assert_eq!(events.len(), expected_paths.len());
1323 for ev in events.iter() {
1324 per_path_msgs.push(msgs_from_ev!(ev));
1327 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1328 let mut next_msgs = Some(path_msgs);
1329 let mut expected_next_node = next_hop;
1331 macro_rules! last_update_fulfill_dance {
1332 ($node: expr, $prev_node: expr) => {
1334 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1335 check_added_monitors!($node, 0);
1336 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1337 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1341 macro_rules! mid_update_fulfill_dance {
1342 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1344 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1345 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;
1346 expect_payment_forwarded!($node, Some(fee as u64), false);
1347 expected_total_fee_msat += fee as u64;
1348 check_added_monitors!($node, 1);
1349 let new_next_msgs = if $new_msgs {
1350 let events = $node.node.get_and_clear_pending_msg_events();
1351 assert_eq!(events.len(), 1);
1352 let (res, nexthop) = msgs_from_ev!(&events[0]);
1353 expected_next_node = nexthop;
1356 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1359 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1360 next_msgs = new_next_msgs;
1365 let mut prev_node = expected_route.last().unwrap();
1366 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1367 assert_eq!(expected_next_node, node.node.get_our_node_id());
1368 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1369 if next_msgs.is_some() {
1370 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1372 assert!(!update_next_msgs);
1373 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1375 if !skip_last && idx == expected_route.len() - 1 {
1376 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1383 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1386 expected_total_fee_msat
1388 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) {
1389 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1391 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1395 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1396 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1399 pub const TEST_FINAL_CLTV: u32 = 70;
1401 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) {
1402 let payee = Payee::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1403 .with_features(InvoiceFeatures::known());
1404 let scorer = test_utils::TestScorer::with_fixed_penalty(0);
1405 let route = get_route(
1406 &origin_node.node.get_our_node_id(), &payee, &origin_node.network_graph,
1407 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1408 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1409 assert_eq!(route.paths.len(), 1);
1410 assert_eq!(route.paths[0].len(), expected_route.len());
1411 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1412 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1415 let res = send_along_route(origin_node, route, expected_route, recv_value);
1416 (res.0, res.1, res.2)
1419 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1420 let payee = Payee::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1421 .with_features(InvoiceFeatures::known());
1422 let scorer = test_utils::TestScorer::with_fixed_penalty(0);
1423 let route = get_route(&origin_node.node.get_our_node_id(), &payee, origin_node.network_graph, None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1424 assert_eq!(route.paths.len(), 1);
1425 assert_eq!(route.paths[0].len(), expected_route.len());
1426 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1427 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1430 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1431 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1432 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1435 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1436 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1437 claim_payment(&origin, expected_route, our_payment_preimage);
1440 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) {
1441 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1442 for path in expected_paths.iter() {
1443 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1445 assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1446 expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1447 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1449 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1450 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1451 assert_eq!(events.len(), expected_paths.len());
1452 for ev in events.iter() {
1453 let (update_fail, commitment_signed, node_id) = match ev {
1454 &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 } } => {
1455 assert!(update_add_htlcs.is_empty());
1456 assert!(update_fulfill_htlcs.is_empty());
1457 assert_eq!(update_fail_htlcs.len(), 1);
1458 assert!(update_fail_malformed_htlcs.is_empty());
1459 assert!(update_fee.is_none());
1460 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1462 _ => panic!("Unexpected event"),
1464 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1466 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1467 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()));
1469 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1470 let mut next_msgs = Some(path_msgs);
1471 let mut expected_next_node = next_hop;
1472 let mut prev_node = expected_route.last().unwrap();
1474 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1475 assert_eq!(expected_next_node, node.node.get_our_node_id());
1476 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1477 if next_msgs.is_some() {
1478 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1479 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1480 if !update_next_node {
1481 expect_pending_htlcs_forwardable!(node);
1484 let events = node.node.get_and_clear_pending_msg_events();
1485 if update_next_node {
1486 assert_eq!(events.len(), 1);
1488 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 } } => {
1489 assert!(update_add_htlcs.is_empty());
1490 assert!(update_fulfill_htlcs.is_empty());
1491 assert_eq!(update_fail_htlcs.len(), 1);
1492 assert!(update_fail_malformed_htlcs.is_empty());
1493 assert!(update_fee.is_none());
1494 expected_next_node = node_id.clone();
1495 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1497 _ => panic!("Unexpected event"),
1500 assert!(events.is_empty());
1502 if !skip_last && idx == expected_route.len() - 1 {
1503 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1510 let prev_node = expected_route.first().unwrap();
1511 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1512 check_added_monitors!(origin_node, 0);
1513 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1514 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1515 let events = origin_node.node.get_and_clear_pending_events();
1516 assert_eq!(events.len(), 1);
1518 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, .. } => {
1519 assert_eq!(payment_hash, our_payment_hash);
1520 assert!(rejected_by_dest);
1521 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1522 for (idx, hop) in expected_route.iter().enumerate() {
1523 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1526 _ => panic!("Unexpected event"),
1532 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1533 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1536 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1537 let mut chan_mon_cfgs = Vec::new();
1538 for i in 0..node_count {
1539 let tx_broadcaster = test_utils::TestBroadcaster {
1540 txn_broadcasted: Mutex::new(Vec::new()),
1541 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1543 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1544 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1545 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1546 let persister = test_utils::TestPersister::new();
1547 let seed = [i as u8; 32];
1548 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1549 let network_graph = NetworkGraph::new(chain_source.genesis_hash);
1551 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, network_graph });
1557 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1558 let mut nodes = Vec::new();
1560 for i in 0..node_count {
1561 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);
1562 let seed = [i as u8; 32];
1563 nodes.push(NodeCfg {
1564 chain_source: &chanmon_cfgs[i].chain_source,
1565 logger: &chanmon_cfgs[i].logger,
1566 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1567 fee_estimator: &chanmon_cfgs[i].fee_estimator,
1569 keys_manager: &chanmon_cfgs[i].keys_manager,
1571 features: InitFeatures::known(),
1572 network_graph: &chanmon_cfgs[i].network_graph,
1579 pub fn test_default_channel_config() -> UserConfig {
1580 let mut default_config = UserConfig::default();
1581 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1582 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1583 default_config.channel_options.cltv_expiry_delta = 6*6;
1584 default_config.channel_options.announced_channel = true;
1585 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1586 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1587 // It now defaults to 1, so we simply set it to the expected value here.
1588 default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1589 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1590 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1591 default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1595 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>> {
1596 let mut chanmgrs = Vec::new();
1597 for i in 0..node_count {
1598 let network = Network::Testnet;
1599 let params = ChainParameters {
1601 best_block: BestBlock::from_genesis(network),
1603 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1604 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1605 chanmgrs.push(node);
1611 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>> {
1612 let mut nodes = Vec::new();
1613 let chan_count = Rc::new(RefCell::new(0));
1614 let payment_count = Rc::new(RefCell::new(0));
1615 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1617 for i in 0..node_count {
1618 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].network_graph, None, cfgs[i].logger);
1620 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
1621 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
1622 node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, net_graph_msg_handler,
1623 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1624 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1625 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1626 connect_style: Rc::clone(&connect_style),
1630 for i in 0..node_count {
1631 for j in (i+1)..node_count {
1632 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1633 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1640 // Note that the following only works for CLTV values up to 128
1641 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1642 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1644 #[derive(PartialEq)]
1645 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1646 /// Tests that the given node has broadcast transactions for the given Channel
1648 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1649 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1650 /// broadcast and the revoked outputs were claimed.
1652 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1653 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1655 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1657 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> {
1658 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1659 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1661 let mut res = Vec::with_capacity(2);
1662 node_txn.retain(|tx| {
1663 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1664 check_spends!(tx, chan.3);
1665 if commitment_tx.is_none() {
1666 res.push(tx.clone());
1671 if let Some(explicit_tx) = commitment_tx {
1672 res.push(explicit_tx.clone());
1675 assert_eq!(res.len(), 1);
1677 if has_htlc_tx != HTLCType::NONE {
1678 node_txn.retain(|tx| {
1679 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1680 check_spends!(tx, res[0]);
1681 if has_htlc_tx == HTLCType::TIMEOUT {
1682 assert!(tx.lock_time != 0);
1684 assert!(tx.lock_time == 0);
1686 res.push(tx.clone());
1690 assert!(res.len() == 2 || res.len() == 3);
1692 assert_eq!(res[1], res[2]);
1696 assert!(node_txn.is_empty());
1700 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1701 /// HTLC transaction.
1702 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1703 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1704 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1705 // for revoked htlc outputs
1706 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1707 node_txn.retain(|tx| {
1708 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1709 check_spends!(tx, revoked_tx);
1713 node_txn.retain(|tx| {
1714 check_spends!(tx, commitment_revoked_tx);
1717 assert!(node_txn.is_empty());
1720 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1721 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1723 assert!(node_txn.len() >= 1);
1724 assert_eq!(node_txn[0].input.len(), 1);
1725 let mut found_prev = false;
1727 for tx in prev_txn {
1728 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1729 check_spends!(node_txn[0], tx);
1730 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1731 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1737 assert!(found_prev);
1739 let mut res = Vec::new();
1740 mem::swap(&mut *node_txn, &mut res);
1744 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) {
1745 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1746 assert_eq!(events_1.len(), 2);
1747 let as_update = match events_1[0] {
1748 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1751 _ => panic!("Unexpected event"),
1754 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1755 assert_eq!(node_id, nodes[b].node.get_our_node_id());
1756 assert_eq!(msg.data, expected_error);
1757 if needs_err_handle {
1758 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1761 _ => panic!("Unexpected event"),
1764 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1765 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1766 let bs_update = match events_2[0] {
1767 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1770 _ => panic!("Unexpected event"),
1772 if !needs_err_handle {
1774 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1775 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1776 assert_eq!(msg.data, expected_error);
1778 _ => panic!("Unexpected event"),
1783 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1784 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1788 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1789 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
1793 macro_rules! get_channel_value_stat {
1794 ($node: expr, $channel_id: expr) => {{
1795 let chan_lock = $node.node.channel_state.lock().unwrap();
1796 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1797 chan.get_value_stat()
1801 macro_rules! get_chan_reestablish_msgs {
1802 ($src_node: expr, $dst_node: expr) => {
1804 let mut res = Vec::with_capacity(1);
1805 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1806 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1807 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1808 res.push(msg.clone());
1810 panic!("Unexpected event")
1818 macro_rules! handle_chan_reestablish_msgs {
1819 ($src_node: expr, $dst_node: expr) => {
1821 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1823 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1825 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1831 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
1833 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1836 let mut revoke_and_ack = None;
1837 let mut commitment_update = None;
1838 let order = if let Some(ev) = msg_events.get(idx) {
1840 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1841 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1842 revoke_and_ack = Some(msg.clone());
1844 RAACommitmentOrder::RevokeAndACKFirst
1846 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1847 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1848 commitment_update = Some(updates.clone());
1850 RAACommitmentOrder::CommitmentFirst
1852 &MessageSendEvent::SendChannelUpdate { .. } => RAACommitmentOrder::CommitmentFirst,
1853 _ => panic!("Unexpected event"),
1856 RAACommitmentOrder::CommitmentFirst
1859 if let Some(ev) = msg_events.get(idx) {
1861 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1862 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1863 assert!(revoke_and_ack.is_none());
1864 revoke_and_ack = Some(msg.clone());
1867 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1868 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1869 assert!(commitment_update.is_none());
1870 commitment_update = Some(updates.clone());
1873 &MessageSendEvent::SendChannelUpdate { .. } => {},
1874 _ => panic!("Unexpected event"),
1878 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
1879 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1880 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1883 (funding_locked, revoke_and_ack, commitment_update, order)
1888 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1889 /// for claims/fails they are separated out.
1890 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)) {
1891 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1892 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1893 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1894 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1896 if send_funding_locked.0 {
1897 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1899 for reestablish in reestablish_1.iter() {
1900 assert_eq!(reestablish.next_remote_commitment_number, 0);
1903 if send_funding_locked.1 {
1904 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1906 for reestablish in reestablish_2.iter() {
1907 assert_eq!(reestablish.next_remote_commitment_number, 0);
1910 if send_funding_locked.0 || send_funding_locked.1 {
1911 // If we expect any funding_locked's, both sides better have set
1912 // next_holder_commitment_number to 1
1913 for reestablish in reestablish_1.iter() {
1914 assert_eq!(reestablish.next_local_commitment_number, 1);
1916 for reestablish in reestablish_2.iter() {
1917 assert_eq!(reestablish.next_local_commitment_number, 1);
1921 let mut resp_1 = Vec::new();
1922 for msg in reestablish_1 {
1923 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1924 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1926 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1927 check_added_monitors!(node_b, 1);
1929 check_added_monitors!(node_b, 0);
1932 let mut resp_2 = Vec::new();
1933 for msg in reestablish_2 {
1934 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1935 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1937 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1938 check_added_monitors!(node_a, 1);
1940 check_added_monitors!(node_a, 0);
1943 // We don't yet support both needing updates, as that would require a different commitment dance:
1944 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
1945 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1946 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
1947 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1949 for chan_msgs in resp_1.drain(..) {
1950 if send_funding_locked.0 {
1951 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1952 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1953 if !announcement_event.is_empty() {
1954 assert_eq!(announcement_event.len(), 1);
1955 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1956 //TODO: Test announcement_sigs re-sending
1957 } else { panic!("Unexpected event!"); }
1960 assert!(chan_msgs.0.is_none());
1963 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1964 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1965 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1966 check_added_monitors!(node_a, 1);
1968 assert!(chan_msgs.1.is_none());
1970 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 {
1971 let commitment_update = chan_msgs.2.unwrap();
1972 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1973 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1975 assert!(commitment_update.update_add_htlcs.is_empty());
1977 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1978 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
1979 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1980 for update_add in commitment_update.update_add_htlcs {
1981 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1983 for update_fulfill in commitment_update.update_fulfill_htlcs {
1984 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1986 for update_fail in commitment_update.update_fail_htlcs {
1987 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1990 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1991 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1993 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1994 check_added_monitors!(node_a, 1);
1995 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1996 // No commitment_signed so get_event_msg's assert(len == 1) passes
1997 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1998 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1999 check_added_monitors!(node_b, 1);
2002 assert!(chan_msgs.2.is_none());
2006 for chan_msgs in resp_2.drain(..) {
2007 if send_funding_locked.1 {
2008 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2009 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2010 if !announcement_event.is_empty() {
2011 assert_eq!(announcement_event.len(), 1);
2012 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
2013 //TODO: Test announcement_sigs re-sending
2014 } else { panic!("Unexpected event!"); }
2017 assert!(chan_msgs.0.is_none());
2020 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2021 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2022 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2023 check_added_monitors!(node_b, 1);
2025 assert!(chan_msgs.1.is_none());
2027 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 {
2028 let commitment_update = chan_msgs.2.unwrap();
2029 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2030 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2032 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2033 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2034 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2035 for update_add in commitment_update.update_add_htlcs {
2036 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2038 for update_fulfill in commitment_update.update_fulfill_htlcs {
2039 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2041 for update_fail in commitment_update.update_fail_htlcs {
2042 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2045 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2046 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2048 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2049 check_added_monitors!(node_b, 1);
2050 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2051 // No commitment_signed so get_event_msg's assert(len == 1) passes
2052 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2053 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2054 check_added_monitors!(node_a, 1);
2057 assert!(chan_msgs.2.is_none());