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::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> {
234 if !::std::thread::panicking() {
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 macro_rules! get_revoke_commit_msgs {
340 ($node: expr, $node_id: expr) => {
342 use util::events::MessageSendEvent;
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"),
405 macro_rules! get_htlc_update_msgs {
406 ($node: expr, $node_id: expr) => {
408 let events = $node.node.get_and_clear_pending_msg_events();
409 assert_eq!(events.len(), 1);
411 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
412 assert_eq!(*node_id, $node_id);
415 _ => panic!("Unexpected event"),
422 macro_rules! get_channel_ref {
423 ($node: expr, $lock: ident, $channel_id: expr) => {
425 $lock = $node.node.channel_state.lock().unwrap();
426 $lock.by_id.get_mut(&$channel_id).unwrap()
432 macro_rules! get_feerate {
433 ($node: expr, $channel_id: expr) => {
436 let chan = get_channel_ref!($node, lock, $channel_id);
442 /// Returns a channel monitor given a channel id, making some naive assumptions
444 macro_rules! get_monitor {
445 ($node: expr, $channel_id: expr) => {
447 use bitcoin::hashes::Hash;
448 let mut monitor = None;
449 // Assume funding vout is either 0 or 1 blindly
451 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
452 $crate::chain::transaction::OutPoint {
453 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
465 /// Returns any local commitment transactions for the channel.
467 macro_rules! get_local_commitment_txn {
468 ($node: expr, $channel_id: expr) => {
470 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
475 /// Check the error from attempting a payment.
477 macro_rules! unwrap_send_err {
478 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
480 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
481 assert_eq!(fails.len(), 1);
487 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
488 assert_eq!(results.len(), 1);
490 Err($type) => { $check },
499 /// Check whether N channel monitor(s) have been added.
501 macro_rules! check_added_monitors {
502 ($node: expr, $count: expr) => {
504 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
505 assert_eq!(added_monitors.len(), $count);
506 added_monitors.clear();
511 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) {
512 let chan_id = *node.network_chan_count.borrow();
514 let events = node.node.get_and_clear_pending_events();
515 assert_eq!(events.len(), 1);
517 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
518 assert_eq!(*channel_value_satoshis, expected_chan_value);
519 assert_eq!(user_channel_id, expected_user_chan_id);
521 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
522 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
524 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
525 (*temporary_channel_id, tx, funding_outpoint)
527 _ => panic!("Unexpected event"),
531 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 {
532 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
533 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()));
534 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()));
536 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
537 assert_eq!(temporary_channel_id, create_chan_id);
539 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
540 check_added_monitors!(node_a, 0);
542 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()));
544 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
545 assert_eq!(added_monitors.len(), 1);
546 assert_eq!(added_monitors[0].0, funding_output);
547 added_monitors.clear();
550 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()));
552 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
553 assert_eq!(added_monitors.len(), 1);
554 assert_eq!(added_monitors[0].0, funding_output);
555 added_monitors.clear();
558 let events_4 = node_a.node.get_and_clear_pending_events();
559 assert_eq!(events_4.len(), 0);
561 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
562 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
563 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
568 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) {
569 confirm_transaction_at(node_conf, tx, conf_height);
570 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
571 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()));
574 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]) {
576 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
577 assert_eq!(events_6.len(), 2);
578 ((match events_6[0] {
579 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
580 channel_id = msg.channel_id.clone();
581 assert_eq!(*node_id, node_recv.node.get_our_node_id());
584 _ => panic!("Unexpected event"),
585 }, match events_6[1] {
586 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
587 assert_eq!(*node_id, node_recv.node.get_our_node_id());
590 _ => panic!("Unexpected event"),
594 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]) {
595 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
596 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
597 confirm_transaction_at(node_a, tx, conf_height);
598 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
599 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
602 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) {
603 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
604 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
608 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) {
609 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
610 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
611 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
613 let events_7 = node_b.node.get_and_clear_pending_msg_events();
614 assert_eq!(events_7.len(), 1);
615 let (announcement, bs_update) = match events_7[0] {
616 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
619 _ => panic!("Unexpected event"),
622 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
623 let events_8 = node_a.node.get_and_clear_pending_msg_events();
624 assert_eq!(events_8.len(), 1);
625 let as_update = match events_8[0] {
626 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
627 assert!(*announcement == *msg);
628 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
629 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
632 _ => panic!("Unexpected event"),
635 *node_a.network_chan_count.borrow_mut() += 1;
637 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
640 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) {
641 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
644 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) {
645 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
646 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
647 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
650 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) {
651 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
652 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
653 assert!(a_events.len() >= 2);
655 // ann should be re-generated by broadcast_node_announcement - check that we have it.
656 let mut found_ann_1 = false;
657 for event in a_events.iter() {
659 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
660 if msg == ann { found_ann_1 = true; }
662 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
663 _ => panic!("Unexpected event {:?}", event),
666 assert!(found_ann_1);
668 let a_node_announcement = match a_events.last().unwrap() {
669 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
672 _ => panic!("Unexpected event"),
675 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
676 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
677 assert!(b_events.len() >= 2);
679 // ann should be re-generated by broadcast_node_announcement - check that we have it.
680 let mut found_ann_2 = false;
681 for event in b_events.iter() {
683 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
684 if msg == ann { found_ann_2 = true; }
686 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
687 _ => panic!("Unexpected event"),
690 assert!(found_ann_2);
692 let b_node_announcement = match b_events.last().unwrap() {
693 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
696 _ => panic!("Unexpected event"),
700 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
701 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
702 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
703 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
704 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
709 macro_rules! check_spends {
710 ($tx: expr, $($spends_txn: expr),*) => {
713 for outp in $spends_txn.output.iter() {
714 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Input tx output didn't meet dust limit");
717 for outp in $tx.output.iter() {
718 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Spending tx output didn't meet dust limit");
720 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
722 if out_point.txid == $spends_txn.txid() {
723 return $spends_txn.output.get(out_point.vout as usize).cloned()
728 let mut total_value_in = 0;
729 for input in $tx.input.iter() {
730 total_value_in += get_output(&input.previous_output).unwrap().value;
732 let mut total_value_out = 0;
733 for output in $tx.output.iter() {
734 total_value_out += output.value;
736 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
737 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
738 assert!(total_value_out + min_fee <= total_value_in);
739 $tx.verify(get_output).unwrap();
744 macro_rules! get_closing_signed_broadcast {
745 ($node: expr, $dest_pubkey: expr) => {
747 let events = $node.get_and_clear_pending_msg_events();
748 assert!(events.len() == 1 || events.len() == 2);
749 (match events[events.len() - 1] {
750 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
751 assert_eq!(msg.contents.flags & 2, 2);
754 _ => panic!("Unexpected event"),
755 }, if events.len() == 2 {
757 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
758 assert_eq!(*node_id, $dest_pubkey);
761 _ => panic!("Unexpected event"),
768 /// Check that a channel's closing channel update has been broadcasted, and optionally
769 /// check whether an error message event has occurred.
771 macro_rules! check_closed_broadcast {
772 ($node: expr, $with_error_msg: expr) => {{
773 use $crate::util::events::MessageSendEvent;
774 use $crate::ln::msgs::ErrorAction;
776 let msg_events = $node.node.get_and_clear_pending_msg_events();
777 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
778 match msg_events[0] {
779 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
780 assert_eq!(msg.contents.flags & 2, 2);
782 _ => panic!("Unexpected event"),
785 match msg_events[1] {
786 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
787 // TODO: Check node_id
790 _ => panic!("Unexpected event"),
796 /// Check that a channel's closing channel events has been issued
798 macro_rules! check_closed_event {
799 ($node: expr, $events: expr, $reason: expr) => {
800 check_closed_event!($node, $events, $reason, false);
802 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
803 use $crate::util::events::Event;
805 let events = $node.node.get_and_clear_pending_events();
806 assert_eq!(events.len(), $events);
807 let expected_reason = $reason;
808 let mut issues_discard_funding = false;
809 for event in events {
811 Event::ChannelClosed { ref reason, .. } => {
812 assert_eq!(*reason, expected_reason);
814 Event::DiscardFunding { .. } => {
815 issues_discard_funding = true;
817 _ => panic!("Unexpected event"),
820 assert_eq!($is_check_discard_funding, issues_discard_funding);
824 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) {
825 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) };
826 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) };
829 node_a.close_channel(channel_id).unwrap();
830 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()));
832 let events_1 = node_b.get_and_clear_pending_msg_events();
833 assert!(events_1.len() >= 1);
834 let shutdown_b = match events_1[0] {
835 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
836 assert_eq!(node_id, &node_a.get_our_node_id());
839 _ => panic!("Unexpected event"),
842 let closing_signed_b = if !close_inbound_first {
843 assert_eq!(events_1.len(), 1);
846 Some(match events_1[1] {
847 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
848 assert_eq!(node_id, &node_a.get_our_node_id());
851 _ => panic!("Unexpected event"),
855 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
856 let (as_update, bs_update) = if close_inbound_first {
857 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
858 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
860 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
861 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
862 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
863 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
865 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
866 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
867 assert!(none_a.is_none());
868 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
869 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
870 (as_update, bs_update)
872 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
874 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
875 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
877 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
878 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
879 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
881 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
882 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
883 assert!(none_b.is_none());
884 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
885 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
886 (as_update, bs_update)
888 assert_eq!(tx_a, tx_b);
889 check_spends!(tx_a, funding_tx);
891 (as_update, bs_update, tx_a)
894 pub struct SendEvent {
895 pub node_id: PublicKey,
896 pub msgs: Vec<msgs::UpdateAddHTLC>,
897 pub commitment_msg: msgs::CommitmentSigned,
900 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
901 assert!(updates.update_fulfill_htlcs.is_empty());
902 assert!(updates.update_fail_htlcs.is_empty());
903 assert!(updates.update_fail_malformed_htlcs.is_empty());
904 assert!(updates.update_fee.is_none());
905 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
908 pub fn from_event(event: MessageSendEvent) -> SendEvent {
910 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
911 _ => panic!("Unexpected event type!"),
915 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
916 let mut events = node.node.get_and_clear_pending_msg_events();
917 assert_eq!(events.len(), 1);
918 SendEvent::from_event(events.pop().unwrap())
922 macro_rules! commitment_signed_dance {
923 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
925 check_added_monitors!($node_a, 0);
926 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
927 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
928 check_added_monitors!($node_a, 1);
929 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
932 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
934 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
935 check_added_monitors!($node_b, 0);
936 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
937 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
938 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
939 check_added_monitors!($node_b, 1);
940 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
941 let (bs_revoke_and_ack, extra_msg_option) = {
942 let events = $node_b.node.get_and_clear_pending_msg_events();
943 assert!(events.len() <= 2);
945 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
946 assert_eq!(*node_id, $node_a.node.get_our_node_id());
949 _ => panic!("Unexpected event"),
950 }, events.get(1).map(|e| e.clone()))
952 check_added_monitors!($node_b, 1);
954 assert!($node_a.node.get_and_clear_pending_events().is_empty());
955 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
957 (extra_msg_option, bs_revoke_and_ack)
960 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
962 check_added_monitors!($node_a, 0);
963 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
964 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
965 check_added_monitors!($node_a, 1);
966 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
967 assert!(extra_msg_option.is_none());
971 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
973 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
974 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
975 check_added_monitors!($node_a, 1);
979 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
981 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
984 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
986 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
988 expect_pending_htlcs_forwardable!($node_a);
989 check_added_monitors!($node_a, 1);
991 let channel_state = $node_a.node.channel_state.lock().unwrap();
992 assert_eq!(channel_state.pending_msg_events.len(), 1);
993 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
994 assert_ne!(*node_id, $node_b.node.get_our_node_id());
995 } else { panic!("Unexpected event"); }
997 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1003 /// Get a payment preimage and hash.
1005 macro_rules! get_payment_preimage_hash {
1006 ($dest_node: expr) => {
1008 get_payment_preimage_hash!($dest_node, None)
1011 ($dest_node: expr, $min_value_msat: expr) => {
1013 use bitcoin::hashes::Hash as _;
1014 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1015 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1016 *payment_count += 1;
1017 let payment_hash = $crate::ln::PaymentHash(
1018 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1019 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1020 (payment_preimage, payment_hash, payment_secret)
1027 macro_rules! get_route_and_payment_hash {
1028 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1029 $crate::get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
1031 ($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
1032 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1033 let payee = $crate::routing::router::Payee::from_node_id($recv_node.node.get_our_node_id())
1034 .with_features($crate::ln::features::InvoiceFeatures::known())
1035 .with_route_hints($last_hops);
1036 let scorer = $crate::util::test_utils::TestScorer::with_fixed_penalty(0);
1037 let route = $crate::routing::router::get_route(
1038 &$send_node.node.get_our_node_id(), &payee, $send_node.network_graph,
1039 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1040 $recv_value, $cltv, $send_node.logger, &scorer
1042 (route, payment_hash, payment_preimage, payment_secret)
1046 macro_rules! expect_pending_htlcs_forwardable_ignore {
1048 let events = $node.node.get_and_clear_pending_events();
1049 assert_eq!(events.len(), 1);
1051 Event::PendingHTLCsForwardable { .. } => { },
1052 _ => panic!("Unexpected event"),
1057 macro_rules! expect_pending_htlcs_forwardable {
1059 expect_pending_htlcs_forwardable_ignore!($node);
1060 $node.node.process_pending_htlc_forwards();
1065 macro_rules! expect_pending_htlcs_forwardable_from_events {
1066 ($node: expr, $events: expr, $ignore: expr) => {{
1067 assert_eq!($events.len(), 1);
1069 Event::PendingHTLCsForwardable { .. } => { },
1070 _ => panic!("Unexpected event"),
1073 $node.node.process_pending_htlc_forwards();
1078 #[cfg(any(test, feature = "unstable"))]
1079 macro_rules! expect_payment_received {
1080 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1081 let events = $node.node.get_and_clear_pending_events();
1082 assert_eq!(events.len(), 1);
1084 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1085 assert_eq!($expected_payment_hash, *payment_hash);
1086 assert_eq!($expected_recv_value, amt);
1088 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1089 assert!(payment_preimage.is_none());
1090 assert_eq!($expected_payment_secret, *payment_secret);
1095 _ => panic!("Unexpected event"),
1102 macro_rules! expect_payment_sent_without_paths {
1103 ($node: expr, $expected_payment_preimage: expr) => {
1104 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1106 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1107 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1112 macro_rules! expect_payment_sent {
1113 ($node: expr, $expected_payment_preimage: expr) => {
1114 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1116 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1117 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1119 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1120 use bitcoin::hashes::Hash as _;
1121 let events = $node.node.get_and_clear_pending_events();
1122 let expected_payment_hash = $crate::ln::PaymentHash(
1123 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1125 assert!(events.len() > 1);
1127 assert_eq!(events.len(), 1);
1129 let expected_payment_id = match events[0] {
1130 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1131 assert_eq!($expected_payment_preimage, *payment_preimage);
1132 assert_eq!(expected_payment_hash, *payment_hash);
1133 assert!(fee_paid_msat.is_some());
1134 if $expected_fee_msat_opt.is_some() {
1135 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1139 _ => panic!("Unexpected event"),
1142 for i in 1..events.len() {
1144 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1145 assert_eq!(payment_id, expected_payment_id);
1146 assert_eq!(payment_hash, Some(expected_payment_hash));
1148 _ => panic!("Unexpected event"),
1157 macro_rules! expect_payment_path_successful {
1159 let events = $node.node.get_and_clear_pending_events();
1160 assert_eq!(events.len(), 1);
1162 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1163 _ => panic!("Unexpected event"),
1168 macro_rules! expect_payment_forwarded {
1169 ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1170 let events = $node.node.get_and_clear_pending_events();
1171 assert_eq!(events.len(), 1);
1173 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1174 assert_eq!(fee_earned_msat, $expected_fee);
1175 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1177 _ => panic!("Unexpected event"),
1183 macro_rules! expect_payment_failed_with_update {
1184 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1185 let events = $node.node.get_and_clear_pending_events();
1186 assert_eq!(events.len(), 1);
1188 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref network_update, ref error_code, ref error_data, ref path, ref retry, .. } => {
1189 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1190 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1191 assert!(retry.is_some(), "expected retry.is_some()");
1192 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1193 assert_eq!(retry.as_ref().unwrap().payee.pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1194 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1195 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1196 match network_update {
1197 &Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !$chan_closed => {
1198 assert_eq!(msg.contents.short_channel_id, $scid);
1199 assert_eq!(msg.contents.flags & 2, 0);
1201 &Some(NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if $chan_closed => {
1202 assert_eq!(short_channel_id, $scid);
1203 assert!(is_permanent);
1205 Some(_) => panic!("Unexpected update type"),
1206 None => panic!("Expected update"),
1209 _ => panic!("Unexpected event"),
1215 macro_rules! expect_payment_failed {
1216 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1217 let events = $node.node.get_and_clear_pending_events();
1218 assert_eq!(events.len(), 1);
1220 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, network_update: _, ref error_code, ref error_data, ref path, ref retry, .. } => {
1221 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1222 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1223 assert!(retry.is_some(), "expected retry.is_some()");
1224 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1225 assert_eq!(retry.as_ref().unwrap().payee.pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1226 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1227 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1229 assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
1230 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
1233 _ => panic!("Unexpected event"),
1238 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 {
1239 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1240 check_added_monitors!(origin_node, expected_paths.len());
1241 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1245 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>) {
1246 let mut payment_event = SendEvent::from_event(ev);
1247 let mut prev_node = origin_node;
1249 for (idx, &node) in expected_path.iter().enumerate() {
1250 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1252 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1253 check_added_monitors!(node, 0);
1254 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1256 expect_pending_htlcs_forwardable!(node);
1258 if idx == expected_path.len() - 1 {
1259 let events_2 = node.node.get_and_clear_pending_events();
1260 if payment_received_expected {
1261 assert_eq!(events_2.len(), 1);
1263 Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1264 assert_eq!(our_payment_hash, *payment_hash);
1266 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1267 assert_eq!(expected_preimage, *payment_preimage);
1268 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1270 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1271 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1272 assert!(our_payment_secret.is_none());
1275 assert_eq!(amt, recv_value);
1277 _ => panic!("Unexpected event"),
1280 assert!(events_2.is_empty());
1283 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1284 assert_eq!(events_2.len(), 1);
1285 check_added_monitors!(node, 1);
1286 payment_event = SendEvent::from_event(events_2.remove(0));
1287 assert_eq!(payment_event.msgs.len(), 1);
1294 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) {
1295 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1296 assert_eq!(events.len(), expected_route.len());
1297 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1298 // Once we've gotten through all the HTLCs, the last one should result in a
1299 // PaymentReceived (but each previous one should not!), .
1300 let expect_payment = path_idx == expected_route.len() - 1;
1301 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1305 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) {
1306 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1307 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1308 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1311 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 {
1312 for path in expected_paths.iter() {
1313 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1315 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1316 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1318 let mut expected_total_fee_msat = 0;
1320 macro_rules! msgs_from_ev {
1323 &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 } } => {
1324 assert!(update_add_htlcs.is_empty());
1325 assert_eq!(update_fulfill_htlcs.len(), 1);
1326 assert!(update_fail_htlcs.is_empty());
1327 assert!(update_fail_malformed_htlcs.is_empty());
1328 assert!(update_fee.is_none());
1329 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1331 _ => panic!("Unexpected event"),
1335 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1336 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1337 assert_eq!(events.len(), expected_paths.len());
1338 for ev in events.iter() {
1339 per_path_msgs.push(msgs_from_ev!(ev));
1342 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1343 let mut next_msgs = Some(path_msgs);
1344 let mut expected_next_node = next_hop;
1346 macro_rules! last_update_fulfill_dance {
1347 ($node: expr, $prev_node: expr) => {
1349 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1350 check_added_monitors!($node, 0);
1351 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1352 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1356 macro_rules! mid_update_fulfill_dance {
1357 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1359 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1360 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;
1361 expect_payment_forwarded!($node, Some(fee as u64), false);
1362 expected_total_fee_msat += fee as u64;
1363 check_added_monitors!($node, 1);
1364 let new_next_msgs = if $new_msgs {
1365 let events = $node.node.get_and_clear_pending_msg_events();
1366 assert_eq!(events.len(), 1);
1367 let (res, nexthop) = msgs_from_ev!(&events[0]);
1368 expected_next_node = nexthop;
1371 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1374 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1375 next_msgs = new_next_msgs;
1380 let mut prev_node = expected_route.last().unwrap();
1381 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1382 assert_eq!(expected_next_node, node.node.get_our_node_id());
1383 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1384 if next_msgs.is_some() {
1385 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1387 assert!(!update_next_msgs);
1388 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1390 if !skip_last && idx == expected_route.len() - 1 {
1391 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1398 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1401 expected_total_fee_msat
1403 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) {
1404 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1406 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1410 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1411 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1414 pub const TEST_FINAL_CLTV: u32 = 70;
1416 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) {
1417 let payee = Payee::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1418 .with_features(InvoiceFeatures::known());
1419 let scorer = test_utils::TestScorer::with_fixed_penalty(0);
1420 let route = get_route(
1421 &origin_node.node.get_our_node_id(), &payee, &origin_node.network_graph,
1422 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1423 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 res = send_along_route(origin_node, route, expected_route, recv_value);
1431 (res.0, res.1, res.2)
1434 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1435 let payee = Payee::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1436 .with_features(InvoiceFeatures::known());
1437 let scorer = test_utils::TestScorer::with_fixed_penalty(0);
1438 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();
1439 assert_eq!(route.paths.len(), 1);
1440 assert_eq!(route.paths[0].len(), expected_route.len());
1441 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1442 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1445 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1446 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1447 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1450 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1451 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1452 claim_payment(&origin, expected_route, our_payment_preimage);
1455 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) {
1456 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1457 for path in expected_paths.iter() {
1458 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1460 assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1461 expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1462 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1464 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1465 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1466 assert_eq!(events.len(), expected_paths.len());
1467 for ev in events.iter() {
1468 let (update_fail, commitment_signed, node_id) = match ev {
1469 &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 } } => {
1470 assert!(update_add_htlcs.is_empty());
1471 assert!(update_fulfill_htlcs.is_empty());
1472 assert_eq!(update_fail_htlcs.len(), 1);
1473 assert!(update_fail_malformed_htlcs.is_empty());
1474 assert!(update_fee.is_none());
1475 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1477 _ => panic!("Unexpected event"),
1479 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1481 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1482 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()));
1484 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1485 let mut next_msgs = Some(path_msgs);
1486 let mut expected_next_node = next_hop;
1487 let mut prev_node = expected_route.last().unwrap();
1489 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1490 assert_eq!(expected_next_node, node.node.get_our_node_id());
1491 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1492 if next_msgs.is_some() {
1493 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1494 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1495 if !update_next_node {
1496 expect_pending_htlcs_forwardable!(node);
1499 let events = node.node.get_and_clear_pending_msg_events();
1500 if update_next_node {
1501 assert_eq!(events.len(), 1);
1503 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 } } => {
1504 assert!(update_add_htlcs.is_empty());
1505 assert!(update_fulfill_htlcs.is_empty());
1506 assert_eq!(update_fail_htlcs.len(), 1);
1507 assert!(update_fail_malformed_htlcs.is_empty());
1508 assert!(update_fee.is_none());
1509 expected_next_node = node_id.clone();
1510 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1512 _ => panic!("Unexpected event"),
1515 assert!(events.is_empty());
1517 if !skip_last && idx == expected_route.len() - 1 {
1518 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1525 let prev_node = expected_route.first().unwrap();
1526 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1527 check_added_monitors!(origin_node, 0);
1528 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1529 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1530 let events = origin_node.node.get_and_clear_pending_events();
1531 assert_eq!(events.len(), 1);
1533 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, .. } => {
1534 assert_eq!(payment_hash, our_payment_hash);
1535 assert!(rejected_by_dest);
1536 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1537 for (idx, hop) in expected_route.iter().enumerate() {
1538 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1541 _ => panic!("Unexpected event"),
1547 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1548 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1551 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1552 let mut chan_mon_cfgs = Vec::new();
1553 for i in 0..node_count {
1554 let tx_broadcaster = test_utils::TestBroadcaster {
1555 txn_broadcasted: Mutex::new(Vec::new()),
1556 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1558 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1559 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1560 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1561 let persister = test_utils::TestPersister::new();
1562 let seed = [i as u8; 32];
1563 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1564 let network_graph = NetworkGraph::new(chain_source.genesis_hash);
1566 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, network_graph });
1572 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1573 let mut nodes = Vec::new();
1575 for i in 0..node_count {
1576 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);
1577 let seed = [i as u8; 32];
1578 nodes.push(NodeCfg {
1579 chain_source: &chanmon_cfgs[i].chain_source,
1580 logger: &chanmon_cfgs[i].logger,
1581 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1582 fee_estimator: &chanmon_cfgs[i].fee_estimator,
1584 keys_manager: &chanmon_cfgs[i].keys_manager,
1586 features: InitFeatures::known(),
1587 network_graph: &chanmon_cfgs[i].network_graph,
1594 pub fn test_default_channel_config() -> UserConfig {
1595 let mut default_config = UserConfig::default();
1596 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1597 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1598 default_config.channel_options.cltv_expiry_delta = 6*6;
1599 default_config.channel_options.announced_channel = true;
1600 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1601 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1602 // It now defaults to 1, so we simply set it to the expected value here.
1603 default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1604 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1605 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1606 default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1610 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>> {
1611 let mut chanmgrs = Vec::new();
1612 for i in 0..node_count {
1613 let network = Network::Testnet;
1614 let params = ChainParameters {
1616 best_block: BestBlock::from_genesis(network),
1618 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1619 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1620 chanmgrs.push(node);
1626 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>> {
1627 let mut nodes = Vec::new();
1628 let chan_count = Rc::new(RefCell::new(0));
1629 let payment_count = Rc::new(RefCell::new(0));
1630 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1632 for i in 0..node_count {
1633 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].network_graph, None, cfgs[i].logger);
1635 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
1636 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
1637 node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, net_graph_msg_handler,
1638 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1639 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1640 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1641 connect_style: Rc::clone(&connect_style),
1645 for i in 0..node_count {
1646 for j in (i+1)..node_count {
1647 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1648 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1655 // Note that the following only works for CLTV values up to 128
1656 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1657 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1659 #[derive(PartialEq)]
1660 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1661 /// Tests that the given node has broadcast transactions for the given Channel
1663 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1664 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1665 /// broadcast and the revoked outputs were claimed.
1667 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1668 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1670 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1672 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> {
1673 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1674 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1676 let mut res = Vec::with_capacity(2);
1677 node_txn.retain(|tx| {
1678 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1679 check_spends!(tx, chan.3);
1680 if commitment_tx.is_none() {
1681 res.push(tx.clone());
1686 if let Some(explicit_tx) = commitment_tx {
1687 res.push(explicit_tx.clone());
1690 assert_eq!(res.len(), 1);
1692 if has_htlc_tx != HTLCType::NONE {
1693 node_txn.retain(|tx| {
1694 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1695 check_spends!(tx, res[0]);
1696 if has_htlc_tx == HTLCType::TIMEOUT {
1697 assert!(tx.lock_time != 0);
1699 assert!(tx.lock_time == 0);
1701 res.push(tx.clone());
1705 assert!(res.len() == 2 || res.len() == 3);
1707 assert_eq!(res[1], res[2]);
1711 assert!(node_txn.is_empty());
1715 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1716 /// HTLC transaction.
1717 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1718 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1719 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1720 // for revoked htlc outputs
1721 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1722 node_txn.retain(|tx| {
1723 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1724 check_spends!(tx, revoked_tx);
1728 node_txn.retain(|tx| {
1729 check_spends!(tx, commitment_revoked_tx);
1732 assert!(node_txn.is_empty());
1735 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1736 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1738 assert!(node_txn.len() >= 1);
1739 assert_eq!(node_txn[0].input.len(), 1);
1740 let mut found_prev = false;
1742 for tx in prev_txn {
1743 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1744 check_spends!(node_txn[0], tx);
1745 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1746 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1752 assert!(found_prev);
1754 let mut res = Vec::new();
1755 mem::swap(&mut *node_txn, &mut res);
1759 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) {
1760 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1761 assert_eq!(events_1.len(), 2);
1762 let as_update = match events_1[0] {
1763 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1766 _ => panic!("Unexpected event"),
1769 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1770 assert_eq!(node_id, nodes[b].node.get_our_node_id());
1771 assert_eq!(msg.data, expected_error);
1772 if needs_err_handle {
1773 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1776 _ => panic!("Unexpected event"),
1779 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1780 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1781 let bs_update = match events_2[0] {
1782 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1785 _ => panic!("Unexpected event"),
1787 if !needs_err_handle {
1789 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1790 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1791 assert_eq!(msg.data, expected_error);
1793 _ => panic!("Unexpected event"),
1798 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1799 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1803 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1804 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
1808 macro_rules! get_channel_value_stat {
1809 ($node: expr, $channel_id: expr) => {{
1810 let chan_lock = $node.node.channel_state.lock().unwrap();
1811 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1812 chan.get_value_stat()
1816 macro_rules! get_chan_reestablish_msgs {
1817 ($src_node: expr, $dst_node: expr) => {
1819 let mut res = Vec::with_capacity(1);
1820 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1821 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1822 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1823 res.push(msg.clone());
1825 panic!("Unexpected event")
1833 macro_rules! handle_chan_reestablish_msgs {
1834 ($src_node: expr, $dst_node: expr) => {
1836 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1838 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1840 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1846 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
1848 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1851 let mut revoke_and_ack = None;
1852 let mut commitment_update = None;
1853 let order = if let Some(ev) = msg_events.get(idx) {
1855 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1856 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1857 revoke_and_ack = Some(msg.clone());
1859 RAACommitmentOrder::RevokeAndACKFirst
1861 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1862 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1863 commitment_update = Some(updates.clone());
1865 RAACommitmentOrder::CommitmentFirst
1867 &MessageSendEvent::SendChannelUpdate { .. } => RAACommitmentOrder::CommitmentFirst,
1868 _ => panic!("Unexpected event"),
1871 RAACommitmentOrder::CommitmentFirst
1874 if let Some(ev) = msg_events.get(idx) {
1876 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1877 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1878 assert!(revoke_and_ack.is_none());
1879 revoke_and_ack = Some(msg.clone());
1882 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1883 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1884 assert!(commitment_update.is_none());
1885 commitment_update = Some(updates.clone());
1888 &MessageSendEvent::SendChannelUpdate { .. } => {},
1889 _ => panic!("Unexpected event"),
1893 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
1894 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1895 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1898 (funding_locked, revoke_and_ack, commitment_update, order)
1903 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1904 /// for claims/fails they are separated out.
1905 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)) {
1906 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1907 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1908 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1909 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1911 if send_funding_locked.0 {
1912 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1914 for reestablish in reestablish_1.iter() {
1915 assert_eq!(reestablish.next_remote_commitment_number, 0);
1918 if send_funding_locked.1 {
1919 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1921 for reestablish in reestablish_2.iter() {
1922 assert_eq!(reestablish.next_remote_commitment_number, 0);
1925 if send_funding_locked.0 || send_funding_locked.1 {
1926 // If we expect any funding_locked's, both sides better have set
1927 // next_holder_commitment_number to 1
1928 for reestablish in reestablish_1.iter() {
1929 assert_eq!(reestablish.next_local_commitment_number, 1);
1931 for reestablish in reestablish_2.iter() {
1932 assert_eq!(reestablish.next_local_commitment_number, 1);
1936 let mut resp_1 = Vec::new();
1937 for msg in reestablish_1 {
1938 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1939 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1941 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1942 check_added_monitors!(node_b, 1);
1944 check_added_monitors!(node_b, 0);
1947 let mut resp_2 = Vec::new();
1948 for msg in reestablish_2 {
1949 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1950 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1952 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1953 check_added_monitors!(node_a, 1);
1955 check_added_monitors!(node_a, 0);
1958 // We don't yet support both needing updates, as that would require a different commitment dance:
1959 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
1960 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1961 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
1962 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1964 for chan_msgs in resp_1.drain(..) {
1965 if send_funding_locked.0 {
1966 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1967 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1968 if !announcement_event.is_empty() {
1969 assert_eq!(announcement_event.len(), 1);
1970 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1971 //TODO: Test announcement_sigs re-sending
1972 } else { panic!("Unexpected event!"); }
1975 assert!(chan_msgs.0.is_none());
1978 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1979 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1980 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1981 check_added_monitors!(node_a, 1);
1983 assert!(chan_msgs.1.is_none());
1985 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 {
1986 let commitment_update = chan_msgs.2.unwrap();
1987 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1988 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1990 assert!(commitment_update.update_add_htlcs.is_empty());
1992 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1993 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
1994 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1995 for update_add in commitment_update.update_add_htlcs {
1996 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1998 for update_fulfill in commitment_update.update_fulfill_htlcs {
1999 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2001 for update_fail in commitment_update.update_fail_htlcs {
2002 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2005 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2006 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2008 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2009 check_added_monitors!(node_a, 1);
2010 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2011 // No commitment_signed so get_event_msg's assert(len == 1) passes
2012 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2013 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2014 check_added_monitors!(node_b, 1);
2017 assert!(chan_msgs.2.is_none());
2021 for chan_msgs in resp_2.drain(..) {
2022 if send_funding_locked.1 {
2023 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2024 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2025 if !announcement_event.is_empty() {
2026 assert_eq!(announcement_event.len(), 1);
2027 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
2028 //TODO: Test announcement_sigs re-sending
2029 } else { panic!("Unexpected event!"); }
2032 assert!(chan_msgs.0.is_none());
2035 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2036 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2037 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2038 check_added_monitors!(node_b, 1);
2040 assert!(chan_msgs.1.is_none());
2042 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 {
2043 let commitment_update = chan_msgs.2.unwrap();
2044 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2045 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2047 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2048 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2049 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2050 for update_add in commitment_update.update_add_htlcs {
2051 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2053 for update_fulfill in commitment_update.update_fulfill_htlcs {
2054 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2056 for update_fail in commitment_update.update_fail_htlcs {
2057 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2060 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2061 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2063 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2064 check_added_monitors!(node_b, 1);
2065 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2066 // No commitment_signed so get_event_msg's assert(len == 1) passes
2067 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2068 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2069 check_added_monitors!(node_a, 1);
2072 assert!(chan_msgs.2.is_none());