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 /// Gets an RAA and CS which were sent in response to a commitment update
340 macro_rules! get_revoke_commit_msgs {
341 ($node: expr, $node_id: expr) => {
343 use $crate::util::events::MessageSendEvent;
344 let events = $node.node.get_and_clear_pending_msg_events();
345 assert_eq!(events.len(), 2);
347 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
348 assert_eq!(*node_id, $node_id);
351 _ => panic!("Unexpected event"),
353 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
354 assert_eq!(*node_id, $node_id);
355 assert!(updates.update_add_htlcs.is_empty());
356 assert!(updates.update_fulfill_htlcs.is_empty());
357 assert!(updates.update_fail_htlcs.is_empty());
358 assert!(updates.update_fail_malformed_htlcs.is_empty());
359 assert!(updates.update_fee.is_none());
360 updates.commitment_signed.clone()
362 _ => panic!("Unexpected event"),
368 /// Get an specific event message from the pending events queue.
370 macro_rules! get_event_msg {
371 ($node: expr, $event_type: path, $node_id: expr) => {
373 let events = $node.node.get_and_clear_pending_msg_events();
374 assert_eq!(events.len(), 1);
376 $event_type { ref node_id, ref msg } => {
377 assert_eq!(*node_id, $node_id);
380 _ => panic!("Unexpected event"),
386 /// Get a specific event from the pending events queue.
388 macro_rules! get_event {
389 ($node: expr, $event_type: path) => {
391 let mut events = $node.node.get_and_clear_pending_events();
392 assert_eq!(events.len(), 1);
393 let ev = events.pop().unwrap();
395 $event_type { .. } => {
398 _ => panic!("Unexpected event"),
405 /// Gets an UpdateHTLCs MessageSendEvent
406 macro_rules! get_htlc_update_msgs {
407 ($node: expr, $node_id: expr) => {
409 let events = $node.node.get_and_clear_pending_msg_events();
410 assert_eq!(events.len(), 1);
412 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
413 assert_eq!(*node_id, $node_id);
416 _ => panic!("Unexpected event"),
423 macro_rules! get_channel_ref {
424 ($node: expr, $lock: ident, $channel_id: expr) => {
426 $lock = $node.node.channel_state.lock().unwrap();
427 $lock.by_id.get_mut(&$channel_id).unwrap()
433 macro_rules! get_feerate {
434 ($node: expr, $channel_id: expr) => {
437 let chan = get_channel_ref!($node, lock, $channel_id);
443 /// Returns a channel monitor given a channel id, making some naive assumptions
445 macro_rules! get_monitor {
446 ($node: expr, $channel_id: expr) => {
448 use bitcoin::hashes::Hash;
449 let mut monitor = None;
450 // Assume funding vout is either 0 or 1 blindly
452 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
453 $crate::chain::transaction::OutPoint {
454 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
466 /// Returns any local commitment transactions for the channel.
468 macro_rules! get_local_commitment_txn {
469 ($node: expr, $channel_id: expr) => {
471 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
476 /// Check the error from attempting a payment.
478 macro_rules! unwrap_send_err {
479 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
481 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
482 assert_eq!(fails.len(), 1);
488 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
489 assert_eq!(results.len(), 1);
491 Err($type) => { $check },
500 /// Check whether N channel monitor(s) have been added.
502 macro_rules! check_added_monitors {
503 ($node: expr, $count: expr) => {
505 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
506 assert_eq!(added_monitors.len(), $count);
507 added_monitors.clear();
512 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) {
513 let chan_id = *node.network_chan_count.borrow();
515 let events = node.node.get_and_clear_pending_events();
516 assert_eq!(events.len(), 1);
518 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
519 assert_eq!(*channel_value_satoshis, expected_chan_value);
520 assert_eq!(user_channel_id, expected_user_chan_id);
522 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
523 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
525 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
526 (*temporary_channel_id, tx, funding_outpoint)
528 _ => panic!("Unexpected event"),
531 pub fn sign_funding_transaction<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, channel_value: u64, expected_temporary_channel_id: [u8; 32]) -> Transaction {
532 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
533 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
535 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_ok());
536 check_added_monitors!(node_a, 0);
538 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
539 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
540 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
542 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
543 assert_eq!(added_monitors.len(), 1);
544 assert_eq!(added_monitors[0].0, funding_output);
545 added_monitors.clear();
548 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()));
550 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
551 assert_eq!(added_monitors.len(), 1);
552 assert_eq!(added_monitors[0].0, funding_output);
553 added_monitors.clear();
556 let events_4 = node_a.node.get_and_clear_pending_events();
557 assert_eq!(events_4.len(), 0);
559 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
560 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
561 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
563 // Ensure that funding_transaction_generated is idempotent.
564 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_err());
565 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
566 check_added_monitors!(node_a, 0);
571 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 {
572 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
573 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
574 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
575 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
576 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
577 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
578 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
580 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
583 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) {
584 confirm_transaction_at(node_conf, tx, conf_height);
585 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
586 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()));
589 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]) {
591 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
592 assert_eq!(events_6.len(), 2);
593 ((match events_6[0] {
594 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
595 channel_id = msg.channel_id.clone();
596 assert_eq!(*node_id, node_recv.node.get_our_node_id());
599 _ => panic!("Unexpected event"),
600 }, match events_6[1] {
601 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
602 assert_eq!(*node_id, node_recv.node.get_our_node_id());
605 _ => panic!("Unexpected event"),
609 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]) {
610 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
611 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
612 confirm_transaction_at(node_a, tx, conf_height);
613 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
614 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
617 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) {
618 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
619 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
623 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) {
624 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
625 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
626 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
628 let events_7 = node_b.node.get_and_clear_pending_msg_events();
629 assert_eq!(events_7.len(), 1);
630 let (announcement, bs_update) = match events_7[0] {
631 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
634 _ => panic!("Unexpected event"),
637 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
638 let events_8 = node_a.node.get_and_clear_pending_msg_events();
639 assert_eq!(events_8.len(), 1);
640 let as_update = match events_8[0] {
641 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
642 assert!(*announcement == *msg);
643 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
644 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
647 _ => panic!("Unexpected event"),
650 *node_a.network_chan_count.borrow_mut() += 1;
652 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
655 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) {
656 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
659 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) {
660 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
661 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
662 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
665 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) {
666 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
667 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
668 assert!(a_events.len() >= 2);
670 // ann should be re-generated by broadcast_node_announcement - check that we have it.
671 let mut found_ann_1 = false;
672 for event in a_events.iter() {
674 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
675 if msg == ann { found_ann_1 = true; }
677 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
678 _ => panic!("Unexpected event {:?}", event),
681 assert!(found_ann_1);
683 let a_node_announcement = match a_events.last().unwrap() {
684 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
687 _ => panic!("Unexpected event"),
690 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
691 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
692 assert!(b_events.len() >= 2);
694 // ann should be re-generated by broadcast_node_announcement - check that we have it.
695 let mut found_ann_2 = false;
696 for event in b_events.iter() {
698 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
699 if msg == ann { found_ann_2 = true; }
701 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
702 _ => panic!("Unexpected event"),
705 assert!(found_ann_2);
707 let b_node_announcement = match b_events.last().unwrap() {
708 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
711 _ => panic!("Unexpected event"),
715 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
716 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
717 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
718 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
719 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
724 macro_rules! check_spends {
725 ($tx: expr, $($spends_txn: expr),*) => {
728 for outp in $spends_txn.output.iter() {
729 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Input tx output didn't meet dust limit");
732 for outp in $tx.output.iter() {
733 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Spending tx output didn't meet dust limit");
735 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
737 if out_point.txid == $spends_txn.txid() {
738 return $spends_txn.output.get(out_point.vout as usize).cloned()
743 let mut total_value_in = 0;
744 for input in $tx.input.iter() {
745 total_value_in += get_output(&input.previous_output).unwrap().value;
747 let mut total_value_out = 0;
748 for output in $tx.output.iter() {
749 total_value_out += output.value;
751 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
752 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
753 assert!(total_value_out + min_fee <= total_value_in);
754 $tx.verify(get_output).unwrap();
759 macro_rules! get_closing_signed_broadcast {
760 ($node: expr, $dest_pubkey: expr) => {
762 let events = $node.get_and_clear_pending_msg_events();
763 assert!(events.len() == 1 || events.len() == 2);
764 (match events[events.len() - 1] {
765 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
766 assert_eq!(msg.contents.flags & 2, 2);
769 _ => panic!("Unexpected event"),
770 }, if events.len() == 2 {
772 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
773 assert_eq!(*node_id, $dest_pubkey);
776 _ => panic!("Unexpected event"),
783 /// Check that a channel's closing channel update has been broadcasted, and optionally
784 /// check whether an error message event has occurred.
786 macro_rules! check_closed_broadcast {
787 ($node: expr, $with_error_msg: expr) => {{
788 use $crate::util::events::MessageSendEvent;
789 use $crate::ln::msgs::ErrorAction;
791 let msg_events = $node.node.get_and_clear_pending_msg_events();
792 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
793 match msg_events[0] {
794 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
795 assert_eq!(msg.contents.flags & 2, 2);
797 _ => panic!("Unexpected event"),
800 match msg_events[1] {
801 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
802 // TODO: Check node_id
805 _ => panic!("Unexpected event"),
811 /// Check that a channel's closing channel events has been issued
813 macro_rules! check_closed_event {
814 ($node: expr, $events: expr, $reason: expr) => {
815 check_closed_event!($node, $events, $reason, false);
817 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
818 use $crate::util::events::Event;
820 let events = $node.node.get_and_clear_pending_events();
821 assert_eq!(events.len(), $events);
822 let expected_reason = $reason;
823 let mut issues_discard_funding = false;
824 for event in events {
826 Event::ChannelClosed { ref reason, .. } => {
827 assert_eq!(*reason, expected_reason);
829 Event::DiscardFunding { .. } => {
830 issues_discard_funding = true;
832 _ => panic!("Unexpected event"),
835 assert_eq!($is_check_discard_funding, issues_discard_funding);
839 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) {
840 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) };
841 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) };
844 node_a.close_channel(channel_id).unwrap();
845 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()));
847 let events_1 = node_b.get_and_clear_pending_msg_events();
848 assert!(events_1.len() >= 1);
849 let shutdown_b = match events_1[0] {
850 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
851 assert_eq!(node_id, &node_a.get_our_node_id());
854 _ => panic!("Unexpected event"),
857 let closing_signed_b = if !close_inbound_first {
858 assert_eq!(events_1.len(), 1);
861 Some(match events_1[1] {
862 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
863 assert_eq!(node_id, &node_a.get_our_node_id());
866 _ => panic!("Unexpected event"),
870 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
871 let (as_update, bs_update) = if close_inbound_first {
872 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
873 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
875 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
876 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
877 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
878 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
880 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
881 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
882 assert!(none_a.is_none());
883 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
884 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
885 (as_update, bs_update)
887 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
889 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
890 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
892 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
893 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
894 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
896 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
897 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
898 assert!(none_b.is_none());
899 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
900 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
901 (as_update, bs_update)
903 assert_eq!(tx_a, tx_b);
904 check_spends!(tx_a, funding_tx);
906 (as_update, bs_update, tx_a)
909 pub struct SendEvent {
910 pub node_id: PublicKey,
911 pub msgs: Vec<msgs::UpdateAddHTLC>,
912 pub commitment_msg: msgs::CommitmentSigned,
915 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
916 assert!(updates.update_fulfill_htlcs.is_empty());
917 assert!(updates.update_fail_htlcs.is_empty());
918 assert!(updates.update_fail_malformed_htlcs.is_empty());
919 assert!(updates.update_fee.is_none());
920 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
923 pub fn from_event(event: MessageSendEvent) -> SendEvent {
925 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
926 _ => panic!("Unexpected event type!"),
930 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
931 let mut events = node.node.get_and_clear_pending_msg_events();
932 assert_eq!(events.len(), 1);
933 SendEvent::from_event(events.pop().unwrap())
938 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
939 /// commitment update.
940 macro_rules! commitment_signed_dance {
941 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
943 check_added_monitors!($node_a, 0);
944 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
945 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
946 check_added_monitors!($node_a, 1);
947 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
950 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
952 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
953 check_added_monitors!($node_b, 0);
954 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
955 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
956 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
957 check_added_monitors!($node_b, 1);
958 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
959 let (bs_revoke_and_ack, extra_msg_option) = {
960 let events = $node_b.node.get_and_clear_pending_msg_events();
961 assert!(events.len() <= 2);
963 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
964 assert_eq!(*node_id, $node_a.node.get_our_node_id());
967 _ => panic!("Unexpected event"),
968 }, events.get(1).map(|e| e.clone()))
970 check_added_monitors!($node_b, 1);
972 assert!($node_a.node.get_and_clear_pending_events().is_empty());
973 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
975 (extra_msg_option, bs_revoke_and_ack)
978 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
980 check_added_monitors!($node_a, 0);
981 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
982 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
983 check_added_monitors!($node_a, 1);
984 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
985 assert!(extra_msg_option.is_none());
989 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
991 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
992 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
993 check_added_monitors!($node_a, 1);
997 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
999 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1002 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1004 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1005 if $fail_backwards {
1006 $crate::expect_pending_htlcs_forwardable!($node_a);
1007 check_added_monitors!($node_a, 1);
1009 let channel_state = $node_a.node.channel_state.lock().unwrap();
1010 assert_eq!(channel_state.pending_msg_events.len(), 1);
1011 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1012 assert_ne!(*node_id, $node_b.node.get_our_node_id());
1013 } else { panic!("Unexpected event"); }
1015 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1021 /// Get a payment preimage and hash.
1023 macro_rules! get_payment_preimage_hash {
1024 ($dest_node: expr) => {
1026 get_payment_preimage_hash!($dest_node, None)
1029 ($dest_node: expr, $min_value_msat: expr) => {
1031 use bitcoin::hashes::Hash as _;
1032 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1033 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1034 *payment_count += 1;
1035 let payment_hash = $crate::ln::PaymentHash(
1036 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1037 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1038 (payment_preimage, payment_hash, payment_secret)
1045 macro_rules! get_route_and_payment_hash {
1046 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1047 $crate::get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
1049 ($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
1050 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1051 let payee = $crate::routing::router::Payee::from_node_id($recv_node.node.get_our_node_id())
1052 .with_features($crate::ln::features::InvoiceFeatures::known())
1053 .with_route_hints($last_hops);
1054 let scorer = $crate::util::test_utils::TestScorer::with_fixed_penalty(0);
1055 let route = $crate::routing::router::get_route(
1056 &$send_node.node.get_our_node_id(), &payee, $send_node.network_graph,
1057 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1058 $recv_value, $cltv, $send_node.logger, &scorer
1060 (route, payment_hash, payment_preimage, payment_secret)
1065 /// Clears (and ignores) a PendingHTLCsForwardable event
1066 macro_rules! expect_pending_htlcs_forwardable_ignore {
1068 let events = $node.node.get_and_clear_pending_events();
1069 assert_eq!(events.len(), 1);
1071 Event::PendingHTLCsForwardable { .. } => { },
1072 _ => panic!("Unexpected event"),
1078 /// Handles a PendingHTLCsForwardable event
1079 macro_rules! expect_pending_htlcs_forwardable {
1081 $crate::expect_pending_htlcs_forwardable_ignore!($node);
1082 $node.node.process_pending_htlc_forwards();
1084 // Ensure process_pending_htlc_forwards is idempotent.
1085 $node.node.process_pending_htlc_forwards();
1090 macro_rules! expect_pending_htlcs_forwardable_from_events {
1091 ($node: expr, $events: expr, $ignore: expr) => {{
1092 assert_eq!($events.len(), 1);
1094 Event::PendingHTLCsForwardable { .. } => { },
1095 _ => panic!("Unexpected event"),
1098 $node.node.process_pending_htlc_forwards();
1100 // Ensure process_pending_htlc_forwards is idempotent.
1101 $node.node.process_pending_htlc_forwards();
1106 #[cfg(any(test, feature = "unstable"))]
1107 macro_rules! expect_payment_received {
1108 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1109 let events = $node.node.get_and_clear_pending_events();
1110 assert_eq!(events.len(), 1);
1112 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1113 assert_eq!($expected_payment_hash, *payment_hash);
1114 assert_eq!($expected_recv_value, amt);
1116 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1117 assert!(payment_preimage.is_none());
1118 assert_eq!($expected_payment_secret, *payment_secret);
1123 _ => panic!("Unexpected event"),
1130 macro_rules! expect_payment_sent_without_paths {
1131 ($node: expr, $expected_payment_preimage: expr) => {
1132 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1134 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1135 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1140 macro_rules! expect_payment_sent {
1141 ($node: expr, $expected_payment_preimage: expr) => {
1142 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1144 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1145 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1147 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1148 use bitcoin::hashes::Hash as _;
1149 let events = $node.node.get_and_clear_pending_events();
1150 let expected_payment_hash = $crate::ln::PaymentHash(
1151 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1153 assert!(events.len() > 1);
1155 assert_eq!(events.len(), 1);
1157 let expected_payment_id = match events[0] {
1158 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1159 assert_eq!($expected_payment_preimage, *payment_preimage);
1160 assert_eq!(expected_payment_hash, *payment_hash);
1161 assert!(fee_paid_msat.is_some());
1162 if $expected_fee_msat_opt.is_some() {
1163 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1167 _ => panic!("Unexpected event"),
1170 for i in 1..events.len() {
1172 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1173 assert_eq!(payment_id, expected_payment_id);
1174 assert_eq!(payment_hash, Some(expected_payment_hash));
1176 _ => panic!("Unexpected event"),
1185 macro_rules! expect_payment_path_successful {
1187 let events = $node.node.get_and_clear_pending_events();
1188 assert_eq!(events.len(), 1);
1190 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1191 _ => panic!("Unexpected event"),
1196 macro_rules! expect_payment_forwarded {
1197 ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1198 let events = $node.node.get_and_clear_pending_events();
1199 assert_eq!(events.len(), 1);
1201 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1202 assert_eq!(fee_earned_msat, $expected_fee);
1203 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1205 _ => panic!("Unexpected event"),
1210 pub struct PaymentFailedConditions<'a> {
1211 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1212 pub(crate) expected_blamed_scid: Option<u64>,
1213 pub(crate) expected_blamed_chan_closed: Option<bool>,
1216 impl<'a> PaymentFailedConditions<'a> {
1217 pub fn new() -> Self {
1219 expected_htlc_error_data: None,
1220 expected_blamed_scid: None,
1221 expected_blamed_chan_closed: None,
1224 pub fn blamed_scid(mut self, scid: u64) -> Self {
1225 self.expected_blamed_scid = Some(scid);
1228 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1229 self.expected_blamed_chan_closed = Some(closed);
1232 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1233 self.expected_htlc_error_data = Some((code, data));
1239 macro_rules! expect_payment_failed_with_update {
1240 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1241 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest,
1242 $crate::ln::functional_test_utils::PaymentFailedConditions::new().blamed_scid($scid).blamed_chan_closed($chan_closed));
1247 macro_rules! expect_payment_failed {
1248 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1249 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1251 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1253 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest, conditions);
1258 macro_rules! expect_payment_failed_conditions {
1259 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $conditions: expr) => {
1260 let events = $node.node.get_and_clear_pending_events();
1261 assert_eq!(events.len(), 1);
1263 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data, ref path, ref retry, ref network_update, .. } => {
1264 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1265 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1266 assert!(retry.is_some(), "expected retry.is_some()");
1267 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1268 assert_eq!(retry.as_ref().unwrap().payee.pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1270 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1271 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1272 if let Some((code, data)) = $conditions.expected_htlc_error_data {
1273 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1274 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1277 if let Some(chan_closed) = $conditions.expected_blamed_chan_closed {
1278 match network_update {
1279 &Some($crate::routing::network_graph::NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1280 if let Some(scid) = $conditions.expected_blamed_scid {
1281 assert_eq!(msg.contents.short_channel_id, scid);
1283 assert_eq!(msg.contents.flags & 2, 0);
1285 &Some($crate::routing::network_graph::NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if chan_closed => {
1286 if let Some(scid) = $conditions.expected_blamed_scid {
1287 assert_eq!(short_channel_id, scid);
1289 assert!(is_permanent);
1291 Some(_) => panic!("Unexpected update type"),
1292 None => panic!("Expected update"),
1296 _ => panic!("Unexpected event"),
1301 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 {
1302 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1303 check_added_monitors!(origin_node, expected_paths.len());
1304 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1308 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>) {
1309 let mut payment_event = SendEvent::from_event(ev);
1310 let mut prev_node = origin_node;
1312 for (idx, &node) in expected_path.iter().enumerate() {
1313 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1315 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1316 check_added_monitors!(node, 0);
1317 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1319 expect_pending_htlcs_forwardable!(node);
1321 if idx == expected_path.len() - 1 {
1322 let events_2 = node.node.get_and_clear_pending_events();
1323 if payment_received_expected {
1324 assert_eq!(events_2.len(), 1);
1326 Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1327 assert_eq!(our_payment_hash, *payment_hash);
1329 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1330 assert_eq!(expected_preimage, *payment_preimage);
1331 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1333 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1334 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1335 assert!(our_payment_secret.is_none());
1338 assert_eq!(amt, recv_value);
1340 _ => panic!("Unexpected event"),
1343 assert!(events_2.is_empty());
1346 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1347 assert_eq!(events_2.len(), 1);
1348 check_added_monitors!(node, 1);
1349 payment_event = SendEvent::from_event(events_2.remove(0));
1350 assert_eq!(payment_event.msgs.len(), 1);
1357 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) {
1358 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1359 assert_eq!(events.len(), expected_route.len());
1360 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1361 // Once we've gotten through all the HTLCs, the last one should result in a
1362 // PaymentReceived (but each previous one should not!), .
1363 let expect_payment = path_idx == expected_route.len() - 1;
1364 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1368 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) {
1369 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1370 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1371 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1374 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 {
1375 for path in expected_paths.iter() {
1376 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1378 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1379 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1381 let mut expected_total_fee_msat = 0;
1383 macro_rules! msgs_from_ev {
1386 &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 } } => {
1387 assert!(update_add_htlcs.is_empty());
1388 assert_eq!(update_fulfill_htlcs.len(), 1);
1389 assert!(update_fail_htlcs.is_empty());
1390 assert!(update_fail_malformed_htlcs.is_empty());
1391 assert!(update_fee.is_none());
1392 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1394 _ => panic!("Unexpected event"),
1398 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1399 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1400 assert_eq!(events.len(), expected_paths.len());
1401 for ev in events.iter() {
1402 per_path_msgs.push(msgs_from_ev!(ev));
1405 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1406 let mut next_msgs = Some(path_msgs);
1407 let mut expected_next_node = next_hop;
1409 macro_rules! last_update_fulfill_dance {
1410 ($node: expr, $prev_node: expr) => {
1412 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1413 check_added_monitors!($node, 0);
1414 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1415 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1419 macro_rules! mid_update_fulfill_dance {
1420 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1422 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1423 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;
1424 expect_payment_forwarded!($node, Some(fee as u64), false);
1425 expected_total_fee_msat += fee as u64;
1426 check_added_monitors!($node, 1);
1427 let new_next_msgs = if $new_msgs {
1428 let events = $node.node.get_and_clear_pending_msg_events();
1429 assert_eq!(events.len(), 1);
1430 let (res, nexthop) = msgs_from_ev!(&events[0]);
1431 expected_next_node = nexthop;
1434 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1437 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1438 next_msgs = new_next_msgs;
1443 let mut prev_node = expected_route.last().unwrap();
1444 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1445 assert_eq!(expected_next_node, node.node.get_our_node_id());
1446 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1447 if next_msgs.is_some() {
1448 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1450 assert!(!update_next_msgs);
1451 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1453 if !skip_last && idx == expected_route.len() - 1 {
1454 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1461 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1465 // Ensure that claim_funds is idempotent.
1466 assert!(!expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1467 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1468 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1470 expected_total_fee_msat
1472 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) {
1473 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1475 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1479 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1480 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1483 pub const TEST_FINAL_CLTV: u32 = 70;
1485 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) {
1486 let payee = Payee::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1487 .with_features(InvoiceFeatures::known());
1488 let scorer = test_utils::TestScorer::with_fixed_penalty(0);
1489 let route = get_route(
1490 &origin_node.node.get_our_node_id(), &payee, &origin_node.network_graph,
1491 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1492 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1493 assert_eq!(route.paths.len(), 1);
1494 assert_eq!(route.paths[0].len(), expected_route.len());
1495 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1496 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1499 let res = send_along_route(origin_node, route, expected_route, recv_value);
1500 (res.0, res.1, res.2)
1503 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1504 let payee = Payee::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1505 .with_features(InvoiceFeatures::known());
1506 let scorer = test_utils::TestScorer::with_fixed_penalty(0);
1507 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();
1508 assert_eq!(route.paths.len(), 1);
1509 assert_eq!(route.paths[0].len(), expected_route.len());
1510 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1511 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1514 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1515 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1516 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1519 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1520 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1521 claim_payment(&origin, expected_route, our_payment_preimage);
1524 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) {
1525 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1526 for path in expected_paths.iter() {
1527 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1529 assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1530 expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1531 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1533 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1534 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1535 assert_eq!(events.len(), expected_paths.len());
1536 for ev in events.iter() {
1537 let (update_fail, commitment_signed, node_id) = match ev {
1538 &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 } } => {
1539 assert!(update_add_htlcs.is_empty());
1540 assert!(update_fulfill_htlcs.is_empty());
1541 assert_eq!(update_fail_htlcs.len(), 1);
1542 assert!(update_fail_malformed_htlcs.is_empty());
1543 assert!(update_fee.is_none());
1544 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1546 _ => panic!("Unexpected event"),
1548 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1550 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1551 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()));
1553 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1554 let mut next_msgs = Some(path_msgs);
1555 let mut expected_next_node = next_hop;
1556 let mut prev_node = expected_route.last().unwrap();
1558 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1559 assert_eq!(expected_next_node, node.node.get_our_node_id());
1560 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1561 if next_msgs.is_some() {
1562 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1563 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1564 if !update_next_node {
1565 expect_pending_htlcs_forwardable!(node);
1568 let events = node.node.get_and_clear_pending_msg_events();
1569 if update_next_node {
1570 assert_eq!(events.len(), 1);
1572 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 } } => {
1573 assert!(update_add_htlcs.is_empty());
1574 assert!(update_fulfill_htlcs.is_empty());
1575 assert_eq!(update_fail_htlcs.len(), 1);
1576 assert!(update_fail_malformed_htlcs.is_empty());
1577 assert!(update_fee.is_none());
1578 expected_next_node = node_id.clone();
1579 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1581 _ => panic!("Unexpected event"),
1584 assert!(events.is_empty());
1586 if !skip_last && idx == expected_route.len() - 1 {
1587 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1594 let prev_node = expected_route.first().unwrap();
1595 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1596 check_added_monitors!(origin_node, 0);
1597 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1598 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1599 let events = origin_node.node.get_and_clear_pending_events();
1600 assert_eq!(events.len(), 1);
1602 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, .. } => {
1603 assert_eq!(payment_hash, our_payment_hash);
1604 assert!(rejected_by_dest);
1605 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1606 for (idx, hop) in expected_route.iter().enumerate() {
1607 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1610 _ => panic!("Unexpected event"),
1615 // Ensure that fail_htlc_backwards is idempotent.
1616 assert!(!expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1617 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
1618 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1619 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1622 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1623 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1626 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1627 let mut chan_mon_cfgs = Vec::new();
1628 for i in 0..node_count {
1629 let tx_broadcaster = test_utils::TestBroadcaster {
1630 txn_broadcasted: Mutex::new(Vec::new()),
1631 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1633 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1634 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1635 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1636 let persister = test_utils::TestPersister::new();
1637 let seed = [i as u8; 32];
1638 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1639 let network_graph = NetworkGraph::new(chain_source.genesis_hash);
1641 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, network_graph });
1647 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1648 let mut nodes = Vec::new();
1650 for i in 0..node_count {
1651 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);
1652 let seed = [i as u8; 32];
1653 nodes.push(NodeCfg {
1654 chain_source: &chanmon_cfgs[i].chain_source,
1655 logger: &chanmon_cfgs[i].logger,
1656 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1657 fee_estimator: &chanmon_cfgs[i].fee_estimator,
1659 keys_manager: &chanmon_cfgs[i].keys_manager,
1661 features: InitFeatures::known(),
1662 network_graph: &chanmon_cfgs[i].network_graph,
1669 pub fn test_default_channel_config() -> UserConfig {
1670 let mut default_config = UserConfig::default();
1671 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1672 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1673 default_config.channel_options.cltv_expiry_delta = 6*6;
1674 default_config.channel_options.announced_channel = true;
1675 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1676 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1677 // It now defaults to 1, so we simply set it to the expected value here.
1678 default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1679 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1680 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1681 default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1685 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>> {
1686 let mut chanmgrs = Vec::new();
1687 for i in 0..node_count {
1688 let network = Network::Testnet;
1689 let params = ChainParameters {
1691 best_block: BestBlock::from_genesis(network),
1693 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1694 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1695 chanmgrs.push(node);
1701 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>> {
1702 let mut nodes = Vec::new();
1703 let chan_count = Rc::new(RefCell::new(0));
1704 let payment_count = Rc::new(RefCell::new(0));
1705 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1707 for i in 0..node_count {
1708 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].network_graph, None, cfgs[i].logger);
1710 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
1711 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
1712 node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, net_graph_msg_handler,
1713 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1714 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1715 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1716 connect_style: Rc::clone(&connect_style),
1720 for i in 0..node_count {
1721 for j in (i+1)..node_count {
1722 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1723 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1730 // Note that the following only works for CLTV values up to 128
1731 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1732 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1734 #[derive(PartialEq)]
1735 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1736 /// Tests that the given node has broadcast transactions for the given Channel
1738 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1739 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1740 /// broadcast and the revoked outputs were claimed.
1742 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1743 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1745 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1747 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> {
1748 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1749 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1751 let mut res = Vec::with_capacity(2);
1752 node_txn.retain(|tx| {
1753 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1754 check_spends!(tx, chan.3);
1755 if commitment_tx.is_none() {
1756 res.push(tx.clone());
1761 if let Some(explicit_tx) = commitment_tx {
1762 res.push(explicit_tx.clone());
1765 assert_eq!(res.len(), 1);
1767 if has_htlc_tx != HTLCType::NONE {
1768 node_txn.retain(|tx| {
1769 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1770 check_spends!(tx, res[0]);
1771 if has_htlc_tx == HTLCType::TIMEOUT {
1772 assert!(tx.lock_time != 0);
1774 assert!(tx.lock_time == 0);
1776 res.push(tx.clone());
1780 assert!(res.len() == 2 || res.len() == 3);
1782 assert_eq!(res[1], res[2]);
1786 assert!(node_txn.is_empty());
1790 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1791 /// HTLC transaction.
1792 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1793 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1794 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1795 // for revoked htlc outputs
1796 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1797 node_txn.retain(|tx| {
1798 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1799 check_spends!(tx, revoked_tx);
1803 node_txn.retain(|tx| {
1804 check_spends!(tx, commitment_revoked_tx);
1807 assert!(node_txn.is_empty());
1810 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1811 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1813 assert!(node_txn.len() >= 1);
1814 assert_eq!(node_txn[0].input.len(), 1);
1815 let mut found_prev = false;
1817 for tx in prev_txn {
1818 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1819 check_spends!(node_txn[0], tx);
1820 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1821 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1827 assert!(found_prev);
1829 let mut res = Vec::new();
1830 mem::swap(&mut *node_txn, &mut res);
1834 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) {
1835 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1836 assert_eq!(events_1.len(), 2);
1837 let as_update = match events_1[0] {
1838 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1841 _ => panic!("Unexpected event"),
1844 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1845 assert_eq!(node_id, nodes[b].node.get_our_node_id());
1846 assert_eq!(msg.data, expected_error);
1847 if needs_err_handle {
1848 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1851 _ => panic!("Unexpected event"),
1854 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1855 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1856 let bs_update = match events_2[0] {
1857 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1860 _ => panic!("Unexpected event"),
1862 if !needs_err_handle {
1864 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1865 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1866 assert_eq!(msg.data, expected_error);
1868 _ => panic!("Unexpected event"),
1873 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1874 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1878 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1879 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
1883 macro_rules! get_channel_value_stat {
1884 ($node: expr, $channel_id: expr) => {{
1885 let chan_lock = $node.node.channel_state.lock().unwrap();
1886 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1887 chan.get_value_stat()
1891 macro_rules! get_chan_reestablish_msgs {
1892 ($src_node: expr, $dst_node: expr) => {
1894 let mut res = Vec::with_capacity(1);
1895 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1896 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1897 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1898 res.push(msg.clone());
1900 panic!("Unexpected event")
1908 macro_rules! handle_chan_reestablish_msgs {
1909 ($src_node: expr, $dst_node: expr) => {
1911 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1913 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1915 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1921 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
1923 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1926 let mut revoke_and_ack = None;
1927 let mut commitment_update = None;
1928 let order = if let Some(ev) = msg_events.get(idx) {
1930 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1931 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1932 revoke_and_ack = Some(msg.clone());
1934 RAACommitmentOrder::RevokeAndACKFirst
1936 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1937 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1938 commitment_update = Some(updates.clone());
1940 RAACommitmentOrder::CommitmentFirst
1942 &MessageSendEvent::SendChannelUpdate { .. } => RAACommitmentOrder::CommitmentFirst,
1943 _ => panic!("Unexpected event"),
1946 RAACommitmentOrder::CommitmentFirst
1949 if let Some(ev) = msg_events.get(idx) {
1951 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1952 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1953 assert!(revoke_and_ack.is_none());
1954 revoke_and_ack = Some(msg.clone());
1957 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1958 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1959 assert!(commitment_update.is_none());
1960 commitment_update = Some(updates.clone());
1963 &MessageSendEvent::SendChannelUpdate { .. } => {},
1964 _ => panic!("Unexpected event"),
1968 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
1969 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1970 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1973 (funding_locked, revoke_and_ack, commitment_update, order)
1978 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1979 /// for claims/fails they are separated out.
1980 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)) {
1981 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1982 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1983 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1984 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1986 if send_funding_locked.0 {
1987 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1989 for reestablish in reestablish_1.iter() {
1990 assert_eq!(reestablish.next_remote_commitment_number, 0);
1993 if send_funding_locked.1 {
1994 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1996 for reestablish in reestablish_2.iter() {
1997 assert_eq!(reestablish.next_remote_commitment_number, 0);
2000 if send_funding_locked.0 || send_funding_locked.1 {
2001 // If we expect any funding_locked's, both sides better have set
2002 // next_holder_commitment_number to 1
2003 for reestablish in reestablish_1.iter() {
2004 assert_eq!(reestablish.next_local_commitment_number, 1);
2006 for reestablish in reestablish_2.iter() {
2007 assert_eq!(reestablish.next_local_commitment_number, 1);
2011 let mut resp_1 = Vec::new();
2012 for msg in reestablish_1 {
2013 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2014 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2016 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2017 check_added_monitors!(node_b, 1);
2019 check_added_monitors!(node_b, 0);
2022 let mut resp_2 = Vec::new();
2023 for msg in reestablish_2 {
2024 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2025 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2027 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2028 check_added_monitors!(node_a, 1);
2030 check_added_monitors!(node_a, 0);
2033 // We don't yet support both needing updates, as that would require a different commitment dance:
2034 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2035 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2036 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2037 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2039 for chan_msgs in resp_1.drain(..) {
2040 if send_funding_locked.0 {
2041 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2042 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2043 if !announcement_event.is_empty() {
2044 assert_eq!(announcement_event.len(), 1);
2045 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
2046 //TODO: Test announcement_sigs re-sending
2047 } else { panic!("Unexpected event!"); }
2050 assert!(chan_msgs.0.is_none());
2053 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2054 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2055 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2056 check_added_monitors!(node_a, 1);
2058 assert!(chan_msgs.1.is_none());
2060 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 {
2061 let commitment_update = chan_msgs.2.unwrap();
2062 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2063 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2065 assert!(commitment_update.update_add_htlcs.is_empty());
2067 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2068 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2069 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2070 for update_add in commitment_update.update_add_htlcs {
2071 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2073 for update_fulfill in commitment_update.update_fulfill_htlcs {
2074 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2076 for update_fail in commitment_update.update_fail_htlcs {
2077 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2080 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2081 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2083 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2084 check_added_monitors!(node_a, 1);
2085 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2086 // No commitment_signed so get_event_msg's assert(len == 1) passes
2087 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2088 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2089 check_added_monitors!(node_b, 1);
2092 assert!(chan_msgs.2.is_none());
2096 for chan_msgs in resp_2.drain(..) {
2097 if send_funding_locked.1 {
2098 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2099 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2100 if !announcement_event.is_empty() {
2101 assert_eq!(announcement_event.len(), 1);
2102 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
2103 //TODO: Test announcement_sigs re-sending
2104 } else { panic!("Unexpected event!"); }
2107 assert!(chan_msgs.0.is_none());
2110 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2111 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2112 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2113 check_added_monitors!(node_b, 1);
2115 assert!(chan_msgs.1.is_none());
2117 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 {
2118 let commitment_update = chan_msgs.2.unwrap();
2119 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2120 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2122 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2123 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2124 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2125 for update_add in commitment_update.update_add_htlcs {
2126 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2128 for update_fulfill in commitment_update.update_fulfill_htlcs {
2129 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2131 for update_fail in commitment_update.update_fail_htlcs {
2132 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2135 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2136 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2138 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2139 check_added_monitors!(node_b, 1);
2140 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2141 // No commitment_signed so get_event_msg's assert(len == 1) passes
2142 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2143 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2144 check_added_monitors!(node_a, 1);
2147 assert!(chan_msgs.2.is_none());