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::{Confirm, Listen, Watch};
14 use chain::channelmonitor::ChannelMonitor;
15 use chain::transaction::OutPoint;
16 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
17 use ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
18 use routing::router::{Route, get_route};
19 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
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};
27 use util::errors::APIError;
28 use util::config::UserConfig;
29 use util::ser::{ReadableArgs, Writeable, Readable};
31 use bitcoin::blockdata::block::{Block, BlockHeader};
32 use bitcoin::blockdata::constants::genesis_block;
33 use bitcoin::blockdata::transaction::{Transaction, TxOut};
34 use bitcoin::network::constants::Network;
36 use bitcoin::hashes::sha256::Hash as Sha256;
37 use bitcoin::hashes::Hash;
38 use bitcoin::hash_types::BlockHash;
40 use bitcoin::secp256k1::key::PublicKey;
43 use core::cell::RefCell;
45 use std::sync::{Arc, Mutex};
48 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
50 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
51 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
52 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
53 confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
54 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
56 /// Mine a signle block containing the given transaction
57 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
58 let height = node.best_block_info().1 + 1;
59 confirm_transaction_at(node, tx, height);
61 /// Mine the given transaction at the given height, mining blocks as required to build to that
63 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
64 let first_connect_height = node.best_block_info().1 + 1;
65 assert!(first_connect_height <= conf_height);
66 if conf_height > first_connect_height {
67 connect_blocks(node, conf_height - first_connect_height);
69 let mut block = Block {
70 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: conf_height, bits: 42, nonce: 42 },
73 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
74 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
76 block.txdata.push(tx.clone());
77 connect_block(node, &block);
80 /// The possible ways we may notify a ChannelManager of a new block
81 #[derive(Clone, Copy, PartialEq)]
82 pub enum ConnectStyle {
83 /// Calls best_block_updated first, detecting transactions in the block only after receiving the
84 /// header and height information.
86 /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
87 /// make a single best_block_updated call.
88 BestBlockFirstSkippingBlocks,
89 /// Calls transactions_confirmed first, detecting transactions in the block before updating the
90 /// header and height information.
92 /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
93 /// make a single best_block_updated call.
94 TransactionsFirstSkippingBlocks,
95 /// Provides the full block via the chain::Listen interface. In the current code this is
96 /// equivalent to TransactionsFirst with some additional assertions.
100 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
101 let skip_intermediaries = match *node.connect_style.borrow() {
102 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
106 let height = node.best_block_info().1 + 1;
107 let mut block = Block {
108 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: height, bits: 42, nonce: 42 },
113 do_connect_block(node, &block, skip_intermediaries);
115 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: height + i, bits: 42, nonce: 42 },
119 connect_block(node, &block);
120 block.header.block_hash()
123 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
124 do_connect_block(node, block, false);
127 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
128 let height = node.best_block_info().1 + 1;
129 if !skip_intermediaries {
130 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
131 match *node.connect_style.borrow() {
132 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
133 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
134 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
135 node.node.best_block_updated(&block.header, height);
136 node.node.transactions_confirmed(&block.header, &txdata, height);
138 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
139 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
140 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
141 node.node.transactions_confirmed(&block.header, &txdata, height);
142 node.node.best_block_updated(&block.header, height);
144 ConnectStyle::FullBlockViaListen => {
145 node.chain_monitor.chain_monitor.block_connected(&block, height);
146 node.node.block_connected(&block, height);
150 node.node.test_process_background_events();
151 node.blocks.lock().unwrap().push((block.header, height));
154 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
156 let orig_header = node.blocks.lock().unwrap().pop().unwrap();
157 assert!(orig_header.1 > 0); // Cannot disconnect genesis
158 let prev_header = node.blocks.lock().unwrap().last().unwrap().clone();
160 match *node.connect_style.borrow() {
161 ConnectStyle::FullBlockViaListen => {
162 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
163 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
165 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
167 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
168 node.node.best_block_updated(&prev_header.0, prev_header.1);
172 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
173 node.node.best_block_updated(&prev_header.0, prev_header.1);
179 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
180 let count = node.blocks.lock().unwrap().len() as u32 - 1;
181 disconnect_blocks(node, count);
184 pub struct TestChanMonCfg {
185 pub tx_broadcaster: test_utils::TestBroadcaster,
186 pub fee_estimator: test_utils::TestFeeEstimator,
187 pub chain_source: test_utils::TestChainSource,
188 pub persister: test_utils::TestPersister,
189 pub logger: test_utils::TestLogger,
190 pub keys_manager: test_utils::TestKeysInterface,
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 node_seed: [u8; 32],
203 pub struct Node<'a, 'b: 'a, 'c: 'b> {
204 pub chain_source: &'c test_utils::TestChainSource,
205 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
206 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
207 pub keys_manager: &'b test_utils::TestKeysInterface,
208 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
209 pub net_graph_msg_handler: NetGraphMsgHandler<&'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
210 pub node_seed: [u8; 32],
211 pub network_payment_count: Rc<RefCell<u8>>,
212 pub network_chan_count: Rc<RefCell<u32>>,
213 pub logger: &'c test_utils::TestLogger,
214 pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
215 pub connect_style: Rc<RefCell<ConnectStyle>>,
217 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
218 pub fn best_block_hash(&self) -> BlockHash {
219 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
221 pub fn best_block_info(&self) -> (BlockHash, u32) {
222 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
226 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
228 if !::std::thread::panicking() {
229 // Check that we processed all pending events
230 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
231 assert!(self.node.get_and_clear_pending_events().is_empty());
232 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
234 // Check that if we serialize the Router, we can deserialize it again.
236 let mut w = test_utils::TestVecWriter(Vec::new());
237 let network_graph_ser = self.net_graph_msg_handler.network_graph.read().unwrap();
238 network_graph_ser.write(&mut w).unwrap();
239 let network_graph_deser = <NetworkGraph>::read(&mut ::std::io::Cursor::new(&w.0)).unwrap();
240 assert!(network_graph_deser == *self.net_graph_msg_handler.network_graph.read().unwrap());
241 let net_graph_msg_handler = NetGraphMsgHandler::from_net_graph(
242 Some(self.chain_source), self.logger, network_graph_deser
244 let mut chan_progress = 0;
246 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
247 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
248 assert!(orig_announcements == deserialized_announcements);
249 chan_progress = match orig_announcements.last() {
250 Some(announcement) => announcement.0.contents.short_channel_id + 1,
254 let mut node_progress = None;
256 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
257 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
258 assert!(orig_announcements == deserialized_announcements);
259 node_progress = match orig_announcements.last() {
260 Some(announcement) => Some(announcement.contents.node_id),
266 // Check that if we serialize and then deserialize all our channel monitors we get the
267 // same set of outputs to watch for on chain as we have now. Note that if we write
268 // tests that fully close channels and remove the monitors at some point this may break.
269 let feeest = test_utils::TestFeeEstimator { sat_per_kw: 253 };
270 let mut deserialized_monitors = Vec::new();
272 let old_monitors = self.chain_monitor.chain_monitor.monitors.read().unwrap();
273 for (_, old_monitor) in old_monitors.iter() {
274 let mut w = test_utils::TestVecWriter(Vec::new());
275 old_monitor.write(&mut w).unwrap();
276 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
277 &mut ::std::io::Cursor::new(&w.0), self.keys_manager).unwrap();
278 deserialized_monitors.push(deserialized_monitor);
282 // Before using all the new monitors to check the watch outpoints, use the full set of
283 // them to ensure we can write and reload our ChannelManager.
285 let mut channel_monitors = HashMap::new();
286 for monitor in deserialized_monitors.iter_mut() {
287 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
290 let mut w = test_utils::TestVecWriter(Vec::new());
291 self.node.write(&mut w).unwrap();
292 <(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 {
293 default_config: *self.node.get_current_default_configuration(),
294 keys_manager: self.keys_manager,
295 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: 253 },
296 chain_monitor: self.chain_monitor,
297 tx_broadcaster: &test_utils::TestBroadcaster {
298 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
299 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
301 logger: &test_utils::TestLogger::new(),
306 let persister = test_utils::TestPersister::new();
307 let broadcaster = test_utils::TestBroadcaster {
308 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
309 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
311 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
312 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
313 for deserialized_monitor in deserialized_monitors.drain(..) {
314 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
318 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
319 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
324 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) {
325 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
328 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) {
329 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);
330 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
331 (announcement, as_update, bs_update, channel_id, tx)
334 macro_rules! get_revoke_commit_msgs {
335 ($node: expr, $node_id: expr) => {
337 let events = $node.node.get_and_clear_pending_msg_events();
338 assert_eq!(events.len(), 2);
340 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
341 assert_eq!(*node_id, $node_id);
344 _ => panic!("Unexpected event"),
346 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
347 assert_eq!(*node_id, $node_id);
348 assert!(updates.update_add_htlcs.is_empty());
349 assert!(updates.update_fulfill_htlcs.is_empty());
350 assert!(updates.update_fail_htlcs.is_empty());
351 assert!(updates.update_fail_malformed_htlcs.is_empty());
352 assert!(updates.update_fee.is_none());
353 updates.commitment_signed.clone()
355 _ => panic!("Unexpected event"),
361 /// Get an specific event message from the pending events queue.
363 macro_rules! get_event_msg {
364 ($node: expr, $event_type: path, $node_id: expr) => {
366 let events = $node.node.get_and_clear_pending_msg_events();
367 assert_eq!(events.len(), 1);
369 $event_type { ref node_id, ref msg } => {
370 assert_eq!(*node_id, $node_id);
373 _ => panic!("Unexpected event"),
379 /// Get a specific event from the pending events queue.
381 macro_rules! get_event {
382 ($node: expr, $event_type: path) => {
384 let mut events = $node.node.get_and_clear_pending_events();
385 assert_eq!(events.len(), 1);
386 let ev = events.pop().unwrap();
388 $event_type { .. } => {
391 _ => panic!("Unexpected event"),
398 macro_rules! get_htlc_update_msgs {
399 ($node: expr, $node_id: expr) => {
401 let events = $node.node.get_and_clear_pending_msg_events();
402 assert_eq!(events.len(), 1);
404 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
405 assert_eq!(*node_id, $node_id);
408 _ => panic!("Unexpected event"),
415 macro_rules! get_feerate {
416 ($node: expr, $channel_id: expr) => {
418 let chan_lock = $node.node.channel_state.lock().unwrap();
419 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
425 /// Returns any local commitment transactions for the channel.
427 macro_rules! get_local_commitment_txn {
428 ($node: expr, $channel_id: expr) => {
430 let monitors = $node.chain_monitor.chain_monitor.monitors.read().unwrap();
431 let mut commitment_txn = None;
432 for (funding_txo, monitor) in monitors.iter() {
433 if funding_txo.to_channel_id() == $channel_id {
434 commitment_txn = Some(monitor.unsafe_get_latest_holder_commitment_txn(&$node.logger));
438 commitment_txn.unwrap()
443 /// Check the error from attempting a payment.
445 macro_rules! unwrap_send_err {
446 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
448 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
449 assert_eq!(fails.len(), 1);
455 &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
456 assert_eq!(fails.len(), 1);
458 Err($type) => { $check },
467 /// Check whether N channel monitor(s) have been added.
469 macro_rules! check_added_monitors {
470 ($node: expr, $count: expr) => {
472 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
473 assert_eq!(added_monitors.len(), $count);
474 added_monitors.clear();
479 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) {
480 let chan_id = *node.network_chan_count.borrow();
482 let events = node.node.get_and_clear_pending_events();
483 assert_eq!(events.len(), 1);
485 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
486 assert_eq!(*channel_value_satoshis, expected_chan_value);
487 assert_eq!(user_channel_id, expected_user_chan_id);
489 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
490 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
492 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
493 (*temporary_channel_id, tx, funding_outpoint)
495 _ => panic!("Unexpected event"),
499 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 {
500 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
501 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()));
502 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()));
504 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
506 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
507 check_added_monitors!(node_a, 0);
509 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()));
511 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
512 assert_eq!(added_monitors.len(), 1);
513 assert_eq!(added_monitors[0].0, funding_output);
514 added_monitors.clear();
517 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()));
519 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
520 assert_eq!(added_monitors.len(), 1);
521 assert_eq!(added_monitors[0].0, funding_output);
522 added_monitors.clear();
525 let events_4 = node_a.node.get_and_clear_pending_events();
526 assert_eq!(events_4.len(), 0);
528 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
529 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
530 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
535 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) {
536 confirm_transaction_at(node_conf, tx, conf_height);
537 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
538 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()));
541 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]) {
543 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
544 assert_eq!(events_6.len(), 2);
545 ((match events_6[0] {
546 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
547 channel_id = msg.channel_id.clone();
548 assert_eq!(*node_id, node_recv.node.get_our_node_id());
551 _ => panic!("Unexpected event"),
552 }, match events_6[1] {
553 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
554 assert_eq!(*node_id, node_recv.node.get_our_node_id());
557 _ => panic!("Unexpected event"),
561 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]) {
562 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
563 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
564 confirm_transaction_at(node_a, tx, conf_height);
565 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
566 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
569 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) {
570 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
571 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
575 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) {
576 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
577 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
578 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
580 let events_7 = node_b.node.get_and_clear_pending_msg_events();
581 assert_eq!(events_7.len(), 1);
582 let (announcement, bs_update) = match events_7[0] {
583 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
586 _ => panic!("Unexpected event"),
589 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
590 let events_8 = node_a.node.get_and_clear_pending_msg_events();
591 assert_eq!(events_8.len(), 1);
592 let as_update = match events_8[0] {
593 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
594 assert!(*announcement == *msg);
595 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
596 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
599 _ => panic!("Unexpected event"),
602 *node_a.network_chan_count.borrow_mut() += 1;
604 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
607 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) {
608 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
611 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) {
612 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
613 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
614 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
617 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) {
618 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
619 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
620 assert!(a_events.len() >= 2);
622 // ann should be re-generated by broadcast_node_announcement - check that we have it.
623 let mut found_ann_1 = false;
624 for event in a_events.iter() {
626 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
627 if msg == ann { found_ann_1 = true; }
629 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
630 _ => panic!("Unexpected event {:?}", event),
633 assert!(found_ann_1);
635 let a_node_announcement = match a_events.last().unwrap() {
636 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
639 _ => panic!("Unexpected event"),
642 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
643 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
644 assert!(b_events.len() >= 2);
646 // ann should be re-generated by broadcast_node_announcement - check that we have it.
647 let mut found_ann_2 = false;
648 for event in b_events.iter() {
650 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
651 if msg == ann { found_ann_2 = true; }
653 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
654 _ => panic!("Unexpected event"),
657 assert!(found_ann_2);
659 let b_node_announcement = match b_events.last().unwrap() {
660 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
663 _ => panic!("Unexpected event"),
667 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
668 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
669 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
670 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
671 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
675 macro_rules! check_spends {
676 ($tx: expr, $($spends_txn: expr),*) => {
678 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
680 if out_point.txid == $spends_txn.txid() {
681 return $spends_txn.output.get(out_point.vout as usize).cloned()
686 let mut total_value_in = 0;
687 for input in $tx.input.iter() {
688 total_value_in += get_output(&input.previous_output).unwrap().value;
690 let mut total_value_out = 0;
691 for output in $tx.output.iter() {
692 total_value_out += output.value;
694 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
695 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
696 assert!(total_value_out + min_fee <= total_value_in);
697 $tx.verify(get_output).unwrap();
702 macro_rules! get_closing_signed_broadcast {
703 ($node: expr, $dest_pubkey: expr) => {
705 let events = $node.get_and_clear_pending_msg_events();
706 assert!(events.len() == 1 || events.len() == 2);
707 (match events[events.len() - 1] {
708 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
709 assert_eq!(msg.contents.flags & 2, 2);
712 _ => panic!("Unexpected event"),
713 }, if events.len() == 2 {
715 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
716 assert_eq!(*node_id, $dest_pubkey);
719 _ => panic!("Unexpected event"),
726 /// Check that a channel's closing channel update has been broadcasted, and optionally
727 /// check whether an error message event has occurred.
729 macro_rules! check_closed_broadcast {
730 ($node: expr, $with_error_msg: expr) => {{
731 let events = $node.node.get_and_clear_pending_msg_events();
732 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
734 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
735 assert_eq!(msg.contents.flags & 2, 2);
737 _ => panic!("Unexpected event"),
741 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
742 // TODO: Check node_id
745 _ => panic!("Unexpected event"),
751 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) {
752 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) };
753 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
756 node_a.close_channel(channel_id).unwrap();
757 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()));
759 let events_1 = node_b.get_and_clear_pending_msg_events();
760 assert!(events_1.len() >= 1);
761 let shutdown_b = match events_1[0] {
762 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
763 assert_eq!(node_id, &node_a.get_our_node_id());
766 _ => panic!("Unexpected event"),
769 let closing_signed_b = if !close_inbound_first {
770 assert_eq!(events_1.len(), 1);
773 Some(match events_1[1] {
774 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
775 assert_eq!(node_id, &node_a.get_our_node_id());
778 _ => panic!("Unexpected event"),
782 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
783 let (as_update, bs_update) = if close_inbound_first {
784 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
785 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
786 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
787 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
788 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
790 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
791 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
792 assert!(none_b.is_none());
793 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
794 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
795 (as_update, bs_update)
797 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
799 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
800 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
801 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
802 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
804 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
805 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
806 assert!(none_a.is_none());
807 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
808 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
809 (as_update, bs_update)
811 assert_eq!(tx_a, tx_b);
812 check_spends!(tx_a, funding_tx);
814 (as_update, bs_update, tx_a)
817 pub struct SendEvent {
818 pub node_id: PublicKey,
819 pub msgs: Vec<msgs::UpdateAddHTLC>,
820 pub commitment_msg: msgs::CommitmentSigned,
823 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
824 assert!(updates.update_fulfill_htlcs.is_empty());
825 assert!(updates.update_fail_htlcs.is_empty());
826 assert!(updates.update_fail_malformed_htlcs.is_empty());
827 assert!(updates.update_fee.is_none());
828 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
831 pub fn from_event(event: MessageSendEvent) -> SendEvent {
833 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
834 _ => panic!("Unexpected event type!"),
838 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
839 let mut events = node.node.get_and_clear_pending_msg_events();
840 assert_eq!(events.len(), 1);
841 SendEvent::from_event(events.pop().unwrap())
845 macro_rules! commitment_signed_dance {
846 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
848 check_added_monitors!($node_a, 0);
849 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
850 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
851 check_added_monitors!($node_a, 1);
852 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
855 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
857 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
858 check_added_monitors!($node_b, 0);
859 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
860 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
861 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
862 check_added_monitors!($node_b, 1);
863 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
864 let (bs_revoke_and_ack, extra_msg_option) = {
865 let events = $node_b.node.get_and_clear_pending_msg_events();
866 assert!(events.len() <= 2);
868 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
869 assert_eq!(*node_id, $node_a.node.get_our_node_id());
872 _ => panic!("Unexpected event"),
873 }, events.get(1).map(|e| e.clone()))
875 check_added_monitors!($node_b, 1);
877 assert!($node_a.node.get_and_clear_pending_events().is_empty());
878 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
880 (extra_msg_option, bs_revoke_and_ack)
883 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
885 check_added_monitors!($node_a, 0);
886 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
887 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
888 check_added_monitors!($node_a, 1);
889 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
890 assert!(extra_msg_option.is_none());
894 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
896 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
897 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
898 check_added_monitors!($node_a, 1);
902 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
904 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
907 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
909 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
911 expect_pending_htlcs_forwardable!($node_a);
912 check_added_monitors!($node_a, 1);
914 let channel_state = $node_a.node.channel_state.lock().unwrap();
915 assert_eq!(channel_state.pending_msg_events.len(), 1);
916 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
917 assert_ne!(*node_id, $node_b.node.get_our_node_id());
918 } else { panic!("Unexpected event"); }
920 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
926 /// Get a payment preimage and hash.
928 macro_rules! get_payment_preimage_hash {
929 ($dest_node: expr) => {
931 let payment_preimage = PaymentPreimage([*$dest_node.network_payment_count.borrow(); 32]);
932 *$dest_node.network_payment_count.borrow_mut() += 1;
933 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
934 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
935 (payment_preimage, payment_hash, payment_secret)
941 macro_rules! get_route_and_payment_hash {
942 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
943 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node);
944 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
945 let route = get_route(&$send_node.node.get_our_node_id(),
946 &net_graph_msg_handler.network_graph.read().unwrap(),
947 &$recv_node.node.get_our_node_id(), None, None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, $send_node.logger).unwrap();
948 (route, payment_hash, payment_preimage, payment_secret)
952 macro_rules! expect_pending_htlcs_forwardable_ignore {
954 let events = $node.node.get_and_clear_pending_events();
955 assert_eq!(events.len(), 1);
957 Event::PendingHTLCsForwardable { .. } => { },
958 _ => panic!("Unexpected event"),
963 macro_rules! expect_pending_htlcs_forwardable {
965 expect_pending_htlcs_forwardable_ignore!($node);
966 $node.node.process_pending_htlc_forwards();
970 #[cfg(any(test, feature = "unstable"))]
971 macro_rules! expect_payment_received {
972 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
973 let events = $node.node.get_and_clear_pending_events();
974 assert_eq!(events.len(), 1);
976 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
977 assert_eq!($expected_payment_hash, *payment_hash);
978 assert!(payment_preimage.is_none());
979 assert_eq!($expected_payment_secret, *payment_secret);
980 assert_eq!($expected_recv_value, amt);
982 _ => panic!("Unexpected event"),
987 macro_rules! expect_payment_sent {
988 ($node: expr, $expected_payment_preimage: expr) => {
989 let events = $node.node.get_and_clear_pending_events();
990 assert_eq!(events.len(), 1);
992 Event::PaymentSent { ref payment_preimage } => {
993 assert_eq!($expected_payment_preimage, *payment_preimage);
995 _ => panic!("Unexpected event"),
1001 macro_rules! expect_payment_failed {
1002 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1003 let events = $node.node.get_and_clear_pending_events();
1004 assert_eq!(events.len(), 1);
1006 Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data } => {
1007 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1008 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1009 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1010 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1012 assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
1013 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
1016 _ => panic!("Unexpected event"),
1021 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) {
1022 origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1023 check_added_monitors!(origin_node, expected_paths.len());
1024 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1027 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: PaymentSecret, ev: MessageSendEvent, payment_received_expected: bool) {
1028 let mut payment_event = SendEvent::from_event(ev);
1029 let mut prev_node = origin_node;
1031 for (idx, &node) in expected_path.iter().enumerate() {
1032 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1034 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1035 check_added_monitors!(node, 0);
1036 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1038 expect_pending_htlcs_forwardable!(node);
1040 if idx == expected_path.len() - 1 {
1041 let events_2 = node.node.get_and_clear_pending_events();
1042 if payment_received_expected {
1043 assert_eq!(events_2.len(), 1);
1045 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
1046 assert_eq!(our_payment_hash, *payment_hash);
1047 assert!(payment_preimage.is_none());
1048 assert_eq!(our_payment_secret, *payment_secret);
1049 assert_eq!(amt, recv_value);
1051 _ => panic!("Unexpected event"),
1054 assert!(events_2.is_empty());
1057 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1058 assert_eq!(events_2.len(), 1);
1059 check_added_monitors!(node, 1);
1060 payment_event = SendEvent::from_event(events_2.remove(0));
1061 assert_eq!(payment_event.msgs.len(), 1);
1068 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) {
1069 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1070 assert_eq!(events.len(), expected_route.len());
1071 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1072 // Once we've gotten through all the HTLCs, the last one should result in a
1073 // PaymentReceived (but each previous one should not!), .
1074 let expect_payment = path_idx == expected_route.len() - 1;
1075 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), our_payment_secret, ev, expect_payment);
1079 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) {
1080 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1081 send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1082 (our_payment_preimage, our_payment_hash, our_payment_secret)
1085 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) {
1086 for path in expected_paths.iter() {
1087 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1089 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1090 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1092 macro_rules! msgs_from_ev {
1095 &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 } } => {
1096 assert!(update_add_htlcs.is_empty());
1097 assert_eq!(update_fulfill_htlcs.len(), 1);
1098 assert!(update_fail_htlcs.is_empty());
1099 assert!(update_fail_malformed_htlcs.is_empty());
1100 assert!(update_fee.is_none());
1101 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1103 _ => panic!("Unexpected event"),
1107 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1108 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1109 assert_eq!(events.len(), expected_paths.len());
1110 for ev in events.iter() {
1111 per_path_msgs.push(msgs_from_ev!(ev));
1114 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1115 let mut next_msgs = Some(path_msgs);
1116 let mut expected_next_node = next_hop;
1118 macro_rules! last_update_fulfill_dance {
1119 ($node: expr, $prev_node: expr) => {
1121 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1122 check_added_monitors!($node, 0);
1123 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1124 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1128 macro_rules! mid_update_fulfill_dance {
1129 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1131 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1132 check_added_monitors!($node, 1);
1133 let new_next_msgs = if $new_msgs {
1134 let events = $node.node.get_and_clear_pending_msg_events();
1135 assert_eq!(events.len(), 1);
1136 let (res, nexthop) = msgs_from_ev!(&events[0]);
1137 expected_next_node = nexthop;
1140 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1143 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1144 next_msgs = new_next_msgs;
1149 let mut prev_node = expected_route.last().unwrap();
1150 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1151 assert_eq!(expected_next_node, node.node.get_our_node_id());
1152 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1153 if next_msgs.is_some() {
1154 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1156 assert!(!update_next_msgs);
1157 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1159 if !skip_last && idx == expected_route.len() - 1 {
1160 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1167 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1168 expect_payment_sent!(origin_node, our_payment_preimage);
1173 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1174 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1177 pub const TEST_FINAL_CLTV: u32 = 70;
1179 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) {
1180 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1181 let logger = test_utils::TestLogger::new();
1182 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1183 assert_eq!(route.paths.len(), 1);
1184 assert_eq!(route.paths[0].len(), expected_route.len());
1185 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1186 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1189 send_along_route(origin_node, route, expected_route, recv_value)
1192 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1193 let logger = test_utils::TestLogger::new();
1194 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1195 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1196 assert_eq!(route.paths.len(), 1);
1197 assert_eq!(route.paths[0].len(), expected_route.len());
1198 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1199 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1202 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1203 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1204 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1207 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1208 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1209 claim_payment(&origin, expected_route, our_payment_preimage);
1212 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) {
1213 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1214 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
1215 check_added_monitors!(expected_route.last().unwrap(), 1);
1217 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
1218 macro_rules! update_fail_dance {
1219 ($node: expr, $prev_node: expr, $last_node: expr) => {
1221 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1222 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
1223 if skip_last && $last_node {
1224 expect_pending_htlcs_forwardable!($node);
1230 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
1231 let mut prev_node = expected_route.last().unwrap();
1232 for (idx, node) in expected_route.iter().rev().enumerate() {
1233 assert_eq!(expected_next_node, node.node.get_our_node_id());
1234 if next_msgs.is_some() {
1235 // We may be the "last node" for the purpose of the commitment dance if we're
1236 // skipping the last node (implying it is disconnected) and we're the
1237 // second-to-last node!
1238 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
1241 let events = node.node.get_and_clear_pending_msg_events();
1242 if !skip_last || idx != expected_route.len() - 1 {
1243 assert_eq!(events.len(), 1);
1245 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 } } => {
1246 assert!(update_add_htlcs.is_empty());
1247 assert!(update_fulfill_htlcs.is_empty());
1248 assert_eq!(update_fail_htlcs.len(), 1);
1249 assert!(update_fail_malformed_htlcs.is_empty());
1250 assert!(update_fee.is_none());
1251 expected_next_node = node_id.clone();
1252 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1254 _ => panic!("Unexpected event"),
1257 assert!(events.is_empty());
1259 if !skip_last && idx == expected_route.len() - 1 {
1260 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1267 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1269 let events = origin_node.node.get_and_clear_pending_events();
1270 assert_eq!(events.len(), 1);
1272 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1273 assert_eq!(payment_hash, our_payment_hash);
1274 assert!(rejected_by_dest);
1276 _ => panic!("Unexpected event"),
1281 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1282 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1285 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1286 let mut chan_mon_cfgs = Vec::new();
1287 for i in 0..node_count {
1288 let tx_broadcaster = test_utils::TestBroadcaster {
1289 txn_broadcasted: Mutex::new(Vec::new()),
1290 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1292 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
1293 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1294 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1295 let persister = test_utils::TestPersister::new();
1296 let seed = [i as u8; 32];
1297 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1299 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1305 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1306 let mut nodes = Vec::new();
1308 for i in 0..node_count {
1309 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);
1310 let seed = [i as u8; 32];
1311 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 });
1317 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>> {
1318 let mut chanmgrs = Vec::new();
1319 for i in 0..node_count {
1320 let mut default_config = UserConfig::default();
1321 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1322 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1323 default_config.channel_options.cltv_expiry_delta = 6*6;
1324 default_config.channel_options.announced_channel = true;
1325 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1326 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
1327 let network = Network::Testnet;
1328 let params = ChainParameters {
1330 best_block: BestBlock::from_genesis(network),
1332 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);
1333 chanmgrs.push(node);
1339 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>> {
1340 let mut nodes = Vec::new();
1341 let chan_count = Rc::new(RefCell::new(0));
1342 let payment_count = Rc::new(RefCell::new(0));
1343 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1345 for i in 0..node_count {
1346 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].chain_source.genesis_hash, None, cfgs[i].logger);
1347 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1348 tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1349 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1350 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1351 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1352 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1353 connect_style: Rc::clone(&connect_style),
1360 // Note that the following only works for CLTV values up to 128
1361 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1362 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1364 #[derive(PartialEq)]
1365 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1366 /// Tests that the given node has broadcast transactions for the given Channel
1368 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1369 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1370 /// broadcast and the revoked outputs were claimed.
1372 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1373 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1375 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1377 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> {
1378 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1379 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1381 let mut res = Vec::with_capacity(2);
1382 node_txn.retain(|tx| {
1383 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1384 check_spends!(tx, chan.3);
1385 if commitment_tx.is_none() {
1386 res.push(tx.clone());
1391 if let Some(explicit_tx) = commitment_tx {
1392 res.push(explicit_tx.clone());
1395 assert_eq!(res.len(), 1);
1397 if has_htlc_tx != HTLCType::NONE {
1398 node_txn.retain(|tx| {
1399 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1400 check_spends!(tx, res[0]);
1401 if has_htlc_tx == HTLCType::TIMEOUT {
1402 assert!(tx.lock_time != 0);
1404 assert!(tx.lock_time == 0);
1406 res.push(tx.clone());
1410 assert!(res.len() == 2 || res.len() == 3);
1412 assert_eq!(res[1], res[2]);
1416 assert!(node_txn.is_empty());
1420 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1421 /// HTLC transaction.
1422 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1423 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1424 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1425 // for revoked htlc outputs
1426 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1427 node_txn.retain(|tx| {
1428 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1429 check_spends!(tx, revoked_tx);
1433 node_txn.retain(|tx| {
1434 check_spends!(tx, commitment_revoked_tx);
1437 assert!(node_txn.is_empty());
1440 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1441 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1443 assert!(node_txn.len() >= 1);
1444 assert_eq!(node_txn[0].input.len(), 1);
1445 let mut found_prev = false;
1447 for tx in prev_txn {
1448 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1449 check_spends!(node_txn[0], tx);
1450 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1451 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1457 assert!(found_prev);
1459 let mut res = Vec::new();
1460 mem::swap(&mut *node_txn, &mut res);
1464 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) {
1465 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1466 assert_eq!(events_1.len(), 2);
1467 let as_update = match events_1[0] {
1468 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1471 _ => panic!("Unexpected event"),
1474 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1475 assert_eq!(node_id, nodes[b].node.get_our_node_id());
1476 assert_eq!(msg.data, expected_error);
1477 if needs_err_handle {
1478 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1481 _ => panic!("Unexpected event"),
1484 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1485 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1486 let bs_update = match events_2[0] {
1487 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1490 _ => panic!("Unexpected event"),
1492 if !needs_err_handle {
1494 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1495 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1496 assert_eq!(msg.data, expected_error);
1498 _ => panic!("Unexpected event"),
1503 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1504 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1508 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1509 handle_announce_close_broadcast_events(nodes, a, b, false, "Commitment or closing transaction was confirmed on chain.");
1513 macro_rules! get_channel_value_stat {
1514 ($node: expr, $channel_id: expr) => {{
1515 let chan_lock = $node.node.channel_state.lock().unwrap();
1516 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1517 chan.get_value_stat()
1521 macro_rules! get_chan_reestablish_msgs {
1522 ($src_node: expr, $dst_node: expr) => {
1524 let mut res = Vec::with_capacity(1);
1525 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1526 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1527 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1528 res.push(msg.clone());
1530 panic!("Unexpected event")
1538 macro_rules! handle_chan_reestablish_msgs {
1539 ($src_node: expr, $dst_node: expr) => {
1541 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1543 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1545 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1551 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
1553 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1556 let mut revoke_and_ack = None;
1557 let mut commitment_update = None;
1558 let order = if let Some(ev) = msg_events.get(idx) {
1561 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1562 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1563 revoke_and_ack = Some(msg.clone());
1564 RAACommitmentOrder::RevokeAndACKFirst
1566 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1567 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1568 commitment_update = Some(updates.clone());
1569 RAACommitmentOrder::CommitmentFirst
1571 _ => panic!("Unexpected event"),
1574 RAACommitmentOrder::CommitmentFirst
1577 if let Some(ev) = msg_events.get(idx) {
1579 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1580 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1581 assert!(revoke_and_ack.is_none());
1582 revoke_and_ack = Some(msg.clone());
1584 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1585 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1586 assert!(commitment_update.is_none());
1587 commitment_update = Some(updates.clone());
1589 _ => panic!("Unexpected event"),
1593 (funding_locked, revoke_and_ack, commitment_update, order)
1598 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1599 /// for claims/fails they are separated out.
1600 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)) {
1601 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1602 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1603 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1604 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1606 if send_funding_locked.0 {
1607 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1609 for reestablish in reestablish_1.iter() {
1610 assert_eq!(reestablish.next_remote_commitment_number, 0);
1613 if send_funding_locked.1 {
1614 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1616 for reestablish in reestablish_2.iter() {
1617 assert_eq!(reestablish.next_remote_commitment_number, 0);
1620 if send_funding_locked.0 || send_funding_locked.1 {
1621 // If we expect any funding_locked's, both sides better have set
1622 // next_holder_commitment_number to 1
1623 for reestablish in reestablish_1.iter() {
1624 assert_eq!(reestablish.next_local_commitment_number, 1);
1626 for reestablish in reestablish_2.iter() {
1627 assert_eq!(reestablish.next_local_commitment_number, 1);
1631 let mut resp_1 = Vec::new();
1632 for msg in reestablish_1 {
1633 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1634 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1636 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1637 check_added_monitors!(node_b, 1);
1639 check_added_monitors!(node_b, 0);
1642 let mut resp_2 = Vec::new();
1643 for msg in reestablish_2 {
1644 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1645 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1647 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1648 check_added_monitors!(node_a, 1);
1650 check_added_monitors!(node_a, 0);
1653 // We don't yet support both needing updates, as that would require a different commitment dance:
1654 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1655 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1657 for chan_msgs in resp_1.drain(..) {
1658 if send_funding_locked.0 {
1659 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1660 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1661 if !announcement_event.is_empty() {
1662 assert_eq!(announcement_event.len(), 1);
1663 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1664 //TODO: Test announcement_sigs re-sending
1665 } else { panic!("Unexpected event!"); }
1668 assert!(chan_msgs.0.is_none());
1671 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1672 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1673 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1674 check_added_monitors!(node_a, 1);
1676 assert!(chan_msgs.1.is_none());
1678 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1679 let commitment_update = chan_msgs.2.unwrap();
1680 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1681 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1683 assert!(commitment_update.update_add_htlcs.is_empty());
1685 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1686 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1687 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1688 for update_add in commitment_update.update_add_htlcs {
1689 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1691 for update_fulfill in commitment_update.update_fulfill_htlcs {
1692 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1694 for update_fail in commitment_update.update_fail_htlcs {
1695 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1698 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1699 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1701 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1702 check_added_monitors!(node_a, 1);
1703 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1704 // No commitment_signed so get_event_msg's assert(len == 1) passes
1705 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1706 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1707 check_added_monitors!(node_b, 1);
1710 assert!(chan_msgs.2.is_none());
1714 for chan_msgs in resp_2.drain(..) {
1715 if send_funding_locked.1 {
1716 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1717 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1718 if !announcement_event.is_empty() {
1719 assert_eq!(announcement_event.len(), 1);
1720 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1721 //TODO: Test announcement_sigs re-sending
1722 } else { panic!("Unexpected event!"); }
1725 assert!(chan_msgs.0.is_none());
1728 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1729 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1730 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1731 check_added_monitors!(node_b, 1);
1733 assert!(chan_msgs.1.is_none());
1735 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1736 let commitment_update = chan_msgs.2.unwrap();
1737 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1738 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1740 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1741 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1742 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1743 for update_add in commitment_update.update_add_htlcs {
1744 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1746 for update_fulfill in commitment_update.update_fulfill_htlcs {
1747 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1749 for update_fail in commitment_update.update_fail_htlcs {
1750 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1753 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1754 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1756 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1757 check_added_monitors!(node_b, 1);
1758 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1759 // No commitment_signed so get_event_msg's assert(len == 1) passes
1760 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1761 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1762 check_added_monitors!(node_a, 1);
1765 assert!(chan_msgs.2.is_none());