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::{Listen, Watch};
14 use chain::channelmonitor::ChannelMonitor;
15 use chain::transaction::OutPoint;
16 use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure};
17 use routing::router::{Route, get_route};
18 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
19 use ln::features::InitFeatures;
21 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
22 use util::enforcing_trait_impls::EnforcingSigner;
24 use util::test_utils::TestChainMonitor;
25 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
26 use util::errors::APIError;
27 use util::config::UserConfig;
28 use util::ser::{ReadableArgs, Writeable, Readable};
30 use bitcoin::blockdata::block::{Block, BlockHeader};
31 use bitcoin::blockdata::constants::genesis_block;
32 use bitcoin::blockdata::transaction::{Transaction, TxOut};
33 use bitcoin::network::constants::Network;
35 use bitcoin::hashes::sha256::Hash as Sha256;
36 use bitcoin::hashes::Hash;
37 use bitcoin::hash_types::BlockHash;
39 use bitcoin::secp256k1::key::PublicKey;
41 use std::cell::RefCell;
45 use std::collections::HashMap;
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 >= 1 {
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: 42, 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 pub enum ConnectStyle {
81 /// Calls update_best_block first, detecting transactions in the block only after receiving the
82 /// header and height information.
84 /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
85 /// make a single update_best_block call.
86 BestBlockFirstSkippingBlocks,
87 /// Calls transactions_confirmed first, detecting transactions in the block before updating the
88 /// header and height information.
90 /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
91 /// make a single update_best_block call.
92 TransactionsFirstSkippingBlocks,
93 /// Provides the full block via the chain::Listen interface. In the current code this is
94 /// equivalent to TransactionsFirst with some additional assertions.
98 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
99 let skip_intermediaries = match *node.connect_style.borrow() {
100 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
104 let mut block = Block {
105 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
109 for _ in 0..depth - 1 {
110 do_connect_block(node, &block, skip_intermediaries);
112 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
116 connect_block(node, &block);
117 block.header.block_hash()
120 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
121 do_connect_block(node, block, false);
124 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_manager: bool) {
125 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
126 let height = node.best_block_info().1 + 1;
127 node.chain_monitor.chain_monitor.block_connected(&block.header, &txdata, height);
129 match *node.connect_style.borrow() {
130 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
131 node.node.update_best_block(&block.header, height);
132 node.node.transactions_confirmed(&block.header, height, &block.txdata.iter().enumerate().collect::<Vec<_>>());
134 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
135 node.node.transactions_confirmed(&block.header, height, &block.txdata.iter().enumerate().collect::<Vec<_>>());
136 node.node.update_best_block(&block.header, height);
138 ConnectStyle::FullBlockViaListen => {
139 Listen::block_connected(node.node, &block, height);
143 node.node.test_process_background_events();
144 node.blocks.borrow_mut().push((block.header, height));
147 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
149 let orig_header = node.blocks.borrow_mut().pop().unwrap();
150 assert!(orig_header.1 > 0); // Cannot disconnect genesis
151 let prev_header = node.blocks.borrow().last().unwrap().clone();
153 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
154 match *node.connect_style.borrow() {
155 ConnectStyle::FullBlockViaListen => {
156 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
158 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
160 node.node.update_best_block(&prev_header.0, prev_header.1);
164 node.node.update_best_block(&prev_header.0, prev_header.1);
170 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
171 let count = node.blocks.borrow_mut().len() as u32 - 1;
172 disconnect_blocks(node, count);
175 pub struct TestChanMonCfg {
176 pub tx_broadcaster: test_utils::TestBroadcaster,
177 pub fee_estimator: test_utils::TestFeeEstimator,
178 pub chain_source: test_utils::TestChainSource,
179 pub persister: test_utils::TestPersister,
180 pub logger: test_utils::TestLogger,
181 pub keys_manager: test_utils::TestKeysInterface,
184 pub struct NodeCfg<'a> {
185 pub chain_source: &'a test_utils::TestChainSource,
186 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
187 pub fee_estimator: &'a test_utils::TestFeeEstimator,
188 pub chain_monitor: test_utils::TestChainMonitor<'a>,
189 pub keys_manager: &'a test_utils::TestKeysInterface,
190 pub logger: &'a test_utils::TestLogger,
191 pub node_seed: [u8; 32],
194 pub struct Node<'a, 'b: 'a, 'c: 'b> {
195 pub chain_source: &'c test_utils::TestChainSource,
196 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
197 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
198 pub keys_manager: &'b test_utils::TestKeysInterface,
199 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
200 pub net_graph_msg_handler: NetGraphMsgHandler<&'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
201 pub node_seed: [u8; 32],
202 pub network_payment_count: Rc<RefCell<u8>>,
203 pub network_chan_count: Rc<RefCell<u32>>,
204 pub logger: &'c test_utils::TestLogger,
205 pub blocks: RefCell<Vec<(BlockHeader, u32)>>,
206 pub connect_style: Rc<RefCell<ConnectStyle>>,
208 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
209 pub fn best_block_hash(&self) -> BlockHash {
210 self.blocks.borrow_mut().last().unwrap().0.block_hash()
212 pub fn best_block_info(&self) -> (BlockHash, u32) {
213 self.blocks.borrow_mut().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
217 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
219 if !::std::thread::panicking() {
220 // Check that we processed all pending events
221 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
222 assert!(self.node.get_and_clear_pending_events().is_empty());
223 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
225 // Check that if we serialize the Router, we can deserialize it again.
227 let mut w = test_utils::TestVecWriter(Vec::new());
228 let network_graph_ser = self.net_graph_msg_handler.network_graph.read().unwrap();
229 network_graph_ser.write(&mut w).unwrap();
230 let network_graph_deser = <NetworkGraph>::read(&mut ::std::io::Cursor::new(&w.0)).unwrap();
231 assert!(network_graph_deser == *self.net_graph_msg_handler.network_graph.read().unwrap());
232 let net_graph_msg_handler = NetGraphMsgHandler::from_net_graph(
233 Some(self.chain_source), self.logger, network_graph_deser
235 let mut chan_progress = 0;
237 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
238 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
239 assert!(orig_announcements == deserialized_announcements);
240 chan_progress = match orig_announcements.last() {
241 Some(announcement) => announcement.0.contents.short_channel_id + 1,
245 let mut node_progress = None;
247 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
248 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
249 assert!(orig_announcements == deserialized_announcements);
250 node_progress = match orig_announcements.last() {
251 Some(announcement) => Some(announcement.contents.node_id),
257 // Check that if we serialize and then deserialize all our channel monitors we get the
258 // same set of outputs to watch for on chain as we have now. Note that if we write
259 // tests that fully close channels and remove the monitors at some point this may break.
260 let feeest = test_utils::TestFeeEstimator { sat_per_kw: 253 };
261 let mut deserialized_monitors = Vec::new();
263 let old_monitors = self.chain_monitor.chain_monitor.monitors.read().unwrap();
264 for (_, old_monitor) in old_monitors.iter() {
265 let mut w = test_utils::TestVecWriter(Vec::new());
266 old_monitor.write(&mut w).unwrap();
267 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
268 &mut ::std::io::Cursor::new(&w.0), self.keys_manager).unwrap();
269 deserialized_monitors.push(deserialized_monitor);
273 // Before using all the new monitors to check the watch outpoints, use the full set of
274 // them to ensure we can write and reload our ChannelManager.
276 let mut channel_monitors = HashMap::new();
277 for monitor in deserialized_monitors.iter_mut() {
278 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
281 let mut w = test_utils::TestVecWriter(Vec::new());
282 self.node.write(&mut w).unwrap();
283 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(w.0), ChannelManagerReadArgs {
284 default_config: UserConfig::default(),
285 keys_manager: self.keys_manager,
286 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: 253 },
287 chain_monitor: self.chain_monitor,
288 tx_broadcaster: &test_utils::TestBroadcaster {
289 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
291 logger: &test_utils::TestLogger::new(),
296 let persister = test_utils::TestPersister::new();
297 let broadcaster = test_utils::TestBroadcaster {
298 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
300 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
301 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
302 for deserialized_monitor in deserialized_monitors.drain(..) {
303 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
307 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
308 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
313 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) {
314 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
317 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) {
318 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);
319 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
320 (announcement, as_update, bs_update, channel_id, tx)
323 macro_rules! get_revoke_commit_msgs {
324 ($node: expr, $node_id: expr) => {
326 let events = $node.node.get_and_clear_pending_msg_events();
327 assert_eq!(events.len(), 2);
329 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
330 assert_eq!(*node_id, $node_id);
333 _ => panic!("Unexpected event"),
335 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
336 assert_eq!(*node_id, $node_id);
337 assert!(updates.update_add_htlcs.is_empty());
338 assert!(updates.update_fulfill_htlcs.is_empty());
339 assert!(updates.update_fail_htlcs.is_empty());
340 assert!(updates.update_fail_malformed_htlcs.is_empty());
341 assert!(updates.update_fee.is_none());
342 updates.commitment_signed.clone()
344 _ => panic!("Unexpected event"),
350 /// Get an specific event message from the pending events queue.
352 macro_rules! get_event_msg {
353 ($node: expr, $event_type: path, $node_id: expr) => {
355 let events = $node.node.get_and_clear_pending_msg_events();
356 assert_eq!(events.len(), 1);
358 $event_type { ref node_id, ref msg } => {
359 assert_eq!(*node_id, $node_id);
362 _ => panic!("Unexpected event"),
368 /// Get a specific event from the pending events queue.
370 macro_rules! get_event {
371 ($node: expr, $event_type: path) => {
373 let mut events = $node.node.get_and_clear_pending_events();
374 assert_eq!(events.len(), 1);
375 let ev = events.pop().unwrap();
377 $event_type { .. } => {
380 _ => panic!("Unexpected event"),
387 macro_rules! get_htlc_update_msgs {
388 ($node: expr, $node_id: expr) => {
390 let events = $node.node.get_and_clear_pending_msg_events();
391 assert_eq!(events.len(), 1);
393 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
394 assert_eq!(*node_id, $node_id);
397 _ => panic!("Unexpected event"),
404 macro_rules! get_feerate {
405 ($node: expr, $channel_id: expr) => {
407 let chan_lock = $node.node.channel_state.lock().unwrap();
408 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
414 /// Returns any local commitment transactions for the channel.
416 macro_rules! get_local_commitment_txn {
417 ($node: expr, $channel_id: expr) => {
419 let monitors = $node.chain_monitor.chain_monitor.monitors.read().unwrap();
420 let mut commitment_txn = None;
421 for (funding_txo, monitor) in monitors.iter() {
422 if funding_txo.to_channel_id() == $channel_id {
423 commitment_txn = Some(monitor.unsafe_get_latest_holder_commitment_txn(&$node.logger));
427 commitment_txn.unwrap()
432 /// Check the error from attempting a payment.
434 macro_rules! unwrap_send_err {
435 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
437 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
438 assert_eq!(fails.len(), 1);
444 &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
445 assert_eq!(fails.len(), 1);
447 Err($type) => { $check },
456 /// Check whether N channel monitor(s) have been added.
458 macro_rules! check_added_monitors {
459 ($node: expr, $count: expr) => {
461 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
462 assert_eq!(added_monitors.len(), $count);
463 added_monitors.clear();
468 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) {
469 let chan_id = *node.network_chan_count.borrow();
471 let events = node.node.get_and_clear_pending_events();
472 assert_eq!(events.len(), 1);
474 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
475 assert_eq!(*channel_value_satoshis, expected_chan_value);
476 assert_eq!(user_channel_id, expected_user_chan_id);
478 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
479 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
481 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
482 (*temporary_channel_id, tx, funding_outpoint)
484 _ => panic!("Unexpected event"),
488 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 {
489 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
490 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()));
491 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()));
493 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
495 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
496 check_added_monitors!(node_a, 0);
498 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()));
500 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
501 assert_eq!(added_monitors.len(), 1);
502 assert_eq!(added_monitors[0].0, funding_output);
503 added_monitors.clear();
506 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()));
508 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
509 assert_eq!(added_monitors.len(), 1);
510 assert_eq!(added_monitors[0].0, funding_output);
511 added_monitors.clear();
514 let events_4 = node_a.node.get_and_clear_pending_events();
515 assert_eq!(events_4.len(), 0);
517 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
518 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
519 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
524 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) {
525 confirm_transaction_at(node_conf, tx, conf_height);
526 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
527 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()));
530 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]) {
532 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
533 assert_eq!(events_6.len(), 2);
534 ((match events_6[0] {
535 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
536 channel_id = msg.channel_id.clone();
537 assert_eq!(*node_id, node_recv.node.get_our_node_id());
540 _ => panic!("Unexpected event"),
541 }, match events_6[1] {
542 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
543 assert_eq!(*node_id, node_recv.node.get_our_node_id());
546 _ => panic!("Unexpected event"),
550 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]) {
551 let conf_height = std::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
552 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
553 confirm_transaction_at(node_a, tx, conf_height);
554 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
555 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
558 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) {
559 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
560 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
564 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) {
565 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
566 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
567 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
569 let events_7 = node_b.node.get_and_clear_pending_msg_events();
570 assert_eq!(events_7.len(), 1);
571 let (announcement, bs_update) = match events_7[0] {
572 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
575 _ => panic!("Unexpected event"),
578 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
579 let events_8 = node_a.node.get_and_clear_pending_msg_events();
580 assert_eq!(events_8.len(), 1);
581 let as_update = match events_8[0] {
582 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
583 assert!(*announcement == *msg);
584 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
585 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
588 _ => panic!("Unexpected event"),
591 *node_a.network_chan_count.borrow_mut() += 1;
593 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
596 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) {
597 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
600 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) {
601 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
602 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
603 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
606 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) {
607 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
608 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
609 assert_eq!(a_events.len(), 1);
610 let a_node_announcement = match a_events[0] {
611 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
614 _ => panic!("Unexpected event"),
617 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
618 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
619 assert_eq!(b_events.len(), 1);
620 let b_node_announcement = match b_events[0] {
621 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
624 _ => panic!("Unexpected event"),
628 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
629 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
630 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
631 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
632 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
636 macro_rules! check_spends {
637 ($tx: expr, $($spends_txn: expr),*) => {
639 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
641 if out_point.txid == $spends_txn.txid() {
642 return $spends_txn.output.get(out_point.vout as usize).cloned()
647 let mut total_value_in = 0;
648 for input in $tx.input.iter() {
649 total_value_in += get_output(&input.previous_output).unwrap().value;
651 let mut total_value_out = 0;
652 for output in $tx.output.iter() {
653 total_value_out += output.value;
655 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
656 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
657 assert!(total_value_out + min_fee <= total_value_in);
658 $tx.verify(get_output).unwrap();
663 macro_rules! get_closing_signed_broadcast {
664 ($node: expr, $dest_pubkey: expr) => {
666 let events = $node.get_and_clear_pending_msg_events();
667 assert!(events.len() == 1 || events.len() == 2);
668 (match events[events.len() - 1] {
669 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
670 assert_eq!(msg.contents.flags & 2, 2);
673 _ => panic!("Unexpected event"),
674 }, if events.len() == 2 {
676 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
677 assert_eq!(*node_id, $dest_pubkey);
680 _ => panic!("Unexpected event"),
687 /// Check that a channel's closing channel update has been broadcasted, and optionally
688 /// check whether an error message event has occurred.
690 macro_rules! check_closed_broadcast {
691 ($node: expr, $with_error_msg: expr) => {{
692 let events = $node.node.get_and_clear_pending_msg_events();
693 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
695 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
696 assert_eq!(msg.contents.flags & 2, 2);
698 _ => panic!("Unexpected event"),
702 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
703 // TODO: Check node_id
706 _ => panic!("Unexpected event"),
712 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) {
713 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) };
714 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
717 node_a.close_channel(channel_id).unwrap();
718 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()));
720 let events_1 = node_b.get_and_clear_pending_msg_events();
721 assert!(events_1.len() >= 1);
722 let shutdown_b = match events_1[0] {
723 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
724 assert_eq!(node_id, &node_a.get_our_node_id());
727 _ => panic!("Unexpected event"),
730 let closing_signed_b = if !close_inbound_first {
731 assert_eq!(events_1.len(), 1);
734 Some(match events_1[1] {
735 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
736 assert_eq!(node_id, &node_a.get_our_node_id());
739 _ => panic!("Unexpected event"),
743 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
744 let (as_update, bs_update) = if close_inbound_first {
745 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
746 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
747 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
748 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
749 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
751 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
752 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
753 assert!(none_b.is_none());
754 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
755 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
756 (as_update, bs_update)
758 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
760 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
761 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
762 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
763 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
765 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
766 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
767 assert!(none_a.is_none());
768 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
769 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
770 (as_update, bs_update)
772 assert_eq!(tx_a, tx_b);
773 check_spends!(tx_a, funding_tx);
775 (as_update, bs_update, tx_a)
778 pub struct SendEvent {
779 pub node_id: PublicKey,
780 pub msgs: Vec<msgs::UpdateAddHTLC>,
781 pub commitment_msg: msgs::CommitmentSigned,
784 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
785 assert!(updates.update_fulfill_htlcs.is_empty());
786 assert!(updates.update_fail_htlcs.is_empty());
787 assert!(updates.update_fail_malformed_htlcs.is_empty());
788 assert!(updates.update_fee.is_none());
789 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
792 pub fn from_event(event: MessageSendEvent) -> SendEvent {
794 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
795 _ => panic!("Unexpected event type!"),
799 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
800 let mut events = node.node.get_and_clear_pending_msg_events();
801 assert_eq!(events.len(), 1);
802 SendEvent::from_event(events.pop().unwrap())
806 macro_rules! commitment_signed_dance {
807 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
809 check_added_monitors!($node_a, 0);
810 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
811 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
812 check_added_monitors!($node_a, 1);
813 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
816 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
818 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
819 check_added_monitors!($node_b, 0);
820 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
821 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
822 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
823 check_added_monitors!($node_b, 1);
824 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
825 let (bs_revoke_and_ack, extra_msg_option) = {
826 let events = $node_b.node.get_and_clear_pending_msg_events();
827 assert!(events.len() <= 2);
829 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
830 assert_eq!(*node_id, $node_a.node.get_our_node_id());
833 _ => panic!("Unexpected event"),
834 }, events.get(1).map(|e| e.clone()))
836 check_added_monitors!($node_b, 1);
838 assert!($node_a.node.get_and_clear_pending_events().is_empty());
839 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
841 (extra_msg_option, bs_revoke_and_ack)
844 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
846 check_added_monitors!($node_a, 0);
847 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
848 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
849 check_added_monitors!($node_a, 1);
850 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
851 assert!(extra_msg_option.is_none());
855 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
857 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
858 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
859 check_added_monitors!($node_a, 1);
863 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
865 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
868 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
870 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
872 expect_pending_htlcs_forwardable!($node_a);
873 check_added_monitors!($node_a, 1);
875 let channel_state = $node_a.node.channel_state.lock().unwrap();
876 assert_eq!(channel_state.pending_msg_events.len(), 1);
877 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
878 assert_ne!(*node_id, $node_b.node.get_our_node_id());
879 } else { panic!("Unexpected event"); }
881 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
887 /// Get a payment preimage and hash.
889 macro_rules! get_payment_preimage_hash {
892 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
893 *$node.network_payment_count.borrow_mut() += 1;
894 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
895 (payment_preimage, payment_hash)
900 macro_rules! expect_pending_htlcs_forwardable_ignore {
902 let events = $node.node.get_and_clear_pending_events();
903 assert_eq!(events.len(), 1);
905 Event::PendingHTLCsForwardable { .. } => { },
906 _ => panic!("Unexpected event"),
911 macro_rules! expect_pending_htlcs_forwardable {
913 expect_pending_htlcs_forwardable_ignore!($node);
914 $node.node.process_pending_htlc_forwards();
918 #[cfg(any(test, feature = "unstable"))]
919 macro_rules! expect_payment_received {
920 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
921 let events = $node.node.get_and_clear_pending_events();
922 assert_eq!(events.len(), 1);
924 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
925 assert_eq!($expected_payment_hash, *payment_hash);
926 assert_eq!(None, *payment_secret);
927 assert_eq!($expected_recv_value, amt);
929 _ => panic!("Unexpected event"),
934 macro_rules! expect_payment_sent {
935 ($node: expr, $expected_payment_preimage: expr) => {
936 let events = $node.node.get_and_clear_pending_events();
937 assert_eq!(events.len(), 1);
939 Event::PaymentSent { ref payment_preimage } => {
940 assert_eq!($expected_payment_preimage, *payment_preimage);
942 _ => panic!("Unexpected event"),
948 macro_rules! expect_payment_failed {
949 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
950 let events = $node.node.get_and_clear_pending_events();
951 assert_eq!(events.len(), 1);
953 Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data } => {
954 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
955 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
956 assert!(error_code.is_some(), "expected error_code.is_some() = true");
957 assert!(error_data.is_some(), "expected error_data.is_some() = true");
959 assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
960 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
963 _ => panic!("Unexpected event"),
968 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: Option<PaymentSecret>) {
969 origin_node.node.send_payment(&route, our_payment_hash, &our_payment_secret).unwrap();
970 check_added_monitors!(origin_node, expected_paths.len());
971 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
974 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) {
975 let mut payment_event = SendEvent::from_event(ev);
976 let mut prev_node = origin_node;
978 for (idx, &node) in expected_path.iter().enumerate() {
979 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
981 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
982 check_added_monitors!(node, 0);
983 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
985 expect_pending_htlcs_forwardable!(node);
987 if idx == expected_path.len() - 1 {
988 let events_2 = node.node.get_and_clear_pending_events();
989 if payment_received_expected {
990 assert_eq!(events_2.len(), 1);
992 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
993 assert_eq!(our_payment_hash, *payment_hash);
994 assert_eq!(our_payment_secret, *payment_secret);
995 assert_eq!(amt, recv_value);
997 _ => panic!("Unexpected event"),
1000 assert!(events_2.is_empty());
1003 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1004 assert_eq!(events_2.len(), 1);
1005 check_added_monitors!(node, 1);
1006 payment_event = SendEvent::from_event(events_2.remove(0));
1007 assert_eq!(payment_event.msgs.len(), 1);
1014 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: Option<PaymentSecret>) {
1015 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1016 assert_eq!(events.len(), expected_route.len());
1017 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1018 // Once we've gotten through all the HTLCs, the last one should result in a
1019 // PaymentReceived (but each previous one should not!), .
1020 let expect_payment = path_idx == expected_route.len() - 1;
1021 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), our_payment_secret, ev, expect_payment);
1025 pub fn send_along_route_with_hash<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, route: Route, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, our_payment_hash: PaymentHash) {
1026 send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, None);
1029 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) {
1030 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
1031 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
1032 (our_payment_preimage, our_payment_hash)
1035 pub fn claim_payment_along_route_with_secret<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_preimage: PaymentPreimage, our_payment_secret: Option<PaymentSecret>, expected_amount: u64) {
1036 for path in expected_paths.iter() {
1037 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1039 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage, &our_payment_secret, expected_amount));
1040 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1042 macro_rules! msgs_from_ev {
1045 &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 } } => {
1046 assert!(update_add_htlcs.is_empty());
1047 assert_eq!(update_fulfill_htlcs.len(), 1);
1048 assert!(update_fail_htlcs.is_empty());
1049 assert!(update_fail_malformed_htlcs.is_empty());
1050 assert!(update_fee.is_none());
1051 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1053 _ => panic!("Unexpected event"),
1057 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1058 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1059 assert_eq!(events.len(), expected_paths.len());
1060 for ev in events.iter() {
1061 per_path_msgs.push(msgs_from_ev!(ev));
1064 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1065 let mut next_msgs = Some(path_msgs);
1066 let mut expected_next_node = next_hop;
1068 macro_rules! last_update_fulfill_dance {
1069 ($node: expr, $prev_node: expr) => {
1071 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1072 check_added_monitors!($node, 0);
1073 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1074 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1078 macro_rules! mid_update_fulfill_dance {
1079 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1081 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1082 check_added_monitors!($node, 1);
1083 let new_next_msgs = if $new_msgs {
1084 let events = $node.node.get_and_clear_pending_msg_events();
1085 assert_eq!(events.len(), 1);
1086 let (res, nexthop) = msgs_from_ev!(&events[0]);
1087 expected_next_node = nexthop;
1090 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1093 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1094 next_msgs = new_next_msgs;
1099 let mut prev_node = expected_route.last().unwrap();
1100 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1101 assert_eq!(expected_next_node, node.node.get_our_node_id());
1102 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1103 if next_msgs.is_some() {
1104 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1106 assert!(!update_next_msgs);
1107 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1109 if !skip_last && idx == expected_route.len() - 1 {
1110 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1117 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1118 expect_payment_sent!(origin_node, our_payment_preimage);
1123 pub fn claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], skip_last: bool, our_payment_preimage: PaymentPreimage, expected_amount: u64) {
1124 claim_payment_along_route_with_secret(origin_node, &[expected_route], skip_last, our_payment_preimage, None, expected_amount);
1127 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage, expected_amount: u64) {
1128 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
1131 pub const TEST_FINAL_CLTV: u32 = 50;
1133 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
1134 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1135 let logger = test_utils::TestLogger::new();
1136 let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &expected_route.last().unwrap().node.get_our_node_id(), None, None, &Vec::new(), recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1137 assert_eq!(route.paths.len(), 1);
1138 assert_eq!(route.paths[0].len(), expected_route.len());
1139 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1140 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1143 send_along_route(origin_node, route, expected_route, recv_value)
1146 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1147 let logger = test_utils::TestLogger::new();
1148 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1149 let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &expected_route.last().unwrap().node.get_our_node_id(), None, None, &Vec::new(), recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1150 assert_eq!(route.paths.len(), 1);
1151 assert_eq!(route.paths[0].len(), expected_route.len());
1152 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1153 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1156 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
1157 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1158 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1161 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64) {
1162 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1163 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
1166 pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], skip_last: bool, our_payment_hash: PaymentHash) {
1167 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, &None));
1168 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
1169 check_added_monitors!(expected_route.last().unwrap(), 1);
1171 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
1172 macro_rules! update_fail_dance {
1173 ($node: expr, $prev_node: expr, $last_node: expr) => {
1175 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1176 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
1177 if skip_last && $last_node {
1178 expect_pending_htlcs_forwardable!($node);
1184 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
1185 let mut prev_node = expected_route.last().unwrap();
1186 for (idx, node) in expected_route.iter().rev().enumerate() {
1187 assert_eq!(expected_next_node, node.node.get_our_node_id());
1188 if next_msgs.is_some() {
1189 // We may be the "last node" for the purpose of the commitment dance if we're
1190 // skipping the last node (implying it is disconnected) and we're the
1191 // second-to-last node!
1192 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
1195 let events = node.node.get_and_clear_pending_msg_events();
1196 if !skip_last || idx != expected_route.len() - 1 {
1197 assert_eq!(events.len(), 1);
1199 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 } } => {
1200 assert!(update_add_htlcs.is_empty());
1201 assert!(update_fulfill_htlcs.is_empty());
1202 assert_eq!(update_fail_htlcs.len(), 1);
1203 assert!(update_fail_malformed_htlcs.is_empty());
1204 assert!(update_fee.is_none());
1205 expected_next_node = node_id.clone();
1206 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1208 _ => panic!("Unexpected event"),
1211 assert!(events.is_empty());
1213 if !skip_last && idx == expected_route.len() - 1 {
1214 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1221 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1223 let events = origin_node.node.get_and_clear_pending_events();
1224 assert_eq!(events.len(), 1);
1226 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1227 assert_eq!(payment_hash, our_payment_hash);
1228 assert!(rejected_by_dest);
1230 _ => panic!("Unexpected event"),
1235 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1236 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1239 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1240 let mut chan_mon_cfgs = Vec::new();
1241 for i in 0..node_count {
1242 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
1243 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
1244 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1245 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1246 let persister = test_utils::TestPersister::new();
1247 let seed = [i as u8; 32];
1248 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1250 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1256 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1257 let mut nodes = Vec::new();
1259 for i in 0..node_count {
1260 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);
1261 let seed = [i as u8; 32];
1262 nodes.push(NodeCfg { chain_source: &chanmon_cfgs[i].chain_source, logger: &chanmon_cfgs[i].logger, tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster, fee_estimator: &chanmon_cfgs[i].fee_estimator, chain_monitor, keys_manager: &chanmon_cfgs[i].keys_manager, node_seed: seed });
1268 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>> {
1269 let mut chanmgrs = Vec::new();
1270 for i in 0..node_count {
1271 let mut default_config = UserConfig::default();
1272 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1273 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1274 default_config.channel_options.cltv_expiry_delta = 6*6;
1275 default_config.channel_options.announced_channel = true;
1276 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1277 default_config.own_channel_config.our_htlc_minimum_msat = 1000; // sanitization being done by the sender, to exerce receiver logic we need to lift of limit
1278 let network = Network::Testnet;
1279 let params = ChainParameters {
1281 latest_hash: genesis_block(network).header.block_hash(),
1284 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager, if node_config[i].is_some() { node_config[i].clone().unwrap() } else { default_config }, params);
1285 chanmgrs.push(node);
1291 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>> {
1292 let mut nodes = Vec::new();
1293 let chan_count = Rc::new(RefCell::new(0));
1294 let payment_count = Rc::new(RefCell::new(0));
1295 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1297 for i in 0..node_count {
1298 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].chain_source.genesis_hash, None, cfgs[i].logger);
1299 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1300 tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1301 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1302 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1303 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1304 blocks: RefCell::new(vec![(genesis_block(Network::Testnet).header, 0)]),
1305 connect_style: Rc::clone(&connect_style),
1312 // Note that the following only works for CLTV values up to 128
1313 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1314 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1316 #[derive(PartialEq)]
1317 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1318 /// Tests that the given node has broadcast transactions for the given Channel
1320 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1321 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1322 /// broadcast and the revoked outputs were claimed.
1324 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1325 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1327 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1329 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> {
1330 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1331 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1333 let mut res = Vec::with_capacity(2);
1334 node_txn.retain(|tx| {
1335 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1336 check_spends!(tx, chan.3);
1337 if commitment_tx.is_none() {
1338 res.push(tx.clone());
1343 if let Some(explicit_tx) = commitment_tx {
1344 res.push(explicit_tx.clone());
1347 assert_eq!(res.len(), 1);
1349 if has_htlc_tx != HTLCType::NONE {
1350 node_txn.retain(|tx| {
1351 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1352 check_spends!(tx, res[0]);
1353 if has_htlc_tx == HTLCType::TIMEOUT {
1354 assert!(tx.lock_time != 0);
1356 assert!(tx.lock_time == 0);
1358 res.push(tx.clone());
1362 assert!(res.len() == 2 || res.len() == 3);
1364 assert_eq!(res[1], res[2]);
1368 assert!(node_txn.is_empty());
1372 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1373 /// HTLC transaction.
1374 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1375 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1376 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1377 // for revoked htlc outputs
1378 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1379 node_txn.retain(|tx| {
1380 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1381 check_spends!(tx, revoked_tx);
1385 node_txn.retain(|tx| {
1386 check_spends!(tx, commitment_revoked_tx);
1389 assert!(node_txn.is_empty());
1392 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1393 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1395 assert!(node_txn.len() >= 1);
1396 assert_eq!(node_txn[0].input.len(), 1);
1397 let mut found_prev = false;
1399 for tx in prev_txn {
1400 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1401 check_spends!(node_txn[0], tx);
1402 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1403 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1409 assert!(found_prev);
1411 let mut res = Vec::new();
1412 mem::swap(&mut *node_txn, &mut res);
1416 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1417 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1418 assert_eq!(events_1.len(), 2);
1419 let as_update = match events_1[0] {
1420 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1423 _ => panic!("Unexpected event"),
1426 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1427 assert_eq!(node_id, nodes[b].node.get_our_node_id());
1428 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1430 _ => panic!("Unexpected event"),
1433 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1434 assert_eq!(events_2.len(), 2);
1435 let bs_update = match events_2[0] {
1436 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1439 _ => panic!("Unexpected event"),
1442 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1443 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1444 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1446 _ => panic!("Unexpected event"),
1450 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1451 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1456 macro_rules! get_channel_value_stat {
1457 ($node: expr, $channel_id: expr) => {{
1458 let chan_lock = $node.node.channel_state.lock().unwrap();
1459 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1460 chan.get_value_stat()
1464 macro_rules! get_chan_reestablish_msgs {
1465 ($src_node: expr, $dst_node: expr) => {
1467 let mut res = Vec::with_capacity(1);
1468 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1469 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1470 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1471 res.push(msg.clone());
1473 panic!("Unexpected event")
1481 macro_rules! handle_chan_reestablish_msgs {
1482 ($src_node: expr, $dst_node: expr) => {
1484 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1486 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1488 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1494 let mut revoke_and_ack = None;
1495 let mut commitment_update = None;
1496 let order = if let Some(ev) = msg_events.get(idx) {
1499 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1500 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1501 revoke_and_ack = Some(msg.clone());
1502 RAACommitmentOrder::RevokeAndACKFirst
1504 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1505 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1506 commitment_update = Some(updates.clone());
1507 RAACommitmentOrder::CommitmentFirst
1509 _ => panic!("Unexpected event"),
1512 RAACommitmentOrder::CommitmentFirst
1515 if let Some(ev) = msg_events.get(idx) {
1517 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1518 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1519 assert!(revoke_and_ack.is_none());
1520 revoke_and_ack = Some(msg.clone());
1522 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1523 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1524 assert!(commitment_update.is_none());
1525 commitment_update = Some(updates.clone());
1527 _ => panic!("Unexpected event"),
1531 (funding_locked, revoke_and_ack, commitment_update, order)
1536 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1537 /// for claims/fails they are separated out.
1538 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_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool)) {
1539 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1540 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1541 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1542 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1544 if send_funding_locked.0 {
1545 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1547 for reestablish in reestablish_1.iter() {
1548 assert_eq!(reestablish.next_remote_commitment_number, 0);
1551 if send_funding_locked.1 {
1552 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1554 for reestablish in reestablish_2.iter() {
1555 assert_eq!(reestablish.next_remote_commitment_number, 0);
1558 if send_funding_locked.0 || send_funding_locked.1 {
1559 // If we expect any funding_locked's, both sides better have set
1560 // next_holder_commitment_number to 1
1561 for reestablish in reestablish_1.iter() {
1562 assert_eq!(reestablish.next_local_commitment_number, 1);
1564 for reestablish in reestablish_2.iter() {
1565 assert_eq!(reestablish.next_local_commitment_number, 1);
1569 let mut resp_1 = Vec::new();
1570 for msg in reestablish_1 {
1571 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1572 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1574 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1575 check_added_monitors!(node_b, 1);
1577 check_added_monitors!(node_b, 0);
1580 let mut resp_2 = Vec::new();
1581 for msg in reestablish_2 {
1582 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1583 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1585 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1586 check_added_monitors!(node_a, 1);
1588 check_added_monitors!(node_a, 0);
1591 // We don't yet support both needing updates, as that would require a different commitment dance:
1592 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1593 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1595 for chan_msgs in resp_1.drain(..) {
1596 if send_funding_locked.0 {
1597 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1598 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1599 if !announcement_event.is_empty() {
1600 assert_eq!(announcement_event.len(), 1);
1601 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1602 //TODO: Test announcement_sigs re-sending
1603 } else { panic!("Unexpected event!"); }
1606 assert!(chan_msgs.0.is_none());
1609 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1610 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1611 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1612 check_added_monitors!(node_a, 1);
1614 assert!(chan_msgs.1.is_none());
1616 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1617 let commitment_update = chan_msgs.2.unwrap();
1618 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1619 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1621 assert!(commitment_update.update_add_htlcs.is_empty());
1623 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1624 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1625 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1626 for update_add in commitment_update.update_add_htlcs {
1627 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1629 for update_fulfill in commitment_update.update_fulfill_htlcs {
1630 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1632 for update_fail in commitment_update.update_fail_htlcs {
1633 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1636 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1637 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1639 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1640 check_added_monitors!(node_a, 1);
1641 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1642 // No commitment_signed so get_event_msg's assert(len == 1) passes
1643 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1644 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1645 check_added_monitors!(node_b, 1);
1648 assert!(chan_msgs.2.is_none());
1652 for chan_msgs in resp_2.drain(..) {
1653 if send_funding_locked.1 {
1654 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1655 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1656 if !announcement_event.is_empty() {
1657 assert_eq!(announcement_event.len(), 1);
1658 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1659 //TODO: Test announcement_sigs re-sending
1660 } else { panic!("Unexpected event!"); }
1663 assert!(chan_msgs.0.is_none());
1666 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1667 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1668 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1669 check_added_monitors!(node_b, 1);
1671 assert!(chan_msgs.1.is_none());
1673 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1674 let commitment_update = chan_msgs.2.unwrap();
1675 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1676 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1678 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1679 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1680 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1681 for update_add in commitment_update.update_add_htlcs {
1682 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1684 for update_fulfill in commitment_update.update_fulfill_htlcs {
1685 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1687 for update_fail in commitment_update.update_fail_htlcs {
1688 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1691 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1692 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1694 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1695 check_added_monitors!(node_b, 1);
1696 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1697 // No commitment_signed so get_event_msg's assert(len == 1) passes
1698 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1699 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1700 check_added_monitors!(node_a, 1);
1703 assert!(chan_msgs.2.is_none());