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::channelmanager::{BestBlock, 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 {
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 #[derive(Clone, Copy, PartialEq)]
81 pub enum ConnectStyle {
82 /// Calls best_block_updated first, detecting transactions in the block only after receiving the
83 /// header and height information.
85 /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
86 /// make a single best_block_updated call.
87 BestBlockFirstSkippingBlocks,
88 /// Calls transactions_confirmed first, detecting transactions in the block before updating the
89 /// header and height information.
91 /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
92 /// make a single best_block_updated call.
93 TransactionsFirstSkippingBlocks,
94 /// Provides the full block via the chain::Listen interface. In the current code this is
95 /// equivalent to TransactionsFirst with some additional assertions.
99 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
100 let skip_intermediaries = match *node.connect_style.borrow() {
101 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
105 let mut block = Block {
106 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
110 for _ in 0..depth - 1 {
111 do_connect_block(node, &block, skip_intermediaries);
113 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
117 connect_block(node, &block);
118 block.header.block_hash()
121 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
122 do_connect_block(node, block, false);
125 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
126 let height = node.best_block_info().1 + 1;
127 if !skip_intermediaries {
128 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
129 match *node.connect_style.borrow() {
130 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
131 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
132 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
133 node.node.best_block_updated(&block.header, height);
134 node.node.transactions_confirmed(&block.header, &txdata, height);
136 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
137 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
138 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
139 node.node.transactions_confirmed(&block.header, &txdata, height);
140 node.node.best_block_updated(&block.header, height);
142 ConnectStyle::FullBlockViaListen => {
143 node.chain_monitor.chain_monitor.block_connected(&block, height);
144 node.node.block_connected(&block, height);
148 node.node.test_process_background_events();
149 node.blocks.borrow_mut().push((block.header, height));
152 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
154 let orig_header = node.blocks.borrow_mut().pop().unwrap();
155 assert!(orig_header.1 > 0); // Cannot disconnect genesis
156 let prev_header = node.blocks.borrow().last().unwrap().clone();
158 match *node.connect_style.borrow() {
159 ConnectStyle::FullBlockViaListen => {
160 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
161 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
163 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
165 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
166 node.node.best_block_updated(&prev_header.0, prev_header.1);
170 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
171 node.node.best_block_updated(&prev_header.0, prev_header.1);
177 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
178 let count = node.blocks.borrow_mut().len() as u32 - 1;
179 disconnect_blocks(node, count);
182 pub struct TestChanMonCfg {
183 pub tx_broadcaster: test_utils::TestBroadcaster,
184 pub fee_estimator: test_utils::TestFeeEstimator,
185 pub chain_source: test_utils::TestChainSource,
186 pub persister: test_utils::TestPersister,
187 pub logger: test_utils::TestLogger,
188 pub keys_manager: test_utils::TestKeysInterface,
191 pub struct NodeCfg<'a> {
192 pub chain_source: &'a test_utils::TestChainSource,
193 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
194 pub fee_estimator: &'a test_utils::TestFeeEstimator,
195 pub chain_monitor: test_utils::TestChainMonitor<'a>,
196 pub keys_manager: &'a test_utils::TestKeysInterface,
197 pub logger: &'a test_utils::TestLogger,
198 pub node_seed: [u8; 32],
201 pub struct Node<'a, 'b: 'a, 'c: 'b> {
202 pub chain_source: &'c test_utils::TestChainSource,
203 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
204 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
205 pub keys_manager: &'b test_utils::TestKeysInterface,
206 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
207 pub net_graph_msg_handler: NetGraphMsgHandler<&'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
208 pub node_seed: [u8; 32],
209 pub network_payment_count: Rc<RefCell<u8>>,
210 pub network_chan_count: Rc<RefCell<u32>>,
211 pub logger: &'c test_utils::TestLogger,
212 pub blocks: RefCell<Vec<(BlockHeader, u32)>>,
213 pub connect_style: Rc<RefCell<ConnectStyle>>,
215 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
216 pub fn best_block_hash(&self) -> BlockHash {
217 self.blocks.borrow_mut().last().unwrap().0.block_hash()
219 pub fn best_block_info(&self) -> (BlockHash, u32) {
220 self.blocks.borrow_mut().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
224 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
226 if !::std::thread::panicking() {
227 // Check that we processed all pending events
228 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
229 assert!(self.node.get_and_clear_pending_events().is_empty());
230 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
232 // Check that if we serialize the Router, we can deserialize it again.
234 let mut w = test_utils::TestVecWriter(Vec::new());
235 let network_graph_ser = self.net_graph_msg_handler.network_graph.read().unwrap();
236 network_graph_ser.write(&mut w).unwrap();
237 let network_graph_deser = <NetworkGraph>::read(&mut ::std::io::Cursor::new(&w.0)).unwrap();
238 assert!(network_graph_deser == *self.net_graph_msg_handler.network_graph.read().unwrap());
239 let net_graph_msg_handler = NetGraphMsgHandler::from_net_graph(
240 Some(self.chain_source), self.logger, network_graph_deser
242 let mut chan_progress = 0;
244 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
245 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
246 assert!(orig_announcements == deserialized_announcements);
247 chan_progress = match orig_announcements.last() {
248 Some(announcement) => announcement.0.contents.short_channel_id + 1,
252 let mut node_progress = None;
254 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
255 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
256 assert!(orig_announcements == deserialized_announcements);
257 node_progress = match orig_announcements.last() {
258 Some(announcement) => Some(announcement.contents.node_id),
264 // Check that if we serialize and then deserialize all our channel monitors we get the
265 // same set of outputs to watch for on chain as we have now. Note that if we write
266 // tests that fully close channels and remove the monitors at some point this may break.
267 let feeest = test_utils::TestFeeEstimator { sat_per_kw: 253 };
268 let mut deserialized_monitors = Vec::new();
270 let old_monitors = self.chain_monitor.chain_monitor.monitors.read().unwrap();
271 for (_, old_monitor) in old_monitors.iter() {
272 let mut w = test_utils::TestVecWriter(Vec::new());
273 old_monitor.write(&mut w).unwrap();
274 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
275 &mut ::std::io::Cursor::new(&w.0), self.keys_manager).unwrap();
276 deserialized_monitors.push(deserialized_monitor);
280 // Before using all the new monitors to check the watch outpoints, use the full set of
281 // them to ensure we can write and reload our ChannelManager.
283 let mut channel_monitors = HashMap::new();
284 for monitor in deserialized_monitors.iter_mut() {
285 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
288 let mut w = test_utils::TestVecWriter(Vec::new());
289 self.node.write(&mut w).unwrap();
290 <(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 {
291 default_config: *self.node.get_current_default_configuration(),
292 keys_manager: self.keys_manager,
293 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: 253 },
294 chain_monitor: self.chain_monitor,
295 tx_broadcaster: &test_utils::TestBroadcaster {
296 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
298 logger: &test_utils::TestLogger::new(),
303 let persister = test_utils::TestPersister::new();
304 let broadcaster = test_utils::TestBroadcaster {
305 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
307 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
308 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
309 for deserialized_monitor in deserialized_monitors.drain(..) {
310 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
314 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
315 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
320 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) {
321 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
324 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) {
325 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);
326 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
327 (announcement, as_update, bs_update, channel_id, tx)
330 macro_rules! get_revoke_commit_msgs {
331 ($node: expr, $node_id: expr) => {
333 let events = $node.node.get_and_clear_pending_msg_events();
334 assert_eq!(events.len(), 2);
336 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
337 assert_eq!(*node_id, $node_id);
340 _ => panic!("Unexpected event"),
342 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
343 assert_eq!(*node_id, $node_id);
344 assert!(updates.update_add_htlcs.is_empty());
345 assert!(updates.update_fulfill_htlcs.is_empty());
346 assert!(updates.update_fail_htlcs.is_empty());
347 assert!(updates.update_fail_malformed_htlcs.is_empty());
348 assert!(updates.update_fee.is_none());
349 updates.commitment_signed.clone()
351 _ => panic!("Unexpected event"),
357 /// Get an specific event message from the pending events queue.
359 macro_rules! get_event_msg {
360 ($node: expr, $event_type: path, $node_id: expr) => {
362 let events = $node.node.get_and_clear_pending_msg_events();
363 assert_eq!(events.len(), 1);
365 $event_type { ref node_id, ref msg } => {
366 assert_eq!(*node_id, $node_id);
369 _ => panic!("Unexpected event"),
375 /// Get a specific event from the pending events queue.
377 macro_rules! get_event {
378 ($node: expr, $event_type: path) => {
380 let mut events = $node.node.get_and_clear_pending_events();
381 assert_eq!(events.len(), 1);
382 let ev = events.pop().unwrap();
384 $event_type { .. } => {
387 _ => panic!("Unexpected event"),
394 macro_rules! get_htlc_update_msgs {
395 ($node: expr, $node_id: expr) => {
397 let events = $node.node.get_and_clear_pending_msg_events();
398 assert_eq!(events.len(), 1);
400 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
401 assert_eq!(*node_id, $node_id);
404 _ => panic!("Unexpected event"),
411 macro_rules! get_feerate {
412 ($node: expr, $channel_id: expr) => {
414 let chan_lock = $node.node.channel_state.lock().unwrap();
415 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
421 /// Returns any local commitment transactions for the channel.
423 macro_rules! get_local_commitment_txn {
424 ($node: expr, $channel_id: expr) => {
426 let monitors = $node.chain_monitor.chain_monitor.monitors.read().unwrap();
427 let mut commitment_txn = None;
428 for (funding_txo, monitor) in monitors.iter() {
429 if funding_txo.to_channel_id() == $channel_id {
430 commitment_txn = Some(monitor.unsafe_get_latest_holder_commitment_txn(&$node.logger));
434 commitment_txn.unwrap()
439 /// Check the error from attempting a payment.
441 macro_rules! unwrap_send_err {
442 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
444 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
445 assert_eq!(fails.len(), 1);
451 &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
452 assert_eq!(fails.len(), 1);
454 Err($type) => { $check },
463 /// Check whether N channel monitor(s) have been added.
465 macro_rules! check_added_monitors {
466 ($node: expr, $count: expr) => {
468 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
469 assert_eq!(added_monitors.len(), $count);
470 added_monitors.clear();
475 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) {
476 let chan_id = *node.network_chan_count.borrow();
478 let events = node.node.get_and_clear_pending_events();
479 assert_eq!(events.len(), 1);
481 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
482 assert_eq!(*channel_value_satoshis, expected_chan_value);
483 assert_eq!(user_channel_id, expected_user_chan_id);
485 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
486 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
488 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
489 (*temporary_channel_id, tx, funding_outpoint)
491 _ => panic!("Unexpected event"),
495 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 {
496 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
497 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()));
498 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()));
500 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
502 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
503 check_added_monitors!(node_a, 0);
505 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()));
507 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
508 assert_eq!(added_monitors.len(), 1);
509 assert_eq!(added_monitors[0].0, funding_output);
510 added_monitors.clear();
513 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()));
515 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
516 assert_eq!(added_monitors.len(), 1);
517 assert_eq!(added_monitors[0].0, funding_output);
518 added_monitors.clear();
521 let events_4 = node_a.node.get_and_clear_pending_events();
522 assert_eq!(events_4.len(), 0);
524 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
525 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
526 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
531 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) {
532 confirm_transaction_at(node_conf, tx, conf_height);
533 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
534 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()));
537 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]) {
539 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
540 assert_eq!(events_6.len(), 2);
541 ((match events_6[0] {
542 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
543 channel_id = msg.channel_id.clone();
544 assert_eq!(*node_id, node_recv.node.get_our_node_id());
547 _ => panic!("Unexpected event"),
548 }, match events_6[1] {
549 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
550 assert_eq!(*node_id, node_recv.node.get_our_node_id());
553 _ => panic!("Unexpected event"),
557 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]) {
558 let conf_height = std::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
559 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
560 confirm_transaction_at(node_a, tx, conf_height);
561 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
562 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
565 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) {
566 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
567 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
571 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) {
572 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
573 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
574 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
576 let events_7 = node_b.node.get_and_clear_pending_msg_events();
577 assert_eq!(events_7.len(), 1);
578 let (announcement, bs_update) = match events_7[0] {
579 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
582 _ => panic!("Unexpected event"),
585 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
586 let events_8 = node_a.node.get_and_clear_pending_msg_events();
587 assert_eq!(events_8.len(), 1);
588 let as_update = match events_8[0] {
589 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
590 assert!(*announcement == *msg);
591 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
592 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
595 _ => panic!("Unexpected event"),
598 *node_a.network_chan_count.borrow_mut() += 1;
600 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
603 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) {
604 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
607 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) {
608 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
609 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
610 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
613 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) {
614 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
615 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
616 assert_eq!(a_events.len(), 1);
617 let a_node_announcement = match a_events[0] {
618 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
621 _ => panic!("Unexpected event"),
624 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
625 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
626 assert_eq!(b_events.len(), 1);
627 let b_node_announcement = match b_events[0] {
628 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
631 _ => panic!("Unexpected event"),
635 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
636 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
637 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
638 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
639 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
643 macro_rules! check_spends {
644 ($tx: expr, $($spends_txn: expr),*) => {
646 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
648 if out_point.txid == $spends_txn.txid() {
649 return $spends_txn.output.get(out_point.vout as usize).cloned()
654 let mut total_value_in = 0;
655 for input in $tx.input.iter() {
656 total_value_in += get_output(&input.previous_output).unwrap().value;
658 let mut total_value_out = 0;
659 for output in $tx.output.iter() {
660 total_value_out += output.value;
662 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
663 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
664 assert!(total_value_out + min_fee <= total_value_in);
665 $tx.verify(get_output).unwrap();
670 macro_rules! get_closing_signed_broadcast {
671 ($node: expr, $dest_pubkey: expr) => {
673 let events = $node.get_and_clear_pending_msg_events();
674 assert!(events.len() == 1 || events.len() == 2);
675 (match events[events.len() - 1] {
676 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
677 assert_eq!(msg.contents.flags & 2, 2);
680 _ => panic!("Unexpected event"),
681 }, if events.len() == 2 {
683 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
684 assert_eq!(*node_id, $dest_pubkey);
687 _ => panic!("Unexpected event"),
694 /// Check that a channel's closing channel update has been broadcasted, and optionally
695 /// check whether an error message event has occurred.
697 macro_rules! check_closed_broadcast {
698 ($node: expr, $with_error_msg: expr) => {{
699 let events = $node.node.get_and_clear_pending_msg_events();
700 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
702 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
703 assert_eq!(msg.contents.flags & 2, 2);
705 _ => panic!("Unexpected event"),
709 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
710 // TODO: Check node_id
713 _ => panic!("Unexpected event"),
719 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) {
720 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) };
721 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
724 node_a.close_channel(channel_id).unwrap();
725 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()));
727 let events_1 = node_b.get_and_clear_pending_msg_events();
728 assert!(events_1.len() >= 1);
729 let shutdown_b = match events_1[0] {
730 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
731 assert_eq!(node_id, &node_a.get_our_node_id());
734 _ => panic!("Unexpected event"),
737 let closing_signed_b = if !close_inbound_first {
738 assert_eq!(events_1.len(), 1);
741 Some(match events_1[1] {
742 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
743 assert_eq!(node_id, &node_a.get_our_node_id());
746 _ => panic!("Unexpected event"),
750 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
751 let (as_update, bs_update) = if close_inbound_first {
752 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
753 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
754 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
755 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
756 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
758 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
759 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
760 assert!(none_b.is_none());
761 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
762 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
763 (as_update, bs_update)
765 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
767 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
768 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
769 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
770 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
772 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
773 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
774 assert!(none_a.is_none());
775 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
776 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
777 (as_update, bs_update)
779 assert_eq!(tx_a, tx_b);
780 check_spends!(tx_a, funding_tx);
782 (as_update, bs_update, tx_a)
785 pub struct SendEvent {
786 pub node_id: PublicKey,
787 pub msgs: Vec<msgs::UpdateAddHTLC>,
788 pub commitment_msg: msgs::CommitmentSigned,
791 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
792 assert!(updates.update_fulfill_htlcs.is_empty());
793 assert!(updates.update_fail_htlcs.is_empty());
794 assert!(updates.update_fail_malformed_htlcs.is_empty());
795 assert!(updates.update_fee.is_none());
796 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
799 pub fn from_event(event: MessageSendEvent) -> SendEvent {
801 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
802 _ => panic!("Unexpected event type!"),
806 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
807 let mut events = node.node.get_and_clear_pending_msg_events();
808 assert_eq!(events.len(), 1);
809 SendEvent::from_event(events.pop().unwrap())
813 macro_rules! commitment_signed_dance {
814 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
816 check_added_monitors!($node_a, 0);
817 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
818 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
819 check_added_monitors!($node_a, 1);
820 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
823 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
825 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
826 check_added_monitors!($node_b, 0);
827 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
828 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
829 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
830 check_added_monitors!($node_b, 1);
831 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
832 let (bs_revoke_and_ack, extra_msg_option) = {
833 let events = $node_b.node.get_and_clear_pending_msg_events();
834 assert!(events.len() <= 2);
836 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
837 assert_eq!(*node_id, $node_a.node.get_our_node_id());
840 _ => panic!("Unexpected event"),
841 }, events.get(1).map(|e| e.clone()))
843 check_added_monitors!($node_b, 1);
845 assert!($node_a.node.get_and_clear_pending_events().is_empty());
846 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
848 (extra_msg_option, bs_revoke_and_ack)
851 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
853 check_added_monitors!($node_a, 0);
854 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
855 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
856 check_added_monitors!($node_a, 1);
857 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
858 assert!(extra_msg_option.is_none());
862 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
864 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
865 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
866 check_added_monitors!($node_a, 1);
870 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
872 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
875 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
877 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
879 expect_pending_htlcs_forwardable!($node_a);
880 check_added_monitors!($node_a, 1);
882 let channel_state = $node_a.node.channel_state.lock().unwrap();
883 assert_eq!(channel_state.pending_msg_events.len(), 1);
884 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
885 assert_ne!(*node_id, $node_b.node.get_our_node_id());
886 } else { panic!("Unexpected event"); }
888 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
894 /// Get a payment preimage and hash.
896 macro_rules! get_payment_preimage_hash {
899 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
900 *$node.network_payment_count.borrow_mut() += 1;
901 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
902 (payment_preimage, payment_hash)
907 macro_rules! expect_pending_htlcs_forwardable_ignore {
909 let events = $node.node.get_and_clear_pending_events();
910 assert_eq!(events.len(), 1);
912 Event::PendingHTLCsForwardable { .. } => { },
913 _ => panic!("Unexpected event"),
918 macro_rules! expect_pending_htlcs_forwardable {
920 expect_pending_htlcs_forwardable_ignore!($node);
921 $node.node.process_pending_htlc_forwards();
925 #[cfg(any(test, feature = "unstable"))]
926 macro_rules! expect_payment_received {
927 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
928 let events = $node.node.get_and_clear_pending_events();
929 assert_eq!(events.len(), 1);
931 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
932 assert_eq!($expected_payment_hash, *payment_hash);
933 assert_eq!(None, *payment_secret);
934 assert_eq!($expected_recv_value, amt);
936 _ => panic!("Unexpected event"),
941 macro_rules! expect_payment_sent {
942 ($node: expr, $expected_payment_preimage: expr) => {
943 let events = $node.node.get_and_clear_pending_events();
944 assert_eq!(events.len(), 1);
946 Event::PaymentSent { ref payment_preimage } => {
947 assert_eq!($expected_payment_preimage, *payment_preimage);
949 _ => panic!("Unexpected event"),
955 macro_rules! expect_payment_failed {
956 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
957 let events = $node.node.get_and_clear_pending_events();
958 assert_eq!(events.len(), 1);
960 Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data } => {
961 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
962 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
963 assert!(error_code.is_some(), "expected error_code.is_some() = true");
964 assert!(error_data.is_some(), "expected error_data.is_some() = true");
966 assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
967 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
970 _ => panic!("Unexpected event"),
975 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>) {
976 origin_node.node.send_payment(&route, our_payment_hash, &our_payment_secret).unwrap();
977 check_added_monitors!(origin_node, expected_paths.len());
978 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
981 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) {
982 let mut payment_event = SendEvent::from_event(ev);
983 let mut prev_node = origin_node;
985 for (idx, &node) in expected_path.iter().enumerate() {
986 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
988 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
989 check_added_monitors!(node, 0);
990 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
992 expect_pending_htlcs_forwardable!(node);
994 if idx == expected_path.len() - 1 {
995 let events_2 = node.node.get_and_clear_pending_events();
996 if payment_received_expected {
997 assert_eq!(events_2.len(), 1);
999 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1000 assert_eq!(our_payment_hash, *payment_hash);
1001 assert_eq!(our_payment_secret, *payment_secret);
1002 assert_eq!(amt, recv_value);
1004 _ => panic!("Unexpected event"),
1007 assert!(events_2.is_empty());
1010 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1011 assert_eq!(events_2.len(), 1);
1012 check_added_monitors!(node, 1);
1013 payment_event = SendEvent::from_event(events_2.remove(0));
1014 assert_eq!(payment_event.msgs.len(), 1);
1021 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>) {
1022 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1023 assert_eq!(events.len(), expected_route.len());
1024 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1025 // Once we've gotten through all the HTLCs, the last one should result in a
1026 // PaymentReceived (but each previous one should not!), .
1027 let expect_payment = path_idx == expected_route.len() - 1;
1028 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), our_payment_secret, ev, expect_payment);
1032 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) {
1033 send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, None);
1036 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) {
1037 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
1038 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
1039 (our_payment_preimage, our_payment_hash)
1042 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) {
1043 for path in expected_paths.iter() {
1044 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1046 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage, &our_payment_secret, expected_amount));
1047 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1049 macro_rules! msgs_from_ev {
1052 &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 } } => {
1053 assert!(update_add_htlcs.is_empty());
1054 assert_eq!(update_fulfill_htlcs.len(), 1);
1055 assert!(update_fail_htlcs.is_empty());
1056 assert!(update_fail_malformed_htlcs.is_empty());
1057 assert!(update_fee.is_none());
1058 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1060 _ => panic!("Unexpected event"),
1064 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1065 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1066 assert_eq!(events.len(), expected_paths.len());
1067 for ev in events.iter() {
1068 per_path_msgs.push(msgs_from_ev!(ev));
1071 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1072 let mut next_msgs = Some(path_msgs);
1073 let mut expected_next_node = next_hop;
1075 macro_rules! last_update_fulfill_dance {
1076 ($node: expr, $prev_node: expr) => {
1078 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1079 check_added_monitors!($node, 0);
1080 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1081 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1085 macro_rules! mid_update_fulfill_dance {
1086 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1088 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1089 check_added_monitors!($node, 1);
1090 let new_next_msgs = if $new_msgs {
1091 let events = $node.node.get_and_clear_pending_msg_events();
1092 assert_eq!(events.len(), 1);
1093 let (res, nexthop) = msgs_from_ev!(&events[0]);
1094 expected_next_node = nexthop;
1097 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1100 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1101 next_msgs = new_next_msgs;
1106 let mut prev_node = expected_route.last().unwrap();
1107 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1108 assert_eq!(expected_next_node, node.node.get_our_node_id());
1109 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1110 if next_msgs.is_some() {
1111 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1113 assert!(!update_next_msgs);
1114 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1116 if !skip_last && idx == expected_route.len() - 1 {
1117 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1124 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1125 expect_payment_sent!(origin_node, our_payment_preimage);
1130 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) {
1131 claim_payment_along_route_with_secret(origin_node, &[expected_route], skip_last, our_payment_preimage, None, expected_amount);
1134 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) {
1135 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
1138 pub const TEST_FINAL_CLTV: u32 = 50;
1140 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
1141 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1142 let logger = test_utils::TestLogger::new();
1143 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();
1144 assert_eq!(route.paths.len(), 1);
1145 assert_eq!(route.paths[0].len(), expected_route.len());
1146 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1147 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1150 send_along_route(origin_node, route, expected_route, recv_value)
1153 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1154 let logger = test_utils::TestLogger::new();
1155 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1156 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();
1157 assert_eq!(route.paths.len(), 1);
1158 assert_eq!(route.paths[0].len(), expected_route.len());
1159 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1160 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1163 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
1164 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1165 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1168 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64) {
1169 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1170 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
1173 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) {
1174 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, &None));
1175 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
1176 check_added_monitors!(expected_route.last().unwrap(), 1);
1178 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
1179 macro_rules! update_fail_dance {
1180 ($node: expr, $prev_node: expr, $last_node: expr) => {
1182 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1183 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
1184 if skip_last && $last_node {
1185 expect_pending_htlcs_forwardable!($node);
1191 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
1192 let mut prev_node = expected_route.last().unwrap();
1193 for (idx, node) in expected_route.iter().rev().enumerate() {
1194 assert_eq!(expected_next_node, node.node.get_our_node_id());
1195 if next_msgs.is_some() {
1196 // We may be the "last node" for the purpose of the commitment dance if we're
1197 // skipping the last node (implying it is disconnected) and we're the
1198 // second-to-last node!
1199 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
1202 let events = node.node.get_and_clear_pending_msg_events();
1203 if !skip_last || idx != expected_route.len() - 1 {
1204 assert_eq!(events.len(), 1);
1206 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 } } => {
1207 assert!(update_add_htlcs.is_empty());
1208 assert!(update_fulfill_htlcs.is_empty());
1209 assert_eq!(update_fail_htlcs.len(), 1);
1210 assert!(update_fail_malformed_htlcs.is_empty());
1211 assert!(update_fee.is_none());
1212 expected_next_node = node_id.clone();
1213 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1215 _ => panic!("Unexpected event"),
1218 assert!(events.is_empty());
1220 if !skip_last && idx == expected_route.len() - 1 {
1221 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1228 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1230 let events = origin_node.node.get_and_clear_pending_events();
1231 assert_eq!(events.len(), 1);
1233 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1234 assert_eq!(payment_hash, our_payment_hash);
1235 assert!(rejected_by_dest);
1237 _ => panic!("Unexpected event"),
1242 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1243 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1246 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1247 let mut chan_mon_cfgs = Vec::new();
1248 for i in 0..node_count {
1249 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
1250 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
1251 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1252 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1253 let persister = test_utils::TestPersister::new();
1254 let seed = [i as u8; 32];
1255 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1257 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1263 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1264 let mut nodes = Vec::new();
1266 for i in 0..node_count {
1267 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);
1268 let seed = [i as u8; 32];
1269 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 });
1275 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>> {
1276 let mut chanmgrs = Vec::new();
1277 for i in 0..node_count {
1278 let mut default_config = UserConfig::default();
1279 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1280 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1281 default_config.channel_options.cltv_expiry_delta = 6*6;
1282 default_config.channel_options.announced_channel = true;
1283 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1284 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
1285 let network = Network::Testnet;
1286 let params = ChainParameters {
1288 best_block: BestBlock::from_genesis(network),
1290 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);
1291 chanmgrs.push(node);
1297 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>> {
1298 let mut nodes = Vec::new();
1299 let chan_count = Rc::new(RefCell::new(0));
1300 let payment_count = Rc::new(RefCell::new(0));
1301 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1303 for i in 0..node_count {
1304 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].chain_source.genesis_hash, None, cfgs[i].logger);
1305 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1306 tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1307 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1308 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1309 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1310 blocks: RefCell::new(vec![(genesis_block(Network::Testnet).header, 0)]),
1311 connect_style: Rc::clone(&connect_style),
1318 // Note that the following only works for CLTV values up to 128
1319 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1320 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1322 #[derive(PartialEq)]
1323 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1324 /// Tests that the given node has broadcast transactions for the given Channel
1326 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1327 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1328 /// broadcast and the revoked outputs were claimed.
1330 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1331 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1333 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1335 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> {
1336 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1337 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1339 let mut res = Vec::with_capacity(2);
1340 node_txn.retain(|tx| {
1341 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1342 check_spends!(tx, chan.3);
1343 if commitment_tx.is_none() {
1344 res.push(tx.clone());
1349 if let Some(explicit_tx) = commitment_tx {
1350 res.push(explicit_tx.clone());
1353 assert_eq!(res.len(), 1);
1355 if has_htlc_tx != HTLCType::NONE {
1356 node_txn.retain(|tx| {
1357 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1358 check_spends!(tx, res[0]);
1359 if has_htlc_tx == HTLCType::TIMEOUT {
1360 assert!(tx.lock_time != 0);
1362 assert!(tx.lock_time == 0);
1364 res.push(tx.clone());
1368 assert!(res.len() == 2 || res.len() == 3);
1370 assert_eq!(res[1], res[2]);
1374 assert!(node_txn.is_empty());
1378 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1379 /// HTLC transaction.
1380 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1381 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1382 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1383 // for revoked htlc outputs
1384 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1385 node_txn.retain(|tx| {
1386 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1387 check_spends!(tx, revoked_tx);
1391 node_txn.retain(|tx| {
1392 check_spends!(tx, commitment_revoked_tx);
1395 assert!(node_txn.is_empty());
1398 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1399 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1401 assert!(node_txn.len() >= 1);
1402 assert_eq!(node_txn[0].input.len(), 1);
1403 let mut found_prev = false;
1405 for tx in prev_txn {
1406 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1407 check_spends!(node_txn[0], tx);
1408 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1409 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1415 assert!(found_prev);
1417 let mut res = Vec::new();
1418 mem::swap(&mut *node_txn, &mut res);
1422 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) {
1423 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1424 assert_eq!(events_1.len(), 2);
1425 let as_update = match events_1[0] {
1426 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1429 _ => panic!("Unexpected event"),
1432 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1433 assert_eq!(node_id, nodes[b].node.get_our_node_id());
1434 assert_eq!(msg.data, expected_error);
1435 if needs_err_handle {
1436 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1439 _ => panic!("Unexpected event"),
1442 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1443 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1444 let bs_update = match events_2[0] {
1445 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1448 _ => panic!("Unexpected event"),
1450 if !needs_err_handle {
1452 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1453 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1454 assert_eq!(msg.data, expected_error);
1456 _ => panic!("Unexpected event"),
1461 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1462 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1466 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1467 handle_announce_close_broadcast_events(nodes, a, b, false, "Commitment or closing transaction was confirmed on chain.");
1471 macro_rules! get_channel_value_stat {
1472 ($node: expr, $channel_id: expr) => {{
1473 let chan_lock = $node.node.channel_state.lock().unwrap();
1474 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1475 chan.get_value_stat()
1479 macro_rules! get_chan_reestablish_msgs {
1480 ($src_node: expr, $dst_node: expr) => {
1482 let mut res = Vec::with_capacity(1);
1483 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1484 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1485 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1486 res.push(msg.clone());
1488 panic!("Unexpected event")
1496 macro_rules! handle_chan_reestablish_msgs {
1497 ($src_node: expr, $dst_node: expr) => {
1499 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1501 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1503 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1509 let mut revoke_and_ack = None;
1510 let mut commitment_update = None;
1511 let order = if let Some(ev) = msg_events.get(idx) {
1514 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1515 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1516 revoke_and_ack = Some(msg.clone());
1517 RAACommitmentOrder::RevokeAndACKFirst
1519 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1520 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1521 commitment_update = Some(updates.clone());
1522 RAACommitmentOrder::CommitmentFirst
1524 _ => panic!("Unexpected event"),
1527 RAACommitmentOrder::CommitmentFirst
1530 if let Some(ev) = msg_events.get(idx) {
1532 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1533 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1534 assert!(revoke_and_ack.is_none());
1535 revoke_and_ack = Some(msg.clone());
1537 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1538 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1539 assert!(commitment_update.is_none());
1540 commitment_update = Some(updates.clone());
1542 _ => panic!("Unexpected event"),
1546 (funding_locked, revoke_and_ack, commitment_update, order)
1551 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1552 /// for claims/fails they are separated out.
1553 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)) {
1554 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1555 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1556 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1557 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1559 if send_funding_locked.0 {
1560 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1562 for reestablish in reestablish_1.iter() {
1563 assert_eq!(reestablish.next_remote_commitment_number, 0);
1566 if send_funding_locked.1 {
1567 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1569 for reestablish in reestablish_2.iter() {
1570 assert_eq!(reestablish.next_remote_commitment_number, 0);
1573 if send_funding_locked.0 || send_funding_locked.1 {
1574 // If we expect any funding_locked's, both sides better have set
1575 // next_holder_commitment_number to 1
1576 for reestablish in reestablish_1.iter() {
1577 assert_eq!(reestablish.next_local_commitment_number, 1);
1579 for reestablish in reestablish_2.iter() {
1580 assert_eq!(reestablish.next_local_commitment_number, 1);
1584 let mut resp_1 = Vec::new();
1585 for msg in reestablish_1 {
1586 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1587 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1589 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1590 check_added_monitors!(node_b, 1);
1592 check_added_monitors!(node_b, 0);
1595 let mut resp_2 = Vec::new();
1596 for msg in reestablish_2 {
1597 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1598 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1600 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1601 check_added_monitors!(node_a, 1);
1603 check_added_monitors!(node_a, 0);
1606 // We don't yet support both needing updates, as that would require a different commitment dance:
1607 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1608 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1610 for chan_msgs in resp_1.drain(..) {
1611 if send_funding_locked.0 {
1612 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1613 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1614 if !announcement_event.is_empty() {
1615 assert_eq!(announcement_event.len(), 1);
1616 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1617 //TODO: Test announcement_sigs re-sending
1618 } else { panic!("Unexpected event!"); }
1621 assert!(chan_msgs.0.is_none());
1624 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1625 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1626 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1627 check_added_monitors!(node_a, 1);
1629 assert!(chan_msgs.1.is_none());
1631 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1632 let commitment_update = chan_msgs.2.unwrap();
1633 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1634 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1636 assert!(commitment_update.update_add_htlcs.is_empty());
1638 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1639 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1640 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1641 for update_add in commitment_update.update_add_htlcs {
1642 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1644 for update_fulfill in commitment_update.update_fulfill_htlcs {
1645 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1647 for update_fail in commitment_update.update_fail_htlcs {
1648 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1651 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1652 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1654 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1655 check_added_monitors!(node_a, 1);
1656 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1657 // No commitment_signed so get_event_msg's assert(len == 1) passes
1658 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1659 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1660 check_added_monitors!(node_b, 1);
1663 assert!(chan_msgs.2.is_none());
1667 for chan_msgs in resp_2.drain(..) {
1668 if send_funding_locked.1 {
1669 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1670 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1671 if !announcement_event.is_empty() {
1672 assert_eq!(announcement_event.len(), 1);
1673 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1674 //TODO: Test announcement_sigs re-sending
1675 } else { panic!("Unexpected event!"); }
1678 assert!(chan_msgs.0.is_none());
1681 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1682 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1683 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1684 check_added_monitors!(node_b, 1);
1686 assert!(chan_msgs.1.is_none());
1688 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1689 let commitment_update = chan_msgs.2.unwrap();
1690 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1691 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1693 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1694 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1695 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1696 for update_add in commitment_update.update_add_htlcs {
1697 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1699 for update_fulfill in commitment_update.update_fulfill_htlcs {
1700 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1702 for update_fail in commitment_update.update_fail_htlcs {
1703 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1706 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1707 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1709 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1710 check_added_monitors!(node_b, 1);
1711 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1712 // No commitment_signed so get_event_msg's assert(len == 1) passes
1713 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1714 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1715 check_added_monitors!(node_a, 1);
1718 assert!(chan_msgs.2.is_none());